# 快麦开放平台公开文档全文

以下内容由站点构建时从 Markdown/MDX 文档生成，移除了页面组件 import，并保留正文表格与代码块。

## 接入指南

URL: https://open.kuaimai.com/docs/api/API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97
Markdown: https://open.kuaimai.com/__ai/markdown/api/10-API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/10-%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97.md

# 接入指南

## 快麦ERP开放平台接入指南

**如果是首次对接快麦ERP开放平台（以下简称“开放平台”）的，请先花几分钟阅读一下以下内容，谢谢配合~**

1. 自研商家如有开放平台对接需求的，与快麦ERP销售同学或实施同学确认需要对接的场景后，可联系快麦ERP销售同学或实施同学[申请API权限](/applyApp)，申请API需要提供的信息包括快麦ERP公司名称、快麦商家负责人邮箱、以及需要对接的场景描述，申请审核通过后会以邮件的方式将针对该公司账号的APP Key与APP Secret发送到申请时提供的快麦商家负责人邮箱，邮件内容请商家负责人妥善保管。

2. 自研商家如需使用快麦ERP测试公司账号调试接口，可联系销售同学或实施同学开通测试公司账号，销售同学或实施同学将使用测试公司账号[申请API权限](/applyApp)，申请审核通过后会以邮件的方式将针对该测试公司账号的APP Key与APP Secret发送到申请时提供的邮箱。自研商家可在快麦ERP测试公司账号确认接口调通后，再切换至正式公司账号。

3. API权限提交申请后，一般在1-3工作日内审核。若长时间未审核，可联系实施或客服去问题群让业务机器人开通，开放平台审核（格式：公司名称-开放平台审核-用户申请邮箱）。

4. API权限申请通过后，appkey有效日期与开通的快麦ERP账号有效期一致

5. 特殊说明：若用户需求获取快麦ERP里拼多多订单数据，当前需要[接入拼多多自研接口](https://open.kuaimai.com/docs/question/%E7%B3%BB%E7%BB%9F%E5%85%AC%E5%91%8A/%E6%8B%BC%E5%A4%9A%E5%A4%9A%E8%87%AA%E7%A0%94%E6%8E%A5%E5%8F%A3%E6%8E%A5%E5%85%A5%E5%BC%80%E6%94%BE%E5%85%AC%E5%91%8A/)

**注意：**

1. 为了快麦商家账号的信息安全，正式公司账号的API申请邮箱需要使用快麦商家负责人的邮箱 ，APP Key与APP Secret信息请快麦商家自行妥善保管，商家对APP Key与APP Secret的机密负完全责任，不随意透露给任何第三方，以免造成不必要的损失！商家如果在发现或怀疑他人未经授权就使用其APP Key和APP Secret时立即通知快麦ERP；

2. API近60天内如果无有效调用，开放平台可回收API使用权限；

3. 通过开放平台获取的商家数据均应事先获得商家授权，该数据仅可以展现和使用于数据来源的同一卖家，不允许将数据共享于其他组织或个人使用；

4. 调用API侵犯快麦ERP权利的，开放平台将收回接口权限。

5. 报表/智库模块的接口为增值接口，如果需要对接和使用，请联系销售同学或实施同学获取报价与接口文档。

---

## AI文本说明

URL: https://open.kuaimai.com/docs/api/API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/AI%E6%96%87%E6%9C%AC%E8%AF%B4%E6%98%8E
Markdown: https://open.kuaimai.com/__ai/markdown/api/10-API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/15-AI%E6%96%87%E6%9C%AC%E8%AF%B4%E6%98%8E.md

# AI文本说明

## 概述

快麦开放平台已为公开 API 文档提供面向 AI 大模型和开发者工具的文本说明能力。开发者可以通过 Markdown 页面、`llms.txt` 和 `llms-full.txt` 获取结构化文本，让 AI 辅助理解接口能力、梳理业务对接流程、生成调用示例、排查签名问题和定位错误码。

AI文本说明用于辅助阅读和开发，不替代正式 API 文档、授权流程、接口测试和业务验收。实际接口调用仍以开放平台页面展示的接口文档为准。

## 适用对象

- 正在接入快麦ERP开放平台的自研商家开发者。
- 需要对接订单、商品、库存、仓储、采购、售后等业务接口的技术人员。
- 使用 AI 编程工具、智能问答工具或内部知识库检索开放平台文档的团队。
- 需要快速定位接口文档、错误码、公共参数、签名规则和业务场景说明的开发者。

## 支持的AI文本入口

| 入口 | 地址 | 说明 |
| --- | --- | --- |
| 文档索引 | `https://open.kuaimai.com/llms.txt` | 公开文档索引，按文档分类列出可供 AI 读取的 Markdown 链接。 |
| 全量文档 | `https://open.kuaimai.com/llms-full.txt` | 全部公开文档的 Markdown 全文，适合导入 AI 工具、知识库或本地检索系统。 |
| 单页Markdown | `https://open.kuaimai.com/__ai/markdown/...` | 当前文档页面对应的纯文本 Markdown 内容，适合复制给 AI 单独分析。 |
| 页面复制 | 文档页面右上角“复制页面” | 一键复制当前页面的 Markdown 文本，方便粘贴到 AI 工具中。 |

## llms.txt是什么

`llms.txt` 是为 AI 大模型准备的公开文档入口文件。它会把快麦开放平台的公开 API 文档、场景说明、常见问题和系统公告整理成 AI 更容易读取的文本索引。

开发者可以让 AI 先读取 `llms.txt`，再根据业务场景找到对应文档。例如：

```text
请读取 https://open.kuaimai.com/llms.txt，找到“订单业务对接”“API调用方法详解”和“刷新会话”相关文档，帮我整理自建平台订单接入流程。
```

## llms-full.txt是什么

`llms-full.txt` 是全部公开文档的 Markdown 全文集合。它适合以下场景：

- 将快麦开放平台公开文档导入企业内部 AI 知识库。
- 让 AI 工具一次性检索全部公开 API 文档。
- 用于本地搜索、接口梳理、文档问答和开发辅助。
- 在不了解具体接口名称时，让 AI 先从全量文档中定位相关接口。

`llms-full.txt` 内容较长，如果 AI 工具上下文长度有限，建议优先使用 `llms.txt` 找到相关文档后，再复制具体页面的 Markdown 内容。

## 单页Markdown说明

每个公开文档页面都会生成一个对应的 Markdown 文本地址，路径格式为：

```text
https://open.kuaimai.com/__ai/markdown/文档路径.md
```

例如，API调用方法详解的 Markdown 文本地址为：

```text
https://open.kuaimai.com/__ai/markdown/api/10-API对接说明/20-API调用方法详解.md
```

页面右上角的“以 Markdown 格式查看”会自动打开当前页面对应的 Markdown 文本地址。开发者通常不需要手动拼接 URL。

## 页面复制功能

开放平台文档页面提供面向 AI 使用的快捷操作。开发者可以在页面右上角使用“复制页面”，将当前页面正文复制为 Markdown 文本。

复制后的内容适合用于以下场景：

- 发送给 AI 工具解释接口字段含义。
- 让 AI 根据文档生成接口调用示例。
- 让 AI 对比业务需求和开放平台接口能力。
- 让 AI 整理联调步骤、异常处理和测试 Checklist。

复制页面时只会复制公开文档内容，不会包含开发者的实际授权信息、请求记录或商家业务数据。

## 推荐使用流程

1. 先明确需要对接的业务场景，例如订单、商品、库存、售后、仓储或采购。
2. 打开 `https://open.kuaimai.com/llms.txt`，找到对应分类下的文档。
3. 阅读业务场景说明，确认接口调用方向、前置条件和注意事项。
4. 打开具体 API 文档，复制页面 Markdown 给 AI 分析参数、返回值和调用方式。
5. 结合“API调用方法详解”确认公共参数、签名算法、请求地址和响应格式。
6. 使用测试公司账号或测试数据完成联调验证。
7. 上线前再次核对正式 API 权限、`accessToken` 有效期、刷新会话接口和异常处理逻辑。

## AI可以帮助开发者做什么

- 快速判断某个业务场景应该使用哪些接口。
- 整理接口调用顺序和数据流向。
- 解释公共参数、业务参数、返回字段和错误码。
- 根据文档生成 Java、Python、PHP、C# 等语言的调用示例。
- 检查签名参数是否遗漏、排序是否正确、时间格式是否符合要求。
- 根据错误码和 `trace_id` 辅助排查调用失败原因。
- 将复杂接口文档整理成开发任务清单或联调 Checklist。

## 推荐提示词模板

### 业务场景梳理

```text
你是快麦开放平台 API 对接助手。请只基于我提供的快麦开放平台文档回答，不要编造文档中没有出现的字段、接口或规则。

我的业务场景是：自建平台订单接入。

请帮我输出：
1. 需要阅读的文档列表
2. 推荐接口调用顺序
3. 每个接口的作用
4. 公共参数和签名注意事项
5. 必须提前准备的数据
6. 联调测试 Checklist
7. 常见错误和排查建议
```

### 生成调用代码

```text
请基于以下快麦开放平台文档，生成一个 Python 调用示例。

要求：
1. 使用 hmac 签名方式
2. 公共参数包含 method、appKey、timestamp、version、session、sign_method、sign
3. 不要写死 APP Secret、accessToken 或 refreshToken
4. 用占位符表示敏感信息
5. 在代码注释中标明哪些字段需要开发者按实际业务填写
6. 如果文档没有说明某个字段，请不要自行补充
```

### 排查接口错误

```text
请基于我提供的快麦开放平台文档和接口返回结果，帮我分析失败原因。

接口返回：
粘贴返回内容，但不要粘贴 APP Secret、accessToken、refreshToken 等敏感信息。

请输出：
1. 可能原因
2. 需要核对的参数
3. 签名相关检查项
4. 会话有效性检查项
5. 下一步排查建议
```

### 对比接口能力

```text
我需要实现以下业务需求：
描述你的业务需求。

请基于快麦开放平台文档判断：
1. 是否有对应接口支持
2. 需要使用哪些接口
3. 哪些数据需要提前在快麦ERP维护
4. 哪些字段需要由我的系统传入
5. 哪些状态或结果需要从快麦ERP查询
6. 文档中没有明确说明的风险点
```

## 安全注意事项

请勿将以下敏感信息粘贴到公共 AI 工具中：

- `APP Secret`
- `accessToken`
- `refreshToken`
- 商家账号密码
- 店铺真实业务数据
- 客户手机号、地址、身份证号等个人信息
- 订单、售后、采购、库存等包含敏感经营信息的完整数据

如需让 AI 分析请求参数，请使用脱敏后的示例值。示例中的 `appKey`、`session`、`secret`、订单号、手机号、地址等信息都应替换为占位符。

## 使用限制

AI文本说明仅包含公开文档内容。未发布接口、增值接口、内部接口、商家专属配置和非公开说明不会出现在 `llms.txt` 或 `llms-full.txt` 中。

AI生成的代码和结论需要开发者自行验证。正式上线前，请务必完成接口联调、异常处理、会话刷新、签名校验、重试策略和业务验收。

如果 AI 的回答与开放平台页面文档不一致，请以开放平台页面文档为准。

## 建议优先阅读的文档

| 文档 | 建议阅读原因 |
| --- | --- |
| 接入指南 | 了解 API 权限申请、测试账号、令牌有效期和基础注意事项。 |
| API调用方法详解 | 了解请求地址、公共参数、签名算法、请求方式和响应结构。 |
| 刷新会话(必接) | 了解如何延长 `accessToken` 会话有效期，避免会话过期影响接口调用。 |
| API错误码解释 | 根据错误码快速判断参数、签名、会话或权限问题。 |
| 通用字段说明 | 理解订单、商品、库存等业务中的通用字段含义。 |
| API场景说明 | 按业务流程理解接口调用方向、接口组合和注意事项。 |
| 具体接口文档 | 确认接口名称、业务参数、返回结果和接口限制。 |

## 常见问题

### llms.txt和llms-full.txt有什么区别

`llms.txt` 是文档索引，适合让 AI 快速找到相关文档。`llms-full.txt` 是全文合集，适合导入知识库或让 AI 做全量检索。

### AI文本说明是否可以直接调用接口

不可以。AI文本说明只是文档文本入口。实际接口调用仍需要申请 API 权限，并使用 `APP Key`、`APP Secret`、`accessToken`、签名和业务参数访问开放平台网关。

### 页面Markdown和网页文档内容是否一致

页面Markdown由站点构建时从公开 Markdown/MDX 文档生成，会保留正文、标题、表格和代码块，并移除页面组件相关内容。它用于帮助 AI 更稳定地读取文档正文。

### 可以把APP Secret发给AI帮我调试吗

不建议，也不允许在公共 AI 工具中暴露敏感凭证。请使用脱敏占位符，并只让 AI 分析签名规则、参数顺序和代码逻辑。

### AI生成的接口代码可以直接上线吗

不建议直接上线。AI生成代码只能作为开发参考，必须经过本地测试、测试公司账号联调、异常场景验证和正式环境灰度验证。

---

## API调用方法详解(开发必看)

URL: https://open.kuaimai.com/docs/api/API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/API%E8%B0%83%E7%94%A8%E6%96%B9%E6%B3%95%E8%AF%A6%E8%A7%A3
Markdown: https://open.kuaimai.com/__ai/markdown/api/10-API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/20-API%E8%B0%83%E7%94%A8%E6%96%B9%E6%B3%95%E8%AF%A6%E8%A7%A3.md

# API调用方法详解(开发必看)

## [](https://api.raycloud.com/#%E8%B0%83%E7%94%A8%E6%B5%81%E7%A8%8B)调用流程

根据协议：填充参数 > 生成签名 > 拼装HTTP请求 > 发起HTTP请求> 得到HTTP响应 > 解释json/xml结果

## [](https://api.raycloud.com/#%E8%B0%83%E7%94%A8%E5%85%A5%E5%8F%A3)调用入口

|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2内部专用地址| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**

## [](https://api.raycloud.com/#%E5%85%AC%E5%85%B1%E5%8F%82%E6%95%B0)公共参数

调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 格式化时间(yyyy-MM-dd HH:mm:ss)，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

## [](https://api.raycloud.com/#%E4%B8%9A%E5%8A%A1%E5%8F%82%E6%95%B0)业务参数

API调用除了必须包含公共参数外，如果API本身有业务级的参数也必须传入，每个API的业务级参数请考API文档说明。

## [](https://api.raycloud.com/#%E7%AD%BE%E5%90%8D%E7%AE%97%E6%B3%95)签名算法

为了防止API调用过程中被黑客恶意篡改，调用任何一个API都需要携带签名，TOP服务端会根据请求参数，对签名进行验证，签名不合法的请求将会被拒绝。目前支持的签名算法有三种：MD5(sign\_method=md5)，HMAC\_MD5(sign\_method=hmac)，HMAC\_SHA256（sign\_method=hmac-sha256)，签名大体过程如下：

*   对所有API请求参数（包括公共参数和业务参数，但除去**sign参数、byte\[\]类型的参数以及值为null的参数**），根据参数名称的[ASCII](http://www.asciima.com/)码表的顺序排序。如：foo:1, bar:2, foo\_bar:3, foobar:4排序后的顺序是bar:2, foo:1, foo\_bar:3, foobar:4。
*   将排序好的参数名和参数值拼装在一起，根据上面的示例得到的 **【加密源串】** 结果为：bar2foo1foo\_bar3foobar4。**可以使用官网提供的[API测试工具](/tools)来校验拼接的【加密源串】是否正确**。
*   把拼装好的字符串采用utf-8编码，使用签名算法对编码后的字符串进行摘要。如果使用**MD5**算法，则需要在拼装的字符串**前后**加上app的secret后，再进行摘要，如：md5(secret+bar2foo1foo\_bar3foobar4+secret)；如果使用HMAC\_MD5算法，则需要用app的secret初始化摘要算法后，再进行摘要，如：hmac\_md5(bar2foo1foo\_bar3foobar4)。
*   将摘要得到的字节流结果使用十六进制表示，如：hex(“helloworld”.getBytes(“utf-8”)) = “68656C6C6F776F726C64”

说明：MD5和HMAC\_MD5都是128位长度的摘要算法，用16进制表示，一个十六进制的字符能表示4个位，所以签名后的字符串长度固定为32个十六进制字符。
## [](https://api.raycloud.com/#%E8%B0%83%E7%94%A8%E5%85%A5%E5%8F%A3)Demo示例
Java版本：http://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/open/Java-demo.zip \
PHP版本：http://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/open/php-demo.zip 

 **JAVA签名示例代码**

```java
public static String signTopRequest(Map<String, String> params, String secret, String signMethod) throws IOException {
    // 第一步：检查参数是否已经排序
    String[] keys = params.keySet().toArray(new String[0]);
    Arrays.sort(keys);

    // 第二步：把所有参数名和参数值串在一起
    StringBuilder query = new StringBuilder();
    if (Constants.SIGN_METHOD_MD5.equals(signMethod)) {
        query.append(secret);
    }
    for (String key : keys) {
        String value = params.get(key);
        if (StringUtils.areNotEmpty(key, value)) {
            query.append(key).append(value);
        }
    }

    // 第三步：使用MD5/HMAC加密
    byte[] bytes;
    if (Constants.SIGN_METHOD_HMAC.equals(signMethod)) {
        bytes = encryptHMAC(query.toString(), secret);
    } else {
        query.append(secret);
        bytes = encryptMD5(query.toString());
    }

    // 第四步：把二进制转化为大写的十六进制(正确签名应该为32大写字符串，此方法需要时使用)
    //return byte2hex(bytes);
}

private static byte[] encryptHMACSHA256(String data, String secret) throws IOException  {
    byte[] bytes = null;
    try {
        SecretKey secretKey = new SecretKeySpec(secret.getBytes(Constants.CHARSET_UTF8), "HmacSHA256");
        Mac mac = Mac.getInstance(secretKey.getAlgorithm());
        mac.init(secretKey);
        bytes = mac.doFinal(data.getBytes(Constants.CHARSET_UTF8));
    } catch (GeneralSecurityException gse) {
        throw new IOException(gse.toString());
    }
    return bytes;
}

public static byte[] encryptHMAC(String data, String secret) throws IOException {
    byte[] bytes = null;
    try {
        SecretKey secretKey = new SecretKeySpec(secret.getBytes(Constants.CHARSET_UTF8), "HmacMD5");
        Mac mac = Mac.getInstance(secretKey.getAlgorithm());
        mac.init(secretKey);
        bytes = mac.doFinal(data.getBytes(Constants.CHARSET_UTF8));
    } catch (GeneralSecurityException gse) {
        throw new IOException(gse.toString());
    }
    return bytes;
}

public static byte[] encryptMD5(String data) throws IOException {
    return encryptMD5(data.getBytes(Constants.CHARSET_UTF8));
}

public static byte[] encryptMD5(byte[] data) throws IOException {
    byte[] bytes = null;
    try {
        MessageDigest md = MessageDigest.getInstance("MD5");
        bytes = md.digest(data);
    } catch (GeneralSecurityException gse) {
        throw new IOException(gse.toString());
    }
    return bytes;
}

public static String byte2hex(byte[] bytes) {
    StringBuilder sign = new StringBuilder();
    for(byte bt : bytes){
        String hex = Integer.toHexString(bt & 0xFF);
        if (hex.length() == 1) {
            sign.append("0");
        }
        sign.append(hex.toUpperCase());
    }
    return sign.toString();
}

```

 **Python签名示例代码**

```python
# coding=utf-8

def generate_signature(params, sign_method, secret):
    # 移除sign参数、byte[]类型的参数以及值为null的参数
    params = {k: v for k, v in params.items() if v is not None and k != 'sign'}
    
    # 根据参数名称的ASCII码表的顺序排序
    sorted_params = sorted(params.items(), key=operator.itemgetter(0))

    # 将排序好的参数名和参数值拼装在一起
    str_params = "".join(["{}{}".format(k, v) for k, v in sorted_params])
    print('sign_str:' + str_params)
    if sign_method == 'md5':
        m = hashlib.md5()
        m.update((secret + str_params + secret).encode('utf-8'))
        return m.hexdigest()
    elif sign_method == 'hmac':
        h = hmac.new(secret.encode('utf-8'), str_params.encode('utf-8'), digestmod=hashlib.md5)
        return h.hexdigest()
    elif sign_method == 'hmac-sha256':
        h = hmac.new(secret.encode('utf-8'), str_params.encode('utf-8'), digestmod=hashlib.sha256)
        return h.hexdigest()
    else:
        return None

# 测试
params = {'appKey': '123456', 'session': 'test', 'timestamp': '2023-08-07 14:04:08', 'version': '1.0', 'method':'erp.trade.list.query', 'timeType':'upd_time', 'startTime':'2023-07-21 09:30:40', 'endTime':'2023-07-21 23:59:59', 'pageNo':'1', 'pageSize':'20'}
sign_method = 'hmac'
secret = 'testsecret'
signature = generate_signature(params, sign_method, secret)
print("sign:" + signature)

```
 **C#签名示例代码**

```cpp
        /// <summary>
        /// 签名
        /// </summary>
        /// <param name="params">参数</param>
        /// <param name="secret">secret</param>
        /// <returns></returns>
        public static string Signature(IDictionary<string, string> @params, string secret)
        {
            string result = null;
            if (@params == null)
            {
                return result;
            }
            if (@params != null && @params.ContainsKey("sign"))
            {
                @params.Remove("sign");  
            }
         
            IDictionary<string, string> treeMap = new SortedList<string, string>(StringComparer.Ordinal);

            foreach (KeyValuePair<string, string> kvp in @params)
            {
                treeMap.Add(kvp.Key, kvp.Value);
            }
            System.Collections.IEnumerator iter = @treeMap.Keys.GetEnumerator
                ();
            System.Text.StringBuilder orgin = new System.Text.StringBuilder(secret);
            while (iter.MoveNext())
            {
                string name = (string)iter.Current;
                string value = @treeMap[name];
                if (value != "")
                {
                    orgin.Append(name).Append(value);
                }
            }
            orgin.Append(secret);
            try
            {
                result = Md5Hex(orgin.ToString());
            }
            catch (System.Exception)
            {
                throw new System.Exception("sign error !");
            }
            return result.ToUpper();
        }
       
        /// <summary>
        /// MD5加密并输出十六进制字符串 输出大写字母
        /// </summary>
        /// <param name="str">签名源数据串</param>
        /// <returns>签名值</returns>
        public static string Md5Hex(string str)
        {
            string dest = "";
             
            MD5 md5 = MD5.Create();
            // 加密后是一个字节类型的数组，这里要注意编码UTF8/Unicode等的选择　
            byte[] s = md5.ComputeHash(Encoding.UTF8.GetBytes(str));             
            for (int i = 0; i < s.Length; i++)
            { 
                if (s[i] < 16)
                {
                    dest = String.Format("{0}0{1:X}", dest, s[i]);
                }
                else
                {
                    dest = dest + s[i].ToString("X");
                }

            }
            return dest;
        }
```

## [](https://api.raycloud.com/#%E8%B0%83%E7%94%A8%E7%A4%BA%E4%BE%8B)调用示例

以 open.system.time.get 调用为例，具体步骤如下：

**1. 设置参数值**\
公共参数：

*   method = "open.system.time.get"
*   appKey = "123456"
*   timestamp = "2020-09-21 16:58:00"
*   sign_method = "hmac"
*   session = "test"
*   format = "json"
*   version = "1.0"

业务参数： 无 

**2. 按ASCII顺序排序**

*   appKey = "123456"
*   format = "json"
*   method = "open.system.time.get"
*   session = "test"
*   sign_method = "hmac"
*   timestamp = "2020-09-21 16:58:00"
*   version= "1.0"

**3. 拼接参数名与参数值**

```
hmac：appKey123456formatjsonmethodopen.system.time.getsessiontestsign_methodhmactimestamp2020-09-21 16:58:00version1.0
md5：helloworldappKey123456formatjsonmethodopen.system.time.getsessiontestsign_methodmd5timestamp2020-09-21 16:58:00version1.0helloworld
hmac-sha256：appKey123456formatjsonmethodopen.system.time.getsessiontestsign_methodhmac-sha256timestamp2020-09-21 16:58:00version1.0
```

**4. 生成签名** 

假设app的secret为helloworld，则签名结果为：hex(hmac-sha256(按顺序拼接好的参数名与参数值)) = “7905D5EF37CA177B9219DBFA603F773A7616F424D545E731AAFBB992408F6CEE” 

**5. 组装HTTP请求** 

将所有参数名和参数值采用utf-8进行URL编码（参数顺序可随意，但必须要包括签名参数），然后通过GET或POST（含byte\[\]类型参数）发起请求，如：

**6. postman调用示例**
![image.png](https://cos.easydoc.net/71337301/files/lwoapb7r.png)
## [](https://api.raycloud.com/#%E6%95%B0%E6%8D%AE%E8%BF%94%E5%9B%9E%E7%BB%93%E6%9E%84)数据返回结构

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| code | string | 否 | 错误码，错误时返回 |
| msg | string | 否 | 错误描述信息，错误时返回 |
| success | boolean | 是 | 请求是否正常, true 成功 false 失败 |
| trace\_id | string | 是 | 请求ID，用于排查问题 |
| 其它参数 | object | 否 | 正常的数据信息，根据API的文档返回 |

```json
// 正常的数据返回
{
    "items": [....],
    "success": false,
    "trace_id": "382576054573568"
}

// 异常的数据返回
{
    "code": "40",
    "msg": "服务方法(supplier.list.query:1.0)的应用键参数timestamp无效",
    "success": false,
    "trace_id": "382576054573568"
}

```

## [](https://api.raycloud.com/#%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9)注意事项

*   所有的请求和响应数据编码皆为utf-8格式，URL里的所有参数名和参数值请做URL编码。如果请求的Content-Type是application/x-www-form-urlencoded，则HTTP Body体里的所有参数值也做URL编码；如果是multipart/form-data格式，每个表单字段的参数值无需编码,但每个表单字段的charset部分需要指定为utf-8。
*   参数名与参数值拼装起来的URL长度小于1024个字符时，可以用GET发起请求；参数类型含byte\[\]类型或拼装好的请求URL过长时，必须用POST发起请求。所有API都可以用POST发起请求。
*   生成签名（sign）

---

## API错误码解释

URL: https://open.kuaimai.com/docs/api/API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/API%E9%94%99%E8%AF%AF%E7%A0%81%E8%A7%A3%E9%87%8A
Markdown: https://open.kuaimai.com/__ai/markdown/api/10-API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/30-API%E9%94%99%E8%AF%AF%E7%A0%81%E8%A7%A3%E9%87%8A.md

| 错误码 |错误信息|解决方案|
|-|-|-|
|1|服务不可用|联系管理员|
|9|服务方法(\{0\}:\{1\})业务逻辑出错|联系管理员|
|20|服务方法(\{0\}:\{1\})缺少会话参数:\{2\}|签名不完整|
|invalid_session|用户未启用，请联系管理员启用|联系管理员|
|refresh_frequently|会话刷新太频繁了，请降低频次调用|调用接口并发量过高|
|22|服务方法(\{0\}:\{1\})缺少应用键参数:\{2\}|参数不完整|
|23|服务方法(\{0\}:\{1\})的应用键参数\{2\}无效|参数不完整|
|24|服务方法(\{0\}:\{1\})需要签名,缺少签名参数:\{2\}|参数不完整|
|25|服务方法(\{0\}:\{1\})的签名无效|联系管理员|
|26|服务请求缺少方法名参数|参数不完整|
|27|调用不存在的服务方法|联系管理员|
|28|服务方法,缺少版本参数|参数不完整|
|29|服务方法,不存在对应的版本|参数不完整|
|50|非法参数！|参数不合法|参数不完整|
|25|服务方法(erp.trade.create.new:1.0)的签名无效|签名参数错误|
|401|资源异常，请联系管理员！|联系管理员|
|401|签名错误: 签名参数不完整!|检查请求参数中是否有sign, timestamp, appKey|

---

## 通用字段说明

URL: https://open.kuaimai.com/docs/api/API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/%E9%80%9A%E7%94%A8%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E
Markdown: https://open.kuaimai.com/__ai/markdown/api/10-API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/40-%E9%80%9A%E7%94%A8%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E.md

## 通用字段说明

| 参数 | 参数类型 | 说明 |
| --- | --- | --- |
| userId | string | 店铺编码 |
| warehouseId | long | 仓库ID |
| sid | string | 系统订单号 |
| tid | string | 平台订单号 |
| sids | string | 系统订单号,多个逗号隔开 |
| tids | string | 平台订单号,多个逗号隔开 | 
| sysItemId | string | 系统主商品ID  |
| itemId | string | 平台主商品ID  | 
| sysOuterId | string | 系统商家编码 |
| outerId | string | 平台商家编码 |
| sysSkuId | string | 系统商品skuID |
| skuId | string | 平台skuID |
| skuOuterId | string | 平台规格商家编码 |
| sysSkuOuterId | string | 系统规格商家编码 |
| pageNo | integer | 页码 取值范围:大于零的整数 |
| pageSize | integer | 每页条数 取值范围:大于零的整数 |
| sysItemIds | string | 系统主商品ID,多个用逗号隔开|
| outerIds | string | 平台商家编码,多个用逗号隔开|
| skuOuterIds | string | 平台规格商家编码,多个用逗号隔开 |
| sysSkuIds | string | 系统商品skuId,多个用逗号隔开 |
| orderId | long | 商品子订单ID |
| staffId | long | 员工ID |
| companyId | long | 公司ID |
| oid | long | 子订单平台号 |
| outSid | long | 运单号 |

---

## 快递编码对应表

URL: https://open.kuaimai.com/docs/api/API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/%E5%BF%AB%E9%80%92%E7%BC%96%E7%A0%81%E5%AF%B9%E5%BA%94%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/10-API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/50-%E5%BF%AB%E9%80%92%E7%BC%96%E7%A0%81%E5%AF%B9%E5%BA%94%E8%A1%A8.md

## 现有快递公司信息

| id| name | custom_name | code |
| --- | --- | --- | --- |
|-1|其他|汇强快递|OTHER
|1|中国邮政|邮政平邮|POST
|2|EMS|EMS标准快递|EMS
|3|EMS经济快递|EMS经济快递|EYB
|90|晟邦物流|晟邦物流|CHENGBANG
|100|申通快递|申通快递|STO
|101|圆通速递|圆通速递|YTO
|102|韵达快递|韵达快递|YUNDA
|103|宅急送|宅急送|ZJS
|105|百世物流|百世物流|BEST
|106|联邦快递|联邦快递|FEDEX
|107|德邦物流|德邦物流|DBL
|108|华强物流|华强物流|SHQ
|130|拼多多:如风达|拼多多:如风达|RFD
|132|邮政快递包裹|邮政快递包裹|YZXB
|140|南京晟邦|南京晟邦|NJCHENGBANG
|142|万象物流|万象物流|WXWL
|148|安达信|安达信|ADX
|149|海外快递|海外快递|HWKD
|154|黄马甲|黄马甲|HUANGMAJIA
|156|亚马逊物流|亚马逊物流|YAMAXUNWULIU
|163|芝麻开门|芝麻开门|ZMKM
|165|汇通小红马|汇通小红马|HTXMJ
|180|拼多多:其他|拼多多:其他|SELF
|187|青岛安捷|青岛安捷|ANJELEX
|205|远成快运|远成快运|YCGWL
|211|中邮速递|中邮速递|ZHONGYOUWULIU
|213|EMS-国际件|EMS-国际件|INTEREMS
|214|中铁物流(飞豹)|中铁物流(飞豹)|ZTKY
|217|Flash Express|Flash Express|FLASH
|227|日日顺物流|日日顺物流|RRS
|228|苏宁快递|苏宁快递|SNWL
|231|拼多多:微特派|拼多多:微特派|WEITEPAI
|232|AAE全球专递|AAE全球专递|MYAAE
|233|Aramex|Aramex|ARAMEX
|239|DHL中国|DHL中国|DHLCN
|246|UPS|UPS|UPS
|262|传喜物流|传喜物流|CXCOD
|264|递四方|递四方|4PX
|273|恒路物流|恒路物流|HLWL
|275|加运美|加运美|TMS56
|277|佳怡物流|佳怡物流|JIAYI
|281|京广速递|京广速递|CP449455
|291|民航快递|民航快递|CAE
|305|盛丰物流|盛丰物流|FJSFWLJTYXGS
|306|拼多多:盛辉物流|拼多多:盛辉物流|SHENGHUI
|312|万家物流|万家物流|MANCOWL
|319|燕文物流|燕文物流|YWWL
|324|邮政标准快递|邮政标准快递|POSTBBZ
|325|邮政国际包裹|邮政国际包裹|CNPOSTGJ
|335|优邦国际速运|优邦国际速运|YOUBANG
|336|天际快递|天际快递|TJ
|337|飞洋快递|飞洋快递|FY
|338|拼多多:斑马物联网|拼多多:斑马物联网|BM
|339|易客满|易客满|EKM
|340|京东大件物流|京东大件物流|JDKD
|341|速必达|速必达|SUBIDA
|342|东骏快捷|东骏快捷|DJKJWL
|344|韵达快运|韵达快运|CN7000001021040
|345|安能快运|安能快运|CN7000001000869
|346|安得物流|安得物流|ANDE
|347|中粮我买网|中粮我买网|WM
|348|壹米滴答|壹米滴答|YMDD
|349|当当网|当当网|DD
|350|品骏|品骏|PJ
|351|承诺达特快|承诺达特快|OTP
|352|安迅物流|安迅物流|AXWL
|354|D速物流|D速物流|SDSD
|500|中通快递|中通快递|ZTO
|502|百世汇通|百世汇通|HTKY
|504|天天快递|天天快递|TTKDEX
|505|顺丰速运|顺丰速运|SF
|507|亚风|亚风|AIR
|511|长宇|长宇|CYEXP
|512|大田|大田|DTW
|513|长发|长发|YUD
|1016|中铁快运|中铁快运(飞豹)|CRE
|1056|佳吉快递|佳吉快递|CNEX
|1121|飞远(爱彼西)配送|飞远(爱彼西)配送|HZABC
|1137|东方汇|东方汇|DFH
|1138|首业|首业|SY
|1139|远长|远长|YC
|1185|黑猫宅急便|黑猫宅急便|YCT
|1186|新邦物流|新邦物流|XB
|1191|天地华宇|天地华宇|HOAU
|1192|能达速递|能达速递|NEDA
|1195|龙邦速递|龙邦速递|LB
|1204|快捷快递|快捷快递|FAST
|1207|优速快递|优速快递|UC
|1208|增益速递|增益速递|QRT
|1214|联昊通|联昊通|LTS
|1216|全峰快递|全峰快递|QFKD
|1237|发网|发网|UNIPS
|1259|全一快递|全一快递|UAPEX
|1262|城市100|城市100|BJCS
|1269|广东EMS|广东EMS|GDEMS
|1270|加运美速递|加运美速递|OTHER
|1271|极兔速递|极兔速递|JTSD
|12000|顺心捷达快运|顺心捷达快运|CP471906
|15000|顺丰快运|顺丰快运|SFKY
|105031|百世快运|百世快运|BESTQJT
|200143|国通快递|国通快递|GTO
|200427|飞远配送|飞远配送|GZLT
|200734|邮政国内小包|邮政国内小包|POSTB
|200740|E速宝|E速宝|ESB
|201174|速尔|速尔快递|SURE
|202855|信丰物流|信丰物流|XFWL
|202857|凡宇速递|凡宇速递|GZFY
|204900|居无忧|居无忧|JWY
|204902|贝业新兄弟|贝业新兄弟|BOYOL
|204904|合众阳晟|合众阳晟|YS
|881232|众邮快递|众邮快递|ZYKD
|10000001|厂家自送|厂家自送|OTHER
|10000002|嘉里大通物流|嘉里大通物流|OTHER
|10000003|中国邮政挂号信|中国邮政挂号信|OTHER
|10000004|快行线物流|快行线物流|OTHER
|10000005|微特派|微特派|OTHER
|10000007|斑马物联网|斑马物联网|OTHER
|10000008|一智通物流|一智通物流|OTHER
|10000009|易宅配物流|易宅配物流|OTHER
|10000010|如风达|如风达|100004928
|10000011|上药物流|上药物流|OTHER
|10000012|海关自提|海关自提|OTHER
|10000013|京东大件开放承运商|京东大件开放承运商|OTHER
|1566886844|德邦快运|德邦快运|CN7000001009020
|21000007003|美国速递|美国速递|MGSD
|21000038002|派易国际物流77|派易国际物流77|PKGJWL
|21000046009|RUSTON|RUSTON|RUSTON
|21000046011|ZTOSH|ZTOSH|ZTOSH
|21000048014|ZTOGZ|ZTOGZ|ZTOGZ
|21000051004|燕文北京|燕文北京|YANWENBJ
|21000051006|燕文义乌|燕文义乌|YANWENYW
|21000051008|燕文广州|燕文广州|YANWENGZ
|21000052002|燕文国际|燕文国际|YANWENINTE
|21000052004|燕文上海|燕文上海|YANWENSH
|21000052006|燕文深圳|燕文深圳|YANWENSZ
|5000000004901|安能快递|安能快递|2608021499_235
|5000000007756|邮政国内标准快递|邮政国内标准快递|5000000007756
|5000000110730|德邦快递|德邦快递|DBKD
|5200000110730|京东快递|京东快递|JD
|5300000110730|菜鸟相关物流|菜鸟相关物流|OTHER
|5300000110731|临空物流|临空物流|LKTO
|5300000110732|中通快运|中通快运|3108002701_1011
|5300000110733|跨越速运|跨越速运|CN7000001003751
|5300000110734|远成快运|远成快运|2460304407_385
|5300000110735|九曳供应链|九曳供应链|2383545689_32
|5300000110736|佳吉快运|佳吉快运|JIAJI
|5300000110737|百腾物流|百腾物流|OTHER
|5300000110738|盛辉物流|盛辉物流|OTHER
|5300000110750|自提|自提|ZT
|5300000110760|宇浩物流|宇浩物流|OTHER
|5300000110780|壹米滴答|壹米滴答|2744832184_543
|5300000110790|圆通承诺达|圆通承诺达|CP468398
||丰网速运||FENGWANG|

---

## 联系我们

URL: https://open.kuaimai.com/docs/api/API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC
Markdown: https://open.kuaimai.com/__ai/markdown/api/10-API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/60-%E8%81%94%E7%B3%BB%E6%88%91%E4%BB%AC.md

<div className="km-contact-doc">
  <section className="km-contact-support" aria-label="提交工单咨询">
    <div className="km-contact-support-main">
      <h2>提交工单咨询</h2>
      <div className="km-contact-copy">
      遇到技术问题？请提交工单，我们的技术团队会在工作时间内尽快响应处理。
      支持上传截图和日志附件，便于快速定位问题。
      </div>
      <div className="km-contact-actions">
        <a className="button button--primary" href="https://kaopen.kuaimai.com/" target="_blank" rel="noopener noreferrer">
          提交工单
        </a>
      </div>
    </div>
  </section>

  <section className="km-contact-section" aria-labelledby="km-contact-process-title">
    <h2 id="km-contact-process-title">工单处理流程</h2>
    <ol className="km-contact-steps">
      <li>
        <span className="km-contact-step-index">01</span>
        <div>
          <h3>提交工单</h3>
          <div>填写问题描述，上传相关截图。</div>
        </div>
      </li>
      <li>
        <span className="km-contact-step-index">02</span>
        <div>
          <h3>自动分配</h3>
          <div>系统根据排期规则自动分配处理人。</div>
        </div>
      </li>
      <li>
        <span className="km-contact-step-index">03</span>
        <div>
          <h3>处理中</h3>
          <div>技术团队排查处理，可通过工单继续沟通。</div>
        </div>
      </li>
      <li>
        <span className="km-contact-step-index">04</span>
        <div>
          <h3>确认解决</h3>
          <div>您确认问题已解决后，工单关闭。</div>
        </div>
      </li>
    </ol>
  </section>

  <section className="km-contact-section" aria-labelledby="km-contact-faq-title">
    <h2 id="km-contact-faq-title">常见问题</h2>
    <div className="km-contact-questions">
      <div className="km-contact-question">
        <h3>工单一般多久会有回复？</h3>
        <div>工作时间内提交的工单，我们承诺在2小时内首次响应。复杂问题可能需要更长时间排查，处理人会通过工单与您保持沟通。</div>
      </div>
      <div className="km-contact-question">
        <h3>提交工单后如何查看处理进度？</h3>
        <div>登录开放平台后，点击顶部导航「工单」即可查看您提交的所有工单及当前处理状态。处理人有新回复时，您会收到站内通知和邮件提醒。</div>
      </div>
      <div className="km-contact-question">
        <h3>工单提交后还能补充信息吗？</h3>
        <div>可以。如果处理人请求补充信息，工单状态会变为「待补充信息」，您可以在工单详情页补充相关材料。您也可以主动在工单下追加留言。</div>
      </div>
      <div className="km-contact-question">
        <h3>紧急问题如何处理？</h3>
        <div>如遇生产环境紧急故障，请在工单标题中注明【紧急】，并详细描述故障现象和影响范围。系统会优先分配处理资源。</div>
      </div>
    </div>
  </section>

  <aside className="km-contact-notice" aria-label="温馨提示">
    <strong>温馨提示：</strong>
    为提高问题解决效率，建议提交工单前先查阅
    <a href="/docs/api/API对接说明/接入指南">API文档</a>
    和
    <a href="/docs/question/热点问题/">常见问题</a>。
    工单提交时请尽量提供完整的错误信息、请求参数和返回结果截图。
  </aside>
</div>

---

## 平台编码对应表

URL: https://open.kuaimai.com/docs/api/API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/%E5%B9%B3%E5%8F%B0%E7%BC%96%E7%A0%81%E5%AF%B9%E5%BA%94%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/10-API%E5%AF%B9%E6%8E%A5%E8%AF%B4%E6%98%8E/70-%E5%B9%B3%E5%8F%B0%E7%BC%96%E7%A0%81%E5%AF%B9%E5%BA%94%E8%A1%A8.md

## 平台编码对应表

| 平台名称       | source简码   |
|:---------------|:-------|
| 淘宝           | tb     |
| 环球捕手       | gs     |
| 天猫           | tm     |
| 其它           | sys    |
| 档口           | dangkou|
| 好衣库         | hyk2   |
| 有赞           | yz     |
| 京东           | jd     |
| 抖店(放心购)   | fxg    |
| 快手           | kuaishou|
| 云集POP       | yjpop  |
| 云仓           | yuncang|
| 唯品会JIT      | vipjit |
| 云货优选       | yhyx   |
| 千米           | qm     |
| 万物心选       | wwxx   |
| 小米有品       | xmyp   |
| 阿里巴巴       | 1688   |
| 拼多多         | pdd    |
| 淘外菜鸟       | twcn   |
| 小红书         | xhs    |
| 微盟微商城     | weimeng|
| 今日爆团       | jrbt   |
| 启博微分销平台 | qibo   |
| 好食期         | haoshiqi|
| 洋码头         | ymt    |
| 团好货         | thh    |
| 商陆花         | shangluhua|
| 天猫国际直营   | tmgjzy |
| 度小店         | duxd   |
| B站会员购      | bilibili|
| 微信小商店     | wxxd   |
| lazada         | lazada |
| 沃赢商圈       | wooyingshangquan|
| 未知           | alijk  |
| 丁香           | dingxiang|
| 孩子王         | hzw    |
| HiShop        | hishop |
| 阿里健康       | alihealth|
| 小芒电商       | xiaomang|
| 云集           | yj     |
| 秦丝           | qinsi  |
| 淘工厂         | alibabac2m|
| 1889           | 1889   |
| 天猫超市       | tmcs   |
| 度小店（百度推广账号） | duxiaodian_tgzh |
| 自建平台       | open   |
| 奇门           | qimen  |
| 微店           | wd     |
| 闲鱼           | xy     |
| 腾讯云mall     | txy    |
| 拼多多外单     | pdd_wd  |
| 微信小店（微信视频号） | wxsph |
| 群接龙         | qunjielong|
| 微商相册       | wsxc   |
| TEMU           | pddtemu|
| 行装           | xingzhuang|
| 睿本云         | reabam |
| 饿了么医药健康 | elehealth|
| 希音           | shein  |
| 启博云         | qiboyun |
| 壹品仓         | yipincang|
| 抖音超市       | fxg_cs  |
| 华为商城       | hwsc  |
| 得物       | posion  |

---

## 刷新会话(已废弃)

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%9F%BA%E7%A1%80/%E5%88%B7%E6%96%B0%E4%BC%9A%E8%AF%9D%EF%BC%88%E5%B7%B2%E5%BA%9F%E5%BC%83%EF%BC%89
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/0-%E5%9F%BA%E7%A1%80/0-%E5%88%B7%E6%96%B0%E4%BC%9A%E8%AF%9D%EF%BC%88%E5%B7%B2%E5%BA%9F%E5%BC%83%EF%BC%89.md

# 刷新会话(已废弃)

**请求方法:** POST

### 接口描述
用于刷新会话的Token。刷新会话成功后accessToken与refreshToken信息不变，会话时间延长30天，需要确保30天内能刷新成功，延长会话有效期

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
开放平台对accessToken的过期时间默认设置为30天，所以开发者在会话过期前，
请尽快对接【刷新会话(必接)】接口（接口路径：API文档-基础-刷新会话(必接)），
否则调用API的请求将被平台拒绝。如果会话过期，
请及时联系实施或客服去问题群让业务机器人开通，
开放平台刷新授权格式：公司名称-开放平台刷新授权-appKey；方可继续使用。
刷新会话成功后accessToken与refreshToken信息不变，会话时间延长30天。

### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | open.token.refresh | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | refreshToken | string | 用于刷新会话的token | 必填 |  | 

 

### 请求示例
示例一：

````
{
  "refreshToken":"string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | session | object | session | 必填 | 

# subTable: session
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | expiresIn | long | 到期时间 | 必填 | 
 | companyId | long | 关联的企业ID | 必填 | 
 | accessToken | string | 会话Token | 必填 | 
 | userId | long | 关联的用户ID | 必填 | 
 | refreshToken | string | 用来刷新会话的Token | 必填 | 

 

### 响应示例
```
{
    "session": {
        "expiresIn": long,
        "companyId": "long",
        "accessToken": "string",
        "userId": long,
        "refreshToken": "string"
    }
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释

---

## 店铺查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%9F%BA%E7%A1%80/%E5%BA%97%E9%93%BA%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/0-%E5%9F%BA%E7%A1%80/100-%E5%BA%97%E9%93%BA%E6%9F%A5%E8%AF%A2.md

# 店铺查询

**请求方法:** POST

### 系统相关界面
"界面路径：【基础】----【店铺管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.shop.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | name | string | 店铺名称 |  | 
 | id | long | 店铺编号 |  | 
 | shortName | string | 店铺简称 |  | 
 | pageNo | int | 页码（从1开始） |  | 
 | pageSize | int | 分页大小 |  | 

 

### 请求示例
示例一：

````
{
  "name":"string",
  "id":long,
  "shortName":"string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | object | 数据字典 | 必填 | 

# subTable: list
 | 参数名 | 类型      | 描述                                  | 必填 | 
 | --- |---------|-------------------------------------| - | 
 | userId | long    | 店铺编号                                | 必填 | 
 | title | string  | 店铺名称                                | 必填 | 
 | shortTitle | string  | 店铺简称                                | 必填 | 
 | shopLabel | string  | 店铺标签                                |  |
 | remark | string  | 店铺备注                                | 必填 | 
 | source | string  | 店铺来源：tb淘宝，tm天猫，jd京东，pdd拼多多，sys系统店铺等 | 必填 | 
 | state | integer | 店铺状态：1停用，2未初始化，3启用，4会话失效            | 必填 | 
 | active | integer | 店铺是否激活：0 未启用，1启用                    | 必填 | 
 | nick | string  | 卖家的昵称                               | 必填 | 
 | sendContactId | long    | 默认发货地址编号，也就是淘宝的地址库的编号               | 必填 | 
 | shopId | long    | 店铺ID                                | 必填 | 
 | deadline | date    | 店铺到期时间                              | 必填 |
 | groupName | String  | 店铺组                                   |  |

 

### 响应示例
```
{
  "list": [
    {
      "nick": "zhangsan",
      "sendContactId": 12345,
      "name": "zhangsan",
      "active": 1,
      "remark": "zhangsan",
      "state": 1,
      "shortTitle": "zhangsan",
      "shopLabel": "直营网店",
      "source": "zhangsan",
      "userId": 12345,
      "deadline": 1765961532000
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 获取公司下的标签列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%9F%BA%E7%A1%80/%E8%8E%B7%E5%8F%96%E5%85%AC%E5%8F%B8%E4%B8%8B%E7%9A%84%E6%A0%87%E7%AD%BE%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/0-%E5%9F%BA%E7%A1%80/150-%E8%8E%B7%E5%8F%96%E5%85%AC%E5%8F%B8%E4%B8%8B%E7%9A%84%E6%A0%87%E7%AD%BE%E5%88%97%E8%A1%A8.md

# 获取公司下的标签列表

**请求方法:** POST

### 系统相关界面
界面路径：【交易】----【订单管理】----【订单标签】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.query.tag.list | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | tagType | string | 标签类型  0:自定义标签/系统标签   1:自定义异常/系统异常  |  | 

 

### 请求示例
示例一：

````
{
  "tagType":"string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | 示例：1308861958434052446 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | list | array | 数据列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | remark | string | 标签备注 | 必填 | 
 | id | int | 标签ID | 必填 | 
 | tagName | string | 标签名称 | 必填 | 
 | type | int | 标签类型: 0普通标签, 3系统标签,1自定义异常,-1系统异常 | 必填 | 

 

### 响应示例
```
{
    "traceId": "xxxxxxxxxxxx",
    "success": true,
    "list": [
        {
            "remark": "1.订单缺货发货、缺货审核时，订单自动标记【缺货发货】标签<br/> 2.订单反审核、作废订单、撤销发货时，订单自动取消【缺货发货】标签",
            "id": 1000000000,
            "tagName": "缺货发货",
            "type": 3
        }
    ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|50|查询的标签类型不合法！[0:自定义标签/系统标签   1:自定义异常/系统异常]字段：[tagType];|检查参数|

---

## 客户基础资料查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%9F%BA%E7%A1%80/%E5%AE%A2%E6%88%B7%E5%9F%BA%E7%A1%80%E8%B5%84%E6%96%99%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/0-%E5%9F%BA%E7%A1%80/200-%E5%AE%A2%E6%88%B7%E5%9F%BA%E7%A1%80%E8%B5%84%E6%96%99%E6%9F%A5%E8%AF%A2.md

# 客户基础资料查询

**请求方法:** POST

### 系统相关界面
界面路径：【客户】----【客户基础信息】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.query.customers.list | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | enableStatus | integer | 客户状态 0.停用 1.正常 |  | 
 | level | integer | 客户等级 1.一级  2.二级  3.三级  4.四级  5.五级 |  | 
 | nick | string | 客户昵称 |  | 
 | code | string | 客户编码 |  | 
 | name | string | 客户名称 |  | 
 | pageSize | integer | 每页多少条【默认20】 |  | 
 | pageNo | integer | 第几页【默认1】 |  | 

 

### 请求示例
示例一：

````
{
  "enableStatus":"integer",
  "level":"integer",
  "nick":string,
  "code":string,
  "name":string,
  "pageSize":integer,
  "pageNo":integer
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | 示例：1662552886805615255 | 必填 | 
 | list | array | 数据列表 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | page | object | 数据字典 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | nick | string | 客户昵称 | 必填 | 
 | discountRate | string | 折扣率百分比 | 必填 | 
 | code | string | 客户编码 | 必填 | 
 | name | string | 客户公司全名 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | id | int | 业务主键 | 必填 | 
 | type | int | 客户类型 0.分销商   1.经销商   2.线下渠道   3.其它   4.线上代发 | 必填 | 
 | invoiceTitle | string | 发票抬头 | 必填 | 
 | level | integer | 等级 1.一级  2.二级  3.三级  4.四级  5.五级 | 必填 | 

# subTable: page
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | startRow | int | 起始行 | 必填 | 
 | offsetRow | int | 结束行 | 必填 | 
 | pageNo | int | 第几页 | 必填 | 
 | pageSize | int | 每页多少条 | 必填 | 

 

### 响应示例
```
{
  "list": [
    {
      "code": "zhangsan",
      "address": "zhangsan",
      "externalCode": "zhangsan",
      "city": "zhangsan",
      "type": 1,
      "companyId": 12345,
      "district": "zhangsan",
      "contact": "zhangsan",
      "name": "zhangsan",
      "id": 12345,
      "state": "zhangsan",
      "contactPhone": "zhangsan",
      "status": 1
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 新增修改客户基本信息

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%9F%BA%E7%A1%80/%E6%96%B0%E5%A2%9E%E4%BF%AE%E6%94%B9%E5%AE%A2%E6%88%B7%E5%9F%BA%E6%9C%AC%E4%BF%A1%E6%81%AF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/0-%E5%9F%BA%E7%A1%80/250-%E6%96%B0%E5%A2%9E%E4%BF%AE%E6%94%B9%E5%AE%A2%E6%88%B7%E5%9F%BA%E6%9C%AC%E4%BF%A1%E6%81%AF.md

# 新增修改客户基本信息

**请求方法:** POST

### 系统相关界面
"界面路径：【交易】----【出库单】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.customer.create | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | customerId | Long | 客户id(修改的时候必传) |  | 
 | cmCode | string | 客户编码   唯一 |  | 
 | cmNick | string | 客户昵称   唯一 |  | 
 | cmName | string | 客户公司全名 唯一 |  | 
 | type | integer | 客户类型 |  | 
 | typeCode | integer | 客户类型 |  | 
 | typeMsg | String | 客户类型 |  | 
 | invoiceTitle | String | 发票抬头 |  | 
 | qqNumber | String | qq号 |  | 
 | email | String | 邮箱地址 |  | 
 | fax | String | 传真号 |  | 
 | url | String | 网址 |  | 
 | taxNumber | String | 税号 |  | 
 | province | String | 省 |  | 
 | city | String | 市 |  | 
 | area | String | 区 |  | 
 | address | String | 详细地址（街道） |  | 
 | bankName | String | 开户行 |  | 
 | bankAccount | String | 开户账号 |  | 
 | remark | String | 备注 |  | 
 | zipCode | String | 邮编 |  | 
 | importRowNum | Integer | 导入的行号 |  | 
 | paymentMethod | Integer | 结算方式 0  现付 1  记账 |  | 
 | discountRate | String | 折扣率百分比  99.99 -> 99.99% |  | 
 | level | Integer | 等级 |  | 
 | levelMsg | String | 等级描述 |  | 
 | receivers | List | 收货地址 |  | 
 | contacts | List | 联系人 |  | 
 | defaultContact | List | 默认联系人 |  | 

# subTable: receivers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | Long | 主键id(修改的时候传) |  | 
 | receiver | String | 收货人 |  | 
 | tel | String | 手机号 |  | 
 | phone | String | 固定电话 |  | 
 | zipCode | String | 邮编 |  | 
 | province | String | 省 |  | 
 | city | String | 市 |  | 
 | area | String | 区 |  | 
 | address | String | 详细地址（街道） |  | 
 | receiverDetailAddress | String | 拼接省市区的详细收货地址 |  | 
 | discountRate | String | 折扣率 |  | 

# subTable: contacts
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | Long | 主键id(修改的时候传) |  | 
 | contact | String | 联系人 |  | 
 | tel | String | 手机号 |  | 
 | phone | String | 固定电话 |  | 
 | province | String | 省 |  | 
 | city | String | 市 |  | 
 | area | String | 区 |  | 
 | address | String | 详细地址（街道） |  | 
 | remark | String | 备注 |  | 
 | type | Integer | 联系人类型（0 客户基础信息联系人  1 其它联系人） |  | 

# subTable: defaultContact
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | Long | 主键id |  | 
 | contact | String | 联系人 |  | 
 | tel | String | 手机号 |  | 
 | phone | String | 固定电话 |  | 
 | province | String | 省 |  | 
 | city | String | 市 |  | 
 | area | String | 区 |  | 
 | address | String | 详细地址（街道） |  | 
 | remark | String | 备注 |  | 
 | type | Integer | 联系人类型（0 客户基础信息联系人  1 其它联系人） |  | 
 | cmNick | String | 昵称 |  | 

 

### 请求示例
示例一：

````
{
 "pageNo":"1",
 "pageSize":"10"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | 示例：2010790044167299285 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | customer | object | 数据字典 | 必填 | 

# subTable: customer
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | cmName | string | 示例：11111asda | 必填 | 
 | discountRate | string | 示例：90 | 必填 | 
 | zipCode | string | 示例：1dasdas51 | 必填 | 
 | city | string | 示例：9dsad1 | 必填 | 
 | remark | string | 示例：14dasdas1 | 必填 | 
 | bankName | string | 示例：1dasdas21 | 必填 | 
 | qqNumber | string | 示例：31da11dasdassda | 必填 | 
 | type | int | 示例：1 | 必填 | 
 | province | string | 示例：81das | 必填 | 
 | receivers | array | 数据列表 | 必填 | 
 | customerId | int | 示例：506110604915200 | 必填 | 
 | fax | string | 示例：51dasda | 必填 | 
 | invoiceTitle | string | 示例：21dasdas | 必填 | 
 | email | string | 示例：41dasdas | 必填 | 
 | area | string | 示例：10dasda1 | 必填 | 
 | bankAccount | string | 示例：1dasdas31 | 必填 | 
 | address | string | 示例：11dasdsa1 | 必填 | 
 | level | int | 示例：2 | 必填 | 
 | taxNumber | string | 示例：71dasda | 必填 | 
 | url | string | 示例：61dasdas | 必填 | 
 | defaultContact | object | 数据字典 | 必填 | 
 | cmCode | string | 示例：11dasdasdas | 必填 | 
 | cmNick | string | 示例：11111dasdas | 必填 | 
 | paymentMethod | int | 示例：0 | 必填 | 
 | contacts | array | 数据列表 | 必填 | 

# subTable: customer/receivers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | area | string | 示例：测试aaaaaaaaa | 必填 | 
 | discountRate | string | 示例：测试aaaaaaaaa | 必填 | 
 | zipCode | string | 示例：12daaaaaaaa1 | 必填 | 
 | address | string | 示例：测试收货aaaaaa | 必填 | 
 | receiver | string | 示例：测试收货人aaaaaaaaaaaa | 必填 | 
 | city | string | 示例：测试aaaaaa | 必填 | 
 | province | string | 示例：测试收货aaaaaaaaaa | 必填 | 
 | phone | string | 示例：测试收货人电话aaaaaaaaa | 必填 | 
 | customerId | int | 示例：506110604915200 | 必填 | 
 | cmNick | string | 示例：11111dasdas | 必填 | 
 | tel | string | 示例：测试收货人手机号aaaaaaaaaa | 必填 | 
 | id | int | 示例：158251 | 必填 | 

# subTable: customer/defaultContact
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | area | string | 示例：测试联系人区aaaaaaaaa | 必填 | 
 | address | string | 示例：测试联系人详细地址aaaaaaa | 必填 | 
 | city | string | 示例：测试联系人市aaaaaa | 必填 | 
 | remark | string | 示例：测试联系人备注aaaaaaaaaa | 必填 | 
 | type | int | 示例：0 | 必填 | 
 | province | string | 示例：测试联系人省aaaaaa | 必填 | 
 | phone | string | 示例：测试联系人电话aaaaaaaaa | 必填 | 
 | contact | string | 示例：测试2222联系人aaaaaaaa | 必填 | 
 | customerId | int | 示例：506110604915200 | 必填 | 
 | cmNick | string | 示例：11111dasdas | 必填 | 
 | tel | string | 示例：测试联系人手机号aaaaaaaaa | 必填 | 
 | id | int | 示例：224201 | 必填 | 

# subTable: customer/contacts
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | area | string | 示例：联系人区aaaaaaaa | 必填 | 
 | address | string | 示例：联系人详细地址aaaaaaa | 必填 | 
 | city | string | 示例：联系人市aaaaaaaa | 必填 | 
 | remark | string | 示例：联系人备注aaaaaaaaaaa | 必填 | 
 | type | int | 示例：1 | 必填 | 
 | province | string | 示例：联系人省aaaaaaaa | 必填 | 
 | phone | string | 示例：联系人电话aaaaaa | 必填 | 
 | contact | string | 示例：联系aaaaa | 必填 | 
 | customerId | int | 示例：506110604915200 | 必填 | 
 | cmNick | string | 示例：11111dasdas | 必填 | 
 | tel | string | 示例：联系人手aaaaaaa1 | 必填 | 
 | id | int | 示例：224200 | 必填 | 

 

### 响应示例
```

```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.outstock.list.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|400|资源异常,请联系管理员!|检查参数是否合法|
|50|非法参数!|检查参数类型等是否合法				|

---

## 分销商查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%9F%BA%E7%A1%80/%E5%88%86%E9%94%80%E5%95%86%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/0-%E5%9F%BA%E7%A1%80/300-%E5%88%86%E9%94%80%E5%95%86%E6%9F%A5%E8%AF%A2.md

# 分销商查询

**请求方法:** POST

### 系统相关界面
"界面路径：【基础】----【分销商查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.distributor.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | state | string | 状态:1-查询所有状态；2-查询有效状态; |  | 
 | distributorCompanyIds | string | 分销商编号(可批量查询，使用逗号分割，例如"5579,5579") |  | 
 | distributorName | string | 分销商名称 |  | 
 | pageNo | Integer | 默认1 |  | 
 | pageSize | Integer | 默认20 |  | 

 

### 请求示例
示例一：

````
{
  "state":"string",
  "distributorCompanyIds":"5579,5579",
  "distributorName":"string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | 日志跟踪Id | 必填 | 
 | success | boolean | 返回结果 | 必填 | 
 | list | array | 分销商数据列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | distributorCompanyId | int | 分销商编号 | 必填 | 
 | saleStaffName | string | 业务员 | 必填 | 
 | distributorCompanyName | string | 分销商名称 | 必填 | 
 | helpMsg | string | 助记符 | 必填 | 
 | purchaseAccount | string | 分销采购账户 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | type | int | 1:奇门 | 必填 | 
 | showState | int | 1-待审核;2-已生效;3-已作废;4-已拒绝 | 必填 | 
 | distributorLevel | int | 分销等级 | 必填 | 
 | id | int | 主键 | 必填 | 
 | autoSyncStock | string | 是否自动同步库存 | 必填 | 

 

### 响应示例
```
{
    "traceId": "2310023233178015607",
    "success": true,
    "list": [
        {
            "distributorCompanyId": 1234,
            "saleStaffName": "***",
            "distributorCompanyName": "test",
            "helpMsg": "zhujifu",
            "purchaseAccount": "1688",
            "remark": "备注",
            "type": 1,
            "showState": 2,
            "distributorLevel": 1,
            "id": 48243,
            "autoSyncStock": "false"
        }
    ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.distributor.list.query)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 仓库查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%9F%BA%E7%A1%80/%E4%BB%93%E5%BA%93%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/0-%E5%9F%BA%E7%A1%80/50-%E4%BB%93%E5%BA%93%E6%9F%A5%E8%AF%A2.md

# 仓库查询

**请求方法:** POST

### 系统相关界面
"界面路径：【基础】----【仓库管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.warehouse.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 仓库编码 |  | 
 | name | string | 仓库名称 |  | 
 | id | long | 仓库ID |  | 

 

### 请求示例
示例一：

````
{
  "code":"string",
  "name":"string",
  "id":long
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 数据字典 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述                       | 必填 | 
 | --- | --- |--------------------------| --- | 
 | id | long | 仓库id                     | 必填 | 
 | code | string | 仓库编码                     | 必填 | 
 | name | string | 仓库名称                     | 必填 | 
 | type | integer | 仓库类型：0自有，1第三方，2门店仓库      | 必填 | 
 | status | integer | 仓库状态：0表示停用，1表示正常，2表示禁止发货 | 必填 | 
 | externalCode	 | string | 外部编码                     | 必填 | 
 | state | string | 仓库所在省                    | 必填 | 
 | city | string | 仓库所在市                    | 必填 | 
 | district | string | 仓库所在区                    | 必填 | 
 | address	 | string | 仓库地址                     | 必填 | 
 | companyId | long | 公司编号                     | 必填 | 
 | contact	 | string | 联系人                      | 必填 | 
 | contactPhone | string | 联系方式                     | 必填 | 
 | storeId | string | 门店id                     |  | 

 

### 响应示例
```
{
  "list": [
    {
      "code": "zhangsan",
      "address": "zhangsan",
      "externalCode": "zhangsan",
      "city": "zhangsan",
      "type": 1,
      "companyId": 12345,
      "district": "zhangsan",
      "contact": "zhangsan",
      "name": "zhangsan",
      "id": 12345,
      "state": "zhangsan",
      "contactPhone": "zhangsan",
      "status": 1
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 新增商品标签

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%96%B0%E5%A2%9E%E5%95%86%E5%93%81%E6%A0%87%E7%AD%BE
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/0-%E6%96%B0%E5%A2%9E%E5%95%86%E5%93%81%E6%A0%87%E7%AD%BE.md

# 新增商品标签

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.tag.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | name | string | 标签名称 | 必填 | 
 | styleType | int | 标签样式 1-灰底黑字(默认), 2-绿底黑字 3-粉底黑字 4-紫底白字 5-蓝底白字 6-红底白字 |  | 

 

### 请求示例
示例一：

```` 
{
  "name":"春季新款 "
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 
 | id | long | 示例：1243552344523 | 必填 | 

 

### 响应示例
```
{
    "traceId": "2532358374780058952",
    "success": true,
    "id": 538467517024768
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 设置商品标签

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E8%AE%BE%E7%BD%AE%E5%95%86%E5%93%81%E6%A0%87%E7%AD%BE
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/100-%E8%AE%BE%E7%BD%AE%E5%95%86%E5%93%81%E6%A0%87%E7%AD%BE.md

# 设置商品标签

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.tag.batch.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | tagNames | string | 标签名称，多个以英文逗号隔开（与tagIds二选一） |  | 
 | tagIds | string | 标签ID，多个以英文逗号隔开（与tagNames二选一） |  | 
 | operateType | int |  1 增量修改 2覆盖修改 3删除标签 | 必填 | 
 | itemInfoList | list |  | 必填 | 

# subTable: itemInfoList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码（与ID二选一） |  | 
 | sysItemId | long | 主商品ID （与商家编码二选一） |  | 
 | sysSkuId | long | SKU ID（与商家编码二选一） |  | 

 

### 请求示例
示例一：

```` 
{
    "tagIds": "5383422893102083,53834230674483213",
    "operateType": 1,
    "itemInfoList":
    [
        {
            "outerId": "TEST1005"
        },
        {
            "outerId": "TEST1009-02"
        },
        {
            "sysItemId": 527310077862400
        },
        {
            "sysSkuId": 528721294897664
        }
    ]
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | item | object | 数据字典 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

# subTable: item
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemId | int | 系统商品编码 | 必填 | 
 | barcode | string | 条形码 | 必填 | 
 | picPath | string | 商品图片URL | 必填 | 
 | activeStatus | int | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | title | string | 商品标题 | 必填 | 
 | outerId | string | 商品的商家编码 | 必填 | 
 | type | string | 商品类型 0-普通（含虚拟商品，用 isVirtual字段描述|组合装商品） 1-sku套件 2-纯套件 3-包材商品 | 必填 | 
 | typeTag | int | 基于type下的二级分类 type=0 : 0-正常商品，1-sku加工商品，2-纯加工商品 3-含sku组合装商品 4-不含sku组合装商品 | 必填 | 
 | catId | string | 商品类目 | 必填 | 
 | unit | string | 单位 | 必填 | 
 | isSkuItem | int | 是否是含有sku的商品，是：1，否：0 | 必填 | 
 | isVirtual | int | 是否是虚拟商品，是：1，否：0 | 必填 | 
 | hasSupplier | int | 是否关联供应商 是：1 否：0 | 必填 | 
 | makeGift | boolean | 是否标记为赠品 | 必填 | 
 | created | int | 创建时间 | 必填 | 
 | modified | int | 更新时间 | 必填 | 
 | sellerCids | string | 示例：-1 | 必填 | 
 | sellerCats | array | 数据列表 | 必填 | 

# subTable: item/sellerCats
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | int | 示例：94385 | 必填 | 
 | cid | int | 示例：-1 | 必填 | 
 | name | string | 示例：未分类 | 必填 | 

 

### 响应示例
```
{    
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 商品多码查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81%E5%A4%9A%E7%A0%81%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1000-%E5%95%86%E5%93%81%E5%A4%9A%E7%A0%81%E6%9F%A5%E8%AF%A2.md

# 商品多码查询

**请求方法:** POST

### 接口描述
商品多码查询，可以使用主商家编码、规格商家编码、商品编码来获取商品的编码信息，仅支持开启一品多码的商品查询

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.multicode.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 主商家编码/规格商家编码/商品条码 |  | 

 

### 请求示例
示例一：

```` 
{
  "code":"string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 数据字典 |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 主商家编码 |  | 
 | title | string | 商品标题 |  | 
 | skuOuterId | string | 规格商家编码 |  | 
 | propertiesName | string | 规格属性 |  | 
 | multiCodes | array | 商品条码集合 |  | 
 | sysItemId | long | 系统商品ID |  | 
 | sysSkuId | long | 系统规格ID |  | 

 

### 响应示例
```
{
    "traceId": "3055130172792082545",
    "success": true,
    "list": [
        {
            "sysSkuId": 569075926254080,
            "multiCodes": [
                "AT1",
                "6987878746",
                "AT2"
            ],
            "sysItemId": 569075926225408,
            "outerId": "AT",
            "title": "AT",
            "propertiesName": "橘+紫",
            "skuOuterId": "AT1"
        }
    ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.multicode.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 修改/新增商品V2

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E4%BF%AE%E6%94%B9%E6%96%B0%E5%A2%9E%E5%95%86%E5%93%81V2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1050-%E4%BF%AE%E6%94%B9%E6%96%B0%E5%A2%9E%E5%95%86%E5%93%81V2.md

# 修改/新增商品V2

**请求方法:** POST

### 接口描述
修改/新增商品V2。支持新增/修改普通商品、加工商品、套件商品、组合商品

### 系统相关界面
"界面路径：【商品】----【商品档案V2】----【新建】/【编辑】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 或者 application/json; charset=utf-8| 必填 |

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.general.addorupdate | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemRequestType | integer | 商品类型（0-普通商品，1-加工 2-套件 3-组合 4-虚拟），除了普通商品类型，其他类型的商品都需要填写“单品”字段的值。注意：新增时为必填，修改时为非必填 |  |
 | outerId | string | 平台商家编码（主商家编码） | 必填 | 
 | title | string | 商品名称 | 必填 | 
 | skus | arrayString | sku 列表（含规格时必填）注意这里在请求的时候，需要把skus转化为json字符串然后进行请求 |  |
 | shortTitle | string | 商品简称 |  | 
 | barcode | string | 商品条形码（当用户开启一品双码时，企业数据全局唯一，不能和商家编码重复） |  | 
 | id | long | 系统主商品ID （有值表示修改已存在的商品） |  | 
 | catId | sting | 商品类目属性ID |  | 
 | itemCatName | string | 商品类目名称，各类目层级中如果没有重复可以只传商品类目名称；   支持指定多级类目，类目层级格式：\["根类目","一级类目","二级类目","三级类目"\] |  | 
 | sellerCids | string | 商品分类ID |  | 
 | itemCategoryNames | string | 商品分类名称，各分类层级中如果没有重复可以只传商品分类名称，多个分类用逗号隔开； 支持指定多级分类，分类层级格式：\[\["一级分类","二级分类","三级分类","四级分类1"\],\["一级分类","二级分类","三级分类","四级分类2"\]\] |  | 
 | picPath | string | 预览图片URL |  | 
 | extendPics | array | 辅图列表，最多10张，格式 ["辅图1链接","辅图2链接"] |  |
 | brandId | long | 商品品牌ID (通过品牌接口去查询) |  | 
 | brand | string | 商品品牌名称 |  | 
 | purchasePrice | double | 成本价（单位：元），示例：100.99 |  | 
 | sellingPrice | double | 销售价（单位：元），示例：100.99 |  | 
 | weight | double | 商品重量（单位：Kg）， 示例：0.05 |  | 
 | remark | string | 商品备注 |  | 
 | washLabels | arrayString | 水洗唛列表 |  | 
 | productFeature | int | 申报产品特性   0:普货,1:带电池,2:侵权,3:带磁,4:非液体（化妆品）,5:液体（化妆品）,6:液体（非化妆品）,7:粉末,8:膏体 |  | 
 | makeGift | boolean | 是否标记为赠品（默认为false） |  | 
 | periodCast | integer | 保质期（单位：天） |  | 
 | unit | string | 商品单位 ，示例：件、箱 |  | 
 | x | double | 长（单位：cm） ，示例：0.01 |  | 
 | y | double | 宽（单位：cm） ，示例：0.01 |  | 
 | z | double | 高（单位：cm） ，示例：0.01 |  | 
 | wholesalePrice | double | 批发价（单位：元），示例：100.99 |  | 
 | invoice | string | 开票名称 |  | 
 | boxnum | integer | 箱规 |  | 
 | place | string | 产地 |  | 
 | component | string | 成分 |  | 
 | standard | string | 执行标准 |  | 
 | safekind | string | 安全类别 |  | 
 | marketPrice | double | 市场价（单位：元） |  | 
 | otherPrice1 | double | 其他价格1（单位：元） |  | 
 | otherPrice2 | double | 其他价格2（单位：元） |  | 
 | otherPrice3 | double | 其他价格3（单位：元） |  | 
 | listTime | string | 上架时间 格式为：yyyy-MM-dd HH:mm:ss |  | 
 | customAttribute | arrayString | 自定义属性信息 最多10对属性 kv的map，格式 ：\{definedKey:key1,definedValue:value1\} 注意这里在请求的时候，需要把customAttribute转化为json字符串然后进行请求 |  |
 | activeStatus | boolean | 商品状态，true-启用，false-停用（会影响下面所有规格的状态） |  | 
 | simpleSuiteBridgeModels | array | 单品（与sku层面的单品二选一填写） |  | 
 | uniqueCodeType | integer | 唯一码类型      * 0-弱唯一码      * 1-强唯一码 |  | 
 | suppliers | arrayString |  |  |
 | openProductionDate | boolean | 生产日期管理开关  false 关闭 true 开启           |  | 
 | openBatchNumberManager | boolean | 批次号管理开关 false 关闭 true 开启           |  | 

# subTable: skus
 | 参数名 | 类型 | 描述                                                                                  | 必填 | 
 | --- | --- |-------------------------------------------------------------------------------------| --- | 
 | propertiesName | string | 规格真正的属性，包括颜色属性、其他属性、第三属性、第四属性，以分号分隔，如：“红色;XL”                                       | 必填 | 
 | outerId | string | sku级别的规格商家编码                                                                        | 必填 | 
 | id | long | 平台skuID                                                                             |  | 
 | barcode | string | 规格条形码（如果要更新为空，则传入字符串“empty”）                                                        |  | 
 | weight | double | 重量（单位：Kg），示例：0.05                                                                   |  | 
 | purchasePrice | double | 成本价（单位：元），示例：100.99                                                                 |  | 
 | sellingPrice | double | 销售价（单位：元），示例：100.99                                                                 |  | 
 | wholesalePrice | double | 批发价（单位：元），示例：100.99                                                                 |  | 
 | picPath | string | sku的图片地址                                                                            |  | 
 | propertiesAlias | string | 规格别名                                                                                |  | 
 | sellerCids | string | 规格分类ID                                                                              |  | 
 | itemCategoryNames | string | 规格分类名称，多个用逗号隔开； 支持指定多级分类 ， 格式：\[\["一级分类","二级分类","三级分类"\],\["一级分类","二级分类","三级分类1"\]\] |  | 
 | brandId | string | 规格品牌ID                                                                              |  | 
 | brand | string | 规格品牌名称                                                                              |  | 
 | remark | string | 规格备注                                                                                |  | 
 | skuComponent | string | 规格成分                                                                                |  | 
 | marketPrice | double | 规格市场价（单位：元），示例：100.99                                                               |  | 
 | otherPrice1 | double | 规格其他价格1（单位：元），示例：100.99                                                             |  | 
 | otherPrice2 | double | 规格其他价格2（单位：元），示例：100.99                                                             |  | 
 | otherPrice3 | double | 规格其他价格3（单位：元），示例：100.99                                                             |  | 
 | controlPurchase | boolean | 是否维护历史成本价：默认为false，不维护历史成本价                                                         |  | 
 | uniqueCodeType | integer | 唯一码类型      * 0-弱唯一码      * 1-强唯一码                                                   |  | 
 | activeStatus | boolean | 商品状态，true-启用，false-停用                                                               |  | 
 | simpleSuiteBridgeModels | array | sku级别的单品（与外层单品二选一填写）                                                                |  | 
 | safekind | string | 安全类别                                                                                |  | 
 | standard | string | 执行标准                                                                                |  | 
 | place | string | 产地                                                                                  |  | 
 | suppliers | array |                                                                                     |  | 
 | skuCustomAttribute | array | 规格自定义属性 格式 ：\{definedKey:key1,definedValue:value1\}                                 |  |
 | skuShortTitle | string | 规格简称                                                                                |  |
 | openProductionDate | boolean | 生产日期管理开关 false 关闭 true 开启                                                           |  | 
 | openBatchNumberManager | boolean | 批次号管理开关 false 关闭 true 开启                                                                    |  | 

# subTable: skus/simpleSuiteBridgeModels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemId | long | 系统主商品ID  |  | 
 | sysSkuId | long | 系统商品skuID |  | 
 | ratio | integer | 比例，数量 |  | 
 | amountRatio | double | 金额占比 |  |

# subTable: skus/suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 供应商编码 | 必填 | 
 | itemTitle | string | 供应商商品名称 |  | 
 | itemOuterId | string | 供应商的商品商家编码 |  | 
 | caigouUrl | string | 采购链接 |  | 
 | discountRate | double | 折扣率（不大于100不小于等于0的数字）示例 98.88 |  | 
 | returnRate | double | 退货率或采退率 （不大于100不小于等于0的数字）示例 6.67 |  | 
 | supplierPurchasePrice | double | 供应商报价信息（进价）（不大于9999999.99不小于0的数字） 示例 98.88  |  | 

# subTable: skus/skuCustomAttribute
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | definedKey | string | 规格自定义属性名称 |  | 
 | definedValue | string | 规格自定义属性值 |  | 

# subTable: washLabels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 水洗唛id | 必填 | 
 | sourceType | int | 水洗唛类型 0：系统， 1：自定义 | 必填 | 

# subTable: customAttribute
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | definedKey | string | 属性名称 | 必填 | 
 | definedValue | string | 属性值 |  | 

# subTable: simpleSuiteBridgeModels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemId | long | 系统主商品ID  |  | 
 | sysSkuId | long | 系统商品skuID |  | 
 | ratio | integer | 比例，数量 |  | 
 | amountRatio | double | 金额占比 |  |

# subTable: suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 供应商编码 | 必填 | 
 | caigouUrl | string | 采购链接 |  | 
 | discountRate | double | 折扣率（不大于100不小于等于0的数字）示例 98.88 |  | 
 | returnRate | double | 退货率或采退率 （不大于100不小于等于0的数字）示例 6.67 |  | 
 | itemTitle | string | 供应商商品名称 |  | 
 | itemOuterId | string | 供应商的商品商家编码 |  | 
 | supplierPurchasePrice | double | 供应商报价信息（进价）（不大于9999999.99不小于0的数字） 示例 98.88  |  | 

 

### 请求示例
示例一：

````
{
  "id": long,
  "outerId": "string",
  "barcode": "string",
  "skus": "[{\"id\":1,\"propertiesName\":\"string\"}]",
  "title": "string",
  "shortTitle": "string",
  "catId": long,
  "brandId": long,
  "brand": "string",
  "purchasePrice": double,
  "sellingPrice	": double
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | skus | array | sku列表 | 必填 | 
 | code | string | 返回码 | 必填 | 
 | trace_id | string | 流水id | 必填 | 
 | outerId | string | 平台商家编码 | 必填 | 
 | id | long | 系统主商品ID  | 必填 | 
 | success | boolean | true-成功，false-失败 | 必填 | 

# subTable: skus
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysSkuId | long | 系统商品skuID | 必填 | 
 | skuOuterId | string | 平台商家编码 | 必填 | 

 

### 响应示例
```
{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "code": "zhangsan",
  "skus": [
    {
      "sysSkuId": 12345,
      "skuOuterId": "zhangsan"
    }
  ],
  "solution": "zhangsan",
  "subCode": "zhangsan",
  "outerId": "zhangsan",
  "subMsg": "zhangsan",
  "id": 12345,
  "body": "zhangsan",
  "forbiddenField": "zhangsan"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.general.addorupdate:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|32|商家编码或ID不能为空|请检查商家编码或ID是否有值|
|32|商品标题不能为空|请检查商品标题是否有值|
|32|SKU商家编码不能为空|请检查SKU商家编码是否有值|
|32|SKU规格属性不能为空|请检查SKU规格属性是否有值|
|32|SKU规格属性格式不正确|请检查SKU规格属性格式是否正确|
|32|自定义属性名不能为空|请检查自定义属性名是否有值|
|33|商家编码过长|商家编码不能超过64位字符|
|33|商品标题过长|商家标题不能超过128位字符|
|33|唯一码类型不存在|请检查填写的唯一码类型是否正确|
|33|SKU过多，请分批次处理|SKU数量不能超过1000|
|33|SKU商家编码过长|SKU商家编码不能超过64位字符|
|33|SKU商家编码重复|请更改为新的SKU商家编码|
|33|SKU规格属性过长|SKU规格属性不能超过256位字符|
|33|处理商品信息有误有误|后台处理报错，请联系相应对接人员|
|33|参数有误："msg"|请根据错误提示进行处理|

---

## 修改/新增普通商品

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E4%BF%AE%E6%94%B9%E6%96%B0%E5%A2%9E%E6%99%AE%E9%80%9A%E5%95%86%E5%93%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1100-%E4%BF%AE%E6%94%B9%E6%96%B0%E5%A2%9E%E6%99%AE%E9%80%9A%E5%95%86%E5%93%81.md

# 修改/新增普通商品

**请求方法:** POST

### 接口描述
修改/新增普通商品。仅支持新增/修改普通商品

### 系统相关界面
"界面路径：【商品】----【商品档案】----【新建】/【编辑】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.general.addorupdate | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | outerId | string | 平台商家编码（主商家编码） | 必填 |  | 
 | id | long | 系统主商品ID（有值表示修改已存在的商品） |  |  | 
 | title | string | 商品名称 | 必填 |  | 
 | skus | array | sku 列表（含规格时必填） |  |  | 
 | shortTitle | string | 商品简称 |  |  | 
 | barcode | string | 条形码（当用户开启一品双码时，企业数据全局唯一，不能和商家编码重复） |  |  | 
 | catId | string | 商品类目属性ID |  |  | 
 | sellerCids | string | 商品分类 |  |  | 
 | picPath | string | 预览图片URL |  |  | 
 | brandId | long | 品牌ID (通过品牌接口去查询) |  |  | 
 | brand | string | 品牌名称 |  |  | 
 | purchasePrice | double | 成本价（单位：元），示例：100.99 |  |  | 
 | sellingPrice | double | 销售价（单位：元），示例：100.99 |  |  | 
 | weight | double | 商品重量（单位：Kg）， 示例：0.05 |  |  | 
 | remark | string | 商品备注 |  |  | 
 | washLabels | arrayString | 水洗唛列表 |  |  | 
 | productFeature | int | 申报产品特性   0:普货,1:带电池,2:侵权,3:带磁,4:非液体（化妆品）,5:液体（化妆品）,6:液体（非化妆品）,7:粉末,8:膏体 |  |  | 
 | makeGift | boolean | 是否标记为赠品（默认为false） |  |  | 
 | periodCast | integer | 保质期（单位：天） |  |  | 
 | unit | string | 商品单位 ，示例：件、箱 |  |  | 
 | x | double | 长（单位：cm） ，示例：0.01 |  |  | 
 | y | double | 宽（单位：cm） ，示例：0.01 |  |  | 
 | z | double | 高（单位：cm） ，示例：0.01 |  |  | 
 | wholesalePrice | double | 批发价（单位：元），示例：100.99 |  |  | 
 | invoice | string | 开票名称 |  |  | 
 | boxnum | integer | 箱规 |  |  | 
 | record | string | 商品记录 |  |  | 
 | place | string | 产地 |  |  | 
 | component | string | 成分 |  |  | 
 | standard | string | 执行标准 |  |  | 
 | safekind | string | 安全类别 |  |  | 
 | marketPrice | double | 市场价（单位：元） |  |  | 
 | otherPrice1 | double | 其他价格1（单位：元） |  |  | 
 | otherPrice2 | double | 其他价格2（单位：元） |  |  | 
 | otherPrice3 | double | 其他价格3（单位：元） |  |  | 
 | controlPurchase | boolean | 是否维护历史成本价：默认为false，不维护历史成本价（若有sku列表，则以sku里的controlPurchase字段控制sku记录的历史成本价） |  | false | 
 | listTime | string | 上架时间 格式为：yyyy-MM-dd HH:mm:ss |  |  | 
 | customAttribute | array | 自定义属性信息 最多10对属性 kv的map，格式 ：\{definedKey:key1,definedValue:value1\} |  |  | 
 | activeStatus | boolean | 商品状态，true-启用，false-停用（会影响下面所有规格的状态） |  |  | 
 | uniqueCodeType | integer | 唯一码类型      * 0-弱唯一码      * 1-强唯一码 |  |  | 

# subTable: skus
 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | propertiesName | string | 规格真正的属性，以分号分隔开来 | 必填 |  | 
 | outerId | string | sku级别的规格商家编码 | 必填 |  | 
 | id | long | 平台skuID |  |  | 
 | barcode | string | 规格条形码 |  |  | 
 | weight | double | 重量（单位：Kg），示例：0.05 |  |  | 
 | purchasePrice | double | 成本价（单位：元），示例：100.99 |  |  | 
 | sellingPrice | double | 销售价（单位：元），示例：100.99 |  |  | 
 | wholesalePrice | double | 批发价（单位：元），示例：100.99 |  |  | 
 | picPath | string | sku的图片地址 |  |  | 
 | shortTitle | string | 规格简称 |  |  | 
 | propertiesAlias | string | 规格别名 |  |  | 
 | remark | string | 规格备注 |  |  | 
 | skuComponent | string | 规格成分 |  |  | 
 | marketPrice | double | 规格市场价（单位：元），示例：100.99 |  |  | 
 | otherPrice1 | double | 规格其他价格1（单位：元），示例：100.99 |  |  | 
 | otherPrice2 | double | 规格其他价格2（单位：元），示例：100.99 |  |  | 
 | otherPrice3 | double | 规格其他价格3（单位：元），示例：100.99 |  |  | 
 | controlPurchase | boolean | 是否维护历史成本价：默认为false，不维护历史成本价 |  | false | 
 | uniqueCodeType | integer | 唯一码类型      * 0-弱唯一码      * 1-强唯一码 |  |  | 
 | activeStatus | boolean | 商品状态，true-启用，false-停用 |  |  | 
 | simpleSuiteBridgeModels | array | 单品 |  |  | 
 | standard | string | 执行标准 |  |  | 
 | record | string | 商品记录 |  |  | 
 | place | string | 产地 |  |  | 
 | safekind | string | 安全类别 |  |  | 

# subTable: skus/simpleSuiteBridgeModels
 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sysItemId | long | 系统主商品ID |  |  | 
 | sysSkuId | long | 系统商品skuID |  |  | 
 | ratio | integer | 比例 |  |  | 

# subTable: washLabels
 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | id | long | 水洗唛id | 必填 |  | 
 | sourceType | int | 水洗唛类型 0：系统， 1：自定义 | 必填 |  | 

# subTable: customAttribute
 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | definedKey | string | 属性名称 | 必填 |  | 
 | definedValue | string | 属性值 |  |  | 

 

### 请求示例
示例一：

````
{
  "id": long,
  "outerId": "string",
  "barcode": "string",
  "skus": "[{\"id\":1,\"propertiesName\":\"string\"}]",
  "title": "string",
  "record": "string",
  "place": "string",
  "shortTitle": "string",
  "catId": long,
  "brandId": long,
  "brand": "string",
  "purchasePrice": double,
  "sellingPrice	": double
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | skus | array | sku列表 | 必填 | 
 | trace_id | string | 跟踪流水id | 必填 | 
 | outerId | string | 平台商家编码 | 必填 | 
 | id | long | 系统主商品ID  | 必填 | 
 | success | boolean | true-成功，false-失败 | 必填 | 

# subTable: skus
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysSkuId | long | 系统商品skuID | 必填 | 
 | skuOuterId | string | 平台规格商家编码 | 必填 | 

 

### 响应示例
```
{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "code": "zhangsan",
  "skus": [
    {
      "sysSkuId": 12345,
      "skuOuterId": "zhangsan"
    }
  ],
  "solution": "zhangsan",
  "subCode": "zhangsan",
  "outerId": "zhangsan",
  "subMsg": "zhangsan",
  "id": 12345,
  "body": "zhangsan",
  "forbiddenField": "zhangsan"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.general.addorupdate:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20114|系统主商品ID或平台商家编码不能为空|系统主商品ID或平台商家编码不能同时为空|
|20115|平台商家编码不能超过64个字符|请检查平台商家编码是否超过64个字符|
|20116|商品标题不能为空|请检查商品标题是否为空|
|20117|商品标题不能超过128个字符|请检查商品标题是否超过128个字符|
|20118|唯一码类型不存在，只能为0或1|唯一码类型只能填写为0或1|
|20119|SKU最多支持1000个，请分批次处理|SKU最多支持1000个，请分批次处理|
|20120|平台规格商家编码不能为空|请检查平台规格商家编码是否有值|
|20121|平台规格商家编码不能超过64个字符|请检查平台规格商家编码是否超过64个字符|
|20122|平台规格商家编码重复|平台规格商家编码重复，请重新填写|
|20123|SKU规格属性不能为空|请检查SKU规格属性是否有值|
|20124|SKU规格属性格式不正确|SKU规格属性格式要求以逗号分隔，例如：属性1,属性2,...|
|20125|SKU规格属性不能超过256个字符|请检查SKU规格属性是否超过256个字符|
|20126|自定义属性过多，不能超过10个|请检查自定义属性是否超过10个|
|20127|自定义属性名不能为空|请自定义属性名是否有值|
|20128|自定义属性名不能超过64个字符|请检查自定义属性名是否超过64个字符|
|20129|自定义属性名重复|自定义属性名重复，请重新填写|
|20130|自定义属性值不能超过256个字符|请检查自定义属性值是否超过256个字符|
|20131|SKU信息有误|请检查SKU传参格式是否与文档一致|
|20132|成本价不能低于0|请检查该字段的值是否低于0|
|20133|销售价不能低于0|请检查该字段的值是否低于0|
|20134|重量不能低于0kg|请检查该字段的值是否低于0|
|20135|批发价不能低于0|请检查该字段的值是否低于0|
|20136|长不能低于0|请检查该字段的值是否低于0|
|20137|宽不能低于0|请检查该字段的值是否低于0|
|20138|高不能低于0|请检查该字段的值是否低于0|
|20139|市场价格不能低于0|请检查该字段的值是否低于0|
|20140|其它价格1不能低于0|请检查该字段的值是否低于0|
|20141|其它价格2不能低于0|请检查该字段的值是否低于0|
|20142|其它价格3不能低于0|请检查该字段的值是否低于0|
|20143|修改/新增普通商品有误|请根据返回的错误信息进行处理|

---

## 导入平台商品信息

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%AF%BC%E5%85%A5%E5%B9%B3%E5%8F%B0%E5%95%86%E5%93%81%E4%BF%A1%E6%81%AF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1150-%E5%AF%BC%E5%85%A5%E5%B9%B3%E5%8F%B0%E5%95%86%E5%93%81%E4%BF%A1%E6%81%AF.md

# 导入平台商品信息

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品对应表】----【导入店铺商品】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.tb.item.import | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | requestId | string | 每次请求访问的唯一标识 | 必填 | 
 | userId | long | 店铺id | 必填 | 
 | tbItems | string | 需要导入的平台商品 | 必填 | 

# subTable: tbItems
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | numIid | string | 平台商品id | 必填 | 
 | title | string | 平台商品名称 | 必填 | 
 | outerId | string | 平台商家编码 | 必填 | 
 | skuId | string | 平台规格id | 必填 | 
 | skuTitle | string | 平台规格名称 | 必填 | 
 | skuOuterId | string | 平台规格编码 | 必填 | 

 

### 请求示例
示例一：

```` 
{
  "requestId":"2222"
  "userId":12345
  "tbItems":"[{"numIid":"124123141231211","outerId":"2021ABC111211","skuId":"121311312131211","skuOuterId":"2021ABC111211-红色XL","skuTitle":"红色，XL","title":"连衣裙1121"}]"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | msg | string |  |  | 
 | code | string |  |  | 

 

### 响应示例
````
{
    "traceId": "3958541969736414985",
    "success": true
}
````
### 异常示例
````
{
    "traceId": "3958540894588783755",
    "msg": "缺少要导入的平台商品信息",
    "code": "60000",
    "success": false
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 更新商品历史成本价

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9B%B4%E6%96%B0%E5%95%86%E5%93%81%E5%8E%86%E5%8F%B2%E6%88%90%E6%9C%AC%E4%BB%B7
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1200-%E6%9B%B4%E6%96%B0%E5%95%86%E5%93%81%E5%8E%86%E5%8F%B2%E6%88%90%E6%9C%AC%E4%BB%B7.md

# 更新商品历史成本价

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.history.price.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码/规格商家编码，（同主商品的ID二选一，优先商家编码） | 必填 | 
 | sysItemId | long | 主商品的ID，（同商家编码二选一，优先商家编码） | 必填 | 
 | sysSkuId | long | 规格ID（同商家编码二选一，优先商家编码） | 必填 | 
 | price | string | 成本价（单位：元） | 必填 | 
 | date | date | 成本价更新时间，如未指定则会默认为当前时间 格式yyyy-MM-dd HH:mm:ss |  | 

 

### 请求示例
示例一：

```` 
{
  "outerId":"string"
}
````
示例二：

````
{
  "sysItemId":long,
  "date":"2023-07-03 11:00:12"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "26456474756756854"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询商品出入库记录

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%87%BA%E5%85%A5%E5%BA%93%E8%AE%B0%E5%BD%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1250-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%87%BA%E5%85%A5%E5%BA%93%E8%AE%B0%E5%BD%95.md

# 查询商品出入库记录

**请求方法:** POST

### 系统相关界面
"界面路径：【库存】----【出入库记录】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.stock.in.out.list | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | orderType | integer | 单据类型 0-库存调整|系统调整库存|系统调整出入库  1-采购入库 2-系统订单 3-销退入库|采退入库 4-采退出库 5-库存加工 6-维修出库 7-暂存区清零 8-暂存区平移 9-采退取消 10-覆盖导入 11-增量导入 12-出库导入 13-销退收货 14-销退取消收货 18-清零货位库存  19-调拨出库 20-调拨入库  21-撤销发货 29-次品上架 30-次品下架 |  | 
 | outerId | string | 平台商家编码 |  | 
 | warehouseId | long | 仓库ID |  | 
 | operateTimeBegin | string | 操作开始时间 格式为：yyyy-MM-dd HH:mm:ss |  | 
 | operateTimeEnd | string | 操作结束时间 格式为：yyyy-MM-dd HH:mm:ss |  | 
 | pageSize | integer | 分页数量 | 必填 | 
 | pageNo | integer | 当前页 | 必填 | 
 | orderNumber | string | 单据编号 |  | 

# subTable: orderType
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 |  |  | 0-库存调整|系统调整库存|系统调整出入库  1-采购入库 2-系统订单 3-销退入库|采退入库 4-采退出库 5-库存加工 6-维修出库
7-暂存区清零 8-暂存区平移 9-采退取消 10-覆盖导入 11-增量导入 12-出库导入 13-销退收货 14-销退取消收货 18-清零货位库存
19-调拨出库 20-调拨入库  21-撤销发货 29-次品上架 30-次品下架
31-快速上架 32-混放上架 33-库存下架 34-库存盘点 37-订单拣选 38-订单发货 39-拣选归还 41-补货拣选 42-补货上架 43-采退拣选
44-移库上架 45-移库下架46-自由拣选 47-批发配货出库 48-批发配货拣选  49-库存加工 50-收货单打回  53-其它入库 54-其他出库
55-调拨拣选 59-其它上架 60-暂存区上架 61-波次下架 65-移箱上架 70-档口配货出库 71-档口配货拣选 75-质检出库 76-质检入库
80-移箱下架 87-按箱下架 88-拆箱下架 |  | 

 

### 请求示例
示例一：

````
{
  "pageSize": integer,
  "pageNo": integer
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | msg | string | 返回消息 | 必填 | 
 | traceId | string | 流水id | 必填 | 
 | total | long | 返回总数 | 必填 | 
 | code | string | 返回码 | 必填 | 
 | stockInOutRecordVos | array | 数据列表 | 必填 | 

# subTable: stockInOutRecordVos
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | orderType | string | 单据类型 | 必填 | 
 | orderNumber | string | 单据编号 | 必填 | 
 | customType | string | 自定义出入库类型，可在快麦中维护 | 必填 | 
 | outerId | string | 平台商家编码 | 必填 | 
 | title | string | 商品标题 | 必填 | 
 | propertiesAlias | string | 规格属性别名 | 必填 | 
 | propertiesName | string | 规格真正的属性，以逗号分隔  | 必填 | 
 | barcode | string | 条形码 | 必填 | 
 | boxCode | string | 箱码 | 必填 | 
 | brand | string | 品牌名称 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | sysItemId | long | 系统主商品ID  | 必填 | 
 | sysSkuId | long | 系统商品规格ID | 必填 | 
 | warehouseId | long | 仓库ID | 必填 | 
 | warehouseName | string | 仓库名称 | 必填 | 
 | code | string | 仓库编码 | 必填 | 
 | goodsAllocation | string | 货位编码 | 必填 | 
 | beforeStockNum | long | 操作前总库存 | 必填 | 
 | afterStockNum | long | 操作后总库存 | 必填 | 
 | staffName     |string| 操作人名称   |必填｜
 | stockChange | long | 数量变化, 对于入库(type=1)为正数,表示增加的数量,对于出库(type=2)的系统订单为正数,表示减少的数量,对于库存调整(type=0)正数表示增加负数表示减少 | 必填 | 
 | content | string | 操作详情 | 必填 | 
 | operateTime | date | 操作时间 | 必填 | 
 | id | long | 记录id | 必填 | 
 | inOutWarehouseType | integer | 进出仓类型 -1-无对应关系 0-默认类型 1-暂存调入 2-暂存调出 3-盘点 4-暂存盘点 5-加工进仓 6-加工出仓 7-采退出仓 8-其他入仓 9-其他出仓 10-销售出仓 11-调拨入仓 12-调拨出仓13-维修出仓 14-采购进仓 15-销退入仓  17-质检出仓 18-质检入仓  21-移库上架 22-移库下架 | 必填 | 
 | type | integer | 单据类型 0-库存调整|系统调整库存|系统调整出入库  1-采购入库 2-系统订单 3-销退入库|采退入库 4-采退出库 5-库存加工 6-维修出库 7-暂存区清零 8-暂存区平移 9-采退取消 10-覆盖导入 11-增量导入 12-出库导入 13-销退收货 14-销退取消收货 18-清零货位库存  19-调拨出库 20-调拨入库  21-撤销发货 29-次品上架 30-次品下架 | 必填 | 
 | itemType | integer | 1 良品操作, 0 次品操作 | 必填 | 
 | singleItem | integer | 是否查询单个的商品，0：false，1：true | 必填 | 
 | stockChangeMultiple | array | 货位对应数量;示例：\[-3，-2\] ；goodsAllocation字段为：1库，2库 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productTime | string | 生产日期 | 必填 | 

# subTable: stockInOutRecordVos/type
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 |  |  |  31-快速上架 32-混放上架 33-库存下架 34-库存盘点 37-订单拣选 38-订单发货 39-拣选归还 41-补货拣选 42-补货上架 43-采退拣选 44-移库上架 45-移库下架46-自由拣选 47-批发配货出库 48-批发配货拣选 49-库存加工 50-收货单打回 53-其它入库 54-其他出库 55-调拨拣选 59-其它上架 60-暂存区上架 61-波次下架 65-移箱上架 70-档口配货出库 71-档口配货拣选 75-质检出库 76-质检入库 80-移箱下架 87-按箱下架 88-拆箱下架  | 必填 | 

 

### 响应示例
```
{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "total": 12345,
  "code": "zhangsan",
  "stockInOutRecordVos": [
    {
      "orderType": "zhangsan",
      "orderNumber": 10000,
      "customType": 12345,
      "outerId": 12345,
      "title": "zhangsan",
      "propertiesAlias": "zhangsan",
      "propertiesName": "zhangsan",
      "barcode": 12345,
      "boxCode": 10000,
      "brand": "zhangsan",
      "remark": 12345
      ...
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.stock.in.out.list:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|50|单据类型不合法|请按文档描述的类型填写|
|20001|页码为空或不符合规定|页码的值不能为空，且不能小于1|
|20002|页数为空或不符合规定|页数的值不能为空，且不能小于1|
|20305|仓库ID不能小于0！|仓库ID不能小于0！|
|20314|单据编号最多支持20组!|单据编号最多支持20组!|

---

## 查询库存状态

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%BA%93%E5%AD%98%E7%8A%B6%E6%80%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1300-%E6%9F%A5%E8%AF%A2%E5%BA%93%E5%AD%98%E7%8A%B6%E6%80%81.md

# 查询库存状态

**请求方法:** POST

### 系统相关界面
"界面路径：【库存】----【库存状态】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | stock.api.status.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | itemType | integer | 商品类型；0-组合商品（仅单品），1-套件，2-组合装，3-加工 |  | 0 | 
 | mainOuterId | string | 主商家编码（与规格商家编码二选一，多个逗号隔开） |  |  | 
 | skuOuterId | string | 规格商家编码（与主商家编码二选一，多个逗号隔开） |  |  | 
 | stockStatuses | integer | 库存状态(1-正常，2-警戒，3-无货，4-超卖，6-有货) |  |  | 
 | warehouseId | long | 仓库ID |  |  | 
 | pageSize | integer | 分页数量，最大100条 |  |  | 
 | pageNo | integer | 当前页 |  |  | 
 | created | string | 商品创建时间，格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | modified | string | 商品更新时间，格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | startStockModified | string | 库存修改开始时间，格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | endStockModified | string | 库存修改结束时间，格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | brands | string | 品牌名称，多个以逗号隔开 |  |  | 
 | relationInfoFields | string | 关联字段，多个用逗号隔开，指定查询关联字段信息会在relationInfo中返回， publicStock：公有可用数 |  |  | 

 

### 请求示例
示例一：

````
{
  "stockStatuses": integer,
  "warehouseId": long,
  "pageSize": integer,
  "pageNo": long
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | msg | string | 返回消息 | 必填 | 
 | traceId | string | 流水id | 必填 | 
 | total | long | 返回总数(仅在请求参数pageNo传1时才会返回) | 必填 | 
 | stockStatusVoList | array | 数据列表 | 必填 | 

# subTable: stockStatusVoList
 | 参数名 | 类型 | 描述                               | 必填 | 
 | --- | --- |----------------------------------| --- | 
 | mainOuterId | string | 主商家编码                            | 必填 | 
 | outerId | string | 平台商家编码                           | 必填 | 
 | skuOuterId | String | 平台规格商家编码                         | 必填 | 
 | title | string | 商品名称                             | 必填 | 
 | shortTitle | string | 商品简称                             | 必填 | 
 | stockStatus | integer | 库存状态（1-正常，2-警戒，3-无货，4-超卖，6-有货）   | 必填 | 
 | totalAvailableStockSum | long | 当前商品的实际总库存，实际总库存=实际锁定数+实际可用数+次品数 | 必填 | 
 | totalLockStock | long | 实际锁定数                            | 必填 | 
 | totalAvailableStock | long | 实际可用数                            | 必填 | 
 | totalDefectiveStock | long | 次品数                              | 必填 | 
 | sellableNum | long | 可售数                              | 必填 | 
 | allocateNum | long | 调拨在途数                            | 必填 | 
 | purchaseNum | long | 采购在途数                            | 必填 | 
 | onTheWayNum | Long | 销退在途数                            | 必填 | 
 | refundStock | Long | 销退暂存区库存                          | 必填 | 
 | purchaseStock | Long | 入库暂存区库存                          | 必填 | 
 | sysItemId | long | 系统主商品ID                          | 必填 | 
 | itemBarcode | string | 商品条形码                            | 必填 | 
 | picPath | string | 商品图片                             | 必填 | 
 | sysSkuId | long | 系统商品skuID                        | 必填 | 
 | skuBarcode | string | 规格条形码                            | 必填 | 
 | propertiesName | string | 商品规格属性                           | 必填 | 
 | skuPicPath | string | sku图片                            | 必填 | 
 | brand | string | 品牌                               | 必填 | 
 | itemCategoryNames | string | 商品分类                             | 必填 | 
 | cidName | string | 商品类目                             | 必填 | 
 | sellingPrice | double | 销售价                              | 必填 | 
 | purchasePrice | double | 成本价                              | 必填 | 
 | marketPrice | double | 市场价                              | 必填 | 
 | unit | string | 单位                               | 必填 | 
 | place | string | 产地                               | 必填 | 
 | supplierCodes | string | 供应商编码 多个用,隔开                     | 必填 | 
 | supplierNames | string | 供应商名 多个用,隔开                      | 必填 | 
 | wareHouseId | long | 仓库ID（请求参数指定仓库时有效）                | 必填 | 
 | stockModifiedTime | long | 库存修改时间                           | 必填 | 
 | relationInfo | object | 关联信息（公有可用数）                      | 必填 | 
 | itemTagList | array | 商品标签列表                           |  | 
 | stockLabels | array | 库存标签                             |  | 
 | virtualStock | long | 虚拟库存                               |  | 

# subTable: stockStatusVoList/relationInfo
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | publicStock | Long | 公有可用数 | 必填 | 

# subTable: stockStatusVoList/itemTagList
| 参数名 | 类型 | 描述   | 必填 | 
 | --- | --- |------| --- | 
| tagId | Long | 标签id | 必填 | 
| tagName | string | 标签名称 | 必填 | 

# subTable: stockStatusVoList/stockLabels
| 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
| labelName | string | 标签名称 | 必填 | 

### 响应示例
```
{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "total": 12345,
  "code": "zhangsan",
  "solution": "zhangsan",
  "subCode": "zhangsan",
  "stockStatusVoList": [
    {
      "supplierCodes": "zhangsan",
      "marketPrice": 10000,
      "totalAvailableStock": 12345,
      "sysItemId": 12345,
      "skuPicPath": "zhangsan",
      "itemCategoryNames": "zhangsan",
      "shortTitle": "zhangsan",
      "totalLockStock": 12345,
      "purchasePrice": 10000,
      "title": "zhangsan",
      "allocateNum": 12345,
      "totalAvailableStockSum": 12345,
      "supplierNames": "zhangsan",
      "sellingPrice": 10000,
      "totalDefectiveStock": 12345,
      "sellableNum": 12345,
      "stockStatus": 1,
      "wareHouseId": 12345,
      "place": "zhangsan",
      "brand": "zhangsan",
      "refundStock": 12345,
      "itemBarcode": "zhangsan",
      "propertiesName": "zhangsan",
      "picPath": "zhangsan",
      "sysSkuId": 12345,
      "mainOuterId": "zhangsan",
      "cidName": "zhangsan",
      "unit": "zhangsan",
      "stockModifiedTime": "@date",
      "outerId": "zhangsan",
      "purchaseNum": 12345,
      "skuBarcode": "zhangsan"
    }
  ],
  "subMsg": "zhangsan",
  "body": "zhangsan",
  "forbiddenField": "zhangsan"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(stock.api.status.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|50|库存状态不合法|库存状态(1正常，2警戒，3,无货，4超卖)|
|20001|页码为空或不符合规定|页码的值不能为空，且不能小于1|
|20002|页数为空或不符合规定|页数的值不能为空，且不能小于1|
|20019|页数不能超过100|页数不能超过100|
|20307|商品类型不合法|请检查该参数的值是否规范|
|20305|仓库ID不能为空或小于0|请检查该参数的值是否为空或小于0|

---

## 查询仓库及商品库存信息

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E4%BB%93%E5%BA%93%E5%8F%8A%E5%95%86%E5%93%81%E5%BA%93%E5%AD%98%E4%BF%A1%E6%81%AF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1350-%E6%9F%A5%E8%AF%A2%E4%BB%93%E5%BA%93%E5%8F%8A%E5%95%86%E5%93%81%E5%BA%93%E5%AD%98%E4%BF%A1%E6%81%AF.md

# 查询仓库及商品库存信息

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.warehouse.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 平台商家编码（与平台规格商家编码二选一，二者都有值，则按and条件匹配） |  | 
 | skuOuterId | string | 平台规格商家编码（与平台商家编码二选一，二者都有值，则按and条件匹配） |  | 
 | pageNo | integer | 页码 | 必填 | 
 | pageSize | integer | 每页数量，默认每页pageSize为20 |  | 

 

### 请求参数的逻辑
当outerId与skuOuterId都作为入参，则按两个都完全相等匹配的条件去查询：
1.若outerId存在，skuOuterId也存在，则后台返回结果
2.若outerId存在，而skuOuterId不存在，则后台不返回结果
3.若outerId不存在，而skuOuterId存在，则后台不返回结果
### 请求示例
示例一：

````
{
  "outerId": "string",
  "pageNo": integer
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 平台商家编码 | 必填 | 
 | skus | array | sku列表 | 必填 | 
 | traceId | string | 跟踪流水id | 必填 | 
 | code | string | 返回码 | 必填 | 
 | solution | string | 解决方案 | 必填 | 
 | body | string | 返回内容 | 必填 | 

# subTable: skus
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | skuOuterId | string | 平台规格商家编码（如果为纯商品，则不显示） | 必填 | 
 | supplierCodes | string | 供应商编码 多个用,隔开 | 必填 | 
 | supplierNames | string | 供应商名 多个用,隔开 | 必填 | 
 | mainWareHousesStock | array | sku下所处的仓库库存列表 | 必填 | 

# subTable: skus/mainWareHousesStock
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 仓库ID | 必填 | 
 | code | string | 仓库编码 | 必填 | 
 | name | string | 仓库名称 | 必填 | 
 | externalCode | string | 外部编码 | 必填 | 
 | type | integer | 仓库类型 0自有,1第三方,2门店仓库 | 必填 | 
 | stockStatus | integer | 库存状态(1正常，2警戒，3,无货，4超卖，6有货) | 必填 | 
 | status | integer | 仓库状态，0表示停用，1表示正常，2表示禁止发货 | 必填 | 
 | totalAvailableStockSum | long | 当前商品的实际总库存，实际总库存=实际锁定数+实际可用数+次品数 | 必填 | 
 | totalLockStock | long | 实际锁定数 | 必填 | 
 | totalAvailableStock | long | 实际可用数 | 必填 | 
 | totalDefectiveStock | long | 次品数 | 必填 | 
 | sellableNum | long | 可售数 | 必填 | 

 

### 响应示例
```
{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "total": 12345,
  "code": "zhangsan",
  "solution": "zhangsan",
  "subCode": "zhangsan",
  "stockStatusVoList": [
    {
      "supplierCodes": "zhangsan",
      "marketPrice": 10000,
      "totalAvailableStock": 12345,
      "sysItemId": 12345,
      "skuPicPath": "zhangsan",
      "itemCategoryNames": "zhangsan",
      "shortTitle": "zhangsan",
      "totalLockStock": 12345,
      "purchasePrice": 10000,
      "title": "zhangsan",
      "allocateNum": 12345,
      "totalAvailableStockSum": 12345,
      "supplierNames": "zhangsan",
      "sellingPrice": 10000,
      "totalDefectiveStock": 12345,
      "sellableNum": 12345,
      "stockStatus": 1,
      "wareHouseId": 12345,
      "place": "zhangsan",
      "brand": "zhangsan",
      "refundStock": 12345,
      "itemBarcode": "zhangsan",
      "propertiesName": "zhangsan",
      "picPath": "zhangsan",
      "sysSkuId": 12345,
      "mainOuterId": "zhangsan",
      "cidName": "zhangsan",
      "unit": "zhangsan",
      "stockModifiedTime": "@date",
      "outerId": "zhangsan",
      "purchaseNum": 12345,
      "skuBarcode": "zhangsan"
    }
  ],
  "subMsg": "zhangsan",
  "body": "zhangsan",
  "forbiddenField": "zhangsan"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.warehouse.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20301|主商家编码与SKU商家编码，必须二选一！|主商家编码与SKU商家编码，必须二选一！|
|20302|平台商家编码不支持多个查询!|请检查是否以逗号隔开的形式传了多个|
|20303|平台规格商家编码不支持多个查询!|请检查是否以逗号隔开的形式传了多个|
|20304|查询仓库及商品库存信息有误|请根据返回的错误信息进行处理|

---

## 修改实际库存

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E4%BF%AE%E6%94%B9%E5%AE%9E%E9%99%85%E5%BA%93%E5%AD%98
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1400-%E4%BF%AE%E6%94%B9%E5%AE%9E%E9%99%85%E5%BA%93%E5%AD%98.md

# 修改实际库存

**请求方法:** POST

### 接口描述
修改商品的实际库存 仅支持快麦ERP专业版修改快麦实际库存，同步更新可用库存，企业版及以上（含仓储模块）库存修改不支持使用该接口修改库存

### 系统相关界面
"界面路径：【库存】----【库存盘点】（专业版）"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.available.stock.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | warehouseId | long | 仓库ID | 必填 | 
 | stockNum | long | 实际库存数量 | 实际库存数量, 盘盈库存, 盘亏库存 三个参数中选择一个|
 | overStockNum | long | 盘盈库存，在实际库存数量基础上增加 | 实际库存数量, 盘盈库存, 盘亏库存 三个参数中选择一个 |
 | underStockNum | long | 盘亏库存，在实际库存数量基础上减少 | 实际库存数量, 盘盈库存, 盘亏库存 三个参数中选择一个 |
 | skuOuterIds | string | 平台规格商家编码，多个逗号隔开(同平台商家编码二选一，最多只能传20个) |  | 
 | outerIds | string | 平台商家编码，多个逗号隔开(同平台规格商家编码二选一,最多只能传20个) |  | 

 

### 请求示例

-----------------
````
{
  "skuOuterIds":"001,002",  
  "stockNum":long,  
  "warehouseId":long
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | msg | string | 返回信息 | 必填 | 
 | traceId | string | 流水id 示例：3553483395407017 | 必填 | 
 | code | string | 返回码 | 必填 | 
 | success | boolean | true-成功，false-失败 | 必填 | 

 

### 响应示例
```
{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "code": "zhangsan",
  "solution": "zhangsan",
  "subCode": "zhangsan",
  "subMsg": "zhangsan",
  "body": "zhangsan",
  "forbiddenField": "zhangsan"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.virtual.stock.update)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20305|仓库ID不能为空或小于0|请检查该参数的值是否为空或小于0|
|20308|商品信息不能为空|请检查商品信息字段是否为空|
|20309|平台规格商家编码最多支持20组!|请检查平台规格商家编码是否超过20组|
|20310|虚拟库存数量不能为空或小于0|请检查该参数的值是否为空或小于0|
|20311|平台商品信息最多支持20组！|请检查平台商品信息是否超过20组|
|20112|平台商家编码最多支持20组！|请检查平台商家编码是否超过20组|

---

## 修改虚拟库存

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E4%BF%AE%E6%94%B9%E8%99%9A%E6%8B%9F%E5%BA%93%E5%AD%98
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1450-%E4%BF%AE%E6%94%B9%E8%99%9A%E6%8B%9F%E5%BA%93%E5%AD%98.md

# 修改虚拟库存

**请求方法:** POST

### 系统相关界面
"界面路径：【库存】----【虚拟仓管理】----【编辑】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.virtual.stock.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemIds | array | 商品信息，纯商品sysSkuId传0，(同平台规格商家编码二选一) 格式\[\{"sysItemId":295711729489408,"sysSkuId":123\},\{"sysItemId":282263597731328,"sysSkuId":0\}\] |  | 
 | warehouseId | long | 仓库ID | 必填 | 
 | stockNum | long | 虚拟库存数量 | 必填 | 
 | skuOuterIds | string | 平台规格商家编码，多个逗号隔开(同商品信息二选一，最多只能传20个) |  | 
 | outerIds | string | 平台商家编码，多个逗号隔开(最多只能传20个) |  | 

# subTable: itemIds
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysSkuId | long | 系统商品skuID |  | 
 | sysItemId | long | 系统主商品ID  |  | 

 

### 请求示例
示例一：

````
{
  "itemIds":[
      {
        "sysItemId":long,
        "sysSkuId":long
      },
      {
        "sysItemId":long,
        "sysSkuId":long
      }
    ],
  "stockNum":long,  
  "warehouseId":long
}
````
示例二：

````
{
  "skuOuterIds":"001,002",  
  "stockNum":long,  
  "warehouseId":long
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | msg | string | 返回信息 | 必填 | 
 | traceId | string | 流水id 示例：3553483395407017 | 必填 | 
 | code | string | 返回码 | 必填 | 
 | success | boolean | true-成功，false-失败 | 必填 | 

 

### 响应示例
```
{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "code": "zhangsan",
  "solution": "zhangsan",
  "subCode": "zhangsan",
  "subMsg": "zhangsan",
  "body": "zhangsan",
  "forbiddenField": "zhangsan"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.virtual.stock.update)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20305|仓库ID不能为空或小于0|请检查该参数的值是否为空或小于0|
|20308|商品信息不能为空|请检查商品信息字段是否为空|
|20309|平台规格商家编码最多支持20组!|请检查平台规格商家编码是否超过20组|
|20310|虚拟库存数量不能为空或小于0|请检查该参数的值是否为空或小于0|
|20311|平台商品信息最多支持20组！|请检查平台商品信息是否超过20组|
|20112|平台商家编码最多支持20组！|请检查平台商家编码是否超过20组|

---

## 新增商品分类

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%96%B0%E5%A2%9E%E5%95%86%E5%93%81%E5%88%86%E7%B1%BB
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/150-%E6%96%B0%E5%A2%9E%E5%95%86%E5%93%81%E5%88%86%E7%B1%BB.md

# 新增商品分类

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品分类】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.seller.cat.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sellerCatList | list | 分类列表 | 必填 | 

# subTable: sellerCatList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | firstName | string | 一级分类名称 | 必填 | 
 | secondName | string | 二级分类名称 |  | 
 | thirdName | string | 三级分类名称 |  | 
 | forthName | string | 四级分类名称 |  | 

 

### 请求示例
示例一：

```` 
{
    "sellerCatList":
    [
        {
            "firstName": "服装",
            "secondName": "背心",
            "thirdName": "健身背心",
            "forthName": "健身背心男"
        }
    ]
}
````
### 响应示例
```
{
    "traceId": "2497465701327441942",
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 批量修改虚拟库存

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%89%B9%E9%87%8F%E4%BF%AE%E6%94%B9%E8%99%9A%E6%8B%9F%E5%BA%93%E5%AD%98
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1500-%E6%89%B9%E9%87%8F%E4%BF%AE%E6%94%B9%E8%99%9A%E6%8B%9F%E5%BA%93%E5%AD%98.md

# 批量修改虚拟库存

**请求方法:** POST

### 系统相关界面
"界面路径：【库存】----【库存状态】----【虚拟库存设置】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.virtual.stock.updateV2 | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | stockInfo | arrayString | 库存信息 |  | 

# subTable: stockInfo
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | warehouseId | long | 仓库ID | 必填 | 
 | stockNum | long | 库存数量 | 必填 | 
 | itemIds | array | 商品ID列表(与商家编码列表二者之一必填) |  | 
 | itemOuterIds | array | 商家编码列表(与商品ID列表二者之一必填) |  | 

# subTable: stockInfo/itemIds
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemId | long | 商品id(与规格id二者之一必填) |  | 
 | sysSkuId | long | 规格id(与系统id二者之一必填) |  | 

# subTable: stockInfo/itemOuterIds
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码(与SKU的商家编码二者之一必填) |  | 
 | skuOuterId | string | SKU的商家编码(与商家编码二者之一必填) |  | 

 

### 请求示例
示例一：

```` 
{
    "stockInfo":"[{\"itemOuterIds\":\"[{\\"outerId\\":\\"1111\\",\\"skuOuterId\\":\\"1111-01\\"}]\",\"stockNum\":5,\"warehouseId\":1000}]"
}
````
示例二：

````
{
    "stockInfo":"[{\"itemIds\":\"[{\\"sysItemId\\":3464634646,\\"sysSkuId\\":575764634646}]\",\"stockNum\":50,\"warehouseId\":1898908}]"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

 

### 响应示例
```
{
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.virtual.stock.updateV2:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询虚拟仓

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E8%99%9A%E6%8B%9F%E4%BB%93
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1550-%E6%9F%A5%E8%AF%A2%E8%99%9A%E6%8B%9F%E4%BB%93.md

# 查询虚拟仓

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.virtual.warehouse.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | name | string | 虚拟仓名称 |  | 
 | pageNo | int | 页码（从1开始） |  | 
 | pageSize | int | 分页大小（最大500） | 必填 | 

 

### 请求示例
示例一：

```` 
{
  "name":"string",
  "pageNo":1,
  "pageSize":50
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | object | 虚拟仓列表 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 
 | total | long | 总数 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 虚拟仓ID | 必填 | 
 | name | string | 虚拟仓名称 | 必填 | 
 | warehouseId | long | 归属仓库ID | 必填 | 
 | warehouseName | string | 归属仓库名称 | 必填 | 
 | status | string | 状态 , 正常/未知 | 必填 | 
 | created | string | 创建时间 | 必填 | 
 | modified | string | 修改时间 | 必填 | 
 | memberList | array | 成员 | 必填 | 

# subTable: list/memberList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | name | string | 成员名称 | 必填 | 
 | type | int | 类型 | 必填 | 
 | memberId | long | 成员ID | 必填 | 

 

### 响应示例
````
{
    "traceId": "2631454043714238433",
    "list":
    [
        {
            "created": "2021-04-16 11:27:13",
            "creatorName": "超级管理员",
            "warehouseName": "正木仓库",
            "memberList":
            [
                {
                    "name": "木子小店",
                    "type": 1,
                    "memberId": 75729
                },
                {
                    "name": "秋妈Rachel 优选童品",
                    "type": 1,
                    "memberId": 54415
                }
            ],
            "lockStatus": 1,
            "itemStock": 4,
            "warehouseId": 31358,
            "name": "第一个仓库1",
            "modified": "2022-09-05 10:30:45",
            "modifierName": "超级管理员",
            "id": 2,
            "ratio": 0,
            "status": "正常"
        },
        {
            "created": "2021-04-02 15:35:11",
            "creatorName": "超级管理员",
            "warehouseName": "默认仓库",
            "itemStock": 20,
            "warehouseId": 1871,
            "name": "cc",
            "modified": "2022-08-25 11:15:06",
            "modifierName": "超级管理员",
            "id": 3,
            "ratio": 0,
            "status": "正常"
        }
    ],
    "total": 23,
    "success": true
}
````
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 商品类型转换（款维度）

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81%E7%B1%BB%E5%9E%8B%E8%BD%AC%E6%8D%A2%E6%AC%BE%E7%BB%B4%E5%BA%A6
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1600-%E5%95%86%E5%93%81%E7%B1%BB%E5%9E%8B%E8%BD%AC%E6%8D%A2%E6%AC%BE%E7%BB%B4%E5%BA%A6.md

# 商品类型转换（款维度）

**请求方法:** POST

### 接口描述
商品类型转换。支持普通转加工/组合/套件,套件转组合/加工/普通，组合/加工/套件转普通

### 系统相关界面
"界面路径：【商品】----【商品档案V2】----【新建】/【编辑】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.type.change | 必填 |

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- |
 | changeType | integer | 0 默认值 不转  1 普通/组合/加工转套件 （款维度）2 普通/组合/加工转套件(含sku套件) 3. 普通/套件转组合（款维度）   5.普通/套件转加工（款维度） 20.其他类型转普通（款维度） | 必填 |
 | itemRequestType | integer | 商品类型（0-普通商品，1-加工 2-套件 3-组合），除了普通商品类型，其他类型的商品都需要填写“单品”字段的值。注意：新增时为必填，修改时为非必填 |  | 
 | outerId | string | 平台商家编码（主商家编码） | 必填 | 
 | title | string | 商品名称 | 必填 | 
 | skus | array | sku 列表（含规格时必填） |  | 
 | shortTitle | string | 商品简称 |  | 
 | barcode | string | 商品条形码（当用户开启一品双码时，企业数据全局唯一，不能和商家编码重复） |  | 
 | id | long | 系统主商品ID （有值表示修改已存在的商品） |  | 
 | catId | sting | 商品类目属性ID |  | 
 | itemCatName | string | 商品类目名称，各类目层级中如果没有重复可以只传商品类目名称；   支持指定多级类目，类目层级格式：\["根类目","一级类目","二级类目","三级类目"\] |  | 
 | sellerCids | string | 商品分类ID |  | 
 | itemCategoryNames | string | 商品分类名称，各分类层级中如果没有重复可以只传商品分类名称，多个分类用逗号隔开； 支持指定多级分类，分类层级格式：\[\["一级分类","二级分类","三级分类","四级分类1"\],\["一级分类","二级分类","三级分类","四级分类2"\]\] |  | 
 | picPath | string | 预览图片URL |  | 
 | brandId | long | 商品品牌ID (通过品牌接口去查询) |  | 
 | brand | string | 商品品牌名称 |  | 
 | purchasePrice | double | 成本价（单位：元），示例：100.99 |  | 
 | sellingPrice | double | 销售价（单位：元），示例：100.99 |  | 
 | weight | double | 商品重量（单位：Kg）， 示例：0.05 |  | 
 | remark | string | 商品备注 |  | 
 | washLabels | arrayString | 水洗唛列表 |  | 
 | productFeature | int | 申报产品特性   0:普货,1:带电池,2:侵权,3:带磁,4:非液体（化妆品）,5:液体（化妆品）,6:液体（非化妆品）,7:粉末,8:膏体 |  | 
 | makeGift | boolean | 是否标记为赠品（默认为false） |  | 
 | periodCast | integer | 保质期（单位：天） |  | 
 | unit | string | 商品单位 ，示例：件、箱 |  | 
 | x | double | 长（单位：cm） ，示例：0.01 |  | 
 | y | double | 宽（单位：cm） ，示例：0.01 |  | 
 | z | double | 高（单位：cm） ，示例：0.01 |  | 
 | wholesalePrice | double | 批发价（单位：元），示例：100.99 |  | 
 | invoice | string | 开票名称 |  | 
 | boxnum | integer | 箱规 |  | 
 | place | string | 产地 |  | 
 | component | string | 成分 |  | 
 | standard | string | 执行标准 |  | 
 | safekind | string | 安全类别 |  | 
 | marketPrice | double | 市场价（单位：元） |  | 
 | otherPrice1 | double | 其他价格1（单位：元） |  | 
 | otherPrice2 | double | 其他价格2（单位：元） |  | 
 | otherPrice3 | double | 其他价格3（单位：元） |  | 
 | listTime | string | 上架时间 格式为：yyyy-MM-dd HH:mm:ss |  | 
 | customAttribute | array | 自定义属性信息 最多10对属性 kv的map，格式 ：\{definedKey:key1,definedValue:value1\} |  | 
 | activeStatus | boolean | 商品状态，true-启用，false-停用（会影响下面所有规格的状态） |  | 
 | simpleSuiteBridgeModels | array | 单品（与sku层面的单品二选一填写） |  | 
 | uniqueCodeType | integer | 唯一码类型      * 0-弱唯一码      * 1-强唯一码 |  | 
 | suppliers | array |  |  | 

# subTable: skus
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | propertiesName | string | 规格真正的属性，包括颜色属性、其他属性、第三属性、第四属性，以分号分隔，如：“红色;XL” | 必填 | 
 | outerId | string | sku级别的规格商家编码 | 必填 | 
 | id | long | 平台skuID |  | 
 | barcode | string | 规格条形码（如果要更新为空，则传入字符串“empty”） |  | 
 | weight | double | 重量（单位：Kg），示例：0.05 |  | 
 | purchasePrice | double | 成本价（单位：元），示例：100.99 |  | 
 | sellingPrice | double | 销售价（单位：元），示例：100.99 |  | 
 | wholesalePrice | double | 批发价（单位：元），示例：100.99 |  | 
 | picPath | string | sku的图片地址 |  | 
 | propertiesAlias | string | 规格别名 |  | 
 | sellerCids | string | 规格分类ID |  | 
 | itemCategoryNames | string | 规格分类名称，多个用逗号隔开； 支持指定多级分类 ， 格式：\[\["一级分类","二级分类","三级分类"\],\["一级分类","二级分类","三级分类1"\]\] |  | 
 | brandId | string | 规格品牌ID |  | 
 | brand | string | 规格品牌名称 |  | 
 | remark | string | 规格备注 |  | 
 | skuComponent | string | 规格成分 |  | 
 | marketPrice | double | 规格市场价（单位：元），示例：100.99 |  | 
 | otherPrice1 | double | 规格其他价格1（单位：元），示例：100.99 |  | 
 | otherPrice2 | double | 规格其他价格2（单位：元），示例：100.99 |  | 
 | otherPrice3 | double | 规格其他价格3（单位：元），示例：100.99 |  | 
 | controlPurchase | boolean | 是否维护历史成本价：默认为false，不维护历史成本价 |  | 
 | uniqueCodeType | integer | 唯一码类型      * 0-弱唯一码      * 1-强唯一码 |  | 
 | activeStatus | boolean | 商品状态，true-启用，false-停用 |  | 
 | simpleSuiteBridgeModels | array | sku级别的单品（与外层单品二选一填写） |  | 
 | safekind | string | 安全类别 |  | 
 | standard | string | 执行标准 |  | 
 | place | string | 产地 |  | 
 | suppliers | array |  |  | 
 | skuCustomAttribute | array | 规格自定义属性 格式 ：\{definedKey:key1,definedValue:value1\} |  | 

# subTable: skus/simpleSuiteBridgeModels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemId | long | 系统主商品ID  |  | 
 | sysSkuId | long | 系统商品skuID |  | 
 | ratio | integer | 比例，数量 |  | 

# subTable: skus/suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 供应商编码 | 必填 | 
 | itemTitle | string | 供应商商品名称 |  | 
 | itemOuterId | string | 供应商的商品商家编码 |  | 
 | caigouUrl | string | 采购链接 |  | 
 | discountRate | double | 折扣率（不大于100不小于等于0的数字）示例 98.88 |  | 
 | returnRate | double | 退货率或采退率 （不大于100不小于等于0的数字）示例 6.67 |  | 
 | supplierPurchasePrice | double | 供应商报价信息（进价）（不大于9999999.99不小于0的数字） 示例 98.88  |  | 

# subTable: skus/skuCustomAttribute
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | definedKey | string | 规格自定义属性名称 |  | 
 | definedValue | string | 规格自定义属性值 |  | 

# subTable: washLabels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 水洗唛id | 必填 | 
 | sourceType | int | 水洗唛类型 0：系统， 1：自定义 | 必填 | 

# subTable: customAttribute
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | definedKey | string | 属性名称 | 必填 | 
 | definedValue | string | 属性值 |  | 

# subTable: simpleSuiteBridgeModels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemId | long | 系统主商品ID  |  | 
 | sysSkuId | long | 系统商品skuID |  | 
 | ratio | integer | 比例，数量 |  | 

# subTable: suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 供应商编码 | 必填 | 
 | caigouUrl | string | 采购链接 |  | 
 | discountRate | double | 折扣率（不大于100不小于等于0的数字）示例 98.88 |  | 
 | returnRate | double | 退货率或采退率 （不大于100不小于等于0的数字）示例 6.67 |  | 
 | itemTitle | string | 供应商商品名称 |  | 
 | itemOuterId | string | 供应商的商品商家编码 |  | 
 | supplierPurchasePrice | double | 供应商报价信息（进价）（不大于9999999.99不小于0的数字） 示例 98.88  |  | 

 

### 请求示例
示例一：

````
{
  "id": 637768451490304,
  "changeType": 20,
  "outerId": "其他类型转普通",
  "title": "其他类型转普通"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | skus | array | sku列表 | 必填 | 
 | code | string | 返回码 | 必填 | 
 | trace_id | string | 流水id | 必填 | 
 | outerId | string | 平台商家编码 | 必填 | 
 | id | long | 系统主商品ID  | 必填 | 
 | success | boolean | true-成功，false-失败 | 必填 | 

# subTable: skus
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysSkuId | long | 系统商品skuID | 必填 | 
 | skuOuterId | string | 平台商家编码 | 必填 | 

 

### 响应示例
```
{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "code": "zhangsan",
  "skus": [
    {
      "sysSkuId": 12345,
      "skuOuterId": "zhangsan"
    }
  ],
  "solution": "zhangsan",
  "subCode": "zhangsan",
  "outerId": "zhangsan",
  "subMsg": "zhangsan",
  "id": 12345,
  "body": "zhangsan",
  "forbiddenField": "zhangsan"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.general.addorupdate:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|32|商家编码或ID不能为空|请检查商家编码或ID是否有值|
|32|商品标题不能为空|请检查商品标题是否有值|
|32|SKU商家编码不能为空|请检查SKU商家编码是否有值|
|32|SKU规格属性不能为空|请检查SKU规格属性是否有值|
|32|SKU规格属性格式不正确|请检查SKU规格属性格式是否正确|
|32|自定义属性名不能为空|请检查自定义属性名是否有值|
|33|商家编码过长|商家编码不能超过64位字符|
|33|商品标题过长|商家标题不能超过128位字符|
|33|唯一码类型不存在|请检查填写的唯一码类型是否正确|
|33|SKU过多，请分批次处理|SKU数量不能超过1000|
|33|SKU商家编码过长|SKU商家编码不能超过64位字符|
|33|SKU商家编码重复|请更改为新的SKU商家编码|
|33|SKU规格属性过长|SKU规格属性不能超过256位字符|
|33|处理商品信息有误有误|后台处理报错，请联系相应对接人员|
|33|参数有误："msg"|请根据错误提示进行处理|

---

## 商品历史成本价的查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81%E5%8E%86%E5%8F%B2%E6%88%90%E6%9C%AC%E4%BB%B7%E7%9A%84%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1650-%E5%95%86%E5%93%81%E5%8E%86%E5%8F%B2%E6%88%90%E6%9C%AC%E4%BB%B7%E7%9A%84%E6%9F%A5%E8%AF%A2.md

# 商品历史成本价的查询

**请求方法:** POST

### 接口描述
查询商品的历史成本价

### 系统相关界面
"界面路径：【商品】----【商品档案V2】----【历史成本价】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.history.cost.price.query | 必填 |

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- |
 | sysItemId | long |  系统商品ID | 必填 |
 | sysSkuId | long |  系统规格ID 如果是纯商品 规格id为0 | 必填 |
 | startTime | string |  开始时间 格式 yyyy-MM-dd HH:mm:ss |  |
 | endTime | string |  结束时间 格式 yyyy-MM-dd HH:mm:ss |  |
 | warehouseIdList | string | 仓库ID列表 ,多个用英文逗号分隔 示例：1,2 | |

 

### 请求示例
示例一：

````
{
  "sysItemId": 637768451490304,
  "sysSkuId": 0
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 数据字典 | 必填 | 

# subTable: list
 | 参数名 | 类型      | 描述                   | 必填 | 
 | --- |---------|----------------------| --- | 
 | sysItemId | long    | 系统商品ID               | 必填 |
 | sysSkuId | long    | 系统规格ID 如果是纯商品 规格id为0 | 必填 |
 | importPrice | Double  | 成本价                  |  |
 | startStr | String  | 开始时间（字符串格式）          |  |
 | endStr | String  | 结束时间（字符串格式）          |  |
 | start | Date    | 开始时间                 |  |
 | end | Date    | 结束时间                 |  |
 | warehouseId | long    | 仓库ID                 |  |
 | warehouseName | String  | 仓库名称                 |  |
 | bargainer | String  | 议价员                 |  |
 | operationType | integer | 操作类型 初始化档案成本价写 '修改档案成本价写 手动修改后写入 3 加权成本价写入 4 采购单价格修改 5 导入历史成本价修改 批量历史成本价修改 其他入库 10 其他出库 11   |  |
 

### 响应示例

```
{
  "traceId" : "4947170770479861506",
  "success" : true,
  "list" : [ {
    "sysSkuId" : 0,
    "startStr" : "2027-08-07 00:00:00",
    "warehouseId" : 0,
    "sysItemId" : 5484225041177088,
    "start" : 1817568000000,
    "operationType" : 16,
    "end" : 1893427200000,
    "warehouseName" : "全仓",
    "importPrice" : 28.0
  } ]
}
```
### 异常示例

```
{
    "code": "25",
    "msg": "服务方法(erp.item.general.addorupdate:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```

### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20113|系统主商品ID信息不正确|请检查商家ID是否有值|
|20107|查询商品SKU信息有误|请检查skuID是否有值|
|40002|开始时间不能大于结束时间|开始时间不能大于结束时间|

---

## 清空商品字段

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%B8%85%E7%A9%BA%E5%95%86%E5%93%81%E5%AD%97%E6%AE%B5
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/1700-%E6%B8%85%E7%A9%BA%E5%95%86%E5%93%81%E5%AD%97%E6%AE%B5.md

# 清空商品字段

**请求方法:** POST

### 接口描述
根据商品编码清空指定的商品字段。

### 系统相关界面
"界面路径：【商品】----【商品档案V2】----【编辑】"

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**

### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 |

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method | string | erp.item.clear.field | 必填 |

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | outerId | string | 商品编码 | 必填 |
 | fieldName | string | 需要清空的商品字段名称，多个字段逗号分隔 | 必填 |

### 请求示例
```json
{
  "outerId": "ITEM-001",
  "fieldName": "barcode"
}
```

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | success | boolean | 请求是否成功 | 必填 |
 | trace_id | string | 请求ID，用于问题排查 | 必填 |

### 响应示例
```json
{
  "success": true,
  "trace_id": "3553483395407017"
}
```

### 异常示例
```json
{
  "code": "25",
  "msg": "服务方法(erp.item.clear.field:1.0)的签名无效",
  "success": false,
  "trace_id": "3553483395423660"
}
```

### 错误码解释
| 错误码 | 错误信息 | 解决方案 |
| --- | --- | --- |
| 25 | 签名无效 | 请检查签名参数和签名生成方式 |
| 32 | 待清除的商品字段名称不能为空 | 请检查fieldName是否有值 |
| 33 | 系统商品编码必传或不支持清除指定商品字段 | 请检查outerId和fieldName是否正确 |

---

## 查询商品分类信息

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%88%86%E7%B1%BB%E4%BF%A1%E6%81%AF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/200-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%88%86%E7%B1%BB%E4%BF%A1%E6%81%AF.md

# 查询商品分类信息

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品分类】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.seller.cat.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 

 

### 请求示例

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sellerCats | array | 商品分类列表 | 必填 | 

# subTable: sellerCats
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | created | long | 建档时间 | 必填 | 
 | name | string | 分类名称 | 必填 | 
 | modified | long | 修改时间 | 必填 | 
 | cid | long | 分类编号 | 必填 | 
 | parentCid | long | 父级分类编号，值等于0：表示此类目为店铺下的一级类目，值不等于0：表示此类目有父类目 | 必填 | 
 | id | long | 分类id | 必填 | 

 

### 响应示例
```
{
  "traceId": "1871145332930912361",
  "sellerCats": [
    {
      "parentCid": 0,
      "created": 1649642895000,
      "name": "分类",
      "modified": 1649642895000,
      "id": 5561,
      "cid": -1
    }
  ],
  "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.seller.cat.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|无|无|无|

---

## 商品关联供应商信息更新V1.0

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/%E5%95%86%E5%93%81%E5%85%B3%E8%81%94%E4%BE%9B%E5%BA%94%E5%95%86%E4%BF%A1%E6%81%AF%E6%9B%B4%E6%96%B0V1.0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/2000-%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/0-%E5%95%86%E5%93%81%E5%85%B3%E8%81%94%E4%BE%9B%E5%BA%94%E5%95%86%E4%BF%A1%E6%81%AF%E6%9B%B4%E6%96%B0V1.0.md

# 商品关联供应商信息更新V1.0

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品档案】----【设置关联供应商信息】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|正式环境| https://gw.kuaimai.com/router |
|测试环境| https://pubgwerp.superboss.cc/router|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.supplier.relevance | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemId | long | 平台主商品ID（与平台商家编码二选一） |  | 
 | outerId | string | 平台商家编码（与平台主商品ID二选一） |  | 
 | skuOuterId | string | 平台规格商家编码 |  | 
 | suppliers | array | 供应商信息列表 |  | 

# subTable: suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 供应商ID |  | 
 | code | string | 供应商编码  | 必填 | 
 | itemOuterId | string | 供应商的商品商家编码 |  | 
 | itemTitle | string | 供应商商品名称 |  | 
 | supplierPurchasePrice | double | 供应商报价信息（进价）（不大于9999999.99不小于0的数字） 示例 98.88 |  | 
 | discountRate | double | 折扣率（不大于100不小于等于0的数字）示例 98.88 |  | 
 | returnRate | double | 退货率或采退率 （不大于100不小于等于0的数字）示例 6.67 |  | 
 | caigouUrl | string | 采购链接 |  | 

 

### 请求示例
示例一：

````
{
  "itemId": long,
  "suppliers": [
    {
      "id": long,
      "discountRate": double
    }
  ]
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 流水id | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.supplier.relevance:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20501|平台主商品ID与平台商家编码不能同时为空，必须二选一！|请检查平台主商品ID与平台商家编码是否都为空|
|20502|平台主商品ID不能小于等于0！|请检查平台主商品ID是否小于等于0|
|20503|供应商信息不能为空|请检查供应商信息suppliers字段是否有值|
|20504|供应商信息不能超过1000组，请分批次处理|请检查供应商信息是否超过1000组，超过请分批次处理|
|20505|供应商编码与供应商ID不能同时为空|请检查供应商编码与供应商ID是否都为空|
|20506|供应商编码不能为空|请检查供应商编码是否为空|
|20507|供应商编码重复|请重新填写供应商编码|
|20508|供应商ID不能为空或小于等于0|请检查供应商ID是否为空或小于等于0|
|20509|供应商ID重复|请重新填写供应商ID|
|20510|供应商商品编码过长，不能超过64个字符|请检查供应商商品编码是否超过64个字符|
|20511|供应商商品标题过长，不能超过64个字符|请检查供应商商品标题是否超过64个字符|
|20512|供应商采购链接过长，不能超过1024个字符|请检查供应商采购链接是否超过1024个字符|
|20513|供应商报价信息（进价）不正确，不能小于0且大于等于9999999.99|请检查供应商报价信息（进价）是否小于0且大于等于9999999.99|
|20514|供应商采购折扣率不正确|供应商采购折扣率不能小于等于0，或者大于100|
|20515|供应商采购退货率不正确|供应商采购退货率不能小于等于0，或者大于100|
|20516|供应商信息有误|请检查供应商信息参数是否规范|

---

## 修改商品供应商关系V1.0

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/%E4%BF%AE%E6%94%B9%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV1.0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/2000-%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/100-%E4%BF%AE%E6%94%B9%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV1.0.md

# 修改商品供应商关系V1.0

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品档案】----【设置关联供应商信息】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|正式环境| https://gw.kuaimai.com/router |
|测试环境| https://pubgwerp.superboss.cc/router|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.supplier.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemId | long | 平台主商品ID（与平台商家编码二选一） |  | 
 | outerId | string | 平台商家编码（与平台主商品ID二选一） |  | 
 | skuOuterId | string | 平台规格商家编码 |  | 
 | suppliers | array | 供应商信息列表 |  | 

# subTable: suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | caigouUrl | string | 采购链接 |  | 
 | discountRate | double | 折扣率（不大于100不小于等于0的数字）示例 98.88 |  | 
 | returnRate | double | 退货率或采退率 （不大于100不小于等于0的数字）示例 6.67 |  | 
 | code | string | 供应商编码  | 必填 | 
 | itemTitle | string | 供应商商品名称 |  | 
 | itemOuterId | string | 供应商的商品商家编码 |  | 
 | id | long | 供应商ID |  | 
 | supplierPurchasePrice | double | 供应商报价信息（进价）（不大于9999999.99不小于0的数字） 示例 98.88 |  | 

 

### 请求示例
示例一：

````
{
  "itemId": 1,
  "suppliers": "[{\"id\":1,\"discountRate\":63.54}]"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 流水id | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.supplier.update:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20501|平台主商品ID与平台商家编码不能同时为空，必须二选一！|请检查平台主商品ID与平台商家编码是否都为空|
|20502|平台主商品ID不能小于等于0！|请检查平台主商品ID是否小于等于0|
|20503|供应商信息不能为空|请检查供应商信息suppliers字段是否有值|
|20504|供应商信息不能超过1000组，请分批次处理|请检查供应商信息是否超过1000组，超过请分批次处理|
|20505|供应商编码与供应商ID不能同时为空|请检查供应商编码与供应商ID是否都为空|
|20506|供应商编码不能为空|请检查供应商编码是否为空|
|20507|供应商编码重复|请重新填写供应商编码|
|20508|供应商ID不能为空或小于等于0|请检查供应商ID是否为空或小于等于0|
|20509|供应商ID重复|请重新填写供应商ID|
|20510|供应商商品编码过长，不能超过64个字符|请检查供应商商品编码是否超过64个字符|
|20511|供应商商品标题过长，不能超过64个字符|请检查供应商商品标题是否超过64个字符|
|20512|供应商采购链接过长，不能超过1024个字符|请检查供应商采购链接是否超过1024个字符|
|20513|供应商报价信息（进价）不正确，不能小于0且大于等于9999999.99|请检查供应商报价信息（进价）是否小于0且大于等于9999999.99|
|20514|供应商采购折扣率不正确|供应商采购折扣率不能小于等于0，或者大于100|
|20515|供应商采购退货率不正确|供应商采购退货率不能小于等于0，或者大于100|
|20516|供应商信息有误|请检查供应商信息参数是否规范|

---

## 删除商品供应商关系V1.0

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/%E5%88%A0%E9%99%A4%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV1.0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/2000-%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/150-%E5%88%A0%E9%99%A4%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV1.0.md

# 删除商品供应商关系V1.0

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品档案】----【设置关联供应商信息】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|正式环境| https://gw.kuaimai.com/router |
|测试环境| https://pubgwerp.superboss.cc/router|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.supplier.delete | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemId | long | 平台主商品的ID（与平台商家编码二选一） |  | 
 | outerId | string | 平台商家编码（与平台主商品ID二选一） |  | 
 | skuOuterId | string | 规格商家编码 |  | 
 | supplierIds | string | 供应商ID（与供应商编码 二选一，ID优先），举例：\[long,long\] |  | 
 | supplierCodes | string | 供应商编码 （与供应商ID 二选一，ID优先），举例：\[string,string\] |  | 

 

### 请求示例
示例一：

````
{
  "itemId": long,
  "supplierCodes": "string,string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 流水id | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.supplier.delete:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20501|平台主商品ID与平台商家编码不能同时为空，必须二选一！|请检查平台主商品ID与平台商家编码是否都为空|
|20502|平台主商品ID不能小于等于0！|请检查平台主商品ID是否小于等于0|
|20505|供应商编码与供应商ID不能同时为空|请检查供应商编码与供应商ID是否都为空|
|20506|供应商编码不能为空|请检查供应商编码是否为空|
|20508|供应商ID不能为空或小于等于0|请检查供应商ID是否为空或小于等于0|
|20516|供应商信息有误|请检查供应商信息参数是否规范|
|20517|供应商ID至少要有一组|请检查供应商ID字段是否有值|
|20518|供应商编码至少要有一组|请检查供应商编码字段是否有值|

---

## 添加商品供应商关系V1.0

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/%E6%B7%BB%E5%8A%A0%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV1.0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/2000-%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/200-%E6%B7%BB%E5%8A%A0%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV1.0.md

# 添加商品供应商关系V1.0

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品档案】----【设置关联供应商信息】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|正式环境| https://gw.kuaimai.com/router |
|测试环境| https://pubgwerp.superboss.cc/router|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.supplier.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemId | long | 平台主商品ID（与平台商家编码二选一） |  | 
 | outerId | string | 平台商家编码（与平台主商品ID二选一） |  | 
 | skuOuterId | string | 平台规格商家编码 |  | 
 | suppliers | array | 供应商信息列表 |  | 

# subTable: suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | caigouUrl | string | 采购链接 |  | 
 | discountRate | double | 折扣率（不大于100不小于等于0的数字）示例 98.88 |  | 
 | returnRate | double | 退货率或采退率 （不大于100不小于等于0的数字）示例 6.67 |  | 
 | code | string | 供应商编码 | 必填 | 
 | itemTitle | string | 供应商商品名称 |  | 
 | itemOuterId | string | 供应商的商品商家编码 |  | 
 | id | long | 供应商ID |  | 
 | supplierPurchasePrice | double | 供应商报价信息（进价）（不大于9999999.99不小于0的数字） 示例 98.88 |  | 

 

### 请求示例
示例一：

````
{
  "itemId": long,
  "suppliers": [
    {
      "id": long,
      "discountRate": double
    }
  ]
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 流水id | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.supplier.add:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20501|平台主商品ID与平台商家编码不能同时为空，必须二选一！|请检查平台主商品ID与平台商家编码是否都为空|
|20502|平台主商品ID不能小于等于0！|请检查平台主商品ID是否小于等于0|
|20503|供应商信息不能为空|请检查供应商信息suppliers字段是否有值|
|20504|供应商信息不能超过1000组，请分批次处理|请检查供应商信息是否超过1000组，超过请分批次处理|
|20505|供应商编码与供应商ID不能同时为空|请检查供应商编码与供应商ID是否都为空|
|20506|供应商编码不能为空|请检查供应商编码是否为空|
|20507|供应商编码重复|请重新填写供应商编码|
|20508|供应商ID不能为空或小于等于0|请检查供应商ID是否为空或小于等于0|
|20509|供应商ID重复|请重新填写供应商ID|
|20510|供应商商品编码过长，不能超过64个字符|请检查供应商商品编码是否超过64个字符|
|20511|供应商商品标题过长，不能超过64个字符|请检查供应商商品标题是否超过64个字符|
|20512|供应商采购链接过长，不能超过1024个字符|请检查供应商采购链接是否超过1024个字符|
|20513|供应商报价信息（进价）不正确，不能小于0且大于等于9999999.99|请检查供应商报价信息（进价）是否小于0且大于等于9999999.99|
|20514|供应商采购折扣率不正确|供应商采购折扣率不能小于等于0，或者大于100|
|20515|供应商采购退货率不正确|供应商采购退货率不能小于等于0，或者大于100|
|20516|供应商信息有误|请检查供应商信息参数是否规范|

---

## 查询商品SKU列表V1.0

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81SKU%E5%88%97%E8%A1%A8V1.0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/2000-%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/250-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81SKU%E5%88%97%E8%A1%A8V1.0.md

# 查询商品SKU列表V1.0

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品档案】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|正式环境| https://gw.kuaimai.com/router |
|测试环境| https://pubgwerp.superboss.cc/router|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.sku.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemId | long | 系统主商品ID  | 必填 | 

 

### 请求示例
示例一：

````
{
  "sysItemId":"string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemSkus | array | SKU信息列表 | 必填 | 

# subTable: itemSkus
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | created | long | 创建时间 | 必填 | 
 | sysItemId | long | 系统主商品ID  | 必填 | 
 | skuPicPath | string | sku的图片地址 | 必填 | 
 | weight | double | 重量，单位kg | 必填 | 
 | shortTitle | string | 规格简称 | 必填 | 
 | propertiesName | string | 规格真正的属性，以分号分隔  | 必填 | 
 | propertiesAlias | string | 规格属性别名 | 必填 | 
 | sysSkuId | integer | 系统商品skuID | 必填 | 
 | unit | string | 单位 | 必填 | 
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | hasSupplier | integer | 是否关联供应商 是：1 否：0 | 必填 | 
 | modified | long | 更新时间 | 必填 | 
 | makeGift | boolean | 是否标记为赠品 | 必填 | 
 | barcode | string | 条形码 | 必填 | 
 | skuOuterId | string | 平台规格商家编码 | 必填 | 
 | purchasePrice | double | 成本价 | 必填 | 
 | priceOutput | double | 销售价 | 必填 | 
 | x | double | 长 | 必填 | 
 | y | double | 宽 | 必填 | 
 | z | double | 高 | 必填 | 
 | itemTagList | array | 商品标签列表 | 必填 |

# subTable: itemSkus/itemTagList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | tagId | long | 商品标签ID | 必填 |
 | tagName | string | 商品标签名称 | 必填 |
 | tagStyle | string | 商品标签样式, 1-蓝底白字, 2-红底白字 3-紫底白字 4-绿底黑字 5-灰底黑字 6-粉底黑字 | 必填 |
 | tagRelationSource | int | 商品标签关系来源, 0-系统打上, 1-快麦, 2-API写入 | 必填 |
 | tagRelationSourceDesc | string | 商品标签关系来源描述 | 必填 |

 

### 响应示例
```
{
  "itemSkus": [
    {
      "created": "@date",
      "sysItemId": 12345,
      "skuPicPath": "zhangsan",
      "weight": 10000,
      "shortTitle": "zhangsan",
      "propertiesName": "zhangsan",
      "propertiesAlias": "zhangsan",
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "activeStatus": 1,
      "hasSupplier": 1,
      "modified": "@date",
      "makeGift": true,
      "barcode": "zhangsan",
      "skuOuterId": "zhangsan"
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.sku.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20108|系统主商品ID不能为空|请检查系统主商品ID是否填写|
|20104|查询商品SKU列表有误|请根据返回错误信息进行处理|

---

## 查询多个商品信息V1.0

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/%E6%9F%A5%E8%AF%A2%E5%A4%9A%E4%B8%AA%E5%95%86%E5%93%81%E4%BF%A1%E6%81%AFV1.0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/2000-%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/300-%E6%9F%A5%E8%AF%A2%E5%A4%9A%E4%B8%AA%E5%95%86%E5%93%81%E4%BF%A1%E6%81%AFV1.0.md

# 查询多个商品信息V1.0

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品档案】----【编辑】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|正式环境| https://gw.kuaimai.com/router |
|测试环境| https://pubgwerp.superboss.cc/router|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemIds | string | 系统主商品ID，多个用逗号隔开，最多支持20个  | 必填 | 

 

### 请求示例
示例一：

````
{
  "sysItemIds":"string,string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | items | array | 商品数据列表 | 必填 | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | typeTag | integer | 基于type下的二级分类      * type=0 : 0-正常商品，1-sku加工商品，2-纯加工商品 3-含sku组合装商品 4-不含sku组合装商品 | 必填 | 
 | created | long | 创建时间 | 必填 | 
 | sysItemId | long | 系统主商品ID | 必填 | 
 | weight | double | 重量，单位kg | 必填 | 
 | shortTitle | string | 商品简称 | 必填 | 
 | title | string | 商品标题 | 必填 | 
 | type | string | 商品类型      * 0-普通（含虚拟商品，用 isVirtual字段描述|组合装商品） 1-sku套件 2-纯套件 3-包材商品 | 必填 | 
 | isSkuItem | integer | 是否是含有sku的商品，是：1，否：0 | 必填 | 
 | picPath | string | 商品图片URL | 必填 | 
 | catId | string | 商品类目 | 必填 | 
 | unit | string | 单位 | 必填 | 
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | hasSupplier | integer | 是否关联供应商 是：1 否：0 | 必填 | 
 | modified | long | 更新时间 | 必填 | 
 | outerId | string | 平台商家编码 | 必填 | 
 | makeGift | boolean | 是否标记为赠品 | 必填 | 
 | isVirtual | integer | 是否是虚拟商品，是：1，否：0 | 必填 | 
 | skus | array | sku数据列表 | 必填 | 
 | barcode | string | 条形码 | 必填 | 
 | brand | string | 品牌 | 必填 | 
 | sellerCids | string | 商品分类      * todo 这里关联的是 seller_cat 的cid，cid不是唯一的概率很小。有时间后面需要改造 | 必填 | 
 | sellerCats | array | 商品分类id集合 | 必填 | 
 | purchasePrice | double | 成本价 | 必填 | 
 | priceOutput | double | 销售价 | 必填 | 
 | x | double | 长 | 必填 | 
 | y | double | 宽 | 必填 | 
 | z | double | 高 | 必填 | 

# subTable: items/skus
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | created | long | 创建时间 | 必填 | 
 | sysItemId | long | 系统主商品ID  | 必填 | 
 | skuPicPath | string | sku的图片地址 | 必填 | 
 | weight | double | 重量，单位kg | 必填 | 
 | shortTitle | string | 规格简称 | 必填 | 
 | propertiesName | string | 规格真正的属性，以分号分隔 | 必填 | 
 | propertiesAlias | string | 规格属性别名 | 必填 | 
 | sysSkuId | long | 系统商品skuID | 必填 | 
 | unit | string | 单位 | 必填 | 
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | hasSupplier | integer | 是否关联供应商 是：1 否：0 | 必填 | 
 | modified | long | 更新时间 | 必填 | 
 | makeGift | boolean | 是否标记为赠品 | 必填 | 
 | barcode | string | 条形码 | 必填 | 
 | skuOuterId | string | 平台规格商家编码 | 必填 | 
 | brand | string | 品牌 | 必填 | 
 | purchasePrice | double | 成本价 | 必填 | 
 | priceOutput | double | 销售价 | 必填 | 
 | x | double | 长 | 必填 | 
 | y | double | 宽 | 必填 | 
 | z | double | 高 | 必填 | 

# subTable: items/sellerCats
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 分类流水id | 必填 | 
 | cid | long | 分类编号 | 必填 | 
 | name | string | 分类名称 | 必填 | 

 

### 响应示例
```
{
  "items": [
    {
      "typeTag": 1,
      "created": "@date",
      "sysItemId": 12345,
      "weight": 10000,
      "shortTitle": "zhangsan",
      "title": "zhangsan",
      "type": "zhangsan",
      "isSkuItem": 1,
      "picPath": "zhangsan",
      "catId": "zhangsan",
      "unit": "zhangsan",
      "activeStatus": 1,
      "hasSupplier": 1,
      "modified": "@date",
      "outerId": "zhangsan",
      "makeGift": true,
      "isVirtual": 1,
      "skus": [
        {
          "created": "@date",
          "sysItemId": 12345,
          "skuPicPath": "zhangsan",
          "weight": 10000,
          "shortTitle": "zhangsan",
          "propertiesName": "zhangsan",
          "propertiesAlias": "zhangsan",
          "sysSkuId": 12345,
          "unit": "zhangsan",
          "activeStatus": 1,
          "hasSupplier": 1,
          "modified": "@date",
          "makeGift": true,
          "barcode": "zhangsan",
          "skuOuterId": "zhangsan"
        }
      ],
      "barcode": "zhangsan"
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20111|系统主商品ID最多支持20组！|请减少查询的数量，最多支持20组！|
|20105|系统主商品ID与平台商家编码，必须二选一！|系统主商品ID与平台商家编码，必须二选一！|
|20112|平台商家编码最多支持20组！|请减少查询的数量，最多支持20组！|
|20113|系统主商品ID信息不正确！|请检查系统主商品ID信息是否规范|
|20103|查询商品列表有误|请根据返回错误信息进行处理|

---

## 查询商品关联供应商信息V1.0

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%85%B3%E8%81%94%E4%BE%9B%E5%BA%94%E5%95%86%E4%BF%A1%E6%81%AFV1.0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/2000-%E5%95%86%E5%93%81V1.0%E7%89%88%E6%9C%AC/50-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%85%B3%E8%81%94%E4%BE%9B%E5%BA%94%E5%95%86%E4%BF%A1%E6%81%AFV1.0.md

# 查询商品关联供应商信息V1.0

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品档案】----【设置关联供应商信息】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|正式环境| https://gw.kuaimai.com/router |
|测试环境| https://pubgwerp.superboss.cc/router|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.supplier.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemIds | string | 系统主商品ID,多个用逗号隔开(最多支持20个) | 必填 | 
 | sysSkuIds | string | 系统商品skuId,多个用逗号隔开(最多支持20个) |  | 

 

### 请求示例
示例一：

````
{
  "sysItemIds": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | trace_id | string | 流水id | 必填 | 
 | suppliers | array | 供应商数据列表 | 必填 | 
 | success | boolean | true-成功，false-失败 | 必填 | 

# subTable: suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | caigouUrl | string | 采购链接 | 必填 | 
 | discountRate | double | 折扣率（不大于100不小于0的数字）示例 98.88 | 必填 | 
 | returnRate | double | 退货率或采退率 （不大于100不小于0的数字）示例 6.67 | 必填 | 
 | supplierId | long | 供应商ID | 必填 | 
 | supplierItemOuterId | string | 供应的商品商商家编码 | 必填 | 
 | created | long | 创建时间 | 必填 | 
 | sysItemId | long | 系统主商品ID | 必填 | 
 | supplierCode | string | 供应商编码 | 必填 | 
 | sysSkuId | long | 系统商品skuId ( 当不是sku的时候，为 0 ) | 必填 | 
 | modified | long | 更新时间 | 必填 | 
 | supplierItemTitle | string | 供应商商品名称 | 必填 | 
 | supplierPurchasePrice | double | 供应商报价信息（进价） 示例 98.88 | 必填 | 

 

### 响应示例
```
{
  "suppliers": [
    {
      "supplierName": "zhangsan",
      "caigouUrl": "zhangsan",
      "discountRate": 10000,
      "returnRate": 10000,
      "supplierId": 12345,
      "supplierItemOuterId": "zhangsan",
      "created": "@date",
      "sysItemId": 12345,
      "supplierCode": "zhangsan",
      "sysSkuId": 12345,
      "modified": "@date",
      "supplierItemTitle": "zhangsan",
      "supplierPurchasePrice": 10000
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.supplier.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20519|系统主商品ID与系统商品skuId不能同时为空，必须二选一！|请检查系统主商品ID与系统商品skuId是否都为空|
|20520|系统主商品ID传值不规范|请检查系统主商品ID传多个值是否以逗号隔开|
|20521|系统主商品ID最多支持20组！|请检查系统主商品ID是否超过了20组|
|20522|系统商品skuId传值不规范|请检查系统商品skuId传多个值是否以逗号隔开|
|20523|系统商品skuId最多支持20组！|请检查系统商品skuId是否超过了20组|
|20524|入参不能为空，必须四选一！|请检查四个参数是否其中一个有值|
|20525|查询商品关联供应商有误|请根据返回的错误信息进行处理|

---

## 新增商品类目

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%96%B0%E5%A2%9E%E5%95%86%E5%93%81%E7%B1%BB%E7%9B%AE
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/250-%E6%96%B0%E5%A2%9E%E5%95%86%E5%93%81%E7%B1%BB%E7%9B%AE.md

# 新增商品类目

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品类目】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.classify.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | classifyList | list | 类目列表 | 必填 | 

# subTable: classifyList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | name | string | 根类目名称 | 必填 | 
 | firstName | string | 一级类目名称 |  | 
 | secondName | string | 二级类目名称 |  | 
 | thirdName | string | 三级类目名称 |  | 

 

### 请求示例
示例一：

```` 
{
    "classifyList":
    [
        {
            "name": "运动健身",
            "firstName": "服装",
            "secondName": "背心",
            "thirdName": "健身背心"
        }
    ]
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 

 

### 响应示例
```
{
    "traceId": "2497465701327441942",
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询商品类目信息

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E7%B1%BB%E7%9B%AE%E4%BF%A1%E6%81%AF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/300-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E7%B1%BB%E7%9B%AE%E4%BF%A1%E6%81%AF.md

# 查询商品类目信息

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品类目】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.classify.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 

 

### 请求示例

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | classifies | array | 数据字典 | 必填 | 

# subTable: classifies
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | created | long | 建档时间 | 必填 | 
 | name | string | 类目名称 | 必填 | 
 | modified | long | 修改时间 | 必填 | 
 | id | long | 类目ID | 必填 | 
 | parentId | long | 父级类目节点ID | 必填 | 

 

### 响应示例
```
{
  "classifies": [
    {
      "created": "@date",
      "name": "zhangsan",
      "modified": "@date",
      "id": 12345,
      "parentId": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.classify.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20101|查询类目列表有误|请根据返回错误信息进行处理|

---

## 新增/修改商品品牌

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%96%B0%E5%A2%9E%E4%BF%AE%E6%94%B9%E5%95%86%E5%93%81%E5%93%81%E7%89%8C
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/350-%E6%96%B0%E5%A2%9E%E4%BF%AE%E6%94%B9%E5%95%86%E5%93%81%E5%93%81%E7%89%8C.md

# 新增/修改商品品牌

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品品牌】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.brand.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | brandName | string | 品牌名称 | 必填 | 
 | id | long | 品牌ID（修改时必填） |  | 

 

### 请求示例
示例一：

```` 
{
  "brandName":"string",
  "id":1
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 品牌ID | 必填 | 

 

### 响应示例
```
{
    "traceId": "2497567962320056324",
    "success": true,
    "id": 5030208
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询商品品牌信息

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%93%81%E7%89%8C%E4%BF%A1%E6%81%AF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/400-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%93%81%E7%89%8C%E4%BF%A1%E6%81%AF.md

# 查询商品品牌信息

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品品牌】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | brand.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | pageNo | integer | 页码 取值范围:大于零的整数。 |  | 1 | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200； |  | 40 | 

 

### 请求示例
示例一：

```
{
  "pageNo":1,
  "pageSize":10
}
```
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | items | array | 数据字典 | 必填 | 
 | total | long | 返回总数 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | brandId | long | 品牌ID | 必填 | 
 | brandName | string | 品牌名称 | 必填 | 
 | created | long | 品牌创建时间 | 必填 | 
 | modified | long | 品牌修改时间 | 必填 | 

 

### 响应示例
```
{
  "traceId": "1871260094457119864",
  "total": 1,
  "success": true,
  "items": [
    {
      "brandName": "测试",
      "created": 1665198251000,
      "brandId": 498117188973056,
      "modified": 1665198251000
    }
  ]
}
```
### 异常示例
```
{
    "code": "25",
    "msg": "服务方法(brand.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20001|页码为空或不符合规定|页码的值不能为空，且不能小于1|
|20002|页数为空或不符合规定|页数的值不能为空，且不能小于1或超过200|
|20102|查询品牌列表有误|请根据返回错误信息进行处理|

---

## 商品对应关系查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81%E5%AF%B9%E5%BA%94%E5%85%B3%E7%B3%BB%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/450-%E5%95%86%E5%93%81%E5%AF%B9%E5%BA%94%E5%85%B3%E7%B3%BB%E6%9F%A5%E8%AF%A2.md

# 商品对应关系查询

**请求方法:** POST

### 接口描述
根据平台商品id（最小粒度）查询系统商家编码、根据系统商家编码查平台商品信息

### 系统相关界面
“界面路径：【商品】----【商品对应表】”
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.outerid.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerIds | string | 系统商家编码（最小粒度）,多个用逗号隔开（与numIidList二选一必填） |  | 
 | numIidList | string | 平台商品id或者skuId（如果是规格商品这里传平台规格Id，如果是纯商品这里就是平台商品id）,多个用逗号隔开（与outerIds二选一必填） |  |
 | userId | long | 店铺编码（若选择平台商品id，则与平台店铺id二选一必填） |  | 
 | taobaoId | long | 平台店铺id（若选择平台商品id，则与店铺编码二选一必填） |  | 

 

### 请求示例
示例一：

```` 
{
  "taobaoId":long,
  "numIidList":"string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemOuterIdInfos | array | 平台商品id与商家编码的对应信息列表 |  | 
 | userId | long | 店铺编码 | 必填 | 
 | taobaoId | long | 平台店铺id | 必填 | 

# subTable: itemOuterIdInfos
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | numIid | string | 平台商品id | 必填 | 
 | outerId | string | 系统商家编码（numIid与skuId的商家编码参数名均为outerId） | 必填 | 
 | tbItemList | array | 平台商品信息列表 | 必填 | 

# subTable: itemOuterIdInfos/tbItemList
 | 参数名         | 类型 | 描述 | 必填 | 
 |-------------| --- | --- | --- | 
 | numIid      | string | 平台商品id | 必填 | 
 | outerId     | string | 平台商家编码 | 必填 | 
 | skuId       | string | 平台规格id | 必填 | 
 | skuOuterId  | string | 平台规格商家编码 | 必填 | 
 | taobaoId    | long | 平台店铺id | 必填 | 
 | userId      | long | 店铺编码 | 必填 | 
 | listTime    | long  | 上架时间 | 必填 | 
 | platformUrl | string | 平台链接 | 必填 | 
 | picUrl      | string | 商品图片 | 必填 | 
 | title           | string | 平台商品名称 | 必填 | 

 

### 响应示例
```
{
    "itemOuterIdInfos": [
        {
        "numIid": "string",
        "outerId": "string"
        }
    ],
    "userId": long,
    "taobaoId": long,
    "success": boolean,
    "trace_id": long
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20146|店铺编码和平台店铺ID不能都为空|请检查店铺编码和平台店铺ID是否都为空|
|20147|店铺编码或平台店铺ID不存在！|请检查店铺编码或平台店铺ID是否准确|
|20148|店铺类型不支持！|请检查店铺类型是否不是自建或系统类型|
|20150|查询系统商家编码有误|请根据返回的错误信息进行处理|

---

## 商品对应关系查询（按商品ID）

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81%E5%AF%B9%E5%BA%94%E5%85%B3%E7%B3%BB%E6%9F%A5%E8%AF%A2%EF%BC%88%E6%8C%89%E5%95%86%E5%93%81ID%EF%BC%89
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/455-%E5%95%86%E5%93%81%E5%AF%B9%E5%BA%94%E5%85%B3%E7%B3%BB%E6%9F%A5%E8%AF%A2%EF%BC%88%E6%8C%89%E5%95%86%E5%93%81ID%EF%BC%89.md

# 商品对应关系查询（按商品ID）

**请求方法:** POST

### 接口描述
根据平台商品ID查询该商品下所有SKU的对应关系。适用于抖店等导出数据只有商品ID没有SKU ID的场景。

**注意**：一个平台商品ID可能对应多个ERP商品，每个ERP商品返回一条独立记录。

### 系统相关界面
"界面路径：【商品】----【商品对应表】"

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**

### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | Content-Type | string | multipart/form-data | 必填 |

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method | string | erp.item.outerid.list.byitem.get | 必填 |

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | numIidList | string | 平台商品id，多个用逗号隔开 | 必填 |
 | userId | long | 店铺编码（与平台店铺id二选一必填） | 必填 |
 | taobaoId | long | 平台店铺id（与店铺编码二选一必填） | 必填 |

### 请求示例
```json
{
  "taobaoId": 123456789,
  "numIidList": "1001,1002,1003"
}
```

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | itemOuterIdInfos | array | 平台商品id与商家编码的对应信息列表 | 必填 |
 | userId | long | 店铺编码 | 必填 |
 | taobaoId | long | 平台店铺id | 必填 |

# subTable: itemOuterIdInfos
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | numIid | string | 平台商品id | 必填 |
 | outerId | string | 系统商家编码（有SKU时返回SKU的商家编码，否则返回商品的商家编码） | 必填 |

### 响应示例
```json
{
    "itemOuterIdInfos": [
        {
            "numIid": "1001",
            "outerId": "ERP001"
        },
        {
            "numIid": "1001",
            "outerId": "ERP002"
        },
        {
            "numIid": "1002",
            "outerId": "ERP003"
        }
    ],
    "userId": 123456,
    "taobaoId": 123456789,
    "success": true,
    "trace_id": "3553483395423660"
}
```

**说明**：上述示例中，平台商品ID "1001" 对应了两个ERP商品（ERP001和ERP002），因此返回了两条记录。

### 异常示例
```json
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```

### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20146|店铺编码和平台店铺ID不能都为空|请检查店铺编码和平台店铺ID是否都为空|
|20147|店铺编码或平台店铺ID不存在！|请检查店铺编码或平台店铺ID是否准确|
|20148|店铺类型不支持！|请检查店铺类型是否不是自建或系统类型|
|20150|查询系统商家编码有误|请根据返回的错误信息进行处理|

### 与原接口的区别

| 特性 | erp.item.outerid.list.get | erp.item.outerid.list.byitem.get (新接口) |
|------|---------------------------|-------------------------------------------|
| 接口用途 | 查询平台商品（最小粒度）与ERP商品的对应关系 | 根据平台商品ID查询所有SKU的对应关系 |
| 输入 | 平台商品ID（最小粒度）或系统商家编码 | 平台商品ID（可为商品级，非最小粒度） |
| 输出 | 一对一映射 | 一对多映射（一个商品可对应多个ERP商品） |
| 适用场景 | 有精确SKU ID的场景 | 只有商品ID没有SKU ID的场景（如抖店导出） |

---

## 查询商品标签

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E6%A0%87%E7%AD%BE
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/50-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E6%A0%87%E7%AD%BE.md

# 查询商品标签

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.tag.list | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | name | string | 标签名称 |  | 

 

### 请求示例
示例一：

```` 
{
  "name":"冬季"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | object | 数据字典 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | id | 必填 | 
 | name | string | 名称 | 必填 | 
 | style | int | 样式类型：1-灰底黑字(默认), 2-绿底黑字 3-粉底黑字 4-紫底白字 5-蓝底白字 6-红底白字 | 必填 | 

 

### 响应示例
```
{
    "list": [
        {
            "name": "免拣商品",
            "style": 7,
            "id": 1000000004
        },
        {
            "name": "印花加工",
            "style": 7,
            "id": 1000000000
        }
    ],
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询商品关联供应商信息V2

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%85%B3%E8%81%94%E4%BE%9B%E5%BA%94%E5%95%86%E4%BF%A1%E6%81%AFV2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/500-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%85%B3%E8%81%94%E4%BE%9B%E5%BA%94%E5%95%86%E4%BF%A1%E6%81%AFV2.md

# 查询商品关联供应商信息V2

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品档案V2】----【关联供应商】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.supplier.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemIds | string | 系统主商品ID,多个用逗号隔开(最多支持20个)（参数必须四选一） |  | 
 | sysSkuIds | string | 系统商品skuId,多个用逗号隔开(最多支持20个) |  | 
 | outerIds | string | 平台商家编码,多个用逗号隔开(最多支持20个) |  | 
 | skuOuterIds | string | 平台规格商家编码,多个用逗号隔开(最多支持20个) |  | 

 

### 请求示例
示例一：

````
{
  "sysItemIds": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | trace_id | string | 流水id | 必填 | 
 | suppliers | array | 供应商数据列表 | 必填 | 
 | success | boolean | true-成功，false-失败 | 必填 | 

# subTable: suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | caigouUrl | string | 采购链接 | 必填 | 
 | discountRate | double | 折扣率（不大于100不小于0的数字）示例 98.88 | 必填 | 
 | returnRate | double | 退货率或采退率 （不大于100不小于0的数字）示例 6.67 | 必填 | 
 | supplierId | long | 供应商ID | 必填 | 
 | supplierItemOuterId | string | 供应的商品商商家编码 | 必填 | 
 | created | long | 创建时间 | 必填 | 
 | sysItemId | long | 商品ID | 必填 | 
 | supplierCode | string | 供应商编码 | 必填 | 
 | sysSkuId | long | 规格商品的ID ( 当不是sku的时候，为 0 ) | 必填 | 
 | modified | long | 更新时间 | 必填 | 
 | supplierItemTitle | string | 供应商商品名称 | 必填 | 
 | supplierPurchasePrice | double | 供应商报价信息（进价） 示例 98.88 | 必填 | 

 

### 响应示例
```
{
  "suppliers": [
    {
      "supplierName": "zhangsan",
      "caigouUrl": "zhangsan",
      "discountRate": 10000,
      "returnRate": 10000,
      "supplierId": 12345,
      "supplierItemOuterId": "zhangsan",
      "created": "@date",
      "sysItemId": 12345,
      "supplierCode": "zhangsan",
      "sysSkuId": 12345,
      "modified": "@date",
      "supplierItemTitle": "zhangsan",
      "supplierPurchasePrice": 10000
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.supplier.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20519|系统主商品ID与系统商品skuId不能同时为空，必须二选一！|请检查系统主商品ID与系统商品skuId是否都为空|
|20520|系统主商品ID传值不规范|请检查系统主商品ID传多个值是否以逗号隔开|
|20521|系统主商品ID最多支持20组！|请检查系统主商品ID是否超过了20组|
|20522|系统商品skuId传值不规范|请检查系统商品skuId传多个值是否以逗号隔开|
|20523|系统商品skuId最多支持20组！|请检查系统商品skuId是否超过了20组|
|20525|查询商品关联供应商有误|请根据返回的错误信息进行处理|

---

## 商品关联供应商信息更新V2

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%95%86%E5%93%81%E5%85%B3%E8%81%94%E4%BE%9B%E5%BA%94%E5%95%86%E4%BF%A1%E6%81%AF%E6%9B%B4%E6%96%B0V2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/550-%E5%95%86%E5%93%81%E5%85%B3%E8%81%94%E4%BE%9B%E5%BA%94%E5%95%86%E4%BF%A1%E6%81%AF%E6%9B%B4%E6%96%B0V2.md

# 商品关联供应商信息更新V2

**请求方法:** POST

### 系统相关界面
"界面路径：【商品】----【商品档案V2】----【关联供应商】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.supplier.relevance | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemId | long | 平台主商品ID（与平台商家编码二选一） |  | 
 | outerId | string | 平台商家编码（与平台主商品ID二选一） |  | 
 | skuOuterId | string | 平台规格商家编码 |  | 
 | skuId | long | 平台skuID |  | 
 | suppliers | array | 供应商信息列表 |  | 

# subTable: suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 供应商ID |  | 
 | code | string | 供应商编码 | 必填 | 
 | itemTitle | string | 供应商商品名称 |  | 
 | itemOuterId | string | 供应商的商品商家编码 |  | 
 | supplierPurchasePrice | double | 供应商报价信息（进价）（不大于9999999.99不小于0的数字） 示例 98.88 |  | 
 | discountRate | double | 折扣率（不大于100不小于等于0的数字）示例 98.88 |  | 
 | returnRate | double | 退货率或采退率 （不大于100不小于等于0的数字）示例 6.67 |  | 
 | caigouUrl | string | 采购链接 |  | 

 

### 请求示例
示例一：

````
{
  "itemId": long,
  "skus": [
    {
      "id": long,
      "discountRate": double
    }
  ]
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 流水id | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.supplier.relevance:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20501|平台主商品ID与平台商家编码不能同时为空，必须二选一！|请检查平台主商品ID与平台商家编码是否都为空|
|20502|平台主商品ID不能小于等于0！|请检查平台主商品ID是否小于等于0|
|20503|供应商信息不能为空|请检查供应商信息suppliers字段是否有值|
|20504|供应商信息不能超过1000组，请分批次处理|请检查供应商信息是否超过1000组，超过请分批次处理|
|20505|供应商编码与供应商ID不能同时为空|请检查供应商编码与供应商ID是否都为空|
|20506|供应商编码不能为空|请检查供应商编码是否为空|
|20507|供应商编码重复|请重新填写供应商编码|
|20508|供应商ID不能为空或小于等于0|请检查供应商ID是否为空或小于等于0|
|20509|供应商ID重复|请重新填写供应商ID|
|20510|供应商商品编码过长，不能超过64个字符|请检查供应商商品编码是否超过64个字符|
|20511|供应商商品标题过长，不能超过64个字符|请检查供应商商品标题是否超过64个字符|
|20512|供应商采购链接过长，不能超过1024个字符|请检查供应商采购链接是否超过1024个字符|
|20513|供应商报价信息（进价）不正确，不能小于0且大于等于9999999.99|请检查供应商报价信息（进价）是否小于0且大于等于9999999.99|
|20514|供应商采购折扣率不正确|供应商采购折扣率不能小于等于0，或者大于100|
|20515|供应商采购退货率不正确|供应商采购退货率不能小于等于0，或者大于100|
|20516|供应商信息有误|请检查供应商信息参数是否规范|

---

## 添加商品供应商关系V2

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%B7%BB%E5%8A%A0%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/600-%E6%B7%BB%E5%8A%A0%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV2.md

# 添加商品供应商关系V2

**请求方法:** POST

### 系统相关界面
界面路径：【商品】----【商品档案V2】----【关联供应商】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.supplier.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemId | long | 平台主商品ID（与平台商家编码二选一） |  | 
 | outerId | string | 平台商家编码（与平台主商品ID二选一） |  | 
 | skuOuterId | string | 平台规格商家编码 |  | 
 | skuId | long | 规格商品ID |  | 
 | suppliers | array | 供应商信息列表 |  | 

# subTable: suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | caigouUrl | string | 采购链接 |  | 
 | discountRate | double | 折扣率（不大于100不小于等于0的数字）示例 98.88 |  | 
 | returnRate | double | 退货率或采退率 （不大于100不小于等于0的数字）示例 6.67 |  | 
 | code | string | 供应商编码 | 必填 | 
 | itemTitle | string | 供应商商品名称 |  | 
 | itemOuterId | string | 供应商的商品商家编码 |  | 
 | id | long | 供应商ID |  | 
 | supplierPurchasePrice | double | 供应商报价信息（进价）（不大于9999999.99不小于0的数字）  示例 98.88 |  | 

 

### 请求示例
示例一：

````
{
  "itemId": long,
  "suppliers": [
    {
      "id": long,
      "discountRate": double
    }
  ]
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 流水id | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.supplier.add:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20501|平台主商品ID与平台商家编码不能同时为空，必须二选一！|请检查平台主商品ID与平台商家编码是否都为空|
|20502|平台主商品ID不能小于等于0！|请检查平台主商品ID是否小于等于0|
|20503|供应商信息不能为空|请检查供应商信息suppliers字段是否有值|
|20504|供应商信息不能超过1000组，请分批次处理|请检查供应商信息是否超过1000组，超过请分批次处理|
|20505|供应商编码与供应商ID不能同时为空|请检查供应商编码与供应商ID是否都为空|
|20506|供应商编码不能为空|请检查供应商编码是否为空|
|20507|供应商编码重复|请重新填写供应商编码|
|20508|供应商ID不能为空或小于等于0|请检查供应商ID是否为空或小于等于0|
|20509|供应商ID重复|请重新填写供应商ID|
|20510|供应商商品编码过长，不能超过64个字符|请检查供应商商品编码是否超过64个字符|
|20511|供应商商品标题过长，不能超过64个字符|请检查供应商商品标题是否超过64个字符|
|20512|供应商采购链接过长，不能超过1024个字符|请检查供应商采购链接是否超过1024个字符|
|20513|供应商报价信息（进价）不正确，不能小于0且大于等于9999999.99|请检查供应商报价信息（进价）是否小于0且大于等于9999999.99|
|20514|供应商采购折扣率不正确|供应商采购折扣率不能小于等于0，或者大于100|
|20515|供应商采购退货率不正确|供应商采购退货率不能小于等于0，或者大于100|
|20516|供应商信息有误|请检查供应商信息参数是否规范|

---

## 修改商品供应商关系V2

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E4%BF%AE%E6%94%B9%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/650-%E4%BF%AE%E6%94%B9%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV2.md

# 修改商品供应商关系V2

**请求方法:** POST

### 系统相关界面
界面路径：【商品】----【商品档案V2】----【关联供应商】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.supplier.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemId | long | 平台主商品ID（与平台商家编码二选一） |  | 
 | outerId | string | 平台商家编码（与平台主商品ID二选一） |  | 
 | skuOuterId | string | 平台规格商家编码 |  | 
 | skuId | long | 平台skuID |  | 
 | suppliers | array | 供应商信息列表 |  | 

# subTable: suppliers
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | caigouUrl | string | 采购链接 |  | 
 | discountRate | double | 折扣率（不大于100不小于等于0的数字）示例 98.88 |  | 
 | returnRate | double | 退货率或采退率 （不大于100不小于等于0的数字）示例 6.67 |  | 
 | code | string | 供应商编码 （和  ID 二选一，ID优先） |  | 
 | itemTitle | string | 供应商商品名称 |  | 
 | itemOuterId | string | 供应商的商品商家编码 |  | 
 | id | long | 供应商ID |  | 
 | supplierPurchasePrice | double | 供应商报价信息（进价）（不大于9999999.99不小于0的数字） 示例 98.88  |  | 

 

### 请求示例
示例一：

````
{
  "itemId": long,
  "suppliers": [
    {
      "id": long,
      "discountRate": double
    }
  ]
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 流水id | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.supplier.update:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20501|平台主商品ID与平台商家编码不能同时为空，必须二选一！|请检查平台主商品ID与平台商家编码是否都为空|
|20502|平台主商品ID不能小于等于0！|请检查平台主商品ID是否小于等于0|
|20503|供应商信息不能为空|请检查供应商信息suppliers字段是否有值|
|20504|供应商信息不能超过1000组，请分批次处理|请检查供应商信息是否超过1000组，超过请分批次处理|
|20505|供应商编码与供应商ID不能同时为空|请检查供应商编码与供应商ID是否都为空|
|20506|供应商编码不能为空|请检查供应商编码是否为空|
|20507|供应商编码重复|请重新填写供应商编码|
|20508|供应商ID不能为空或小于等于0|请检查供应商ID是否为空或小于等于0|
|20509|供应商ID重复|请重新填写供应商ID|
|20510|供应商商品编码过长，不能超过64个字符|请检查供应商商品编码是否超过64个字符|
|20511|供应商商品标题过长，不能超过64个字符|请检查供应商商品标题是否超过64个字符|
|20512|供应商采购链接过长，不能超过1024个字符|请检查供应商采购链接是否超过1024个字符|
|20513|供应商报价信息（进价）不正确，不能小于0且大于等于9999999.99|请检查供应商报价信息（进价）是否小于0且大于等于9999999.99|
|20514|供应商采购折扣率不正确|供应商采购折扣率不能小于等于0，或者大于100|
|20515|供应商采购退货率不正确|供应商采购退货率不能小于等于0，或者大于100|
|20516|供应商信息有误|请检查供应商信息参数是否规范|

---

## 删除商品供应商关系V2

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E5%88%A0%E9%99%A4%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/700-%E5%88%A0%E9%99%A4%E5%95%86%E5%93%81%E4%BE%9B%E5%BA%94%E5%95%86%E5%85%B3%E7%B3%BBV2.md

# 删除商品供应商关系V2

**请求方法:** POST

### 系统相关界面
界面路径：【商品】----【商品档案V2】----【关联供应商】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.supplier.delete | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemId | long | 平台主商品的ID（与平台商家编码二选一） |  | 
 | outerId | string | 商家编码，企业数据全局唯一 （和商品ID、规格ID，二选一 |  | 
 | supplierIds | string | 供应商ID（与供应商编码 二选一，ID优先），举例：\[long,long\] |  | 
 | supplierCodes | string | 供应商编码 （与供应商ID 二选一，ID优先），举例：\[string,string\] |  | 
 | skuOuterId | string | 规格商家编码 |  | 
 | skuId | long | 规格商品ID |  | 

 

### 请求示例
示例一：

````
{
  "itemId": long,
  "supplierCodes": "string,string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | trace_id | string | 流水id | 必填 | 
 | success | boolean | true-成功，false-失败 | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.supplier.delete:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20501|平台主商品ID与平台商家编码不能同时为空，必须二选一！|请检查平台主商品ID与平台商家编码是否都为空|
|20502|平台主商品ID不能小于等于0！|请检查平台主商品ID是否小于等于0|
|20505|供应商编码与供应商ID不能同时为空|请检查供应商编码与供应商ID是否都为空|
|20506|供应商编码不能为空|请检查供应商编码是否为空|
|20508|供应商ID不能为空或小于等于0|请检查供应商ID是否为空或小于等于0|
|20516|供应商信息有误|请检查供应商信息参数是否规范|
|20517|供应商ID至少要有一组|请检查供应商ID字段是否有值|
|20518|供应商编码至少要有一组|请检查供应商编码字段是否有值|

---

## 查询商品列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/750-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81%E5%88%97%E8%A1%A8.md

# 查询商品列表

**请求方法:** POST

### 接口描述
查询商品列表，支持获取商品列表，包括普通商品，套件商品、组合商品、加工商品

### 系统相关界面
"界面路径：【商品】----【商品档案】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 |  |  | 
 | startModified | string | 起始的修改时间 , 示例：2000-01-01 00:00:00 |  |  | 
 | endModified | string | 结束的修改时间, 示例：2000-01-01 00:00:00 |  |  | 
 | pageNo | integer | 页码 取值范围:大于零的整数 |  | 1 | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200； |  | 40 | 
 | type | integer | 商品类型 0-普通商品（含组合、加工商品）且不是虚拟商品 1-套件（含纯套件、sku套件） 3-普通商品（含组合、加工商品）且是虚拟商品 6-仅加工商品 7-普通商品（不含组合、加工商品）且不是虚拟商品 8-非包材商品 9-仅组合商品 10-普通商品（含组合、加工、虚拟商品） |  |  | 
 | orderBy | string | 排序方式 示例 modified:desc ， 选值：modified； |  | created:desc | 
 | whetherReturnPurchase | integer | 是否返回采购链接  0.否   1.是 |  | 0 | 

 

### 请求示例
示例一：

````
{
  "pageNo":integer,
  "pageSize":integer
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | msg | string | 返回消息 | 必填 | 
 | traceId | string | 流水id | 必填 | 
 | total | long | 返回总数 | 必填 | 
 | code | string | 返回码 | 必填 | 
 | solution | string | 解决方案 | 必填 | 
 | body | string | 返回内容 | 必填 | 
 | items | array | 数据列表 | 必填 | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 平台商家编码（主商家编码） | 必填 | 
 | sysItemId | long | 系统主商品ID  | 必填 | 
 | title | string | 商品名称 | 必填 | 
 | shortTitle | string | 商品简称 | 必填 | 
 | barcode | string | 商品条形码 | 必填 | 
 | type | string | 商品类型  0-普通（含虚拟商品，用 isVirtual字段描述|组合装商品） 1-sku套件 2-纯套件 3-包材商品 | 必填 | 
 | typeTag | integer | 基于type下的二级分类 type=0 : 0-正常商品，1-sku加工商品，2-纯加工商品 3-含sku组合装商品 4-不含sku组合装商品 | 必填 | 
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | isVirtual | integer | 是否是虚拟商品，是：1，否：0 | 必填 | 
 | catId | string | 商品类目属性ID | 必填 | 
 | picPath | string | 商品图片URL | 必填 | 
 | purchasePrice | double | 成本价（单位：元），示例：100.99 | 必填 | 
 | priceOutput | double | 销售价（单位：元），示例：100.99 | 必填 | 
 | weight | double | 商品重量（单位：Kg）， 示例：0.05 | 必填 | 
 | hasSupplier | integer | 是否关联供应商 是：1 否：0 | 必填 | 
 | hasProduct | integer | 是否开启生产批次 开启：1 关闭：0 | 必填 | 
 | makeGift | boolean | 是否标记为赠品 | 必填 | 
 | unit | string | 商品单位 ，示例：件、箱 | 必填 | 
 | x | double | 长（单位：cm） ，示例：0.01 | 必填 | 
 | y | double | 宽（单位：cm） ，示例：0.01 | 必填 | 
 | z | double | 高（单位：cm） ，示例：0.01 | 必填 | 
 | listTime | long | 上架日期 | 必填 | 
 | isSkuItem | integer | 是否是含有sku的商品，是：1，否：0 | 必填 | 
 | skus | array | 关联的SKU信息列表 | 必填 | 
 | created | long | 创建时间 | 必填 | 
 | modified | long | 更新时间 | 必填 | 
 | purchaseLinkSkuList | array | 采购链接 | 必填 | 
 | boxnum | int | 箱规 | 必填 | 
 | sellerCats | array | 分类列表 | 必填 | 
 | classify | object | 类目 | 必填 | 
 | brand | string | 商品品牌名称 | 必填 | 
 | standard | string | 执行标准 | 必填 | 
 | safekind | string | 安全类别 | 必填 | 
 | shipper | string | 货主 | 非必填 |
 | marketPrice | double | 市场价（单位：元） | 必填 | 
 | otherPrice1 | double | 其他价格1（单位：元） | 必填 | 
 | otherPrice2 | double | 其他价格2（单位：元） | 必填 | 
 | otherPrice3 | double | 其他价格3（单位：元） | 必填 | 
 | customAttribute | array | 规格自定义属性信息，格式 ：\[\{\"definedValue\":\"1111\",\"definedKey\":\"自定义字段名称\"\}\] | 必填 | 
 | remark | string | 商品备注 | 必填 |
 | itemTagList | array | 商品标签列表 | 必填 |

# subTable: items/skus
 | 参数名 | 类型 | 描述 | 必填  | 
 | --- | --- | --- |-----| 
 | propertiesName | string | 规格真正的属性，以逗号分隔  | 必填  | 
 | skuOuterId | string | 平台规格商家编码 | 必填  | 
 | sysItemId | long | 系统主商品ID  | 必填  | 
 | sysSkuId | long | 系统商品skuID | 必填  | 
 | shortTitle | string | 规格简称 | 必填  | 
 | propertiesAlias | string | 规格别名 | 必填  | 
 | barcode | string | 规格条形码 | 必填  | 
 | weight | double | 重量（单位：Kg），示例：0.05 | 必填  | 
 | purchasePrice | double | 成本价（单位：元），示例：100.99 | 必填  | 
 | priceOutput | double | 销售价（单位：元），示例：100.99 | 必填  | 
 | unit | string | 单位 | 必填  | 
 | skuPicPath | string | sku的图片地址 | 必填  | 
 | hasSupplier | integer | 是否关联供应商 是：1 否：0 | 必填  | 
 | makeGift | boolean | 是否标记为赠品 | 必填  | 
 | activeStatus | integer | 规格的可用状态，0表示停用，1表示启用 | 必填  | 
 | created | long | 创建时间 | 必填  | 
 | modified | long | 更新时间 | 必填  | 
 | x | double | 长（单位：cm） ，示例：0.01 | 必填  | 
 | y | double | 宽（单位：cm） ，示例：0.01 | 必填  | 
 | z | double | 高（单位：cm） ，示例：0.01 | 必填  | 
 | boxnum | int | 箱规 | 必填  | 
 | sellerCats | array |  | 必填  | 
 | classify |  |  | 必填  | 
 | brand | string | 规格品牌名称 | 必填  | 
 | standard | string | 执行标准 | 必填  | 
 | safekind | string | 安全类别 | 必填  | 
 | shipper | string | 货主 | 非必填 |
 | marketPrice | double | 规格市场价（单位：元） | 必填  | 
 | otherPrice1 | double | 规格其他价格1（单位：元） | 必填  | 
 | otherPrice2 | double | 规格其他价格2（单位：元） | 必填  | 
 | otherPrice3 | double | 规格其他价格3（单位：元） | 必填  | 
 | customAttribute | array | 自定义属性信息，格式 ：\[\{\"definedValue\":\"1111\",\"definedKey\":\"自定义字段名称\"\}\] | 必填  | 
 | skuComponent | String  | 规格成分                |  |
 | skuRemark | String    | 规格备注                |  |
 | itemTagList | array | 商品标签列表 | 必填 |

# subTable: items/skus/sellerCats
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | name | string | 分类名称 | 必填 | 
 | cid | long | 分类ID | 必填 | 
 | fullName | string | 分类全路径名称 | 必填 | 
 | parentCid | long | 父级分类ID | 必填 | 

# subTable: items/skus/classify
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 类目ID | 必填 | 
 | name | string | 类目名称 | 必填 | 
 | fullName | string | 类目全路径名称 | 必填 | 
 | parentId | long | 父级类目ID | 必填 | 

# subTable: items/skus/customAttribute
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | definedKey | string | 属性名称 | 必填 | 
 | definedValue | string | 属性值 | 必填 |

# subTable: items/itemTagList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | tagId | long | 商品标签ID | 必填 |
 | tagName | string | 商品标签名称 | 必填 |
 | tagStyle | string | 商品标签样式, 1-蓝底白字, 2-红底白字 3-紫底白字 4-绿底黑字 5-灰底黑字 6-粉底黑字 | 必填 |
 | tagRelationSource | int | 商品标签关系来源, 0-系统打上, 1-快麦, 2-API写入 | 必填 |
 | tagRelationSourceDesc | string | 商品标签关系来源描述 | 必填

 # subTable: items/skus/itemTagList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | tagId | long | 商品标签ID | 必填 |
 | tagName | string | 商品标签名称 | 必填 |
 | tagStyle | string | 商品标签样式, 1-蓝底白字, 2-红底白字 3-紫底白字 4-绿底黑字 5-灰底黑字 6-粉底黑字 | 必填 |
 | tagRelationSource | int | 商品标签关系来源, 0-系统打上, 1-快麦, 2-API写入 | 必填 |
 | tagRelationSourceDesc | string | 商品标签关系来源描述 | 必填

# subTable: items/purchaseLinkSkuList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商品的商家编码 | 必填 | 
 | skuOuterId | string | 规格商家编码 | 必填 | 
 | sysItemId | long | 系统商品编码 | 必填 | 
 | sysSkuId | long | 系统规格ID | 必填 | 
 | purchaseLinkList | list | 采购链接详情列表 | 必填 | 

# subTable: items/purchaseLinkSkuList/purchaseLinkList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | defaultFlag | boolean | 默认标识 | 必填 | 
 | link | string | 链接 | 必填 | 
 | source | string | 来源 | 必填 | 
 | sourceName | string | 来源名称 | 必填 | 

# subTable: items/sellerCats
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 分类id，示例：94385 | 必填 | 
 | cid | long | 分类编码，示例：-1 | 必填 | 
 | name | string | 分类名称 | 必填 | 
 | fullName | string | 分类全路径名称 ，示例： \[\"百货1\",\"服装1\",\"男士服饰1\"\] | 必填 | 

# subTable: items/classify
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 类目ID | 必填 | 
 | name | string | 类目名称 | 必填 | 
 | parentId | long | 父级类目ID | 必填 | 
 | fullName | string | 类目全路径名称，示例：\[\"百货1\",\"服装1\",\"男士服饰1\"\] | 必填 | 

# subTable: items/customAttribute
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | definedKey | string | 属性名称 | 必填 | 
 | definedValue | string | 属性值 | 必填 | 

 

### 响应示例
```
{
  "msg": "zhangsan",
  "traceId": "zhangsan",
  "total": 12345,
  "code": "zhangsan",
  "solution": "zhangsan",
  "subCode": "zhangsan",
  "subMsg": "zhangsan",
  "body": "zhangsan",
  "forbiddenField": "zhangsan",
  "items": [
    {
      "typeTag": 1,
      "created": "zhangsan",
      "sysItemId": 12345,
      "weight": 10000,
      "shortTitle": "zhangsan",
      "title": "zhangsan",
      "type": "zhangsan",
      "isSkuItem": 1,
      "picPath": "zhangsan",
      "catId": "zhangsan",
      "unit": "zhangsan",
      "activeStatus": 1,
      "hasSupplier": 1,
      "modified": "zhangsan",
      "outerId": "zhangsan",
      "makeGift": true,
      "isVirtual": 1,
      "items": [
        {
          "created": "zhangsan",
          "sysItemId": 12345,
          "skuPicPath": "zhangsan",
          "weight": 10000,
          "shortTitle": "zhangsan",
          "propertiesName": "zhangsan",
          "propertiesAlias": "zhangsan",
          "sysSkuId": 12345,
          "unit": "zhangsan",
          "activeStatus": 1,
          "hasSupplier": 1,
          "modified": "zhangsan",
          "makeGift": true,
          "barcode": "zhangsan",
          "skuOuterId": "zhangsan"
        }
      ],
      "barcode": "zhangsan"
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.list.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20001|页码为空或不符合规定|页码的值不能为空，且不能小于1|
|20002|页数为空或不符合规定|页数的值不能为空，且不能小于1或超过200|
|20004|排序方式不正确|排序方式的值不能为空，且只能为desc或asc|
|20109|系统商品状态不正确|请检查系统商品状态是否填写规范，其中 0-表示停用，1-表示启用|
|20103|查询商品列表有误|请根据返回错误信息进行处理|
|50|只能选择[0,1,3,6,7,8,9,10]的其中一位商品类型数值|请检查该参数的值是否规范|

---

## 查询单个商品明细

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%8D%95%E4%B8%AA%E5%95%86%E5%93%81%E6%98%8E%E7%BB%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/800-%E6%9F%A5%E8%AF%A2%E5%8D%95%E4%B8%AA%E5%95%86%E5%93%81%E6%98%8E%E7%BB%86.md

# 查询单个商品明细

**请求方法:** POST

### 接口描述
用于获取单个商品sku信息。支持获取指定主商品下的sku商品信息，包括普通商品，套件商品、组合商品、加工商品

### 系统相关界面
"界面路径：【商品】----【商品档案】----【编辑】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | item.single.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 平台商家编码（同系统主商品ID二选一，优先取系统主商品ID） |  | 
 | sysItemId | long | 系统主商品ID（同平台商家编码二选一，优先取系统主商品ID） |  | 
 | whetherReturnPurchase | integer | 是否返回采购链接，0.否 1.是，默认不返回 |  | 

 

### 请求示例
示例一：

````
{
  "outerId":"string"
}
````
示例二：

````
{
  "sysItemId":long
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | item | object | 数据字典 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

# subTable: item
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemId | long | 系统主商品ID | 必填 | 
 | shortTitle | string | 商品简称 | 必填 | 
 | weight | double | 重量，单位kg | 必填 | 
 | barcode | string | 条形码 | 必填 | 
 | picPath | string | 商品图片URL | 必填 | 
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | customAttribute | array | 自定义属性信息，格式：[\{"definedValue":"1111","definedKey":"自定义字段名称"\}] | 必填 | 
 | marketPrice | double | 市场价格 | 必填 | 
 | otherPrice1 | double | 其他价格1 | 必填 | 
 | otherPrice2 | double | 其他价格2 | 必填 | 
 | otherPrice3 | double | 其他价格3 | 必填 | 
 | otherPrice4 | double | 其他价格4 | 必填 | 
 | otherPrice5 | double | 其他价格5 | 必填 | 
 | title | string | 商品标题 | 必填 | 
 | outerId | string | 平台商家编码 | 必填 | 
 | type | string | 商品类型 0-普通（含虚拟商品，用 isVirtual字段描述|组合装商品） 1-sku套件 2-纯套件 3-包材商品 | 必填 | 
 | typeTag | integer | 基于type下的二级分类 type=0 : 0-正常商品，1-sku加工商品，2-纯加工商品 3-含sku组合装商品 4-不含sku组合装商品 | 必填 | 
 | catId | string | 商品类目 | 必填 | 
 | classify | object | 类目 | 必填 | 
 | unit | string | 单位 | 必填 | 
 | isSkuItem | integer | 是否是含有sku的商品，是：1，否：0 | 必填 | 
 | isVirtual | integer | 是否是虚拟商品，是：1，否：0 | 必填 | 
 | hasSupplier | integer | 是否关联供应商 是：1 否：0 | 必填 | 
 | hasProduct | integer | 是否开启生产批次 开启：1 关闭：0 | 必填 | 
 | openProductionDate | integer | 是否开启生产日期管理 开启：1 关闭：0 | 必填 | 
 | makeGift | boolean | 是否标记为赠品，true：标记 false：未标记 | 必填 | 
 | brand | string | 商品品牌名称 | 必填 | 
 | created | long | 创建时间 | 必填 | 
 | modified | long | 更新时间 | 必填 | 
 | skus | array | 关联的SKU信息 | 必填 | 
 | remark | string | 商品备注 | 必填 | 
 | standard | string | 执行标准 | 必填 | 
 | safekind | string | 安全类别 | 必填 | 
 | shipper | string | 货主 |  |
 | component | string | 成份 |  |
 | sellerCids | string | 分类编码，多个以逗号隔开 | 必填 | 
 | sellerCats | array | 分类列表 | 必填 | 
 | purchasePrice | double | 成本价 | 必填 | 
 | priceOutput | double | 销售价 | 必填 | 
 | x | double | 长 | 必填 | 
 | y | double | 宽 | 必填 | 
 | z | double | 高 | 必填 | 
 | volume | double | 体积 | 必填 | 
 | purchaseLinkSkuList | array | 采购链接 | 必填 | 
 | listTime | long | 上架日期 | 必填 | 
 | boxnum | int | 箱规 | 必填 | 
 | record | string | 商品记录 | 必填 |
 | place | string | 产地 | 必填 |
 | suitSingleList | array | 套件明细 | 必填 | 
 | itemTagList | array | 商品标签列表 | 必填 |

# subTable: item/sellerCats
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 分类id，示例：94385 | 必填 | 
 | cid | long | 分类编码，示例：-1 | 必填 | 
 | parentCid | long | 父级分类编码 | 必填 | 
 | name | string | 分类名称，示例：未分类 | 必填 | 
 | fullName | string | 分类全路径名称，示例：["百货1","服装1","男士服饰1"] | 必填 | 

# subTable: item/purchaseLinkSkuList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码 | 必填 | 
 | skuOuterId | string | 规格商家编码 | 必填 | 
 | sysItemId | long | 系统主商品ID | 必填 | 
 | sysSkuId | long | 系统商品skuId | 必填 | 
 | purchaseLinkList | array | 采购链接详情 | 必填 | 

# subTable: item/purchaseLinkSkuList/purchaseLinkList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | defaultFlag | boolean | 默认标识 | 必填 | 
 | link | string | 链接 | 必填 | 
 | source | string | 来源 | 必填 | 
 | sourceName | string | 来源名称 | 必填 | 

# subTable: item/suitSingleList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 平台商家编码 | 必填 | 
 | title | string | 商品名称 | 必填 | 
 | ratio | int | 组合比例 | 必填 | 
 | skuOuterId | string | 规格商家编码 | 必填 | 
 | propertiesName | string | 规格属性 | 必填 | 

# subTable: item/itemTagList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | tagId | long | 商品标签ID | 必填 |
 | tagName | string | 商品标签名称 | 必填 |
 | tagStyle | string | 商品标签样式, 1-蓝底白字, 2-红底白字 3-紫底白字 4-绿底黑字 5-灰底黑字 6-粉底黑字 | 必填 |
 | tagRelationSource | int | 商品标签关系来源, 0-系统打上, 1-快麦, 2-API写入 | 必填 |
 | tagRelationSourceDesc | string | 商品标签关系来源描述 | 必填 |

# subTable: item/classify
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | id | long | 类目ID | 必填 |
 | name | string | 类目名称 | 必填 |
 | parentId | long | 父级类目ID | 必填 |
 | fullName | string | 类目全路径名称，示例：["百货1","服装1","男士服饰1"] | 必填 |

# subTable: item/customAttribute
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | definedKey | string | 属性名称 | 必填 |
 | definedValue | string | 属性值 | 必填 |

# subTable: item/skus
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | sysItemId | long | 系统主商品ID | 必填 |
 | sysSkuId | long | 系统商品skuID | 必填 |
 | propertiesName | string | 规格真正的属性，以分号分隔 | 必填 |
 | propertiesAlias | string | 规格属性别名 | 必填 |
 | shortTitle | string | 规格简称 | 必填 |
 | itemOuterId | string | 主商品编码 | 必填 |
 | skuOuterId | string | 规格商家编码 | 必填 |
 | barcode | string | 条形码 | 必填 |
 | skuPicPath | string | sku的图片地址 | 必填 |
 | weight | double | 重量，单位kg | 必填 |
 | unit | string | 单位 | 必填 |
 | hasSupplier | integer | 是否关联供应商 是：1 否：0 | 必填 |
 | makeGift | boolean | 是否标记为赠品 | 必填 |
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 | 必填 |
 | brand | string | 品牌 | 必填 |
 | purchasePrice | double | 成本价 | 必填 |
 | priceOutput | double | 销售价 | 必填 |
 | x | double | 长 | 必填 |
 | y | double | 宽 | 必填 |
 | z | double | 高 | 必填 |
 | boxnum | int | 箱规 | 必填 |
 | skuComponent | string | 规格成分 |  |
 | skuRemark | string | 规格备注 |  |
 | suitSingleList | array | 套件明细(仅sku套件商品type=1时返回) |  |
 | itemTagList | array | 商品标签列表 | 必填 |
 | created | long | 创建时间 | 必填 |
 | modified | long | 更新时间 | 必填 |

# subTable: item/skus/suitSingleList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | outerId | string | 平台商家编码 | 必填 |
 | title | string | 商品名称 | 必填 |
 | ratio | int | 组合比例 | 必填 |
 | skuOuterId | string | 规格商家编码 | 必填 |
 | propertiesName | string | 规格属性 | 必填 |

# subTable: item/skus/itemTagList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | tagId | long | 商品标签ID | 必填 |
 | tagName | string | 商品标签名称 | 必填 |
 | tagStyle | string | 商品标签样式, 1-蓝底白字, 2-红底白字 3-紫底白字 4-绿底黑字 5-灰底黑字 6-粉底黑字 | 必填 |
 | tagRelationSource | int | 商品标签关系来源, 0-系统打上, 1-快麦, 2-API写入 | 必填 |
 | tagRelationSourceDesc | string | 商品标签关系来源描述 | 必填 |

 

### 响应示例
```
{
    "item": {
        "sysItemId": 12345,
        "shortTitle": "string",
        "weight": 0.05,
        "barcode": "string",
        "picPath": "string",
        "activeStatus": 1,
        "customAttribute": [
            {
                "definedKey": "自定义字段名称",
                "definedValue": "1111"
            }
        ],
        "marketPrice": 100.00,
        "otherPrice1": 100.00,
        "otherPrice2": 100.00,
        "otherPrice3": 100.00,
        "otherPrice4": 100.00,
        "otherPrice5": 100.00,
        "title": "string",
        "outerId": "string",
        "type": "0",
        "typeTag": 0,
        "catId": "string",
        "classify": {
            "id": 12345,
            "name": "string",
            "parentId": 0,
            "fullName": "[\"类目1\",\"类目2\"]"
        },
        "unit": "件",
        "isSkuItem": 1,
        "isVirtual": 0,
        "hasSupplier": 1,
        "hasProduct": 0,
        "openProductionDate": 0,
        "makeGift": false,
        "brand": "string",
        "created": 1600588800000,
        "modified": 1600588800000,
        "skus": [
            {
                "sysItemId": 12345,
                "sysSkuId": 67890,
                "propertiesName": "颜色:红色;尺码:XL",
                "propertiesAlias": "string",
                "shortTitle": "string",
                "itemOuterId": "string",
                "skuOuterId": "string",
                "barcode": "string",
                "skuPicPath": "string",
                "weight": 0.05,
                "unit": "件",
                "hasSupplier": 1,
                "makeGift": false,
                "activeStatus": 1,
                "brand": "string",
                "purchasePrice": 50.00,
                "priceOutput": 99.99,
                "x": 10.0,
                "y": 5.0,
                "z": 2.0,
                "boxnum": 1,
                "skuComponent": "string",
                "skuRemark": "string",
                "suitSingleList": [
                    {
                        "outerId": "string",
                        "title": "string",
                        "ratio": 1,
                        "skuOuterId": "string",
                        "propertiesName": "string"
                    }
                ],
                "itemTagList": [
                    {
                        "tagId": 1,
                        "tagName": "标签名称",
                        "tagStyle": "1",
                        "tagRelationSource": 0,
                        "tagRelationSourceDesc": "系统打上"
                    }
                ],
                "created": 1600588800000,
                "modified": 1600588800000
            }
        ],
        "remark": "string",
        "standard": "string",
        "safekind": "string",
        "shipper": "string",
        "component": "string",
        "sellerCids": "-1,94385",
        "sellerCats": [
            {
                "id": 94385,
                "cid": -1,
                "parentCid": 0,
                "name": "未分类",
                "fullName": "[\"未分类\"]"
            }
        ],
        "purchasePrice": 50.00,
        "priceOutput": 99.99,
        "x": 10.0,
        "y": 5.0,
        "z": 2.0,
        "volume": 100.0,
        "purchaseLinkSkuList": [
            {
                "outerId": "string",
                "skuOuterId": "string",
                "sysItemId": 12345,
                "sysSkuId": 67890,
                "purchaseLinkList": [
                    {
                        "defaultFlag": true,
                        "link": "string",
                        "source": "string",
                        "sourceName": "string"
                    }
                ]
            }
        ],
        "listTime": 1600588800000,
        "boxnum": 10,
        "record": "string",
        "place": "string",
        "suitSingleList": [
            {
                "outerId": "string",
                "title": "string",
                "ratio": 1,
                "skuOuterId": "string",
                "propertiesName": "string"
            }
        ],
        "itemTagList": [
            {
                "tagId": 1,
                "tagName": "标签名称",
                "tagStyle": "1",
                "tagRelationSource": 0,
                "tagRelationSourceDesc": "系统打上"
            }
        ]
    },
    "success": true,
    "trace_id": "3553483395407017"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20105|系统主商品ID与平台商家编码，必须二选一！|系统主商品ID与平台商家编码，必须二选一！|
|20110|查询商品信息有误|请根据返回错误信息进行处理|

---

## 查询商品SKU信息

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81SKU%E4%BF%A1%E6%81%AF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/850-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81SKU%E4%BF%A1%E6%81%AF.md

# 查询商品SKU信息

**请求方法:** POST

### 接口描述
获取商品SKU信息。支持获取指定sku的商品信息，包括sku商品，含sku套件的套件商品

### 系统相关界面
"界面路径：【商品】----【商品档案】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.single.sku.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysSkuId | long | 系统商品skuID（规格商家编码二选一，优先取系统商品skuID） |  | 
 | skuOuterId | string | 规格商家编码（系统商品skuID二选一，优先取系统商品skuID） |  | 
 | whetherReturnPurchase | integer | 是否返回采购链接，0.否 1.是，默认不返回 |  | 

 

### 请求参数的逻辑
当sysSkuId与skuOuterId都作为入参去查询：
1.只会走sysSkuId作为条件去查询返回结果,不会管skuOuterId的参数值

### 请求示例
示例一：

````
{
  "sysSkuId":long
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemSku | array | sku列表 | 必填 | 
 | success | boolean | 是否成功 | 必填 | 
 | traceId | long | 流水id | 必填 | 

# subTable: itemSku
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemId | long | 系统主商品ID  | 必填 | 
 | sysSkuId | long | 系统商品skuID | 必填 | 
 | propertiesName | string | 规格真正的属性，以分号分隔 | 必填 | 
 | propertiesAlias | string | 规格属性别名 | 必填 | 
 | shortTitle | string | 规格简称 | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | skuOuterId | string | 规格商家编码 | 必填 | 
 | x | double | 长 | 必填 | 
 | weight | string | 重量，单位kg | 必填 | 
 | unit | string | 单位 | 必填 | 
 | barcode | string | 条形码 | 必填 | 
 | skuPicPath | string | sku的图片地址 | 必填 | 
 | hasSupplier | integer | 是否关联供应商 是：1 否：0 | 必填 | 
 | makeGift | boolean | 是否标记为赠品 | 必填 | 
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | brand | string | 品牌 | 必填 | 
 | created | long | 创建时间 | 必填 | 
 | modified | long | 更新时间 | 必填 | 
 | purchasePrice | double | 成本价 | 必填 | 
 | priceOutput | double | 销售价 | 必填 | 
 | y | double | 宽 | 必填 | 
 | z | double | 高 | 必填 | 
 | purchaseLinkVoList | array | 采购链接 | 必填 | 
 | boxnum | int | 箱规 | 必填 | 
 | skuComponent | String  | 规格成分                |  |
 | skuRemark | String    | 规格备注                |  |
 | itemTagList | array | 商品标签列表 | 必填 |

# subTable: itemSku/purchaseLinkVoList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | defaultFlag | boolean | 默认标识 | 必填 | 
 | link | string | 链接 | 必填 | 
 | source | string | 来源 | 必填 | 
 | sourceName | string | 来源名称 | 必填 | 

# subTable: itemSku/itemTagList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | tagId | long | 商品标签ID | 必填 |
 | tagName | string | 商品标签名称 | 必填 |
 | tagStyle | string | 商品标签样式, 1-蓝底白字, 2-红底白字 3-紫底白字 4-绿底黑字 5-灰底黑字 6-粉底黑字 | 必填 |
 | tagRelationSource | int | 商品标签关系来源, 0-系统打上, 1-快麦, 2-API写入 | 必填 |
 | tagRelationSourceDesc | string | 商品标签关系来源描述 | 必填 |

 

### 响应示例
```
{
    "itemSkus": [
        {
          "created": "zhangsan",
          "sysItemId": 12345,
          "skuPicPath": "zhangsan",
          "weight": 10000,
          "shortTitle": "zhangsan",
          "propertiesName": "zhangsan",
          "propertiesAlias": "zhangsan",
          "sysSkuId": 12345,
          "unit": "zhangsan",
          "activeStatus": 1,
          "hasSupplier": 1,
          "modified": "zhangsan",
          "makeGift": true,
          "barcode": "zhangsan",
          "skuOuterId": "zhangsan"
        }
      ],
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.single.sku.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20106|系统商品skuID与平台规格商家编码，必须二选一！|系统商品skuID与平台规格商家编码，必须二选一！|
|20107|查询商品SKU信息有误|请根据返回错误信息进行处理|

---

## 查询商品SKU列表V2

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81SKU%E5%88%97%E8%A1%A8V2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/900-%E6%9F%A5%E8%AF%A2%E5%95%86%E5%93%81SKU%E5%88%97%E8%A1%A8V2.md

# 查询商品SKU列表V2

**请求方法:** POST

### 接口描述
获取商品SKU列表V2。支持获取指定主商品下的sku商品列表信息，包括sku商品，含sku套件的套件商品

### 系统相关界面
"界面路径：【商品】----【商品档案V2】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.sku.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码 (同系统主商品ID二选一，优先取系统主商品ID ) |  | 
 | sysItemId | long | 系统主商品ID (同商家编码二选一，优先取系统主商品ID ) |  | 
 | whetherReturnPurchase | integer | 是否返回采购链接，0.否 1.是，默认不返回 |  | 

 

### 请求示例
示例一：

````
{
  "sysSkuId":long
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemSkus | array | sku列表 | 必填 | 
 | success | boolean | 是否成功 | 必填 | 
 | traceId | long | 跟踪id | 必填 | 

# subTable: itemSkus
 | 参数名 | 类型      | 描述                  | 必填 | 
 | --- |---------|---------------------| --- | 
 | sysItemId | long    | 系统主商品ID             | 必填 | 
 | sysSkuId | long    | 系统商品skuID           | 必填 | 
 | propertiesName | string  | 规格真正的属性，以分号分隔       | 必填 | 
 | propertiesAlias | string  | 规格属性别名              | 必填 | 
 | shortTitle | string  | 规格简称                | 必填 | 
 | skuOuterId | string  | 平台规格商家编码            | 必填 | 
 | weight | string  | 重量，单位kg             | 必填 | 
 | unit | string  | 单位                  | 必填 | 
 | barcode | string  | 条形码                 | 必填 | 
 | skuPicPath | string  | sku的图片地址            | 必填 | 
 | hasSupplier | integer | 是否关联供应商 是：1 否：0     | 必填 | 
 | makeGift | boolean | 是否标记为赠品             | 必填 | 
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | brand | string  | 品牌                  | 必填 | 
 | created | long    | 创建时间                | 必填 | 
 | modified | long    | 更新时间                | 必填 | 
 | purchasePrice | double  | 成本价                 | 必填 | 
 | priceOutput | double  | 销售价                 | 必填 | 
 | x | double  | 长                   | 必填 | 
 | y | double  | 宽                   | 必填 | 
 | z | double  | 高                   | 必填 | 
 | purchaseLinkVoList | list    | 采购链接列表              | 必填 | 
 | boxnum | int     | 箱规                  | 必填 | 
 | skuComponent | String  | 规格成分                |  |
 | skuRemark | String    | 规格备注                |  |
 | itemTagList | array | 商品标签列表 | 必填 |

# subTable: itemSkus/purchaseLinkVoList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | defaultFlag | boolean | 默认标识 | 必填 | 
 | link | string | 链接 | 必填 | 
 | source | string | 来源 | 必填 | 
 | sourceName | string | 来源名称 | 必填 | 

# subTable: itemSkus/itemTagList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | tagId | long | 商品标签ID | 必填 |
 | tagName | string | 商品标签名称 | 必填 |
 | tagStyle | string | 商品标签样式, 1-蓝底白字, 2-红底白字 3-紫底白字 4-绿底黑字 5-灰底黑字 6-粉底黑字 | 必填 |
 | tagRelationSource | int | 商品标签关系来源, 0-系统打上, 1-快麦, 2-API写入 | 必填 |
 | tagRelationSourceDesc | string | 商品标签关系来源描述 | 必填 |

 

### 响应示例
```
{
    "itemSkus": [
        {
          "created": "zhangsan",
          "sysItemId": 12345,
          "skuPicPath": "zhangsan",
          "weight": 10000,
          "shortTitle": "zhangsan",
          "propertiesName": "zhangsan",
          "propertiesAlias": "zhangsan",
          "sysSkuId": 12345,
          "unit": "zhangsan",
          "activeStatus": 1,
          "hasSupplier": 1,
          "modified": "zhangsan",
          "makeGift": true,
          "barcode": "zhangsan",
          "skuOuterId": "zhangsan"
        }
      ],
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.sku.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20105|系统主商品ID与平台商家编码，必须二选一！|系统主商品ID与平台商家编码，必须二选一！|
|20104|查询商品SKU列表有误|请根据返回错误信息进行处理|

---

## 查询多个商品信息V2

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%95%86%E5%93%81/%E6%9F%A5%E8%AF%A2%E5%A4%9A%E4%B8%AA%E5%95%86%E5%93%81%E4%BF%A1%E6%81%AFV2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/10-%E5%95%86%E5%93%81/950-%E6%9F%A5%E8%AF%A2%E5%A4%9A%E4%B8%AA%E5%95%86%E5%93%81%E4%BF%A1%E6%81%AFV2.md

# 查询多个商品信息V2

**请求方法:** POST

### 接口描述
查询多个商品信息V2。支持获取指定多个主商品下的sku商品信息，包括普通商品，套件商品、组合商品、加工商品

### 系统相关界面
"界面路径：【商品】----【商品档案V2】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemIds | string | 系统主商品ID，多个用逗号隔开，最多支持20个(同平台商家编码二选一，优先取系统主商品ID) |  | 
 | outerIds | string | 平台商家编码，多个用逗号隔开，最多支持20个(同系统主商品ID二选一，优先取系统主商品ID) |  | 
 | returnSkus | int | 是否返回SKU信息  0:否 1:是 默认 1 | 必填 | 

 

### 请求示例
示例一：

````
{
  "sysItemIds":"string,string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | items | array | 数据列表 | 必填 | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | typeTag | integer | 基于type下的二级分类      * type=0 : 0-正常商品，1-sku加工商品，2-纯加工商品 3-含sku组合装商品 4-不含sku组合装商品 | 必填 | 
 | created | string | 创建时间 | 必填 | 
 | sysItemId | long | 系统商品编码 | 必填 | 
 | weight | double | 重量，单位kg | 必填 | 
 | shortTitle | string | 商品简称 | 必填 | 
 | title | string | 商品标题 | 必填 | 
 | type | string | 商品类型      * 0-普通（含虚拟商品，用 isVirtual字段描述|组合装商品） 1-sku套件 2-纯套件 3-包材商品 | 必填 | 
 | isSkuItem | integer | 是否是含有sku的商品，是：1，否：0 | 必填 | 
 | picPath | string | 商品图片URL | 必填 | 
 | catId | string | 商品类目 | 必填 | 
 | unit | string | 单位 | 必填 | 
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | hasSupplier | integer | 是否关联供应商 是：1 否：0 | 必填 | 
 | modified | string | 更新时间 | 必填 | 
 | outerId | string | 平台商家编码 | 必填 | 
 | makeGift | boolean | 是否标记为赠品 | 必填 | 
 | isVirtual | integer | 是否是虚拟商品，是：1，否：0 | 必填 | 
 | skus | array | sku数据列表 | 必填 | 
 | barcode | string | 条形码 | 必填 | 
 | brand | string | 品牌 | 必填 | 
 | sellerCids | string | 商品分类      * todo 这里关联的是 seller_cat 的cid，cid不是唯一的概率很小。有时间后面需要改造 | 必填 | 
 | sellerCats | array | 商品分类id | 必填 | 
 | purchasePrice | double | 成本价 | 必填 | 
 | priceOutput | double | 销售价 | 必填 | 
 | x | double | 长 | 必填 | 
 | y | double | 宽 | 必填 | 
 | z | double | 高 | 必填 | 
 | purchaseLinkSkuList | array | 采购链接 | 必填 | 
 | listTime | long | 上架日期 | 必填 | 
 | boxnum | int | 箱规 | 必填 | 
 | itemTagList | array | 商品标签列表 | 必填 |

# subTable: items/skus
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | created | string | 创建时间 | 必填 | 
 | sysItemId | long | 系统商品编码  | 必填 | 
 | skuPicPath | string | sku的图片地址 | 必填 | 
 | weight | double | 重量，单位kg | 必填 | 
 | shortTitle | string | 规格简称 | 必填 | 
 | propertiesName | string | 规格真正的属性，以分号分隔 | 必填 | 
 | propertiesAlias | string | 规格属性别名 | 必填 | 
 | sysSkuId | long | 系统规格商品编码 | 必填 | 
 | unit | string | 单位 | 必填 | 
 | activeStatus | integer | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | hasSupplier | integer | 是否关联供应商 是：1 否：0 | 必填 | 
 | modified | string | 更新时间 | 必填 | 
 | makeGift | boolean | 是否标记为赠品 | 必填 | 
 | barcode | string | 条形码 | 必填 | 
 | skuOuterId | string | 平台规格商家编码 | 必填 | 
 | brand | string | 品牌 | 必填 | 
 | purchasePrice | double | 成本价 | 必填 | 
 | priceOutput | double | 销售价 | 必填 | 
 | x | double | 长 | 必填 | 
 | y | double | 宽 | 必填 | 
 | z | double | 高 | 必填 | 
 | boxnum | int | 箱规 | 必填 | 
 | itemTagList | array | 商品标签列表 | 必填 |

# subTable: items/sellerCats
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 分类id | 必填 | 
 | cid | long | cid | 必填 | 
 | name | string | 分类名称 | 必填 | 

# subTable: items/purchaseLinkSkuList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码 | 必填 | 
 | skuOuterId | string | 规格商家编码 | 必填 | 
 | sysItemId | long | 系统商品编码 | 必填 | 
 | sysSkuId | long | 系统规格ID | 必填 | 
 | purchaseLinkList | array | 采购链接详情 | 必填 | 

# subTable: items/purchaseLinkSkuList/purchaseLinkList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | defaultFlag | boolean | 默认标识 | 必填 | 
 | link | string | 链接 | 必填 | 
 | source | string | 来源 | 必填 | 
 | sourceName | string | 来源名称 | 必填 | 

# subTable: items/itemTagList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | tagId | long | 商品标签ID | 必填 |
 | tagName | string | 商品标签名称 | 必填 |
 | tagStyle | string | 商品标签样式, 1-蓝底白字, 2-红底白字 3-紫底白字 4-绿底黑字 5-灰底黑字 6-粉底黑字 | 必填 |
 | tagRelationSource | int | 商品标签关系来源, 0-系统打上, 1-快麦, 2-API写入 | 必填 |
 | tagRelationSourceDesc | string | 商品标签关系来源描述 | 必填 |

# subTable: items/skus/itemTagList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | tagId | long | 商品标签ID | 必填 |
 | tagName | string | 商品标签名称 | 必填 |
 | tagStyle | string | 商品标签样式, 1-蓝底白字, 2-红底白字 3-紫底白字 4-绿底黑字 5-灰底黑字 6-粉底黑字 | 必填 |
 | tagRelationSource | int | 商品标签关系来源, 0-系统打上, 1-快麦, 2-API写入 | 必填 |
 | tagRelationSourceDesc | string | 商品标签关系来源描述 | 必填 |

 

### 响应示例
```
{
  "items": [
    {
      "typeTag": 1,
      "created": "@date",
      "sysItemId": 12345,
      "weight": 10000,
      "shortTitle": "zhangsan",
      "title": "zhangsan",
      "type": "zhangsan",
      "isSkuItem": 1,
      "picPath": "zhangsan",
      "catId": "zhangsan",
      "unit": "zhangsan",
      "activeStatus": 1,
      "hasSupplier": 1,
      "modified": "@date",
      "outerId": "zhangsan",
      "makeGift": true,
      "isVirtual": 1,
      "skus": [
        {
          "created": "@date",
          "sysItemId": 12345,
          "skuPicPath": "zhangsan",
          "weight": 10000,
          "shortTitle": "zhangsan",
          "propertiesName": "zhangsan",
          "propertiesAlias": "zhangsan",
          "sysSkuId": 12345,
          "unit": "zhangsan",
          "activeStatus": 1,
          "hasSupplier": 1,
          "modified": "@date",
          "makeGift": true,
          "barcode": "zhangsan",
          "skuOuterId": "zhangsan"
        }
      ],
      "barcode": "zhangsan"
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20111|系统主商品ID最多支持20组！|请减少查询的数量，最多支持20组！|
|20105|系统主商品ID与平台商家编码，必须二选一！|系统主商品ID与平台商家编码，必须二选一！|
|20112|平台商家编码最多支持20组！|请减少查询的数量，最多支持20组！|
|20113|系统主商品ID信息不正确！|请检查系统主商品ID信息是否规范|
|20103|查询商品列表有误|请根据返回错误信息进行处理|

---

## 订单查询(非淘系,拼多多)

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E8%AE%A2%E5%8D%95%E6%9F%A5%E8%AF%A2%E9%9D%9E%E6%B7%98%E7%B3%BB%E6%8B%BC%E5%A4%9A%E5%A4%9A
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/0-%E8%AE%A2%E5%8D%95%E6%9F%A5%E8%AF%A2%E9%9D%9E%E6%B7%98%E7%B3%BB%E6%8B%BC%E5%A4%9A%E5%A4%9A.md

# 订单查询(非淘系,拼多多)

**请求方法:** POST

### 系统相关界面
界面路径：【交易】----【订单查询】
### 接口备注
此接口不包含淘系、拼多多订单数据，如需获取淘系、拼多多订单，需申请奇门、方舟appkey获取。注：各平台敏感信息受平台政策影响会有不返回或者加密返回的情况，如有需要接入前可确认
[点击前往奇门申请说明](https://open.taobao.com/docV3.htm?docId=109580&docType=1&qq-pf-to=pcqq.group)
[点击前往方舟对接说明](https://open.kuaimai.com/docs/question/%E7%B3%BB%E7%BB%9F%E5%85%AC%E5%91%8A/%E6%8B%BC%E5%A4%9A%E5%A4%9A%E8%87%AA%E7%A0%94%E6%8E%A5%E5%8F%A3%E6%8E%A5%E5%85%A5%E5%BC%80%E6%94%BE%E5%85%AC%E5%91%8A)
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sid | string | 系统订单号，多个逗号隔开 |  |  | 
 | tid | string | 平台订单号，多个逗号隔开 |  |  | 
 | timeType | string | 查询的时间类型：\[created:下单时间\]--\[pay_time:付款时间\]--\[consign_time:发货时间\]--\[audit_time:审核时间\]--\[upd_time:修改时间\]；与startTime、endTime同时使用，时间跨度建议不超过一天。为空时，默认为修改时间 ，归档订单(queryType参数传1时)不支持audit_time, upd_time|  |  | 
 | startTime | string | 起始时间:格式yyyy-MM-dd HH:mm:ss，与timeType、endTime同时使用，时间跨度建议不超过一天 |  |  | 
 | endTime | string | 截止时间:格式yyyy-MM-dd HH:mm:ss，与timeType、startTime同时使用，时间跨度建议不超过一天 |  |  | 
 | userIds | string | 店铺ID，多个逗号隔开 |  |  | 
 | pageSize | integer | 每页多少条，最大支持200，不能小于20 |  | 20 | 
 | pageNo | integer | 页码 |  | 1 | 
 | status | string | 系统状态,对应响应参数的sysStatus订单系统状态(支持多个,逗号隔开).WAIT_BUYER_PAY:待付款,WAIT_AUDIT:待审核,WAIT_FINANCE_AUDIT:待财审,FINISHED_AUDIT:审核完成, WAIT_EXPRESS_PRINT:待打印快递单,WAIT_PACKAGE:待打包,WAIT_WEIGHT:待称重,WAIT_SEND_GOODS:待发货, WAIT_DEST_SEND_GOODS:待供销商发货,SELLER_SEND_GOODS:卖家已发货,FINISHED:交易完成,CLOSED:交易关闭 |  |  | 
 | tagIds | string | 查询指定标签ID集合,多个逗号隔开,最多支持十组 |  |  | 
 | exceptIds | string | 自定义异常标签,多个逗号隔开,最多支持十组 |  |  | 
 | exceptionStatus | string | 系统异常标签,多个逗号隔开,最多支持十组 |  |  | 
 | types | string | 订单类型,多个逗号隔开 1=货到付款;2=纯平台订单（包含平台单拆出去的手工单）;3=平台订单;4=线下订单;5=纯系统手工单（不包含平台单拆出去的手工单）;6=预售订单;7=合并订单;8=拆分订单;9=加急订单;10=空包订单;11=合单提示;12=门店订单;13=换货订单;14=补发订单;16=海外仓订单;17=Lazada;18=报损单;19=领用单;20=调整单;21=客户订单;22=天猫直送;23=平台预售;24=京东直发;25=京东供销;33=分销订单;34=供销订单;35=京配订单;38=唯品会订单;37=唯品会订单JIT;36=平台分销;49=拼多多工厂代发;50=天猫淘宝店铺预售;51=抖音厂商代发;53=亚马逊FBA;54=亚马逊FBM;55=亚马逊多渠道;56=奇门订单;57=得物普通现货;58=得物极速现货;60=全款预售;61=得物直发订单;63=淘宝厂商代发订单;68=天猫国际直邮;99=出库单;62=Lazada-FBL;65=BTAS订单;69=阿里代销;0=普通订单;66=平台拆单;39=BIC订单;48=多级分销;46=档口订单;70=花城农夫帮卖订单;15=跨境订单;26=天猫当日发货;27=天猫24小时发货;28=天猫当日达;29=天猫次日达;30=天猫三日达;31=天猫四日达;32=天猫五日达;52=平台分销;72=快麦通代发;73=1688分销小站;74=速卖通全托管;79=TEMU;80=希音;75=分销订单(明确供销商);76=含拆单标记的订单;77=1688分销小站(分销);78=o2o订单|  |  | 
 | onlyContain | string | 异常查询状态：1:仅包含 2:排除 3:同时包含 |  |  | 
 | consignedType | integer | 发货方式 0.非ERP发货   1.ERP发货 |  |  | 
 | buyerNick | string | 买家ID |  |  | 
 | queryType | integer | 订单查询范围类型    0.三个月内订单 1.三个月之前订单 |  | 0 | 
 | outSids | string | 运单号，多个逗号隔开 |  |  | 
 | useHasNext | boolean  | 传true时不会返回total（不统计总数）, 返回hasNext用以判断是否有下一页数据，传false时按原来逻辑只返回total |  |  | 
 | useCursor | boolean | 传true时开启游标查询 , 仅queryType不为1时有效|  |  | 
 | cursor | string | useCursor传true时,第一次查询该参数不传，之后的每次查询传上一次接口返回的cursor |  |  | 

 

### 请求示例
示例一：

````
{
    "pageNo": "number",
    "userIds": "string",
    "timeType": "string",
    "pageSize": "number",
    "startTime": "string",
    "endTime": "string",
    "tid": "string",
    "sid": "string",
    "status": "string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 | list | array | list |  | 
 | total | long | 总数 仅在非归档订单查询（请求参数useHasNext，useCursor都不为true时）第一页返回 |  | 
 | hasNext | boolean | 是否有下一页 |  | 
 | cursor | string | 游标 |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | paymentDiff | double | 订单差额=系统实付金额-平台实收金额 区间值 |  | 
 | buyerNick | string | 平台订单上的买家昵称 |  | 
 | threePlTiming | integer | 3PL有时效订单标，值true 或者 false |  | 
 | type | string | 订单类型,多个逗号0=普通订单;1=货到付款;3=平台订单;4=线下订单;6=预售订单;7=合并订单;8=拆分订单;9=加急订单;10=空包订单;11=合单提示;12=门店订单;13=换货订单;14=补发订单;16=海外仓订单;17=Lazada;18=报损单;19=领用单;20=调整单;21=客户订单;22=天猫直送;23=平台预售;24=京东直发;25=京东供销;33=分销订单;34=供销订单;35=京配订单;36=平台分销;50=天猫淘宝店铺预售;51=抖音厂商代发;53=亚马逊FBA;54=亚马逊FBM;55=亚马逊多渠道;56=奇门订单;57=得物普通现货;58=得物极速现货;60=全款预售;61=得物直发订单;62=Lazada-FBL;66=平台拆单;99=出库单 |  | 
 | receiverCity | string | 收件市 |  | 
 | invoiceRemark | string | 发票备注 |  | 
 | poNos | string | 唯品会po单号 |  | 
 | packmaCost | double | 包材成本 |  | 
 | receiverPhone | string | 收件人固话 |  | 
 | expressCode | string | 快递公司的编码 |  | 
 | payment | string | 应付金额（系统里添加商品会相应增加） |  | 
 | payAmount | string | 订单买家已付金额（单位：元） | 必填 | 
 | adjustFee | string | 手工调整订单价格 |  | 
 | isExcep | integer | 是否异常订单    1.异常订单   0.否 |  | 
 | exceptIds | string | 自定义异常标签,多个逗号隔开 |  |  | 
 | exceptNames | array | 自定义异常名称列表 |  |  | 
 | receiverZip | string | 收件邮编 |  | 
 | isTmallDelivery | integer | 天猫直送，值true 或者 false |  | 
 | buyerTaxNo | string | 买家税号 |  | 
 | isHalt | integer | 是否挂起订单    1.是   0.否 |  | 
 | warehouseId | long | 仓库编号 |  | 
 | isRefund | long | 1.是   0.否  是否存在退款，退款关闭或者退款成功时该数据不返回 |  | 
 | receiverState | string | 收件省份 |  | 
 | orders | array | 订单商品明细集合 |  | 
 | expressCompanyId | long | 快递公司的编号 |  | 
 | status | string | 订单的平台状态,详情查看各平台开放平台 |  | 
 | isUrgent | integer | 是否是加急订单     1.是   0.否 |  | 
 | theoryPostFee | double | 理论运费 |  | 
 | warehouseName | string | 仓库名称 |  | 
 | hasSuit | boolean | 是否含有套件      true.是   false.否 |  | 
 | itemNum | integer | 订单下的商品数量 |  | 
 | receiverDistrict | string | 收件区县 |  | 
 | taxFee | string | 税费 |  | 
 | isHandlerMessage | integer | 是否处理买家留言： 0：未处理 1：已处理 |  | 
 | grossProfit | double | 毛利润 |  | 
 | postFee | string | 邮费：合单的话，取的是主单的邮费 |  | 
 | receiverMobile | string | 收件人手机号 |  | 
 | singleItemKindNum | integer | 商品单品种类, 最小粒度 |  | 
 | userId | long | 店铺用户编号 |  | 
 | itemKindNum | integer | 订单下的商品种类数 |  | 
 | exceptMemo | string | 异常备注 |  | 
 | ptConsignTime | string | 平台发货时间 |  | 
 | buyerMessage | string | 平台订单上的买家留言 |  | 
 | unifiedStatus | string | 各平台状态映射后的统一状态 待付款：WAIT_BUYER_PAY 待发货：WAIT_SEND_GOODS 卖家部分发货：SELLER_CONSIGNED_PART 卖家已发货:SELLER_SEND_GOODS 交易完成:FINISHED 交易关闭:CLOSED |  | 
 | excep | long | 订单级别的系统异常，参考itemExcep 目前不明确供销商”、“分销商反审核”、“分销商未付款“ |  | 
 | tradeTags | array | 订单自定义标签集合 |  | 
 | shortId | long | 订单短号 |  | 
 | discountFee | string | 优惠 |  | 
 | sellerFlagString | string | 匹配规则用，用逗号分开 |  | 
 | payTime | long | 付款时间 |  | 
 | mobileTail | string | 手机后四位尾号 |  | 
 | source | string | 订单来自哪个平台，例如 tb(淘宝或者天猫平台),jd(京东平台),sys(系统手工订单) |  | 
 | tid | string | 平台订单号 |  | 
 | consignTime | long | 发货时间 |  | 
 | isPresell | integer | 是否为预售订单：0:正常订单，1：是预售；2预售转正常；3：系统预售 |  | 
 | receiverCountry | string | 收件国家，跨境订单使用 |  | 
 | updTime | long | 数据库最后更新时间 |  | 
 | stockStatus | string | 库存状态   EMPTY【库存不足】 NORMAL【正常】 UNALLOCATED【商品未分配】 INSUFFICIENT【库存不足】 RELATION_MODIFIED【商品对应关系修改】 EXCEP【库存不足】 |  | 
 | modified | long | 订单在平台上的修改时间 |  | 
 | created | long | 下单时间 |  | 
 | taobaoId | long | 平台的卖家账户 |  | 
 | weight | double | 重量 |  | 
 | auditMatchRule | integer | 智能审核规则匹配结果 |  | 
 | sysOuterId | string | 返回订单下第一个有匹配关系的商品编码，若都未匹配返回设定值：zzzzzz^随机数字,随机数字 |  | 
 | saleFee | string | 分销金额 |  | 
 | exceptions | string | 订单的异常信息,   店铺停用异常状态:EX_USER_UNACTIVE, 订单挂起:EX_HALT, 换地址:EX_CHANGE_ADDRESS, 退款:EX_REFUND, 部分退款:EX_PART_REFUND, 商品未匹配异常状态:EX_UNALLOCATED, 库存不足异常状态:EX_INSUFFICIENT, 商品对应关系修改异常状态:EX_RELATION_MODIFIED, 换商品的异常状态:EX_CHANGE_ITEM, 风控异常订单:EX_RISK_ORDER, 套件修改异常:EX_SUITE_CHANGE, 普通商品转加工:EX_ITEM_PROCESS_EXCEP, 货单付款重复订单异常:EX_COD_REPEAT, 平台修改备注:EX_UPDATED_SELLERMEMO, 黑名单的异常状态:EX_BLACK, 发货异常:EX_DELIVER, 上传发货异常:EX_UPLOAD_DELIVER, pdd缺货已处理异常:EX_STOCK_OUT, 发货异常:EX_WAITING_RETURN_WMS, 不明确供销商:EX_AMBIGUITY_FX, 分销商反审核:EX_UNAUDIT_FX, 分销商未付款:EX_WAITEPAY_FX, 供销商打回:EX_REPULSE_FX, 外仓商品待拆分:EX_PLATFORM_FX_SPLIT, 等待合并异常:EX_WAIT_MERGE, 商品停用异常:EX_ITEM_SHUTOFF, 天猫超时缺货回告异常:EX_TMCS_STOCK_OUT, 唯一码下架异常:EX_UNIQUE_CODE_OFFSHELF, 天猫国际直营缺货回告异常:EX_TMGJZY_STOCK_OUT, 得物直发物流模板匹配异常:EX_POISON_NOT_MATCH_EXPRESS_TEMPLATE, 唯品会未匹配常态合作码异常:EX_VIP_COOPERATION_CODE_NOT_MATCH |  | 
 | outSid | string | 运单号 |  | 
 | receiverAddress | string | 收件详细地址 |  | 
 | volume | double | 订单体积 |  | 
 | scalping | integer | 是否空单; 1=是; 0=否 |  | 
 | companyId | long | 公司编号 |  | 
 | netWeight | double | 单位kg，订单净重，由子订单综合计算得出，参照Order#netWeight |  | 
 | sellerMemo | string | 平台上的卖家备注 |  | 
 | chSysStatus | string | 订单系统状态的中文说明 |  | 
 | subSource | string | 次来源地 jd 保存订单来源 |  | 
 | sysMemo | string | 订单系统备注 |  | 
 | shopName | string | 店铺名称 |  | 
 | sid | long | 系统订单号 |  | 
 | cancelFrom | integer | 供销订单使用,分销作废来源 0,取消分销属性 1，分销订单作废 |  | 
 | acPayment | string | 不变的实付金额 |  | 
 | sysStatus | string | 订单系统状态   WAIT_BUYER_PAY【待付款】 WAIT_AUDIT【待审核】 WAIT_FINANCE_AUDIT【等待财审】 WAIT_MANUAL_AUDIT【等待人工审核】 FINISHED_AUDIT【审核完成】 WAIT_EXPRESS_PRINT【待打印快递单】 SYS_STATUS_WAIT_DELIVERY_PRINT【待打印发货单】 WAIT_PACKAGE【待打包】 WAIT_WEIGHT【待称重】 WAIT_SEND_GOODS【待发货】 WAIT_DEST_SEND_GOODS【待供销商发货】 SELLER_SEND_GOODS【卖家已发货】 FINISHED【交易完成】 CLOSED【交易关闭】 CANCEL【交易作废】 |  | 
 | manualPaymentAmount | double | 手工支付金额 |  | 
 | fxIsUpload | integer | 分销订单是否在系统上传（供销订单用）  1.是   0.否 |  | 
 | promiseService | string | 承诺服务类型，会有多个服务值，以英文半角逗号","切割，其中 tmallpromise.arrival.timing 代表到货承诺时效 tmallpromise.consign.timing代表发货承诺时效 |  | 
 | cost | double | 订单总成本价,所有商品总成本价之和 |  | 
 | isCancel | integer | 是否为作废订单   1.是   0.否 |  | 
 | receiverName | string | 收件人姓名 |  | 
 | timeoutActionTime | string | 承诺时间 |  | 
 | isHandlerMemo | integer | 是否处理卖家备注： 0：未处理 1：已处理 |  | 
 | expressCompanyName | string | 快递公司的名称 |  | 
 | isCancelDistributorAttribute | integer | 是否是取消分销属性触发的订单同步，如果是1，则不需要匹配供应商，因为是取消分销属性 |  | 
 | tradeFrom | string | 订单来源，例如手机端或者PC端 |  | 
 | platformPaymentAmount | double | 平台支付金额 |  | 
 | totalFee | string | 总额 |  | 
 | wlbTemplateType | integer | 供销订单用 |  | 
 | timingPromise | string | 服务身份标识 |  | 
 | actualPostFee | string | 实际运费 |  | 
 | splitType | integer | 拆单类型 -1:未拆单 1:拆单 |  | 
 | splitSid | long | 如果splitType等于1。则对应拆单的主单的sid。否则为-1 |  | 
 | endTime | string | 完结时间 |  | 
 | templateId | long | 快递模板id | 必填 | 
 | templateName | string | 快递模板名称 | 必填 | 
 | logisticsCompanyId | long | 用户物流公司ID | 必填 | 
 | logisticsCompanyName | string | 用户物流公司名称 | 必填 | 
 | isPackage | integer | 订单是否打包    0.未打包   1.打包 | 必填 | 
 | sellerFlag | integer | 平台上的卖家旗帜   0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红 | 必填 | 
 | salesmanId | long | 业务员ID | 必填 | 
 | salesmanName | string | 业务员名称 | 必填 | 
 | sourceName | string | 订单来源于哪里 分销系统里记为分销商名称 | 必填 | 
 | sourceId | long | 分销商ID | 必填 | 
 | destName | string | 订单归属于哪里 分销系统里记为供销商名称 | 必填 | 
 | destId | long | 供销商ID | 必填 | 
 | expressPrintTime | date | 快递单打印时间 | 必填 | 
 | deliverPrintTime | date | 发货单打印时间 | 必填 | 
 | expressStatus | int | 快递单打印状态  , 0 : 否， 1:是 | 必填 | 
 | deliverStatus | int | 发货单打印状态  , 0 : 否， 1:是 | 必填 | 
 | sellerNick | string | 奇门店铺订单关联的平台店铺名称 | 必填 | 
 | selfBuiltPaymentReceivable | string | 代收金额 |  | 
 | selfBuiltDepositAmount | string | 定金 |  | 
 | selfBuiltPayment | string | 货到付款总金额 |  | 
 | tradeInvoice | object | 订单发票信息 | 必填 | 
 | subShop | object | 子店铺信息 |  | 
 | tradeExt | object | 订单扩展信息 |  | 
 | tradePictureMemoUris | array | 订单文件列表 |  |
 | messageMemos | array | 合单信息 |  |
 | distributor | object | 分销员信息 |  |
 | vipPickNo | string | 捡货单号 |  |
 | vipStorageNo | string | 出仓单ID |  |
 | storageNo | string | 出仓单号 |  |

# subTable: list/distributor
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | distributorName | string | 分销员名称 |  | 
 | distributorPhone | string | 分销员手机号 |  | 

# subTable: list/tradeExt
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | currency | string | 原始货币 |  | 
 | originalPayment | string | 订单实付(原始币种) |  | 
 | originalPostFee | string | 订单运费(原始币种) |  | 
 | originalDiscountFee | string | 订单折扣(原始币种) |  | 
 | originalTaxFee | string | 订单税费(原始币种) |  | 
 | originalOtherFeeBuyer | string | 买家其他费用(原始币种) |  | 
 | originalOtherFeeSeller | string | 卖家其他费用(原始币种) |  | 
 | originalOtherFeeOther | string | 其他方其他费用(原始币种) |  | 

# subTable: list/subShop
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 子店铺ID |  | 
 | shopName | string | 店铺名称 |  | 
 | platformCode | string | 所属平台编码 |  | 
 | shopCode | string | 店铺编码 |  | 
 | logisticsCode | string | 物流商编码 |  | 

# subTable: list/orders
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysSkuPropertiesName | string | 系统SKU的规格属性名称 |  | 
 | discountRate | double | 折扣率 |  | 
 | discountFee | string | 优惠金额 |  | 
 | payTime | long | 付款时间 |  | 
 | numIid | string | 平台商品数字编号 |  | 
 | num | integer | 子订单商品数量 |  | 
 | source | string | 订单来源 tb,tm,jd,sys |  | 
 | shortTitle | string | 商品简称 |  | 
 | sysTitle | string | 系统商品的标题 |  | 
 | type | integer | 0 普通商品 1 赠品 是否是赠品不能根据type来判断，而要根据giftNum>0 来判断 2 套件商品 3 组合商品 4 加工商品 |  | 
 | suits | array | 套件明细(每个套件的实付金额、数量) |  | 
 | tid | string | 所属订单的平台编号 |  | 
 | isPresell | integer | 是否为预售订单 0:正常订单，1：是预售；2预售转正常；3：系统预售 |  | 
 | consignTime | long | 子订单发货时间 |  | 
 | uniqueCode | string | uniqueCode |  | 
 | outerSkuId | string | outer_sku_id |  | 
 | sysSkuPropertiesAlias | string | 系统SKU规格属性别名 |  | 
 | price | string | 商品销售价 |  | 
 | updTime | long | 数据更新时间 |  | 
 | giftNum | string | 赠品的order数量 |  | 
 | stockNum | integer | 分配的库存数量 |  | 
 | stockStatus | string | 当前子订单的库存状态, EMPTY【库存不足】 NORMAL【正常】 UNALLOCATED【商品未分配】 INSUFFICIENT【库存不足】 RELATION_MODIFIED【商品对应关系修改】 EXCEP【库存不足】 |  | 
 | modified | long | 子订单平台的修改时间 |  | 
 | payment | string | 实付金额, 公式: 实付金额 = 应付金额 - 优惠金额 |  | 
 | id | long | 子订单系统编号 |  | 
 | adjustFee | string | 手工调整金额 |  | 
 | skuId | string | 平台规格编号 |  | 
 | created | long | 下单时间 |  | 
 | insufficientCanceled | integer | 是否取消库存缺货异常（INSUFFICIENT,EMPTY,EXCEP）：0 否，1 是 |  | 
 | taobaoId | string | 订单店铺的平台ID |  | 
 | diffStockNum | integer | 缺货数量=num-stockNum（不需要持久化） |  | 
 | sysSkuRemark | string | 系统规格备注 |  | 
 | sysOuterId | string | 系统商家编码，如果是商品则为商品的商家编码，如果为SKU则为SKU的商家编码 |  | 
 | saleFee | string | 分销金额 |  | 
 | exceptions | string | 子订单异常信息 |  | 
 | volume | string | 单个商品体积 |  | 
 | picPath | string | 平台商品图片链接 |  | 
 | sysItemRemark | string | 系统规商品备注 |  | 
 | companyId | long | 公司编号 |  | 
 | unit | string | 系统商品数量单位 |  | 
 | netWeight | string | 单位kg，子订单中单个商品净重 |  | 
 | osGiftCount | string | 前N有礼赠品数量 |  | 
 | oldStatus | string | 子订单旧的平台状态，不做持久化，一般用于订单同步更新时的判断比较 |  | 
 | warehouseId | string | 子订单商品库存操作时的仓库ID,要保证与所属trade中的warehouseId一致 |  | 
 | isVirtual | string | 是否虚拟商品，虚拟商品不需要申请库存，发货时也不需要消费库存、归还库存 |  | 
 | status | string | 子订单平台状态 |  | 
 | sysConsigned | integer | 是否ERP发货  0：未发货，1：ERP发货，2：其他ERP发货 |  | 
 | soid | string | 子订单平台编号（由于某些平台的子订单号为字符类型，需要用此字段保存，后续可将oid修改为String类型） |  | 
 | refundStatus | string | 子订单退款状态    CLOSED：退款关闭 NO_REFUND：未退款 SELLER_CONTINUE_CONSIGN：卖家已发货退款 SELLER_REFUSE_BUYER：卖家拒绝退款 WAIT_SELLER_AGREE：待卖家同意退款 WAIT_BUYER_RETURN_GOODS：待买家退货 WAIT_SELLER_CONFIRM_GOODS：待卖家确认收货 SUCCESS：退款成功 |  | 
 | oid | long | 子订单平台编号(淘宝有,京东没有) |  | 
 | itemSysId | long | 匹配到的系统商品ID |  | 
 | title | string | 平台商品名称 |  | 
 | sid | string | 所属主订单的系统编号 |  | 
 | forcePackNum | string | 强制验货数量 |  | 
 | acPayment | string | 不变的实付金额, 进来后不变 |  | 
 | sysStatus | string | 订单系统状态   WAIT_BUYER_PAY【待付款】 WAIT_AUDIT【待审核】 WAIT_FINANCE_AUDIT【等待财审】 WAIT_MANUAL_AUDIT【等待人工审核】 FINISHED_AUDIT【审核完成】 WAIT_EXPRESS_PRINT【待打印快递单】 SYS_STATUS_WAIT_DELIVERY_PRINT【待打印发货单】 WAIT_PACKAGE【待打包】 WAIT_WEIGHT【待称重】 WAIT_SEND_GOODS【待发货】 WAIT_DEST_SEND_GOODS【待供销商发货】 SELLER_SEND_GOODS【卖家已发货】 FINISHED【交易完成】 CLOSED【交易关闭】 CANCEL【交易作废】 |  | 
 | sysItemOuterId | string | 系统主商家编码 |  | 
 | osSortNum | string | 前N有礼中奖名次，获得奖品的订单才会有该字段 |  | 
 | skuPropertiesName | string | 规格属性名 |  | 
 | skuUnit | string | 系统规格计量单位 |  | 
 | cost | double | 商品成本价 cost*num 该商品总成本价 |  | 
 | isCancel | string | 是否作废，未发货的子订单与所属的trade保持一致 |  | 
 | salePrice | string | 分销价格 |  | 
 | oldPrice | string | 原商品销售价，在套件转单品去匹配赠品时候使用 |  | 
 | postFee | string | 单笔订单运费 |  | 
 | identCode | string | 识别码 |  | 
 | combineId | string | 如果是套件单品,则该字段的值为其所属的套件子订单的id,否则为0 |  | 
 | authorId | long | 达人id （废弃）|  | 
 | authorNo | string | 达人id|  | 
 | authorName | string | 达人名称 |  | 
 | userId | long | 订单所属店铺用户ID |  | 
 | ptConsignTime | long | 平台发货时间 |  | 
 | totalFee | string | 应付金额, 公式: 应付金额 = 商品数量 * 商品单价 + 手工调整价 |  | 
 | sysPicPath | string | 系统商品图片链接 |  | 
 | skuSysId | long | 匹配到的系统规格ID |  | 
 | outerId | string | 商家编码，不做持久化，仅仅只是为了系统订单添加商品使用 |  | 
 | endTime | string | 子订单的交易结束时间 |  | 
 | estimateConTime | string | 预计发货时间 |  | 
 | refundId | string | 平台退款编号 |  | 
 | expressCompanyId |  | 快递公司的编号 |  | 
 | orderExt | object | order扩展信息（订单商品备注） | 必填 | 
 | payAmount | string | 商品买家已付金额（单位：元） | 必填 | 
 | divideOrderFee | string | 平台实付(平台分摊之后的实付金额)（单位：元） | 必填 | 
 | orderStockProducts | list | 生产信息 | 必填 | 

# subTable: list/orders/suits
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysSkuPropertiesName | string | 系统SKU的规格属性名称 |  | 
 | discountRate | double | 折扣率 |  | 
 | discountFee | string | 优惠金额 |  | 
 | payTime | long | 付款时间 |  | 
 | numIid | string | 平台商品数字编号 |  | 
 | num | integer | 子订单商品数量 |  | 
 | source | string | 订单来源 tb,tm,jd,sys |  | 
 | shortTitle | string | 商品简称 |  | 
 | sysTitle | string | 系统商品的标题 |  | 
 | type | integer | 0 普通商品 1 赠品 是否是赠品不能根据type来判断，而要根据giftNum>0 来判断 2 套件商品 3 组合商品 4 加工商品 |  | 
 | cost | double | 该商品总成本价 | 必填 | 
 | outerSkuId | string | 外部skuID | 必填 | 
 | combineId | long | 如果是套件单品,则该字段的值为其所属的套件子订单的id,否则为0 | 必填 | 
 | payAmount | string | 商品买家实付金额 | 必填 | 
 | tid | string | 所属订单的平台编号 | 必填 | 
 | consignTime | long | 子订单发货时间 | 必填 | 
 | isPresell | integer | 是否为预售订单 0:正常订单，1：是预售；2预售转正常；3：系统预售 | 必填 | 
 | price | string | 商品销售价 | 必填 | 
 | updTime | long | 数据更新时间 | 必填 | 
 | giftNum | integer | 赠品的order数量 | 必填 | 
 | stockStatus | string | 当前子订单的库存状态,如库存正常(NORMAL),库存不足(INSUFFICIENT) | 必填 | 
 | modified | long | 子订单平台的修改时间 | 必填 | 
 | payment | string | 实付金额, 公式: 实付金额 = 应付金额 - 优惠金额 | 必填 | 
 | id | long | 子订单系统编号 | 必填 | 
 | adjustFee | string | 手工调整金额 | 必填 | 
 | skuId | string | 平台规格编号 | 必填 | 
 | created | string | 下单时间 | 必填 | 
 | insufficientCanceled | integer | 是否取消库存缺货异常（INSUFFICIENT,EMPTY,EXCEP）：0 否，1 是 | 必填 | 
 | taobaoId | long | 订单店铺的平台ID | 必填 | 
 | sysOuterId | string | 系统商家编码，如果是商品则为商品的商家编码，如果为SKU则为SKU的商家编码 | 必填 | 
 | saleFee | string | 分销金额 | 必填 | 
 | picPath | string | 平台商品图片链接 | 必填 | 
 | volume | double | 单个商品体积 | 必填 | 
 | sysItemRemark | string | 系统规商品备注 | 必填 | 
 | companyId | long | 公司编号 | 必填 | 
 | netWeight | double | 单位kg，子订单中单个商品净重 | 必填 | 
 | unit | string | 系统商品数量单位 | 必填 | 
 | isVirtual | integer | 是否虚拟商品，虚拟商品不需要申请库存，发货时也不需要消费库存、归还库存 | 必填 | 
 | status | string | 子订单平台状态 | 必填 | 
 | sysConsigned | integer | 是否在系统发货  0.否 1.是 2.其他erp发货 | 必填 | 
 | refundStatus | string | 子订单退款状态 | 必填 | 
 | oid | long | 子订单平台编号(淘宝有,京东没有) | 必填 | 
 | title | string | 商品标题 | 必填 | 
 | itemSysId | long | 匹配到的系统商品ID | 必填 | 
 | sid | long | 所属主订单的系统编号 | 必填 | 
 | forcePackNum | integer | 强制验货数量 | 必填 | 
 | sysStatus | string | 订单系统状态 | 必填 | 
 | divideOrderFee | string | 平台实付(平台分摊之后的实付金额) | 必填 | 
 | skuPropertiesName | string | 规格属性名 | 必填 | 
 | cost | double | 商品成本价 | 必填 | 
 | isCancel | integer | 是否作废，未发货的子订单与所属的trade保持一致 | 必填 | 
 | salePrice | string | 分销价格 | 必填 | 
 | combineId | long | 如果是套件单品,则该字段的值为其所属的套件子订单的id,否则为0 | 必填 | 
 | ptConsignTime | long | 平台发货时间 | 必填 | 
 | totalFee | string | 应付金额, 公式: 应付金额 = 商品数量 * 商品单价 + 手工调整价 | 必填 | 
 | sysPicPath | string | 系统商品图片链接 | 必填 | 
 | skuSysId | long | 匹配到的系统规格ID | 必填 | 
 | estimateConTime | long | 预计发货时间 | 必填 | 
 | endTime | long | 子订单的交易结束时间 | 必填 | 
 | orderStockProducts | list | 生产信息（批次、生产日期） | 必填 | 

# subTable: list/orders/suits/orderStockProducts
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | batchNo | string | 批次号 | 必填 | 
 | productionDate | long | 生产日期 |  | 
 | expireDate | long | 到期日期 |  | 
 | lockNum | long | 锁定数量 |  | 

# subTable: list/orders/orderExt
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | orderRemark | string | 订单商品备注 |  | 
 | customization | string | 贺卡信息等 |  | 
 | originalPrice | string | 商品单价(原始币种) |  | 
 | originalPayment | string | 商品实付(原始币种) |  | 
 | originalOtherFee | string | 商品其他费用(原始币种) |  | 

# subTable: list/orders/orderStockProducts
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | batchNo | string | 批次号 | 必填 | 
 | productionDate | long | 生产日期 |  | 
 | expireDate | long | 到期日期 |  | 
 | lockNum | long | 锁定数量 |  | 

# subTable: list/tradeTags
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | bgColor | string | 标签背景颜色 |  | 
 | remark | string | 标签备注 |  | 
 | id | long | 标签id |  | 
 | tagName | string | 标签名称 |  | 
 | fontColor | string | 标签前景颜色 |  | 

# subTable: list/tradeInvoice
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | invoiceType | string | 发票抬头类型：1个人 2企业 | 必填 | 
 | invoiceKind | string | 发票类型：1纸质普通 2纸质专票 3电子普通 4电子专票 | 必填 | 
 | invoiceName | string | 发票抬头 | 必填 | 
 | buyerTaxNo | string | 买家税号 | 必填 | 
 | invoiceRemark | string | 发票备注 | 必填 | 
 | buyerAddress | string | 购方地址 | 必填 | 
 | buyerPhone | string | 购方电话 | 必填 | 
 | buyerBank | string | 购方开户行 | 必填 | 
 | buyerBankAccount | string | 购方开户行账号 | 必填 | 
 | invoiceAmount | string | 开票金额 | 必填 | 
 | email |  | 邮箱 | 必填 |

# subTable: list/messageMemos
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | long | 系统订单号 |  | 
 | tid | string | 平台订单号 |  | 
 | buyerMessage | string | 买家留言 |  | 
 | sellerMemo | string | 卖家备注 |  | 
 | sysMemo | string | 系统备注 |  | 
 | sellerFlag | long | 卖家旗帜 |  | 
 | payment | string | 实付金额 |  | 
 | totalFee | string | 总额 |  | 
 | discountFee | string | 优惠金额 |  | 
 | postFee | string | 邮费 |  | 
 | acPayment | string | 不变的实付金额 |  | 
 | payAmount | string | 订单买家已付金额（单位：元） |  | 
 | theoryPostFee | double | 理论运费 |  | 
 | adjustFee | string | 手工调整订单价格 |  | 
 | paymentDisplay | string | 支付详情 |  | 
 | totalDiscountFee | string | 总共优惠的金额 |  | 
 | created | date | 下单时间 |  | 
 | payTime | date | 付款时间 |  | 
 | consignTime | date | 发货时间 |  | 
 | ptConsignTime | date | 平台发货时间 |  | 
 | taxFee | string | 税费 |  | 
 | saleFee | string | 分销金额 |  | 
 | grossProfit | string | 毛利润 |  | 
 | isHandlerMessage | integer | 是否处理买家留言： 0：未处理 1：已处理 |  | 
 | isHandlerMemo | integer | 是否处理卖家备注： 0：未处理 1：已处理 |  | 
 | addressChanged | integer | 是否标识订单地址修改，1标识 |  | 
 | isMergeMain | integer | 是否标识订单为合单主单，1标识 |  | 
 | unifiedStatus | string | 统一状态 |  | 
 | sysConsigned | integer | 是否ERP发货  0：未发货，1：ERP发货，2：其他ERP发货 |  | 
 | isUpload | integer | 是否上传 |  | 
 | userId | long | 店铺用户编号 |  | 
 | sysStatus | string | 订单系统状态 |  | 
 | actualPostFee | string | 实际运费 |  |

 

### 响应示例
```
{
  "traceId": "1876936694781585983",
  "list": [
    {
      "buyerNick": "XXXXX",
      "threePlTiming": 0,
      "type": "4,99,0",
      "receiverCity": "杭州市",
      "packmaCost": 0,
      "expressCode": "YUNDA",
      "payment": "42",
      "isExcep": 1,
      "receiverZip": "223700",
      "isTmallDelivery": 0,
      "isHalt": 0,
      "warehouseId": XXXX,
      "isRefund": 0,
      "receiverState": "浙江省",
      "orders": [
        {
          "discountRate": 100,
          "discountFee": "0.00",
          "payTime": 1592967330000,
          "num": 2,
          "source": "sys",
          "sysTitle": "12罐 美甲饰品天然鲍鱼贝壳片不规则指甲贴碎片 日系幻彩光疗甲",
          "type": 0,
          "tid": "XXXXXXX",
          "isPresell": 0,
          "consignTime": 946656000000,
          "updTime": 1592967337000,
          "price": "21.00",
          "giftNum": 0,
          "stockNum": 2,
          "modified": 946656000000,
          "stockStatus": "NORMAL",
          "payment": "42.00",
          "id": XXXXXXX,
          "created": 1592967330000,
          "insufficientCanceled": 0,
          "taobaoId": 0,
          "sysOuterId": "SKU000817",
          "saleFee": "0.0",
          "volume": 0,
          "picPath": "XXXXXXX",
          "netWeight": 0,
          "companyId": XXXXXX,
          "isVirtual": 0,
          "sysConsigned": 0,
          "oid": XXXXX,
          "itemSysId": XXXXXXX,
          "sid": XXXXXXX,
          "forcePackNum": 0,
          "sysStatus": "FINISHED_AUDIT",
          "sysItemOuterId": "XXXXXXX",
          "priceDouble": 21,
          "cost": 0,
          "isCancel": 0,
          "salePrice": "0.0",
          "combineId": 0,
          "ptConsignTime": 946656000000,
          "totalFee": "42.00",
          "sysPicPath": "XXXXXXX",
          "skuSysId": -1,
          "endTime": 946656000000
        }
      ],
      "expressCompanyId": 102,
      "isUrgent": 0,
      "theoryPostFee": 0,
      "warehouseName": "默认仓库",
      "itemNum": 2,
      "receiverDistrict": "滨江区",
      "taxFee": "0",
      "isHandlerMessage": 0,
      "grossProfit": 0,
      "salePrice": "0.00",
      "postFee": "0",
      "receiverMobile": "66876387840",
      "userId": 0,
      "splitType": -1,
      "itemKindNum": 1,
      "ptConsignTime": 946656000000,
      "endTime": 946656000000,
      "excep": 0,
      "splitSid": -1,
      "shortId": 63,
      "discountFee": "0.00",
      "payTime": 1592967330000,
      "mobileTail": "7840",
      "source": "sys",
      "templateId": XXXXXX,
      "tid": "XXXXXXX",
      "isPresell": 0,
      "consignTime": 946656000000,
      "updTime": 1632984391000,
      "modified": 946656000000,
      "stockStatus": "NORMAL",
      "created": 1592967330000,
      "taobaoId": 0,
      "weight": 0,
      "sysOuterId": "XXXXXXX",
      "saleFee": "0.00",
      "exceptions": [
        "EX_DELIVER"
      ],
      "volume": 0,
      "receiverAddress": "道588号恒鑫大厦10F光云科技349866876387841",
      "scalping": 0,
      "netWeight": 0,
      "companyId": XXXXXX,
      "sid": XXXXXX,
      "sysStatus": "WAIT_SEND_GOODS",
      "cost": 0,
      "isCancel": 0,
      "receiverName": "XXXXXXX",
      "isHandlerMemo": 0,
      "timeoutActionTime": 946656000000,
      "isPackage": 0,
      "expressCompanyName": "韵达快递",
      "totalFee": "42",
      "templateName": "K_韵达快递标准"
    }
  ],
  "total": 1,
  "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|查询的时间类型不合法！created: 下单时间, pay_time：付款时间，consign_time：发货时间，audit_time：审核时间，upd_time：修改时间]字段：[timeType]|50|检查参数是否合法||
|店铺ID格式不正确！|20014|检查参数是否合法||
|店铺ID数量最大支持10组！|20015|参数过长||
|订单状态不合法！[WAIT_BUYER_PAY：待付款，WAIT_AUDIT：待审核，WAIT_FINANCE_AUDIT：待财审，FINISHED_AUDIT：审核完成，WAIT_EXPRESS_PRINT：待打印快递单，WAIT_PACKAGE：待打包，WAIT_WEIGHT：待称重，WAIT_SEND_GOODS：待发货，WAIT_DEST_SEND_GOODS：待供销商发货，SELLER_SEND_GOODS：卖家已发货，FINISHED：交易完成，CLOSED：交易关闭]字段：[status]|50|检查参数是否合法||
|标签ID格式不正确|20101|检查参数是否合法||
|查询指定标签ID数量最大支持10组|20102|检查参数是否合法||
|标签ID格式不正确|20103|检查参数是否合法||
|排除标签ID数量最大支持10组|20104|检查参数是否合法||
|自定义异常标签ID格式不正确|20105|检查参数是否合法||
|自定义异常标签ID数量最大支持10组|20106|检查参数是否合法||
|系统异常标签ID数量最大支持10组|20108|检查参数是否合法||
|异常查询状态不合法！[1:仅包含  2:排除  3:同时包含]|50|检查参数是否合法||
|订单查询失败|30077|请根据返回的错误信息进行处理||

---

## 创建自建平台订单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E5%88%9B%E5%BB%BA%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0%E8%AE%A2%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/100-%E5%88%9B%E5%BB%BA%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0%E8%AE%A2%E5%8D%95.md

# 创建自建平台订单

**请求方法:** POST

### 接口描述
主要是开放给自建平台/自建商城导入订单数据至ERP，仅支持店铺类型为‘自建平台’的店铺使用该接口创建订单，原名为‘创建订单V2’

### 系统相关界面
"界面路径：【交易】----【订单管理】----【新建订单】"
### 接口说明

该接口可支持自建平台订单的创建，且支持修改指定的订单平台状态，但是不允许逆向流转。

订单平台状态流转：\
WAIT_BUYER_PAY(等待买家付款)-->WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款)-->WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货)-->TRADE_FINISHED(交易成功)/TRADE_CLOSED(付款以后用户退款成功，交易自动关闭)

- 请求参数status指定为‘WAIT_BUYER_PAY’，则订单平台状态为‘待付款’（WAIT_BUYER_PAY），系统状态为‘待付款’（WAIT_BUYER_PAY）；
- 请求参数status指定为‘WAIT_SELLER_SEND_GOODS’，则订单平台状态为‘待发货’（WAIT_SELLER_SEND_GOODS），系统状态为‘待审核’（WAIT_AUDIT）；
- 请求参数status指定为‘WAIT_BUYER_CONFIRM_GOODS’，则订单平台状态为‘已发货’（WAIT_BUYER_CONFIRM_GOODS），系统状态为‘卖家已发货’（SELLER_SEND_GOODS）；
- 请求参数status指定为‘TRADE_FINISHED’，则订单平台状态为‘交易成功’（TRADE_FINISHED），系统状态为‘交易成功’（FINISHED）；
- 请求参数status指定为‘TRADE_CLOSED’，则订单平台状态为‘交易关闭’（TRADE_CLOSED），系统状态为‘交易关闭’（CLOSED）；

注意：
1. 此接口只能创建或修改店铺类型为‘自建平台’的订单。在【基础】--【店铺管理】--【新增店铺】，选择‘自建平台’店铺类型，填写店铺名称等信息，保存；
2. 自建平台的订单不需要通过商品对应表进行对应，创建订单前需要提前在快麦ERP中维护好系统商品，系统商品可直接在快麦里维护，也可通过接口同步商品资料；
3. 此接口不支持修改订单中的商品信息，包括增删改商品，修改商品数量，商品实付金额等操作；
4. 此接口支持修改订单商品的退款状态，请求参数refundStatus可指定的状态包括：‘待卖家同意退款’（WAIT_SELLER_AGREE）、‘退款成功’（SUCCESS）、‘退款关闭‘（CLOSED）、’待买家退货‘（WAIT_BUYER_RETURN_GOODS）、’待卖家确认收货‘（WAIT_SELLER_CONFIRM_GOODS）；
5. 待付款订单如果要推送到快麦ERP，需要在【基础】-【系统配置】-【交易配置】-【订单配置】中的‘平台对接’勾选‘同步待付款订单’配置。

### 实际案例
 #### 场景1
trade设置为已发货， order设置为已发货，同步到erp的订单会更新为其他ERP发货，并且不扣库存
 #### 场景2
trade设置为未发货 ，其中部分order为已发货，部分order为待发货，设置为已发货的order会执行发货并且显示是其他Erp发货，设置为待发货的order为待审核

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.create.new | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | tid | string | 平台订单号 | 必填 |  | 
 | userId | long | 店铺编号 | 必填 |  | 
 | status | string | 订单平台状态 WAIT_BUYER_PAY(等待买家付款)，WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款) ，WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货) ，TRADE_FINISHED(交易成功) ，TRADE_CLOSED(付款以后用户退款成功，交易自动关闭)  | 必填 |  | 
 | receiverName | string | 收件人姓名 | 必填 |  | 
 | receiverState | string | 收件省份 | 必填 |  | 
 | receiverCity | string | 收件市 | 必填 |  | 
 | receiverDistrict | string | 收件区县 | 必填 |  | 
 | receiverStreet | string | 收件街道 | 必填 |  | 
 | receiverAddress | string | 收件详细地址 | 必填 |  | 
 | receiverZip | string | 收件邮编 |  |  | 
 | receiverMobile | string | 收件人手机号 | 必填 |  | 
 | receiverPhone | string | 收件人固话 |  |  | 
 | orders | array | 订单商品明细 | 必填 |  | 
 | payment | string | 订单实付金额（例如1.00）（单位：元） | 必填 |  | 
 | postFee | string | 运费（单位：元） |  |  | 
 | buyerNick | string | 平台订单上的买家昵称 该字段是触发合单的关键标识字段，如为空则无法执行自动合单，可以使用收件人名字，或者收件人手机号作为 buyerNick值 |相同收件人订单进入系统需要自动合并必填  |  | 
 | buyerMessage | string | 平台订单上的买家留言 |  |  | 
 | sellerFlag | string | 订单旗帜 0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红 |  |  | 
 | sellerMemo | string | 平台上的卖家备注 |  |  | 
 | invoiceKind | string | 发票种类  1.电子发票 2.纸质发票  |  |  | 
 | invoiceName | string | 发票抬头 |  |  | 
 | buyerTaxNo | string | 买家税号 |  |  | 
 | invoiceRemark | string | 发票备注 |  |  | 
 | invoiceFormat | string | 发票类型 1.普通发票 2.增值税发票 |  |  | 
 | subSource | string | 次来源地 |  |  | 
 | created | string | 下单时间 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | payTime | string | 付款时间 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | consignTime | string | 发货时间 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | timeoutActionTime | string | 承诺发货时间 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | outSid | string | 运单号 |  |  | 
 | type | string | 订单类型， cod:货到付款 |  |  | 
 | trades | string | 批量订单数据，优先批量订单数据 |  |  | 

# subTable: orders
 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | oid | long | 平台子订单号 |  |  | 
 | outerId | string | 商家编码/规格商家编码（最小粒度商家编码） | 必填 |  | 
 | price | string | 商品销售价（单位：元） | 必填 |  | 
 | num | integer | 商品数量（大于0） | 必填 |  | 
 | giftNum | integer | 大于0则为赠品 |  |  | 
 | payment | string | 实付金额（例如1.00）（单位：元） | 必填 |  | 
 | title | string | 商品标题 |  |  | 
 | picPath | string | 商品图片 |  |  | 
 | status | string | 子订单平台状态 WAIT_BUYER_PAY(等待买家付款)，WAIT_SELLER_SEND_GOODS(等待卖家发货,即:买家已付款) ，WAIT_BUYER_CONFIRM_GOODS(等待买家确认收货,即:卖家已发货) ，TRADE_FINISHED(交易成功) ，TRADE_CLOSED(付款以后用户退款成功，交易自动关闭)  |  |  | 
 | refundStatus | string | 子订单平台退款状态 WAIT_SELLER_AGREE（待卖家同意退款）、SUCCESS（退款成功）、CLOSED（退款关闭）、WAIT_BUYER_RETURN_GOODS（待买家退货）、WAIT_SELLER_CONFIRM_GOODS（待卖家确认收货） |  |  | 
 | orderExt | object | 子订单扩展信息 |  |  | 
 
 # subTable: orders/orderExt
 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | orderRemark | string | 订单商品备注 |  |  | 

### 请求示例
示例一：

````
{
    "payTime": "2022-10-09 01:07:52",
    "created": "2022-10-09 01:07:52",
    "receiverName": "XXXXX",
    "receiverMobile": "XXXXX",
    "userId": "XXXXXX",
    "receiverCity": "长沙市",
    "tid": "202210090001",
    "receiverAddress": "雷锋大道莱茵城",
    "receiverDistrict": "岳麓区",
    "receiverState": "湖南省",
    "payment": "23.60",
    "orders": "[{\"price\":4.90,\"num\":1,\"outerId\":XXXXXXX,\"payment\":2.85,\"title\":\"XXXXXX\"}]",
    "status": "WAIT_SELLER_SEND_GOODS"
}
````
示例二：

````
{
    "trades": "[{\"payTime\":\"2022-10-09 01:07:52\",\"created\":\"2022-10-09 01:07:52\",\"receiverName\":\"陆哲痕\",\"receiverMobile\":\"17701608823\",\"userId\":\"143851\",\"receiverCity\":\"长沙市\",\"tid\":\"202210090004\",\"receiverAddress\":\"雷锋大道莱茵城\",\"receiverDistrict\":\"岳麓区\",\"receiverState\":\"湖南省\",\"payment\":\"23.60\",\"orders\":[{\"price\":4.9,\"num\":1,\"outerId\":\"test0049\",\"payment\":2.85,\"title\":\"测试0049\"}],\"status\":\"WAIT_SELLER_SEND_GOODS\"},{\"payTime\":\"2022-10-09 01:07:52\",\"created\":\"2022-10-09 01:07:52\",\"receiverName\":\"陆哲痕\",\"receiverMobile\":\"17701608823\",\"userId\":\"143851\",\"receiverCity\":\"长沙市\",\"tid\":\"202210090005\",\"receiverAddress\":\"雷锋大道莱茵城\",\"receiverDistrict\":\"岳麓区\",\"receiverState\":\"湖南省\",\"payment\":\"23.60\",\"orders\":[{\"price\":4.9,\"num\":1,\"outerId\":\"test0049\",\"payment\":2.85,\"title\":\"测试0049\"}],\"status\":\"WAIT_SELLER_SEND_GOODS\"}]"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 
 | sid | long | 系统订单号 | 必填 | 
 | tradeList | List | 批量返回 | 必填 | 

# subTable: tradeList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | Long | ERP的Trade流水号，系统生成，全系统唯一 | 必填 | 
 | tid | String | 平台订单号 | 必填 | 

 

### 响应示例

### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.create.new:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|50|发票种类类型不合法！[1（电子发票）；2（纸质发票）]|请检查该参数的值是否规范|
|50|需要开具发票类型不合法！[0（关闭）；1（开启）]|请检查该参数的值是否规范|
|50|发票类型不合法！[1（普通）；2（增值）]|请检查该参数的值是否规范|
|50|旗帜类型不合法！0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红 |请检查该参数的值是否规范|
|50|订单的平台状态枚举值不合法！|请检查该参数的值是否规范|
|30051|店铺编号不能为空|请检查店铺编号是否有值|
|30052|订单商品明细集合不能为空|订单商品明细集合不能为空|
|30053|收件人姓名不能为空|请检查该字段是否有值|
|30055|收件省份不能为空|请检查该字段是否有值|
|30056|收件市不能为空|请检查该字段是否有值|
|30057|收件详细地址不能为空|请检查该字段是否有值|
|30058|收件区县不能为空|请检查该字段是否有值|
|30059|实付金额不能为空|请检查该字段是否有值|
|30060|邮费不能为空|请检查该字段是否有值|
|30061|orders参数传入有误，解析失败|请检查该字段是否有值|
|30062|自定义赠品类型值不合法|请检查该参数的值是否规范|
|30063|是否是虚拟商品类型值不合法|请检查该参数的值是否规范|
|30065|收件人手机号不能为空|请检查该字段是否有值|
|30066|收件人手机号格式有误|请检查该参数的值是否规范，应为11位数字|
|30067|商家编码不能为空|请检查该字段是否有值|
|30068|商品销售价不能为空|请检查该字段是否有值|
|30069|商品销售价格式错误|请检查该参数的值是否规范|
|30070|子订单商品数量不能为空|请检查该字段是否有值|
|30071|实付金额格式错误|请检查该参数的值是否规范|
|30072|平台编号不能为空|请检查该字段是否有值|
|30073|平台状态不能为空|请检查该字段是否有值|
|30074|邮费格式错误|请检查该参数的值是否规范|

---

## 波次播种回传

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E6%B3%A2%E6%AC%A1%E6%92%AD%E7%A7%8D%E5%9B%9E%E4%BC%A0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1000-%E6%B3%A2%E6%AC%A1%E6%92%AD%E7%A7%8D%E5%9B%9E%E4%BC%A0.md

# 波次播种回传

**请求方法:** POST

### 接口描述
波次播种回传，用于将已经播好的商品回传到系统

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.wave.seed | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | waveId | long | 波次号 | 必填 | 
 | list | string | 播种详情json字符串，注意字符串里面双引号要加反斜杠转义符 见示例 | 必填 | 
 | jobNum | string | 员工工号 |  | 

 

### 请求示例
示例一：

````
{
  "waveId":1111,
  "list":"[{
    "details": [{
      "matchedNum": 5, //播种的数量
      "outerId": "MN-milk" //商家编码
    }],
    "positionNo": 1 //位置号
  }]"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | errorList | object | 播种异常的信息 |  | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

# subTable: errorList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | positionNo | long | 位置号 |  | 
 | errorOuterIdList | object | 异常的商家编码信息 |  | 
 | errorMsg | string | 异常信息 | 必填 | 

# subTable: errorList/errorOuterIdList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商品商家编码 | 必填 | 
 | unMatchedNum | integer | 未正常播种的数量 | 必填 | 

 

### 响应示例
```
播种成功响应：
{
    "traceId": "2475286737140096010",
    "success": true
}

存在异常播种响应：
{
    "traceId": "2475286737140096010",
    "errorList": [
        {
            "errorOuterIdList": [
                {
                    "outerId": "MN-milk",
                    "unMatchedNum": 4
                }
            ],
            "positionNo": 1,
            "errorMsg": "位置号1播种数量大于可播数量!"
        }
    ],
    "success": false
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.wave.seed:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.trade.multi.packs.query:1.0)的签名无效|签名参数错误|

---

## 新增商品唯一码

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E6%96%B0%E5%A2%9E%E5%95%86%E5%93%81%E5%94%AF%E4%B8%80%E7%A0%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1050-%E6%96%B0%E5%A2%9E%E5%95%86%E5%93%81%E5%94%AF%E4%B8%80%E7%A0%81.md

# 新增商品唯一码

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【唯一码管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.unique.code.generate | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | generateParams | string | 入参json字符串 | 必填 |  | 
 | businessType | int | 溯源码导入固定传14 | 非必填 |  | 

 

### 请求示例
示例一：

````
[
    {
        "uniqueCode": "uniqueCode", // 唯一码 必传
        "parentUniqueCode": "parentUniqueCode", // 父唯一码 非必传
        "outerId": "outerId", // 商家编码 是sku商品传sku商家编码 必传
        "status": 5, // 唯一码状态 非必传 不传默认是10 枚举看下面唯一码状态枚举
        "supplierId": 1121380, // 供应商id 必传
        "sellingPrice":1.11, // 销售价 非必传
        "costPrice":1.11, // 成本价 非必传
        "weight":1.11, // 重量 非必传
        "itemBatchNo": "itemBatchNo", // 批次 非必传
        "productionDate": "2024-06-19", // 效期 非必传
        "warehouseId": 69583, // 仓库id 只有当status=6时不用传 其他状态都要传
        "goodsSectionCode":"goodsSectionCode", // 货位编码  非必传 tips：当status=11时，此字段必传
        "goodsSectionId":1234, // 货位id 非必传
        "stockPosition": 2, // 库存位置 非必传 枚举看下面唯一码库存位置枚举
        "ICCID": "ICCID", // iccid编码 非必传
        "boxCode": "boxCode" // 箱码 非必传
    }
]
````
唯一码状态枚举：
4："等待收货",
5："已收货",
6："已出库",
10："待入库",
11："在库",
12："已作废",
14： "已退回",
15："已采退"

库存位置枚举：
1： "货位",
2： "入库暂存区",
3： "拣选暂存区",
4： "销退暂存区",
5： "采退暂存区",
6： "次品暂存区",
7： "通用暂存区",
8： "补货暂存区",
9： "出库暂存区"
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 唯一码列表 |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 | total | long | 总数 |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | codeType | integer | 默认0；1（单）；2（多）；3（备） |  | 
 | orderId | long | 子订单id |  | 
 | created | long | 创建时间 |  | 
 | sysItemId | long | 系统主商品ID  |  | 
 | refundStatus | string | WAIT_SELLER_AGREE --待卖家同意退款 WAIT_BUYER_RETURN_GOODS--待买家退货 WAIT_SELLER_CONFIRM_GOODS--待卖家确认收货 SELLER_REFUSE_BUYER--卖家同意退款 CLOSED--退款关闭 SUCCESS--退款成功 NO_REFUND--未退款 |  | 
 | positionStockRegion | string | 分拣库区 |  | 
 | sid | long | 系统订单号 |  | 
 | sysSkuId | long | 系统商品skuID （注意，纯商品是-1） |  | 
 | uniqueCode | string | 唯一码 |  | 
 | modified | long | 修改时间 |  | 
 | outerId | string | 平台商家编码 |  | 
 | positionNo | string | 分拣货位 |  | 
 | printTime | long | 打印时间 |  | 
 | status | integer | 唯一码状态 1-等待采购, 2-等待拣选, 3-已拣选, 4-等待收货, 5-已收货, 6-已出库, 7-已取消, 8-已下架, 9-已出库未收货, 10-待入库, 11-在库, 12-已作废, 13-已验货, 14-已退回, 15-已采退 |  | 
 | waveId | long | 波次号 | 必填 | 
 | ICCID | string | iccid编码 | 必填 | 
 | serialNumberStr | string | 唯一码流水号 | 必填 | 
 | mainOuterId | string | 主商家编码 | 必填 | 
 | skuOuterId | string | 规格商家编码 | 必填 | 
 | sellingPrice | double | 销售价 | 必填 | 
 | costPrice | double | 成本价 | 必填 | 
 | weight | double | 重量 | 必填 | 
 | itemBatchNo | string | 商品批次号 | 必填 | 
 | productionDate | date | 效期 | 必填 | 
 | itemPeriodCast | string | 主商品保质期 | 必填 | 
 | skuPeriodCast | string | 规格商品保质期 | 必填 | 
 | warehouseId | long | 仓库id | 必填 | 
 | stockPosition | integer | 库存位置 | 必填 | 
 | goodsSectionId | long | 货位id | 必填 | 
 | goodsSectionCode | string | 货位编码 | 必填 | 
 | boxCode | string | 箱码 | 必填 | 
 | printNum | integer | 打印次数 | 必填 | 
 | customPrintTime | date | 自定义打印时间 | 必填 | 
 | afterSaleOrderCode | string | 售后工单编号 | 必填 | 
 | saleReturnOrderCode | string | 销退入库单编号 | 必填 | 
 | warehouseEntryCode | string | 关联收货单 | 必填 | 
 | purchaseReturnCode | string | 采退单 | 必填 | 
 | businessCode | string | 采购单 | 必填 | 
 | otherWarehousingOrderCode | string | 其他入库单编号 | 必填 | 
 | otherOutboundOrderCode | string | 其他出库单编号 | 必填 | 

 

### 响应示例
```
{
    "traceId": "3668774785566822984",
    "success": true,
    "list": [
        {
            "codeType": 3,
            "sysItemId": 607817348897280,
            "num": 1,
            "sellingPrice": 0.0,
            "uniqueCode": "baolsOpen122",
            "skuOuterId": "baolsOpen1",
            "created": 1718768409074,
            "costPrice": 0.0,
            "stockPosition": 0,
            "sysSkuId": 0,
            "warehouseId": 69583,
            "outerId": "baolsOpen1",
            "status": 10
        }
    ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.unique.code.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|系统订单号数量最大支持20组！|20003|参数过长||
|内部单号数量最大支持20组！|20005|参数过长||
|售后单号数量最大支持20组！|20006|参数过长||
|唯一码类型不合法！[1（单）；2（多）；3（备）]|50|枚举值不合法||
|是否查询总数枚举值不合法！[true/false]|50|枚举值不合法||
|系统订单号格式不正确！|20009|检查参数是否合法||
|内部订单号格式不正确|20011|检查参数是否合法||
|售后单号格式不正确|20012|检查参数是否合法||

---

## 校验波次唯一码

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E6%A0%A1%E9%AA%8C%E6%B3%A2%E6%AC%A1%E5%94%AF%E4%B8%80%E7%A0%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1100-%E6%A0%A1%E9%AA%8C%E6%B3%A2%E6%AC%A1%E5%94%AF%E4%B8%80%E7%A0%81.md

# 校验波次唯一码

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【唯一码管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.wave.unique.code.validate | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | uniqueCodes | string | 唯一码号,多个逗号隔开，最多支持20组（时间或者唯一码 其中一项必填） |  |  | 
 | startTime | string | 起始时间:格式yyyy-MM-dd HH:mm:ss，与endTime同时使用，时间跨度建议小时数不超过24 |  |  | 
 | endTime | string | 截止时间:格式yyyy-MM-dd HH:mm:ss，与startTime同时使用，时间跨度建议小时数不超过24 |  |  | 
 | pageNo | Integer | 页码 |  |  | 
 | pageSize | Integer | 每页多少条，最大支持500，不能小于50 |  |  | 

 

### 请求示例
示例一：

````
{
 "uniqueCodes":"baolsOpen124,MN-milk%2c439686%2c2%2c1002"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | errorList | array | 校验失败唯一码列表 |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 

# subTable: errorList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | waveId | long | 波次号 | 必填 | 
 | uniqueCode | string | 唯一码 | 必填 | 
 | sid | long | 订单号 | 必填 | 
 | errorMsg | string | 错误信息 | 必填 | 

 

### 响应示例
```
{
    "traceId": "3669319614952014527",
    "errorList": [
        {
            "uniqueCode": "baolsOpen124",
            "errorMsg": "该唯一码不存在"
        },
        {
            "uniqueCode": "MN-milk%2c439686%2c2%2c1002",
            "waveId": 439686,
            "errorMsg": "关联订单异常",
            "sid": 4123793511494333
        }
    ],
    "hasNext": true,
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.wave.unique.code.validate:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|唯一码数量最大支持20组!|20029|参数过长||

---

## 商品唯一码更新

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E5%95%86%E5%93%81%E5%94%AF%E4%B8%80%E7%A0%81%E6%9B%B4%E6%96%B0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1150-%E5%95%86%E5%93%81%E5%94%AF%E4%B8%80%E7%A0%81%E6%9B%B4%E6%96%B0.md

# 商品唯一码更新

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【唯一码管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.unique.code.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | generateParams | string | 入参json字符串 | 必填 |  | 

 

### 请求示例
示例一：

````
[
    {
        "uniqueCode": "YS001%2c000371",  // 唯一码 必传
        "extendField2": "extendField2",  // 扩展字段2
        "extendField3": "extendField3",  // 扩展字段3
        "extendField4": "extendField4",  // 扩展字段4
        "extendField5": "extendField5",  // 扩展字段5
        "ICCID": "ICCID"  // 扩展字段1
    }
]
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 唯一码列表 |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | uniqueCode | string | 唯一码 |  | 
 | extendField2 | string | 扩展字段2 |  | 
 | extendField3 | string | 扩展字段3 |  | 
 | extendField4 | string | 扩展字段4  |  | 
 | extendField5 | string | 扩展字段5 |  | 
 | ICCID | string | 扩展字段1 |  | 

 

### 响应示例
```
{
    "traceId": "3668774785566822984",
    "success": true,
    "list": [
        {
        "uniqueCode": "YS001%2c000371",  
        "extendField2": "extendField2",  
        "extendField3": "extendField3", 
        "extendField4": "extendField4",  
        "extendField5": "extendField5",  
        "ICCID": "ICCID"  
    }
    ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.unique.code.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|系统订单号数量最大支持20组！|20003|参数过长||
|内部单号数量最大支持20组！|20005|参数过长||
|售后单号数量最大支持20组！|20006|参数过长||
|唯一码类型不合法！[1（单）；2（多）；3（备）]|50|枚举值不合法||
|是否查询总数枚举值不合法！[true/false]|50|枚举值不合法||
|系统订单号格式不正确！|20009|检查参数是否合法||
|内部订单号格式不正确|20011|检查参数是否合法||
|售后单号格式不正确|20012|检查参数是否合法||

---

## 修改订单仓库

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E4%BB%93%E5%BA%93
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1200-%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E4%BB%93%E5%BA%93.md

# 修改订单仓库

**请求方法:** POST

### 系统相关界面
"界面路径：【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.change.warehouse | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sids | string | 系统订单号,多个逗号隔开 |  |  | 
 | warehouseId | long | 仓库ID |  |  | 
 | force | boolean | 库存不足时是否强制换仓库 |  |  | 

 

### 请求示例
示例一：

````
{
 "sids":"5058208293858409,5058109148706961",
 "warehouseId": 11232,
 "force":true
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 

### 响应示例
```
{
    "traceId": "3669319614952014527",
    "success": true
}
```
### 异常示例
````
{
    "traceId": "4071991477422416710",
    "msg": "对应仓库null不存在",
    "code": "33",
    "success": false
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|唯一码数量最大支持20组!|20029|参数过长||

---

## 更新订单物流模板

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E6%9B%B4%E6%96%B0%E8%AE%A2%E5%8D%95%E7%89%A9%E6%B5%81%E6%A8%A1%E6%9D%BF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1300-%E6%9B%B4%E6%96%B0%E8%AE%A2%E5%8D%95%E7%89%A9%E6%B5%81%E6%A8%A1%E6%9D%BF.md

# 更新订单物流模板

**请求方法:** POST

### 系统相关界面
"界面路径：【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.logistics.template.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sids | string | 系统订单号,多个逗号隔开 |  |  | 
 | logisticsCompanyId | long | 用户物流公司ID |  |  | 

 

### 请求示例
示例一：

````
{
 "sids":"5058208293858409,5058109148706961",
 "logisticsCompanyId": 11232
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 | logisticsCompanyId | string | 物流公司ID |  | 
 | logisticsCompanyName | string | 物流公司名称 |  | 
 | errorList | array |  |  | 
 | successList | array |  |  | 
 # subTable: errorList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | long | 系统单号|  | 
 | tid | string | 平台单号 |  | 
 | outSid | string | 运单号 |  | 
 | logisticsCompanyName | string | 快递公司名称 |  | 
 | errorCode | string | 错误码 |  | 
 | mesage | string | 错误描述 |  | 
 | canDelivered | int | 快递是否可送达，0表示不可送达，1表示可送达，默认为1 |  | 

 # subTable: successList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | long | 系统单号|  | 
 | tid | string | 平台单号 |  | 
 | outSid | string | 运单号 |  | 
 | logisticsCompanyName | string | 快递公司名称 |  | 
 | errorCode | string | 错误码 |  | 
 | mesage | string | 错误描述 |  | 
 | canDelivered | int | 快递是否可送达，0表示不可送达，1表示可送达，默认为1 |  | 

### 响应示例
```
{
    "traceId": "3895683976502069544",
    "successList": [
        {
            "canDelivered": 9,
            "sid": 4970434559354826
        }
    ],
    "logisticsCompanyId": 46,
    "logisticsCompanyName": "中通快递",
    "success": true
}
```
### 异常示例
````
{
    "traceId": "4071991477422416710",
    "msg": "对应仓库null不存在",
    "code": "33",
    "success": false
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|唯一码数量最大支持20组!|20029|参数过长||

---

## 获取物流单号

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E8%8E%B7%E5%8F%96%E7%89%A9%E6%B5%81%E5%8D%95%E5%8F%B7
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1340-%E8%8E%B7%E5%8F%96%E7%89%A9%E6%B5%81%E5%8D%95%E5%8F%B7.md

# 获取物流单号

**请求方法:** POST

### 系统相关界面
"界面路径：【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.waybill.code.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sids | string | 系统订单号,多个逗号隔开 |  |  | 

 

### 请求示例
示例一：

````
{
 "sids":"5058208293858409,5058109148706961"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true |  | 
 | traceId | string | 示例：3553483395407017 |  | 
 | errorMessage | string | 错误信息 |  | 
 | errorList | array |  |  | 
 | successList | array |  |  | 
 # subTable: errorList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | long | 系统单号|  | 
 | tid | string | 平台单号 |  | 
 | outSid | string | 运单号 |  | 
 | errorCode | string | 错误码 |  | 
 | errorMsg | string | 错误描述 |  | 

 # subTable: successList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | long | 系统单号|  | 
 | tid | string | 平台单号 |  | 
 | outSid | string | 运单号 |  | 
 | errorCode | string | 错误码 |  | 

### 响应示例
```
{
    "traceId": "3895683976502069544",
    "successList": [
        {
            "outSid": "34566577755",
            "sid": 4970434559354826
        }
    ],
    "success": true
}
```
### 异常示例
````
{
    "traceId": "4071991477422416710",
    "msg": "对应仓库null不存在",
    "code": "33",
    "success": false
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|唯一码数量最大支持20组!|20029|参数过长||

---

## 用户物流公司列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E7%94%A8%E6%88%B7%E7%89%A9%E6%B5%81%E5%85%AC%E5%8F%B8%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1350-%E7%94%A8%E6%88%B7%E7%89%A9%E6%B5%81%E5%85%AC%E5%8F%B8%E5%88%97%E8%A1%A8.md

# 用户物流公司列表

**请求方法:** POST

### 系统相关界面
"界面路径：【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.logistics.company.user.list | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | warehouseId | long | 仓库ID |  |  | 

 

### 请求示例
示例一：

````
{
 "warehouseId": 11232
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 | list | array |  |  | 
 # subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 用户物流公司ID |  | 
 | name | string | 物流公司名称 |  | 
 | cloudTemplatePaperType | string | 纸张类型 1： 一联单(76*100)2: 一联单(76*130)3: 二联单（100*150）4: 标准二联单（100*180）5: 三联单（100*210） |  | 
 | expressId | long | 物流公司ID |  | 
 | cpCode | string | 物流服务商ID |  | 
 | cpType | string | 物流服务商业务类型 1：直营 2：加盟 3：落地配 4：直营带网点 |  | 
 | liveStatus | int | 是否停用  0 停用 1 启用 |  | 
 | warehouseIdList | array | 绑定的仓库列表 |  | 
 | created |  date |  创建时间 |  | 
 | modified | date |  创建时间 |  | 

### 响应示例
```
{
    "traceId": "3895683976502069544",
    "list": [
        {
            "cpCode": "YUNDA",
            "cpType": 2,
            "created": 1687157756000,
            "warehouseIdList": [
                85692
            ],
            "companyId": 10438,
            "name": "韵达快递",
            "modified": 1722223766000,
            "id": 49,
            "cloudTemplatePaperType": 2,
            "enableStatus": 1,
            "liveStatus": 1,
            "expressId": 102
        },
        {
            "cpCode": "JBD",
            "created": 1722219922000,
            "warehouseIdList": [
                85692
            ],
            "companyId": 10438,
            "name": "京邦达快递",
            "modified": 1722219922000,
            "id": 275,
            "cloudTemplatePaperType": 1,
            "enableStatus": 1,
            "liveStatus": 1,
            "expressId": 313
        }
    ],
    "success": true
}
```
### 异常示例
````
{
    "traceId": "4071991477422416710",
    "msg": "对应仓库null不存在",
    "code": "33",
    "success": false
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|唯一码数量最大支持20组!|20029|参数过长||

---

## 用户物流模板列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E7%94%A8%E6%88%B7%E7%89%A9%E6%B5%81%E6%A8%A1%E6%9D%BF%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1370-%E7%94%A8%E6%88%B7%E7%89%A9%E6%B5%81%E6%A8%A1%E6%9D%BF%E5%88%97%E8%A1%A8.md

# 用户物流模板列表

**请求方法:** POST

### 系统相关界面
"界面路径：【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.logistics.template.user.list | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | warehouseId | long | 仓库ID | 必填 |  | 

 

### 请求示例
示例一：

````
{
 "warehouseId": 11232
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 | list | array |  |  | 
 # subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 用户物流模板ID |  | 
 | name | string | 物流模板名称 |  | 
 | expressId | long | 快递公司ID |  | 
 | expressName | long | 快递公司名称 |  | 
 | cpCode | string | 物流服务商ID |  | 
 | groupId | string | 分组的id |  | 
 | cpType | string | 物流服务商业务类型 1：直营 2：加盟 3：落地配 4：直营带网点 |  | 
 | liveStatus | int | 是否停用  0 停用 1 启用 |  | 
 | isWlb | array | 是否是电子面单类型   0 否 1 是 |  | 
 | cod | array | 是否是cod模版   0 否 1 是  |  | 
 | wlbTemplateType | array | 电子面单模版类型,0菜鸟 1对接网点   |  | 
 | created |  date |  创建时间 |  | 
 | modified | date |  创建时间 |  | 

### 响应示例
```
{
    "traceId": "5388584898316656671",
    "success": true,
    "list": [
        {
            "templateType": 1,
            "cpType": 2,
            "cloudTemplateId": 401,
            "groupId": 102,
            "liveStatus": 1,
            "isWlb": 1,
            "taobaoId": 949027246592,
            "expressName": "韵达快递",
            "wlbTemplateType": 2,
            "name": "K_韵达快递标准",
            "expressId": 102
        },
        {
            "templateType": 1,
            "cpType": 2,
            "cloudTemplateId": 76303,
            "groupId": 102,
            "liveStatus": 1,
            "isWlb": 1,
            "taobaoId": 949027246592,
            "expressName": "韵达快递",
            "wlbTemplateType": 2,
            "name": "K_韵达快递标准三联",
            "expressId": 102
        }
    ]
}
```
### 异常示例
````
{
    "traceId": "4071991477422416710",
    "msg": "对应仓库null不存在",
    "code": "33",
    "success": false
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||

---

## 即入即出匹配

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E5%8D%B3%E5%85%A5%E5%8D%B3%E5%87%BA%E5%8C%B9%E9%85%8D
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1400-%E5%8D%B3%E5%85%A5%E5%8D%B3%E5%87%BA%E5%8C%B9%E9%85%8D.md

# 即入即出匹配

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【唯一码管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.fast.stock.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | outerId | string | 商家编码(支持售后唯一码) |  |  | 
 | num | Integer | 商品数量 |  |  | 
 | type | Integer | null或0-售后入仓 1-采购入仓 |  |  | 
 | needGoodsSection | boolean | 是否显示不可发商品关联货位 |  |  | 
 | warehouseCode | string | 仓库编码 |  |  | 
 | useSystemConfig | boolean | 是否使用系统中开启的环节配置 null或true-使用系统配置 false-不使用系统配置 |  |  | 
 | goodsSectionSortType | Integer | 货位排序类型 null或0-编码排序 1-拣选区-备货区-次品区，同级别再按编码排序 2-备货区-拣选区-次品区，同级别再按编码排序 |  |  | 

 

### 请求示例
示例一：

````
{
 "outerId":"139108436810453230",
 "num":1,
 "warehouseCode":"A"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | fastInOutStockVO | object | 匹配结果 |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 

# subTable: fastInOutStockVO
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | shipNum | integer | 可发数 | 必填 | 
 | unShipNum | integer | 不可发数 | 必填 | 
 | goodsSectionCode | string | 货位编码 | | 

 

### 响应示例
```
{
    "traceId": "4115985342831359490",
    "success": true,
    "fastInOutStockVO": {
        "shipNum": 1,
        "unShipNum": 0,
        "goodsSectionCode":"A"
    }
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.fast.stock.update:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||

---

## 修改订单商品备注

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E5%95%86%E5%93%81%E5%A4%87%E6%B3%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1450-%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E5%95%86%E5%93%81%E5%A4%87%E6%B3%A8.md

# 修改订单商品备注

**请求方法:** POST

### 系统相关界面
"界面路径：【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.order.remark.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | orderId | long | 订单商品行ID |  |  | 
 | remark | string | 备注 |  |  | 

 

### 请求示例
示例一：

````
{
 "orderId":5058208293858409,
 "remark":"测试"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 

### 响应示例
```
{
    "traceId": "3669319614952014527",
    "success": true
}
```
### 异常示例
````
{
    "traceId": "4071991477422416710",
    "msg": "更新失败",
    "code": "33",
    "success": false
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|唯一码数量最大支持20组!|20029|参数过长||

---

## 批量修改订单商品备注

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E6%89%B9%E9%87%8F%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E5%95%86%E5%93%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1460-%E6%89%B9%E9%87%8F%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E5%95%86%E5%93%81.md

# 批量修改订单商品备注

**请求方法:** POST

### 系统相关界面
"界面路径：【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.order.remark.batchUpdate | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sid | long | 平台单号和系统订单号二选一 |  |  | 
 | tid | long | 平台单号和系统订单号二选一 |  |  | 
 | orders | array | 订单行信息 |  |  | 

 
# subTable: orders
 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | oid | long | 平台子订单号	 |  |  | 
 | orderId | long | 订单商品行ID |  |  | 
 | remark | string | 备注 |  |  | 

 

### 请求示例
示例一：

````
{
"sid":5058208293858407,
"orders":"[{\"orderId\":5607186216589866,\"remark\":\"支付方式:余额/23/,订单类型:,订单编号:0001\"},{\"orderId\":5607186216589867,\"remark\":\"支付方式:余额/23/,订单类型:,订单编号:0002\"}]"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 

### 响应示例
```
{
    "traceId": "3669319614952014527",
    "success": true
}
```
### 异常示例
````
{
    "traceId": "4071991477422416710",
    "msg": "更新失败",
    "code": "33",
    "success": false
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|唯一码数量最大支持20组!|20029|参数过长||

---

## 销售出库查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E9%94%80%E5%94%AE%E5%87%BA%E5%BA%93%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/150-%E9%94%80%E5%94%AE%E5%87%BA%E5%BA%93%E6%9F%A5%E8%AF%A2.md

# 销售出库查询

**请求方法:** POST

### 系统相关界面
界面路径：【交易】----【订单查询】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 接口备注
此接口不包含淘系、拼多多敏感数据（如收件人信息、平台敏感数据等），平台敏感数据不返回，其它平台的敏感信息会根据平台规则同步调整
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.outstock.simple.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sid | string | 系统订单号，多个逗号隔开 |  |  | 
 | tid | string | 平台订单号，多个逗号隔开 |  |  | 
 | timeType | string | 查询的时间类型：\[created:下单时间\]--\[pay_time:付款时间\]--\[consign_time:发货时间\]--\[audit_time:审核时间\]--\[upd_time:修改时间\]；与startTime、endTime同时使用，时间跨度建议不超过一天。为空时，默认为修改时间 ，归档订单(queryType参数传1时)不支持audit_time, upd_time|  |  | 
 | startTime | string | 起始时间:格式yyyy-MM-dd HH:mm:ss，与timeType、endTime同时使用，时间跨度建议不超过一天 |  |  | 
 | endTime | string | 截止时间:格式yyyy-MM-dd HH:mm:ss，与timeType、startTime同时使用，时间跨度建议不超过一天 |  |  | 
 | userIds | string | 店铺ID |  |  | 
 | pageSize | integer | 每页多少条，最大支持200，不能小于20 |  | 20 | 
 | pageNo | integer | 页码 |  | 1 | 
 | status | string | 系统状态,对应响应参数的sysStatus订单系统状态(支持多个,逗号隔开).WAIT_BUYER_PAY:待付款,WAIT_AUDIT:待审核,WAIT_FINANCE_AUDIT:待财审,FINISHED_AUDIT:审核完成, WAIT_EXPRESS_PRINT:待打印快递单,WAIT_PACKAGE:待打包,WAIT_WEIGHT:待称重,WAIT_SEND_GOODS:待发货, WAIT_DEST_SEND_GOODS:待供销商发货,SELLER_SEND_GOODS:卖家已发货,FINISHED:交易完成,CLOSED:交易关闭 |  |  | 
 | tagIds | string | 查询指定标签ID集合,多个逗号隔开,最多支持十组 |  |  | 
 | exceptIds | string | 自定义异常标签,多个逗号隔开,最多支持十组 |  |  | 
 | exceptionStatus | string | 系统异常标签,多个逗号隔开,最多支持十组 |  |  | 
 | onlyContain | string | 异常查询状态：1:仅包含 2:排除 3:同时包含 |  |  | 
 | types | string | 订单类型,多个逗号隔开1=货到付款;2=纯平台订单（包含平台单拆出去的手工单）;3=平台订单;4=线下订单;5=纯系统手工单（不包含平台单拆出去的手工单）;6=预售订单;7=合并订单;8=拆分订单;9=加急订单;10=空包订单;11=合单提示;12=门店订单;13=换货订单;14=补发订单;16=海外仓订单;17=Lazada;18=报损单;19=领用单;20=调整单;21=客户订单;22=天猫直送;23=平台预售;24=京东直发;25=京东供销;33=分销订单;34=供销订单;35=京配订单;38=唯品会订单;37=唯品会订单JIT;36=平台分销;49=拼多多工厂代发;50=天猫淘宝店铺预售;51=抖音厂商代发;53=亚马逊FBA;54=亚马逊FBM;55=亚马逊多渠道;56=奇门订单;57=得物普通现货;58=得物极速现货;60=全款预售;61=得物直发订单;63=淘宝厂商代发订单;68=天猫国际直邮;99=出库单;62=Lazada-FBL;65=BTAS订单;69=阿里代销;0=普通订单;66=平台拆单;39=BIC订单;48=多级分销;46=档口订单;70=花城农夫帮卖订单;15=跨境订单;26=天猫当日发货;27=天猫24小时发货;28=天猫当日达;29=天猫次日达;30=天猫三日达;31=天猫四日达;32=天猫五日达;52=平台分销;72=快麦通代发;73=1688分销小站;74=速卖通全托管;79=TEMU;80=希音;75=分销订单(明确供销商);76=含拆单标记的订单;77=1688分销小站(分销);78=o2o订单 |  |  | 
 | consignedType | integer | 发货方式 0.非ERP发货   1.ERP发货 |  |  | 
 | buyerNick | string | 买家ID |  |  | 
 | queryType | integer | 0.三个月内订单 1.三个月之前订单 |  | 0 | 
 | outSids | string | 运单号，多个逗号隔开 |  |  | 
 | useHasNext | boolean | 传true时不会返回total（不统计总数）, 返回hasNext用以判断是否有下一页数据，传false时按原来逻辑只返回total |  |  | 
 | useCursor | boolean | 传true时开启游标查询 , 仅queryType不为1时有效|  |  | 
 | cursor | string | useCursor传true时,第一次查询该参数不传，之后的每次查询传上一次接口返回的cursor |  |  | 

 

### 请求示例
示例一：

````
{
    "pageNo": "number",
    "userIds": "string",
    "timeType": "string",
    "pageSize": "number",
    "startTime": "string",
    "endTime": "string",
    "tid": "string",
    "sid": "string",
    "status": "string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 | list | array | list |  | 
 | total | long | 总数 仅在非归档订单查询（请求参数useHasNext，useCursor都不为true时）第一页返回 |  | 
 | hasNext | boolean | 是否有下一页 |  | 
 | cursor | string | 游标 |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | type | string | 订单类型,多个逗号1=货到付款;  3=平台订单;  4=线下订单;  6=预售订单;  7=合并订单;  8=拆分订单;  9=加急订单;  10=空包订单;  11=合单提示;  12=门店订单;  13=换货订单;  14=补发订单;  16=海外仓订单;  17=Lazada;  18=报损单;  19=领用单;  20=调整单;  21=客户订单;  22=天猫直送;  23=平台预售;  24=京东直发;  25=京东供销; 33=分销订单;  34=供销订单;  35=京配订单;  36=平台分销;  50=天猫淘宝店铺预售; 51=抖音厂商代发; 53=亚马逊FBA; 54=亚马逊FBM; 55=亚马逊多渠道; 56=奇门订单; 57=得物普通现货; 58=得物极速现货; 60=全款预售; 61=得物直发订单; 62=Lazada-FBL;66=平台拆单 99=出库单 |  | 
 | receiverCountry | string | 收件国家，跨境订单使用（淘系、拼多多订单不返回） |  | 
 | receiverState | string | 收件省份（淘系、拼多多订单不返回） |  | 
 | receiverCity | string | 收件市（淘系、拼多多订单不返回） |  | 
 | receiverDistrict | string | 收件区县（淘系、拼多多订单不返回） |  | 
 | receiverStreet   | string | 收件街道（淘系、拼多多订单不返回） |  |
 | receiverAddress | string | 收件详细地址（淘系、拼多多订单不返回） |  | 
 | receiverZip | string | 收件邮编（淘系、拼多多订单不返回） |  | 
 | receiverMobile | string | 收件人手机号（淘系、拼多多订单不返回） |  | 
 | receiverName | string | 收件人姓名（淘系、拼多多订单不返回） |  | 
 | receiverPhone | string | 收件人固话（淘系、拼多多订单不返回） |  | 
 | buyerNick | string | 平台订单上的买家昵称（淘系、拼多多订单不返回） |  | 
 | warehouseId | long | 仓库id |  | 
 | warehouseName | string | 仓库名称 |  | 
 | orders | array | 订单商品明细集合 |  | 
 | outSid | string | 运单号 |  | 
 | expressCode | string | 快递公司的编码 |  | 
 | expressCompanyName | string | 快递公司的名称 |  | 
 | expressCompanyId | long | 快递公司的编号 |  | 
 | postFee | string | 邮费：合单的话，取的是主单的邮费 |  | 
 | theoryPostFee | double | 理论运费 |  | 
 | actualPostFee | string | 实际运费 |  | 
 | poNos | string | 唯品会po单号 |  | 
 | packmaCost | double | 包材成本 |  | 
 | payment | string | 实付金额（单位：元） |  | 
 | userId | long | 店铺用户编号 |  | 
 | isRefund | long | 1.是   0.否  是否存在退款，退款关闭或者退款成功时该数据不返回 |  | 
 | isExcep | integer | 是否异常订单 |  | 
 | exceptIds | string | 自定义异常标签,多个逗号隔开,最多支持十组 |  |  | 
 | exceptNames | array | 自定义异常名称列表 |  |  | 
 | isHalt | integer | 是否挂起订单 |  | 
 | isUrgent | integer | 是否是加急订单 |  | 
 | isPresell | integer | 是否为预售订单：0:正常订单，1：是预售；2预售转正常；3：系统预售 |  | 
 | isCancel | integer | 是否为作废订单   1.是   0.否 |  | 
 | threePlTiming | integer | 3PL有时效订单标，值true 或者 false |  | 
 | isTmallDelivery | integer | 天猫直送，值true 或者 false |  | 
 | buyerTaxNo | string | 买家税号 |  | 
 | status | string | 订单的平台状态 |  | 
 | paymentDiff | double | 订单差额=系统实付金额-平台实收金额 区间值 |  | 
 | adjustFee | string | 手工调整订单价格 |  | 
 | hasSuit | boolean | 是否含有套件 |  | 
 | itemNum | integer | 订单下的商品数量 |  | 
 | taxFee | string | 税费 |  | 
 | isHandlerMessage | integer | 是否处理买家留言： 0：未处理 1：已处理 |  | 
 | grossProfit | double | 毛利润 |  | 
 | singleItemKindNum | integer | 商品单品种类, 最小粒度 |  | 
 | itemKindNum | integer | 订单下的商品种类数 |  | 
 | exceptMemo | string | 异常备注 |  | 
 | buyerMessage | string | 平台订单上的买家留言（淘系、拼多多订单不返回） |  | 
 | unifiedStatus | string | 各平台状态映射后的统一状态 |  | 
 | excep | long | 订单级别的系统异常，参考itemExcep 目前不明确供销商”、“分销商反审核”、“分销商未付款“ |  | 
 | tradeTags | array | 订单自定义标签集合 |  | 
 | shortId | long | 订单短号 |  | 
 | discountFee | string | 优惠 |  | 
 | sellerFlagString | string | 匹配规则用，用逗号分开 |  | 
 | created | long | 下单时间 |  | 
 | payTime | long | 付款时间 |  | 
 | consignTime | long | 发货时间 |  | 
 | endTime | long | 完结时间 |  | 
 | updTime | long | 数据库最后更新时间 |  | 
 | modified | long | 订单在平台上的修改时间 |  | 
 | ptConsignTime | long | 平台发货时间（淘系、拼多多订单不返回） |  | 
 | mobileTail | string | 手机后四位尾号 |  | 
 | source | string | 订单来自哪个平台，例如 tb(淘宝或者天猫平台),jd(京东平台),sys(系统手工订单) |  | 
 | tid | string | 平台订单号 |  | 
 | needInvoice | integer | 需要开具发票 1开启，0关闭。已废弃，现在可根据根据tradeTags 已开票的标签 |  | 
 | invoiceName | string | 发票抬头（淘系、拼多多订单不返回） |  | 
 | invoiceRemark | string | 发票备注（淘系、拼多多订单不返回） |  | 
 | invoiceFormat | integer | 发票类型 1普通 2增值 |  | 
 | invoiceType | string | 发票类型 |  | 
 | invoiceKind | string | 发票种类（ 1 电子发票 2 纸质发票 ）（淘系、拼多多订单不返回） |  | 
 | stockStatus | string | 库存状态   EMPTY【库存不足】 NORMAL【正常】 UNALLOCATED【商品未分配】 INSUFFICIENT【库存不足】 RELATION_MODIFIED【商品对应关系修改】 EXCEP【库存不足】 |  | 
 | taobaoId | long | 平台的卖家账户（淘系、拼多多订单不返回） |  | 
 | weight | double | 重量 |  | 
 | auditMatchRule | integer | 智能审核规则匹配结果 |  | 
 | sysOuterId | string | 返回订单下第一个有匹配关系的商品编码，若都未匹配返回设定值：zzzzzz^随机数字,随机数字 |  | 
 | saleFee | string | 分销金额 |  | 
 | exceptions | array | 订单的异常信息 店铺停用异常状态:EX_USER_UNACTIVE, 订单挂起:EX_HALT, 换地址:EX_CHANGE_ADDRESS, 退款:EX_REFUND, 部分退款:EX_PART_REFUND, 商品未匹配异常状态:EX_UNALLOCATED, 库存不足异常状态:EX_INSUFFICIENT, 商品对应关系修改异常状态:EX_RELATION_MODIFIED, 换商品的异常状态:EX_CHANGE_ITEM, 风控异常订单:EX_RISK_ORDER, 套件修改异常:EX_SUITE_CHANGE, 普通商品转加工:EX_ITEM_PROCESS_EXCEP, 货单付款重复订单异常:EX_COD_REPEAT, 平台修改备注:EX_UPDATED_SELLERMEMO, 黑名单的异常状态:EX_BLACK, 发货异常:EX_DELIVER, 上传发货异常:EX_UPLOAD_DELIVER, pdd缺货已处理异常:EX_STOCK_OUT, 发货异常:EX_WAITING_RETURN_WMS, 不明确供销商:EX_AMBIGUITY_FX, 分销商反审核:EX_UNAUDIT_FX, 分销商未付款:EX_WAITEPAY_FX, 供销商打回:EX_REPULSE_FX, 外仓商品待拆分:EX_PLATFORM_FX_SPLIT, 等待合并异常:EX_WAIT_MERGE, 商品停用异常:EX_ITEM_SHUTOFF, 天猫超时缺货回告异常:EX_TMCS_STOCK_OUT, 唯一码下架异常:EX_UNIQUE_CODE_OFFSHELF, 天猫国际直营缺货回告异常:EX_TMGJZY_STOCK_OUT, 得物直发物流模板匹配异常:EX_POISON_NOT_MATCH_EXPRESS_TEMPLATE, 唯品会未匹配常态合作码异常:EX_VIP_COOPERATION_CODE_NOT_MATCH |  | 
 | volume | double | 订单体积 |  | 
 | scalping | integer | 是否空单; 1=是; 0=否 |  | 
 | companyId | long | 公司编号 |  | 
 | netWeight | double | 订单净重，由子订单综合计算得出，参照Order#netWeight |  | 
 | sellerMemo | string | 平台上的卖家备注 |  | 
 | subSource | string | 次来源地 jd 保存订单来源 |  | 
 | sysMemo | string | 订单系统备注 |  | 
 | shopName | string | 店铺名称 |  | 
 | sid | long | 系统订单号 |  | 
 | cancelFrom | integer | 供销订单使用,分销作废来源 0,取消分销属性 1，分销订单作废 |  | 
 | acPayment | string | 不变的实付金额 |  | 
 | sysStatus | string | 订单系统状态   WAIT_BUYER_PAY【待付款】 WAIT_AUDIT【待审核】 WAIT_FINANCE_AUDIT【等待财审】 WAIT_MANUAL_AUDIT【等待人工审核】 FINISHED_AUDIT【审核完成】 WAIT_EXPRESS_PRINT【待打印快递单】 SYS_STATUS_WAIT_DELIVERY_PRINT【待打印发货单】 WAIT_PACKAGE【待打包】 WAIT_WEIGHT【待称重】 WAIT_SEND_GOODS【待发货】 WAIT_DEST_SEND_GOODS【待供销商发货】 SELLER_SEND_GOODS【卖家已发货】 FINISHED【交易完成】 CLOSED【交易关闭】 CANCEL【交易作废】 |  | 
 | chSysStatus | string | 订单系统状态的中文说明 |  | 
 | manualPaymentAmount | double | 手工支付金额 |  | 
 | fxIsUpload | integer | 分销订单是否在系统上传（供销订单用） |  | 
 | promiseService | string | 承诺服务类型，会有多个服务值，以英文半角逗号","切割，其中 tmallpromise.arrival.timing 代表到货承诺时效 tmallpromise.consign.timing代表发货承诺时效 |  | 
 | cost | double | 订单总成本价,所有商品总成本价之和 |  | 
 | timeoutActionTime | long | 承诺时间 |  | 
 | isHandlerMemo | integer | 是否处理卖家备注： 0：未处理 1：已处理 |  | 
 | isCancelDistributorAttribute | integer | 是否是取消分销属性触发的订单同步，如果是1，则不需要匹配供应商，因为是取消分销属性 |  | 
 | tradeFrom | string | 订单来源，例如手机端或者PC端 |  | 
 | platformPaymentAmount | double | 平台支付金额（淘系、拼多多订单不返回） |  | 
 | totalFee | string | 总额 |  | 
 | wlbTemplateType | integer | 供销订单用 |  | 
 | expressPrintTime | date | 快递单打印时间 | 必填 | 
 | deliverPrintTime | date |  发货单打印时间 | 必填 | 
 | expressStatus | int | 快递单打印状态 , 0 : 否， 1:是 | 必填 | 
 | deliverStatus |  | 发货单打印状态，  0 : 否， 1:是 | 必填 | 
 | timingPromise | string | 服务身份标识 |  | 
 | splitType | integer | 拆单类型 -1:未拆单 1:拆单 |  | 
 | splitSid | long | 如果splitType等于1。则对应拆单的主单的sid。否则为-1 |  | 
 | templateId | long | 快递模板id | 必填 | 
 | templateName | string | 快递模板名称 | 必填 | 
 | logisticsCompanyId | long | 用户物流公司ID | 必填 | 
 | logisticsCompanyName | string | 用户物流公司名称 | 必填 | 
 | isPackage | integer | 订单是否打包    0.未打包   1.打包 | 必填 | 
 | sellerFlag | long | 平台上的卖家旗帜    0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红 | 必填 | 
 | salesmanId | long | 业务员Id | 必填 | 
 | salesmanName | string | 业务员名称 | 必填 | 
 | sourceId | long | 分销商ID | 必填 | 
 | sourceName | string | 订单来源于哪里 分销系统里记为分销商名称 | 必填 | 
 | destId | long | 供销商ID | 必填 | 
 | destName | string | 订单归属于哪里 分销系统里记为供销商名称 | 必填 | 
 | payAmount | string | 订单买家已付金额（单位：元） | 必填 | 
 | selfBuiltPaymentReceivable | string | 代收金额 |  | 
 | selfBuiltDepositAmount | string | 定金 |  | 
 | selfBuiltPayment | string | 货到付款总金额 |  | 
 | tradeInvoice | object | 订单发票信息（淘系、拼多多订单不返回） | 必填 | 
 | govSubsidyInfo | object | 国补信息 |  | 
 | subShop | object | 子店铺信息 |  | 
 | tradeExt | object | 订单扩展信息 |  | 
 | tradePictureMemoUris | array | 订单文件列表 |  |
 | messageMemos | array | 合单信息 |  |
 | distributor | object | 分销员信息 |  |
 | vipPickNo | string | 捡货单号 |  |
 | vipStorageNo | string | 出仓单ID |  |
 | storageNo | string | 出仓单号 |  |

# subTable: list/distributor
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | distributorName | string | 分销员名称 |  | 
 | distributorPhone | string | 分销员手机号 |  | 

# subTable: list/tradeExt
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | currency | string | 原始货币 |  | 
 | originalPayment | string | 订单实付(原始币种) |  | 
 | originalPostFee | string | 订单运费(原始币种) |  | 
 | originalDiscountFee | string | 订单折扣(原始币种) |  | 
 | originalTaxFee | string | 订单税费(原始币种) |  | 
 | originalOtherFeeBuyer | string | 买家其他费用(原始币种) |  | 
 | originalOtherFeeSeller | string | 卖家其他费用(原始币种) |  | 
 | originalOtherFeeOther | string | 其他方其他费用(原始币种) |  | 

# subTable: list/subShop
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 子店铺ID |  | 
 | shopName | string | 店铺名称 |  | 
 | platformCode | string | 所属平台编码 |  | 
 | shopCode | string | 店铺编码 |  | 
 | logisticsCode | string | 物流商编码 |  | 
# subTable: list/orders
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | userId | long | 订单所属店铺用户ID |  | 
 | tid | string | 所属订单的平台编号 |  | 
 | type | integer | 0 普通商品 1 赠品 是否是赠品不能根据type来判断，而要根据giftNum>0 来判断 2 套件商品 3 组合商品 4 加工商品 |  | 
 | sysStatus | string | 订单系统状态   WAIT_BUYER_PAY【待付款】 WAIT_AUDIT【待审核】 WAIT_FINANCE_AUDIT【等待财审】 WAIT_MANUAL_AUDIT【等待人工审核】 FINISHED_AUDIT【审核完成】 WAIT_EXPRESS_PRINT【待打印快递单】 SYS_STATUS_WAIT_DELIVERY_PRINT【待打印发货单】 WAIT_PACKAGE【待打包】 WAIT_WEIGHT【待称重】 WAIT_SEND_GOODS【待发货】 WAIT_DEST_SEND_GOODS【待供销商发货】 SELLER_SEND_GOODS【卖家已发货】 FINISHED【交易完成】 CLOSED【交易关闭】 CANCEL【交易作废】 |  | 
 | sysSkuPropertiesName | string | 系统SKU的规格属性名称 |  | 
 | discountRate | double | 折扣率 |  | 
 | discountFee | string | 优惠金额 |  | 
 | payTime | long | 付款时间 |  | 
 | created | long | 下单时间 |  | 
 | consignTime | long | 子订单发货时间 |  | 
 | endTime | long | 子订单的交易结束时间 |  | 
 | modified | long | 子订单平台的修改时间 |  | 
 | updTime | long | 数据更新时间 |  | 
 | numIid | string | 平台商品数字编号 |  | 
 | num | integer | 子订单商品数量 |  | 
 | payment | string | 实付金额, 公式: 实付金额 = 应付金额 - 优惠金额（单位：元） |  | 
 | source | string | 订单来源 tb,tm,jd,sys |  | 
 | shortTitle | string | 商品简称 |  | 
 | sysTitle | string | 系统商品的标题 |  | 
 | suits | array | 套件明细(每个套件的实付金额、数量) |  | 
 | isPresell | integer | 是否为预售订单 0:正常订单，1：是预售；2预售转正常；3：系统预售 |  | 
 | uniqueCode | string | uniqueCode |  | 
 | outerSkuId | string | outer_sku_id |  | 
 | sysSkuPropertiesAlias | string | 系统SKU规格属性别名 |  | 
 | price | string | 商品销售价 |  | 
 | giftNum | integer | 赠品的order数量 |  | 
 | stockNum | integer | 分配的库存数量 |  | 
 | stockStatus | string | 当前子订单的库存状态, EMPTY【库存不足】 NORMAL【正常】 UNALLOCATED【商品未分配】 INSUFFICIENT【库存不足】 RELATION_MODIFIED【商品对应关系修改】 EXCEP【库存不足】 |  | 
 | id | long | 子订单系统编号 |  | 
 | adjustFee | string | 手工调整金额 |  | 
 | skuId | string | 平台规格编号 |  | 
 | insufficientCanceled | integer | 是否取消库存缺货异常（INSUFFICIENT,EMPTY,EXCEP）：0 否，1 是 |  | 
 | taobaoId | long | 订单店铺的平台ID（淘系、拼多多订单不返回） |  | 
 | diffStockNum | integer | 缺货数量=num-stockNum（不需要持久化） |  | 
 | sysSkuRemark | string | 系统规格备注 |  | 
 | sysOuterId | string | 系统商家编码，如果是商品则为商品的商家编码，如果为SKU则为SKU的商家编码 |  | 
 | saleFee | string | 分销金额 |  | 
 | exceptions | string | 订单的异常信息 |  | 
 | volume | double | 单个商品体积 |  | 
 | picPath | string | 平台商品图片链接 |  | 
 | sysItemRemark | string | 系统规商品备注 |  | 
 | companyId | long | 公司编号 |  | 
 | unit | string | 系统商品数量单位 |  | 
 | netWeight | string | 子订单中单个商品净重 |  | 
 | osGiftCount | string | 前N有礼赠品数量 |  | 
 | oldStatus | string | 子订单旧的平台状态，不做持久化，一般用于订单同步更新时的判断比较 |  | 
 | warehouseId | long | 子订单商品库存操作时的仓库ID,要保证与所属trade中的warehouseId一致 |  | 
 | authorId | long | 达人id （废弃）|  | 
 | authorNo | string | 达人id|  | 
 | authorName | string | 达人名称 |  | 
 | isVirtual | integer | 是否虚拟商品，虚拟商品不需要申请库存，发货时也不需要消费库存、归还库存 |  | 
 | status | string | 子订单平台状态 |  | 
 | sysConsigned | integer | 是否ERP发货  0：未发货，1：ERP发货，2：其他ERP发货 |  | 
 | soid | string | 子订单平台编号（由于某些平台的子订单号为字符类型，需要用此字段保存，后续可将oid修改为String类型） |  | 
 | refundStatus | string | 子订单退款状态    CLOSED：退款关闭 NO_REFUND：未退款 SELLER_CONTINUE_CONSIGN：卖家已发货退款 SELLER_REFUSE_BUYER：卖家拒绝退款 WAIT_SELLER_AGREE：待卖家同意退款 WAIT_BUYER_RETURN_GOODS：待买家退货 WAIT_SELLER_CONFIRM_GOODS：待卖家确认收货 SUCCESS：退款成功 |  | 
 | oid | long | 子订单平台编号(淘宝有,京东没有) |  | 
 | itemSysId | long | 匹配到的系统商品ID |  | 
 | title | string | 平台商品名称 |  | 
 | sid | long | 所属主订单的系统编号 |  | 
 | forcePackNum | integer | 强制验货数量 |  | 
 | acPayment | string | 不变的实付金额, 进来后不变 |  | 
 | sysItemOuterId | string | 系统主商家编码 |  | 
 | osSortNum | string | 前N有礼中奖名次，获得奖品的订单才会有该字段 |  | 
 | skuPropertiesName | string | 规格属性名 |  | 
 | skuUnit | string | 系统规格计量单位 |  | 
 | cost | double | 商品成本价 cost*num 该商品总成本价 |  | 
 | isCancel | integer | 是否作废，未发货的子订单与所属的trade保持一致 |  | 
 | salePrice | string | 分销价格 |  | 
 | oldPrice | string | 原商品销售价，在套件转单品去匹配赠品时候使用 |  | 
 | postFee | string | 单笔订单运费 |  | 
 | identCode | string | 识别码 |  | 
 | payAmount | string | 商品买家已付金额（单位：元） | 必填 | 
 | combineId | long | 如果是套件单品,则该字段的值为其所属的套件子订单的id,否则为0 |  | 
 | ptConsignTime | long | 平台发货时间（淘系、拼多多订单不返回） |  | 
 | totalFee | string | 应付金额, 公式: 应付金额 = 商品数量 * 商品单价 + 手工调整价 |  | 
 | sysPicPath | string | 系统商品图片链接 |  | 
 | skuSysId | long | 匹配到的系统规格ID |  | 
 | outerId | string | 商家编码，不做持久化，仅仅只是为了系统订单添加商品使用 |  | 
 | estimateConTime | long | 预计发货时间 |  | 
 | refundId | string | 平台退款编号 |  | 
 | expressCompanyId | long | 快递公司的编号 |  | 
 | orderExt | object | order扩展信息（订单商品备注） | 必填 | 
 | divideOrderFee | string | 平台实付(平台分摊之后的实付金额)（单位：元） | 必填 | 
 | orderStockProducts | list | 生产信息（批次、生产日期） | 必填 | 

# subTable: list/orders/suits
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysSkuPropertiesName | string | 系统SKU的规格属性名称 |  | 
 | discountRate | double | 折扣率 |  | 
 | discountFee | string | 优惠金额 |  | 
 | payTime | long | 付款时间 |  | 
 | numIid | string | 平台商品数字编号 |  | 
 | num | integer | 子订单商品数量 |  | 
 | source | string | 订单来源 tb,tm,jd,sys |  | 
 | shortTitle | string | 商品简称 |  | 
 | sysTitle | string | 系统商品的标题 |  | 
 | type | string | 0 普通商品 1 赠品 是否是赠品不能根据type来判断，而要根据giftNum>0 来判断 2 套件商品 3 组合商品 4 加工商品 |  | 
 | cost | double | 该商品总成本价 | 必填 | 
 | outerSkuId | string | 外部skuID | 必填 | 
 | combineId | long | 如果是套件单品,则该字段的值为其所属的套件子订单的id,否则为0 | 必填 | 
 | payAmount | string | 商品买家实付金额 | 必填 | 
 | tid | string | 所属订单的平台编号 | 必填 | 
 | consignTime | long | 子订单发货时间 | 必填 | 
 | isPresell | integer | 是否为预售订单 0:正常订单，1：是预售；2预售转正常；3：系统预售 | 必填 | 
 | price | string | 商品销售价 | 必填 | 
 | updTime | long | 数据更新时间 | 必填 | 
 | giftNum | integer | 赠品的order数量 | 必填 | 
 | stockStatus | string | 当前子订单的库存状态,如库存正常(NORMAL),库存不足(INSUFFICIENT) | 必填 | 
 | modified | long | 子订单平台的修改时间 | 必填 | 
 | payment | string | 实付金额, 公式: 实付金额 = 应付金额 - 优惠金额 | 必填 | 
 | id | long | 子订单系统编号 | 必填 | 
 | adjustFee | string | 手工调整金额 | 必填 | 
 | skuId | string | 平台规格编号 | 必填 | 
 | created | long | 下单时间 | 必填 | 
 | insufficientCanceled | integer | 是否取消库存缺货异常（INSUFFICIENT,EMPTY,EXCEP）：0 否，1 是 | 必填 | 
 | taobaoId | long | 订单店铺的平台ID | 必填 | 
 | sysOuterId | string | 系统商家编码，如果是商品则为商品的商家编码，如果为SKU则为SKU的商家编码 | 必填 | 
 | saleFree | string | 分销金额 | 必填 | 
 | picPath | string | 平台商品图片链接 | 必填 | 
 | volume | double | 单个商品体积 | 必填 | 
 | sysItemRemark | string | 系统规商品备注 | 必填 | 
 | companyId | long | 公司编号 | 必填 | 
 | netWeight | double | 子订单中单个商品净重 | 必填 | 
 | unit | string | 系统商品数量单位 | 必填 | 
 | isVirtual | integer | 是否虚拟商品，虚拟商品不需要申请库存，发货时也不需要消费库存、归还库存 | 必填 | 
 | status | string | 子订单平台状态 | 必填 | 
 | sysConsigned | integer | 是否在系统发货  0.否 1.是 2.其他erp发货 | 必填 | 
 | refundStatus | string | 子订单退款状态 | 必填 | 
 | oid | long | 子订单平台编号(淘宝有,京东没有) | 必填 | 
 | title | string | 商品标题 | 必填 | 
 | itemSysid | long | 匹配到的系统商品ID | 必填 | 
 | sid | long | 所属主订单的系统编号 | 必填 | 
 | forcePackNum | integer | 强制验货数量 | 必填 | 
 | sysStatus | string | 订单系统状态 | 必填 | 
 | divideOrderFee | string | 平台实付(平台分摊之后的实付金额) | 必填 | 
 | skuPropertiesName | string | 规格属性名 | 必填 | 
 | cost | double | 商品成本价 | 必填 | 
 | isCancel | integer | 是否作废，未发货的子订单与所属的trade保持一致 | 必填 | 
 | salePrice | string | 分销价格 | 必填 | 
 | combineId | long | 如果是套件单品,则该字段的值为其所属的套件子订单的id,否则为0 | 必填 | 
 | ptConsignTime | long | 平台发货时间 | 必填 | 
 | totalFree | string | 应付金额, 公式: 应付金额 = 商品数量 * 商品单价 + 手工调整价 | 必填 | 
 | sysPicPath | string | 系统商品图片链接 | 必填 | 
 | skuSysId | long | 匹配到的系统规格ID | 必填 | 
 | estimateConTime | long | 预计发货时间 | 必填 | 
 | endTime | long | 子订单的交易结束时间 | 必填 | 
 | orderStockProducts | list | 生产信息（批次、生产日期） | 必填 | 

# subTable: list/orders/suits/orderStockProducts
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | batchNo | string | 批次号 | 必填 | 
 | productionDate | long | 生产日期 |  | 
 | expireDate | long | 到期日期 |  | 
 | lockNum | long | 锁定数量 |  | 

# subTable: list/orders/orderExt
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | orderRemark | string | 订单商品备注 |  | 
 | customization | string | 礼品 |  | 
 | originalPrice | string | 商品单价(原始币种) |  | 
 | originalPayment | string | 商品实付(原始币种) |  | 
 | originalOtherFee | string | 商品其他费用(原始币种) |  | 

# subTable: list/orders/orderStockProducts
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | batchNo | string | 批次号 | 必填 | 
 | productionDate | long | 生产日期 |  | 
 | expireDate | long | 到期日期 |  | 
 | lockNum | long | 锁定数量 |  | 

# subTable: list/tradeTags
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | bgColor | string | 标签背景颜色 |  | 
 | remark | string | 标签备注 |  | 
 | id | long | 标签id |  | 
 | tagName | string | 标签名称 |  | 
 | fontColor | string | 标签前景颜色 |  | 

# subTable: list/tradeInvoice
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | invoiceType | string | 发票抬头类型：1个人、2企业（淘系、拼多多订单不返回） | 必填 | 
 | invoiceKind | string | 发票类型：发票种类1纸质普通 2纸质专票 3电子普通 4电子专票（淘系、拼多多订单不返回） | 必填 | 
 | invoiceName | string | 发票抬头（淘系、拼多多订单不返回） | 必填 | 
 | buyerTaxNo | string | 买家税号（淘系、拼多多订单不返回） | 必填 | 
 | invoiceRemark | string | 发票备注（淘系、拼多多订单不返回） | 必填 | 
 | buyerAddress | string | 购方地址（淘系、拼多多订单不返回） | 必填 | 
 | buyerPhone | string | 购方电话（淘系、拼多多订单不返回） | 必填 | 
 | buyerBank | string | 购方开户行（淘系、拼多多订单不返回） | 必填 | 
 | buyerBankAccount | string | 购方开户行账号（淘系、拼多多订单不返回） | 必填 | 
 | invoiceAmount | string | 开票金额（淘系、拼多多订单不返回） | 必填 | 
 | email | string |  邮箱（淘系、拼多多订单不返回） | 必填 | 

# subTable: list/govSubsidyInfo
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | subShopId | string | 子店铺id |  | 
 | subShopName | string | 子店铺名称  |  | 
 | govSubsidyAmount | string | 国家补贴金额 |  | 
 | govSubsidyDetail | string | 订单国补详情数据（json字符串存储,业务方根据平台不同逻辑自行解析取想要的字段做业务） |  | 

# subTable: list/messageMemos
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | long | 系统订单号 |  | 
 | tid | string | 平台订单号 |  | 
 | buyerMessage | string | 买家留言 |  | 
 | sellerMemo | string | 卖家备注 |  | 
 | sysMemo | string | 系统备注 |  | 
 | sellerFlag | long | 卖家旗帜 |  | 
 | payment | string | 实付金额 |  | 
 | totalFee | string | 总额 |  | 
 | discountFee | string | 优惠金额 |  | 
 | postFee | string | 邮费 |  | 
 | acPayment | string | 不变的实付金额 |  | 
 | payAmount | string | 订单买家已付金额（单位：元） |  | 
 | theoryPostFee | double | 理论运费 |  | 
 | adjustFee | string | 手工调整订单价格 |  | 
 | paymentDisplay | string | 支付详情 |  | 
 | totalDiscountFee | string | 总共优惠的金额 |  | 
 | created | date | 下单时间 |  | 
 | payTime | date | 付款时间 |  | 
 | consignTime | date | 发货时间 |  | 
 | ptConsignTime | date | 平台发货时间 |  | 
 | taxFee | string | 税费 |  | 
 | saleFee | string | 分销金额 |  | 
 | grossProfit | string | 毛利润 |  | 
 | isHandlerMessage | integer | 是否处理买家留言： 0：未处理 1：已处理 |  | 
 | isHandlerMemo | integer | 是否处理卖家备注： 0：未处理 1：已处理 |  | 
 | addressChanged | integer | 是否标识订单地址修改，1标识 |  | 
 | isMergeMain | integer | 是否标识订单为合单主单，1标识 |  | 
 | unifiedStatus | string | 统一状态 |  | 
 | sysConsigned | integer | 是否ERP发货  0：未发货，1：ERP发货，2：其他ERP发货 |  | 
 | isUpload | integer | 是否上传 |  | 
 | userId | long | 店铺用户编号 |  | 
 | sysStatus | string | 订单系统状态 |  | 
 | actualPostFee | string | 实际运费 |  |
 

### 响应示例
```
{
	"total": "0",
	"list": [{
		"paymentDiff": "number",
		"buyerNick": "string",
		"threePlTiming": "number",
		"type": "string",
		"receiverCity": "string",
		"invoiceRemark": "string",
		"poNos": "string",
		"packmaCost": "number",
		"receiverPhone": "string",
		"expressCode": "string",
		"payment": "string",
		"adjustFee": "string",
		"isExcep": "number",
		"receiverZip": "string",
		"isTmallDelivery": "number",
		"buyerTaxNo": "string",
		"isHalt": "number",
		"warehouseId": long,
		"isRefund": "number",
		"receiverState": "string",
		"expressCompanyId": "number",
		"status": "string",
		"isUrgent": "number",
		"theoryPostFee": "number",
		"warehouseName": "string",
		"hasSuit": "boolean",
		"itemNum": "number",
		"receiverDistrict": "string",
		"taxFee": "string",
		"isHandlerMessage": "number",
		"grossProfit": "number",
		"postFee": "string",
		"receiverMobile": "string",
		"singleItemKindNum": "number",
		"userId": long,
		"itemKindNum": "number",
		"exceptMemo": "string",
		"ptConsignTime": long,
		"buyerMessage": "string",
		"unifiedStatus": "string",
		"excep": "number",
		"shortId": "number",
		"discountFee": "string",
		"sellerFlagString": "string",
		"payTime": long,
		"mobileTail": "string",
		"source": "string",
		"tradePurchaseAmount": "number",
		"tid": "string",
		"invoiceFormat": "number",
		"consignTime": long,
		"isPresell": "number",
		"receiverCountry": "string",
		"updTime": long,
		"stockStatus": "string",
		"modified": long,
		"invoiceType": "string",
		"created": long,
		"taobaoId": long,
		"weight": "number",
		"auditMatchRule": "number",
		"sysOuterId": "string",
		"list": [{
			"bgColor": "string",
			"remark": "string",
			"id": "number",
			"tagName": "string",
			"fontColor": "string",
		}],
		"saleFee": "string",
		"exceptions": "string[]",
		"outSid": "string",
		"receiverAddress": "string",
		"volume": double,
		"scalping": integer,
		"companyId": long,
		"netWeight": double,
		"sellerMemo": "string",
		"chSysStatus": "string",
		"destName": "string",
		"invoiceName": "string",
		"subSource": "string",
		"sysMemo": "string",
		"shopName": "string",
		"sid": long,
		"cancelFrom": "number",
		"acPayment": "string",
		"sysStatus": "string",
		"manualPaymentAmount": "number",
		"fxIsUpload": "number",
		"promiseService": "string",
		"cost": double,
		"isCancel": integer,
		"receiverName": "string",
		"timeoutActionTime": long,
		"isHandlerMemo": "number",
		"expressCompanyName": "string",
		"isCancelDistributorAttribute": "number",
		"tradeFrom": "string",
		"platformPaymentAmount": "number",
		"totalFee": "string",
		"needInvoice": "number",
		"wlbTemplateType": "number",
		"timingPromise": "string",
		"sourceName": "string",
		"invoiceKind": "string"
	}],
	"success": "boolean",
	"trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|查询的时间类型不合法！created: 下单时间, pay_time：付款时间，consign_time：发货时间，audit_time：审核时间，upd_time：修改时间]字段：[timeType]|50|检查参数是否合法||
|店铺ID格式不正确！|20014|检查参数是否合法||
|店铺ID数量最大支持10组！|20015|参数过长||
|订单状态不合法！[WAIT_BUYER_PAY：待付款，WAIT_AUDIT：待审核，WAIT_FINANCE_AUDIT：待财审，FINISHED_AUDIT：审核完成，WAIT_EXPRESS_PRINT：待打印快递单，WAIT_PACKAGE：待打包，WAIT_WEIGHT：待称重，WAIT_SEND_GOODS：待发货，WAIT_DEST_SEND_GOODS：待供销商发货，SELLER_SEND_GOODS：卖家已发货，FINISHED：交易完成，CLOSED：交易关闭]字段：[status]|50|检查参数是否合法||
|标签ID格式不正确|20101|检查参数是否合法||
|查询指定标签ID数量最大支持10组|20102|检查参数是否合法||
|标签ID格式不正确|20103|检查参数是否合法||
|排除标签ID数量最大支持10组|20104|检查参数是否合法||
|自定义异常标签ID格式不正确|20105|检查参数是否合法||
|自定义异常标签ID数量最大支持10组|20106|检查参数是否合法||
|系统异常标签ID数量最大支持10组|20108|检查参数是否合法||
|异常查询状态不合法！[1:仅包含  2:排除  3:同时包含]|50|检查参数是否合法||
|销售出库查询失败|30077|请根据返回的错误信息进行处理||

---

## 订单挂起

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E8%AE%A2%E5%8D%95%E6%8C%82%E8%B5%B7
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1500-%E8%AE%A2%E5%8D%95%E6%8C%82%E8%B5%B7.md

# 订单挂起

**请求方法:** POST

### 系统相关界面
"界面路径：【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.halt | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sids | string | 	系统订单号,多个用逗号分隔，最多支持20组 | 系统订单号和平台订单号二选一 |  | 
 | tids | string | 	平台订单号,多个用逗号分隔，最多支持20组 | 系统订单号和平台订单号二选一 |  | 
 | autoUnHalt | int | 是否开启自动解挂 0不开启 1开启 不开启则仅挂起 | 必填 |  | 
 | unHaltType | int | 解挂依据 0按订单挂起时间 1按承诺发货与揽收时间，如果是否开启自动解挂时间传值为1，那么该字段必填 |  |  | 
 | haltTimeUnit | int | 挂起时长单位 时间单位 1：分 2：小时 3：天 4：月 5：年，如果是否开启自动解挂时间传值为1，那么该字段必填	 |  |  | 
 | haltTimeVal | int | 挂起时长 具体的时长，最大不超过999，如果是否开启自动解挂时间传值为1，那么该字段必填	 |  |  | 
 | isUrgent | int | 自动解除后更新为加急订单 0不更新 1更新，如果是否开启自动解挂时间传值为1，那么该字段必填	 |  |  | 
 

 

### 请求示例
示例一：

````
{
 "sids":"5058208293858409,5058208293858408",
 "autoUnHalt":0
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | successIds | array | 成功id 集合 |  | 
 | failedIds | array | 失败id 集合  |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 

### 响应示例
```
{
    "successIds":[5058208293858409],
    "failedIds":[5058208293858408],
    "traceId": "3669319614952014527",
    "success": true
}
```
### 异常示例
````
{
    "traceId": "4071991477422416710",
    "msg": "失败",
    "code": "33",
    "success": false
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|唯一码数量最大支持20组!|20029|参数过长||

---

## 订单解挂

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E8%AE%A2%E5%8D%95%E8%A7%A3%E6%8C%82
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1550-%E8%AE%A2%E5%8D%95%E8%A7%A3%E6%8C%82.md

# 订单解挂

**请求方法:** POST

### 系统相关界面
"界面路径：【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.unhalt | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sids | string | 	系统订单号,多个用逗号分隔，最多支持20组 | 系统订单号和平台订单号二选一 |  | 
 | tids | string | 	平台订单号,多个用逗号分隔，最多支持20组 | 系统订单号和平台订单号二选一 |  | 

 

### 请求示例
示例一：

````
{
 "sids":"5058208293858409,5058208293858408"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | successIds | array | 成功id 集合 |  | 
 | failedIds | array | 失败id 集合  |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 

### 响应示例
```
{
    "successIds":[5058208293858409],
    "failedIds":[5058208293858408],
    "traceId": "3669319614952014527",
    "success": true
}
```
### 异常示例
````
{
    "traceId": "4071991477422416710",
    "msg": "失败",
    "code": "33",
    "success": false
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|唯一码数量最大支持20组!|20029|参数过长||

---

## 修改订单商品信息

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E5%95%86%E5%93%81%E4%BF%A1%E6%81%AF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1600-%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E5%95%86%E5%93%81%E4%BF%A1%E6%81%AF.md

# 修改订单商品信息

**请求方法:** POST

### 系统相关界面
"界面路径：【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.item.modify | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sid | long | 系统订单号 | 是 |  | 
 | orders | array | 订单商品信息JSON数组字符串| 是 |  |

# subTable: orders
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | id | long | 订单商品ID | 否 |
 | outerId | string | 商家编码 | 是 |
 | price | string | 单价 | 是 |
 | payment | string | 成交金额 | 是 |
 | divideOrderFee | string | 平台实付（平台分摊之后的实付金额） | 否 |
 | num | int | 数量（必须≥1） | 是 |
 | orderRemark | string | 订单商品备注（不能超过1024个字符） | 否 |

### 请求示例

````
{
    "sid": 5058208293858409,
    "orders": "[{\"outerId\":\"SKU001\",\"price\":\"10.00\",\"payment\":\"20.00\",\"num\":2,\"orderRemark\":\"备注信息\"}]"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 是否成功 |  | 
 | trace_id | string | 链路追踪ID |  | 
 

### 响应示例
```
{
    "traceId": "3669319614952014527",
    "success": true
}
```
### 异常示例
````
{
    "traceId": "4071991477422416710",
    "msg": "系统订单号不能为空",
    "code": "33",
    "success": false
}
````

---

## 三方仓接口日志查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E4%B8%89%E6%96%B9%E4%BB%93%E6%8E%A5%E5%8F%A3%E6%97%A5%E5%BF%97%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1650-%E4%B8%89%E6%96%B9%E4%BB%93%E6%8E%A5%E5%8F%A3%E6%97%A5%E5%BF%97%E6%9F%A5%E8%AF%A2.md

# 三方仓接口日志查询

**请求方法:** POST

### 接口描述

分页查询当前授权企业的三方仓接口日志，支持按时间、仓库、单据、货主、模块及处理结果筛选。

### 请求地址

| 环境 | 服务地址（HTTP/HTTPS） |
| --- | --- |
| V2正式环境 | https://gw.superboss.cc/router |

### 公共参数

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | 固定为 erp.party3.warehouse.logs.query |
| appKey | string | 是 | 分配给应用的 AppKey |
| timestamp | string | 是 | 时间戳，时区为 GMT+8，格式为 yyyy-MM-dd HH:mm:ss。服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式，默认为 json，可选值：json |
| version | string | 是 | API协议版本：1.0 |
| sign_method | string | 否 | 签名摘要算法，默认为 hmac，可选值：hmac、md5、hmac-sha256 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息，即 access_token；查询范围由该授权会话确定 |

### 请求头

| 参数名 | 类型 | 描述 | 必填 |
| --- | --- | --- | --- |
| Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 |

### API接口地址

| 参数名 | 类型 | 描述 | 必填 |
| --- | --- | --- | --- |
| method | string | erp.party3.warehouse.logs.query | 必填 |

### 请求参数

| 参数名 | 类型 | 描述 | 必填 |
| --- | --- | --- | --- |
| startTime | string | 查询开始时间，格式 yyyy-MM-dd HH:mm:ss | 必填 |
| endTime | string | 查询结束时间，格式 yyyy-MM-dd HH:mm:ss | 必填 |
| type | integer | 单据类型编码 | |
| busiCode | string | 操作内容对应的业务编码，多个值用英文逗号分隔 | |
| success | integer | 处理结果：1 成功，0 失败 | |
| warehouseIds | string | 仓库 ID，多个值用英文逗号分隔，例如 10001,10002 | |
| tid | string | 平台单号 | |
| customerId | string | 货主 ID 查询条件 | |
| modules | string | 模块编码，多个值用英文逗号分隔 | |
| senders | string | 发起方，多个值用英文逗号分隔 | |
| clueId | string | 日志跟踪号 | |
| types | string | 单据类型编码，多个整数用英文逗号分隔，例如 1,2 | |
| customerIds | string | 货主 ID 查询条件，多个值用英文逗号分隔 | |
| tids | string | 平台单号，多个值用英文逗号分隔 | |
| pageNo | integer | 页码，默认 1 | |
| pageSize | integer | 每页条数，默认 20 | |

### 请求示例

以下 JSON 用于展示业务参数；实际调用时将这些参数与公共参数一起按表单提交，并计算签名。

```json
{
  "startTime": "2026-09-15 00:00:00",
  "endTime": "2026-09-15 23:59:59",
  "warehouseIds": "10001,10002",
  "tids": "DEMO202609150001,DEMO202609150002",
  "success": 1,
  "pageNo": 1,
  "pageSize": 20
}
```

### 响应参数

| 参数名 | 类型 | 描述 | 必填 |
| --- | --- | --- | --- |
| success | boolean | 本次开放接口调用是否成功 | |
| traceId | string | 本次调用的链路追踪 ID | |
| list | array | 当前页日志明细列表 | |
| total | long | 符合查询条件的日志总数 | |
| code | string | 调用失败时的错误码 | |
| msg | string | 调用失败时的错误信息 | |

# subTable: list

| 参数名 | 类型 | 描述 | 必填 |
| --- | --- | --- | --- |
| id | long | 日志 ID | |
| source | string | 第三方平台编码 | |
| sender | string | 发起方 | |
| module | string | 业务模块编码 | |
| content | string | 日志内容 | |
| busiCode | string | 业务编码 | |
| created | long | 日志创建时间，Unix 毫秒时间戳 | |
| warehouseId | long | 仓库 ID | |
| success | integer | 日志处理结果：0 失败，1 成功，2 失败已处理 | |
| requestBody | string | 原始请求报文；若内容为 JSON，仍以字符串返回 | |
| responseBody | string | 原始响应报文；若内容为 JSON，仍以字符串返回 | |
| clueId | string | 日志跟踪号 | |
| type | integer | 日志单据类型编码 | |
| customerId | string | 三方仓路由 ID | |
| tid | string | 平台单号 | |
| sid | long | 系统单号 | |
| sourceName | string | 第三方平台名称 | |
| moduleName | string | 模块名称 | |
| typeName | string | 日志单据类型名称 | |
| warehouseName | string | 仓库名称 | |
| warehouseCode | string | 仓库编码 | |
| party3WarehouseCode | string | 第三方仓仓库编码 | |
| agreeOnName | string | 协议名称 | |
| wmsSystemName | string | WMS系统名称 | |
| shopNick | string | 店铺名称 | |
| ownerCoe | string | 货主 ID | |
| appKey | string | 日志关联的三方仓应用 AppKey | |
| logisticsCode | string | 物流公司编码 | |
| logisticsName | string | 物流公司名称 | |
| customerName | string | 货主名称 | |

### 响应示例

以下为虚构数据，展示一条日志的部分字段。

```json
{
  "success": true,
  "trace_id": "demo-query-trace-001",
  "total": 1,
  "list": [
    {
      "id": 100001,
      "content": "发货单推送成功",
      "created": 1789437600000,
      "warehouseId": 10001,
      "warehouseName": "示例三方仓",
      "warehouseCode": "WH-DEMO-001",
      "party3WarehouseCode": "WMS-DEMO-001",
      "success": 1,
      "requestBody": "{\"orderCode\":\"DEMO202609150001\"}",
      "responseBody": "{\"success\":true}",
      "clueId": "demo-log-clue-001",
      "type": 1,
      "typeName": "发货单推送",
      "tid": "DEMO202609150001",
      "sid": 5000000000000001,
      "ownerCoe": "OWNER-DEMO-001",
      "customerName": "示例货主"
    }
  ]
}
```

### 异常示例

缺少 `startTime` 或 `endTime`：

```json
{
  "code": "40001",
  "msg": "查询时间范围不能为空",
  "success": false
}
```

### 错误码解释

| 错误码 | 错误信息 | 解决方案 |
| --- | --- | --- |
| 40001 | 查询时间范围不能为空 | 同时传入 startTime 和 endTime |
| 33 | 参数错误，具体信息以 msg 为准 | 检查查询条件，确保 warehouseIds 为整数 ID，types 为整数编码，多值使用英文逗号分隔 |
| 9 | 三方仓接口日志查询失败 | 稍后重试；若持续失败，提供调用时间和链路追踪 ID 联系技术支持 |

---

## 快麦ERP奇门自定义接口

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E5%A5%87%E9%97%A8%E8%87%AA%E5%AE%9A%E4%B9%89%E6%8E%A5%E5%8F%A3%E6%8E%A5%E5%85%A5%E8%AF%B4%E6%98%8E
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1700-%E5%A5%87%E9%97%A8%E8%87%AA%E5%AE%9A%E4%B9%89%E6%8E%A5%E5%8F%A3%E6%8E%A5%E5%85%A5%E8%AF%B4%E6%98%8E.md

# 快麦ERP奇门自定义接口

本文根据《快麦ERP奇门自定义接口V2.6.docx》整理，包含奇门自定义接口的接入配置、订单查询和售后单查询。

### 官方接入指南

[自定义奇门官方接入指南](https://open.taobao.com/docV3.htm?docId=106556&docType=1)

### 接口列表及正式请求地址

| 接口 | method | 正式请求地址 |
| --- | --- | --- |
| [订单查询（列表）](./1750-奇门订单查询.md) | `kuaimai.order.list.query` | `http://33c367ryyg.api.taobao.com/router/qm` |
| [售后单查询（列表）](./1800-奇门售后单查询.md) | `kuaimai.refund.list.query` | `http://z29932hpkn.api.taobao.com/router/qm` |

### 奇门系统参数

奇门系统参数 `target_app_key` 固定填写 `23204092`。

### 接口路由参数

接口需要额外携带 `customerId`，通过不同的 `customerId` 路由到不同商家。

| 参数 | 配置说明 |
| --- | --- |
| `customerId` | 可自行定义，原文建议使用有特殊含义、不常规的数字。该值必须在快麦数据库中唯一，用于关联对应公司；在快麦的三方仓仓库中也需填写相同的值。 |
| `warehouseCode` | 使用自行定义的仓库外部编码，不是快麦里的仓库编码。 |

### 文档版本说明

文档版本为 V2.6。各接口的字段名称、类型、必填标记和说明均按原文保留，响应对象按原表格的层级拆分展示。请求参数表中的 `false` 表示非必填。

---

## 奇门订单查询（列表）

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E5%A5%87%E9%97%A8%E8%AE%A2%E5%8D%95%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1750-%E5%A5%87%E9%97%A8%E8%AE%A2%E5%8D%95%E6%9F%A5%E8%AF%A2.md

# 奇门订单查询（列表）

查询订单列表。本文根据《快麦ERP奇门自定义接口V2.6.docx》整理。

### 接入说明

调用前请先阅读[奇门自定义接口接入说明](./1700-奇门自定义接口接入说明.md)，配置 `target_app_key`、`customerId` 和 `warehouseCode`。

### 请求地址

| 环境 | 服务地址 |
| --- | --- |
| 正式环境 | `http://33c367ryyg.api.taobao.com/router/qm` |

### API接口地址

| 参数名 | 值 | 说明 |
| --- | --- | --- |
| `method` | `kuaimai.order.list.query` | 查询订单列表 |

### 请求参数

以下为接口业务参数；`false` 表示非必填。奇门系统参数和路由参数见[接入说明](./1700-奇门自定义接口接入说明.md)。

| 名称 | 类型 | 是否必须 | 描述 |
| --- | --- | --- | --- |
| `pageNo` | Integer | false | 页码 |
| `pageSize` | Integer | false | 页面大小（每页数据条数） |
| `status` | String | false | 订单状态<br />WAIT_BUYER_PAY:待付款,<br />WAIT_AUDIT:待审核,<br />WAIT_FINANCE_AUDIT:待财审,<br />FINISHED_AUDIT:审核完成,<br />WAIT_EXPRESS_PRINT:待打印快递单,<br />WAIT_PACKAGE:待打包,<br />WAIT_WEIGHT:待称重,<br />WAIT_SEND_GOODS:待发货,<br />WAIT_DEST_SEND_GOODS:待供销商发货,<br />SELLER_SEND_GOODS:卖家已发货,<br />FINISHED:交易完成,<br />CLOSED:交易关闭 |
| `startTime` | String | false | 开始时间（yyyy-MM-dd HH:mm:ss）<br />（默认更新时间） |
| `endTime` | String | false | 结束时间（yyyy-MM-dd HH:mm:ss）<br />（默认更新时间） |
| `dateType` | Integer | false | 查询时间类型<br />默认0<br />0:修改时间<br />1:创建时间<br />2:线上下单时间<br />3:发货时间 |
| `userId` | Long | false | 店铺编号 |
| `warehouseId` | Long | false | 订单分仓id |
| `sid` | string | false | 系统订单号 |
| `tid` | string | false | 平台订单号 |
| `tagIds` | string | false | 查询指定标签ID集合,多个逗号隔开,最多支持十组 |
| `types` | string | false | 订单类型包含,多个逗号隔开0=普通订单;1=货到付款; 3=平台订单; 4=线下订单; 6=预售订单; 7=合并订单; 8=拆分订单; 9=加急订单; 10=空包订单; 11=合单提示; 12=门店订单; 13=换货订单; 14=补发订单; 16=海外仓订单; 17=Lazada; 18=报损单; 19=领用单; 20=调整单; 21=客户订单; 22=天猫直送; 23=平台预售; 24=京东直发; 25=京东供销; 33=分销订单; 34=供销订单; 35=京配订单; 36=平台分销; 50=天猫淘宝店铺预售; 51=抖音厂商代发; 53=亚马逊FBA; 54=亚马逊FBM; 55=亚马逊多渠道; 56=奇门订单; 57=得物普通现货; 58=得物极速现货; 60=全款预售; 61=得物直发订单; 62=Lazada-FBL; 66=平台拆单；99=出库单 |

### 响应参数

以下按原文的字段层级展示，各子表标题表示字段所属的对象路径。

#### 顶层字段

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| `total` | Long | 总数 |
| `pageNo` | Integer | 页码 |
| `pageSize` | Integer | 页面大小（每页数据条数） |
| `hasNextPage` | Boolean | 是否有下一页（默认否） |
| `trades` | List | 系统订单 |

#### trades（系统订单）

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| `paymentDiff` | Integer | 订单差额=系统实付金额-平台实收金额 区间值 |
| `buyerNick` | String | 平台订单上的买家昵称 |
| `threePlTiming` | Integer | 3PL有时效订单标<br />值true 或者 false |
| `type` | String | 订单类型<br />0=普通订单;<br />1=货到付款;<br />3=平台订单;<br />4=线下订单;<br />6=预售订单;<br />7=合并订单;<br />8=拆分订单;<br />9=加急订单;<br />10=空包订单;<br />11=合单提示;<br />12=门店订单;<br />13=换货订单;<br />14=补发订单;<br />16=海外仓订单;<br />17=Lazada;<br />18=报损单;<br />19=领用单;<br />20=调整单;<br />21=客户订单;<br />22=天猫直送;<br />23=平台预售;<br />24=京东直发;<br />33=分销订单;<br />34=供销订单;<br />35=京配订单;<br />36=平台分销;<br />50=天猫淘宝店铺预售;<br />51=抖音厂商代发;<br />53=亚马逊FBA;<br />54=亚马逊FBM;<br />55=亚马逊多渠道;<br />56=奇门订单;<br />57=得物普通现货;<br />58=得物极速现货;<br />60=全款预售;<br />61=得物直发订单;<br />62=Lazada-FBL;<br />66=平台拆单;<br />99=出库单; |
| `receiverCity` | String | 收件市 |
| `invoiceRemark` | String | 发票备注 |
| `poNos` | String | 唯品会po单号 |
| `packmaCost` | Double | 包材成本 |
| `receiverPhone` | String | 收件人固话 |
| `expressCode` | String | 快递公司的编码 |
| `payment` | String | 实付金额 |
| `adjustFee` | String | 手工调整订单价格 |
| `isExcep` | Integer | 是否异常订单 |
| `receiverZip` | String | 收件邮编 |
| `isTmallDelivery` | Integer | 天猫直送，值true 或者 false |
| `buyerTaxNo` | String | 买家税号 |
| `isHalt` | Integer | 是否挂起订单 |
| `warehouseId` | Long | 仓库编号 |
| `isRefund` | Integer | 是否包含退款订单 |
| `receiverState` | String | 收件省份 |
| `payAmount` | String | 订单买家已付金额 |
| `orders` | List | 订单商品明细集合 |
| `expressCompanyId` | Long | 快递公司的编号 |
| `status` | String | 订单的平台状态 |
| `isUrgent` | Integer | 是否是加急订单 |
| `theoryPostFee` | Double | 理论运费 |
| `warehouseName` | String | 仓库名称 |
| `hasSuit` | Boolean | 是否含有套件 |
| `itemNum` | Integer | 订单下的商品数量 |
| `receiverDistrict` | String | 收件区县 |
| `taxFee` | String | 税费 |
| `isHandlerMessage` | Integer | 是否处理买家留言：0：未处理 1：已处理 |
| `grossProfit` | Double | 毛利润 |
| `postFee` | String | 邮费 |
| `receiverMobile` | String | 收件人手机号 |
| `singleItemKindNum` | Integer | 商品单品种类, 最小粒度 |
| `userId` | Long | 店铺用户编号 |
| `itemKindNum` | Integer | 订单下的商品种类数 |
| `exceptMemo` | String | 异常备注 |
| `ptConsignTime` | String | 平台发货时间 |
| `buyerMessage` | String | 平台订单上的买家留言 |
| `unifiedStatus` | String | 各平台状态映射后的统一状态 |
| `excep` | Integer | 订单级别的系统异常，参考itemExcep |
| `tradeTags` | List | 订单自定义标签集合 |
| `shortId` | Long | 订单短号 |
| `discountFee` | String | 优惠 |
| `sellerFlagString` | String | 匹配规则用，用逗号分开 |
| `payTime` | String | 付款时间 |
| `mobileTail` | String | 手机后四位尾号 |
| `source` | String | 订单来自哪个平台，例如 tb(淘宝或者天猫平台),jd(京东平台),sys(系统手工订单) |
| `tradePurchaseAmount` | Double | 订单实收金额 |
| `tid` | String | 平台订单号 |
| `invoiceFormat` | Integer | 发票类型 1普通 2增值 |
| `consignTime` | String | 发货时间 |
| `isPresell` | Integer | 是否为预售订单：<br />0:正常订单，<br />1：是预售；<br />2预售转正常；<br />3：系统预售 |
| `receiverCountry` | String | 收件国家，跨境订单使用 |
| `updTime` | String | 数据库最后更新时间 |
| `stockStatus` | String | 库存状态 |
| `modified` | String | 订单在平台上的修改时间 |
| `invoiceType` | String | 发票类型 |
| `created` | String | 下单时间 |
| `taobaoId` | Long | 平台的卖家账户 |
| `weight` | Double | 重量 |
| `auditMatchRule` | Integer | 智能审核规则匹配结果 |
| `sysOuterId` | String | 订单下第一个匹配系统商品的子订单的系统商家编码，若都没有匹配，则直接取第一个商品的平台商家编码 |
| `saleFee` | String | 分销金额 |
| `exceptions` | List | 订单的异常信息 |
| `outSid` | String | 运单号 |
| `receiverAddress` | String | 收件详细地址 |
| `volume` | Double | 订单体积 |
| `scalping` | Integer | 是否空单; 1=是; 0=否 |
| `companyId` | Long | 公司编号 |
| `netWeight` | Double | 订单净重，由子订单综合计算得出，参照Order#netWeight |
| `sellerMemo` | String | 平台上的卖家备注 |
| `chSysStatus` | String | 订单系统状态的中文说明 |
| `destName` | String | 订单归属于哪里 分销系统里记为供销商nname（不持久化） |
| `invoiceName` | String | 发票抬头 |
| `subSource` | String | 次来源地 jd 保存订单来源 |
| `sysMemo` | String | 订单系统备注 |
| `shopName` | String | 店铺名称 |
| `sid` | Long | 系统订单号 |
| `cancelFrom` | Integer | 供销订单使用,分销作废来源<br />0,取消分销属性<br />1，分销订单作废 |
| `acPayment` | String | 不变的实付金额 |
| `sysStatus` | String | 订单的系统状态，平台订单的系统状态由所有平台子订单综合计算得出 |
| `manualPaymentAmount` | Double | 手工支付金额 |
| `fxIsUpload` | Integer | 分销订单是否在系统上传（供销订单用） |
| `promiseService` | String | 承诺服务类型，会有多个服务值，以英文半角逗号","切割，其中 tmallpromise.arrival.timing 代表到货承诺时效 tmallpromise.consign.timing代表发货承诺时效 |
| `cost` | Double | 订单总成本价,所有商品总成本价之和 |
| `isCancel` | Integer | 是否为作废订单 |
| `receiverName` | String | 收件人姓名 |
| `timeoutActionTime` | String | 平台timeout_action_time |
| `isHandlerMemo` | Integer | 是否处理卖家备注： 0：未处理 1：已处理 |
| `expressCompanyName` | String | 快递公司的编号 |
| `isCancelDistributorAttribute` | Integer | 是否是取消分销属性触发的订单同步，如果是1，则不需要匹配供应商，因为是取消分销属性 |
| `tradeFrom` | String | 订单来源，例如手机端或者PC端 |
| `platformPaymentAmount` | Double | 平台支付金额 |
| `totalFee` | String | 总额 |
| `needInvoice` | Integer | 需要开具发票 1开启，0关闭 |
| `wlbTemplateType` | Integer | 供销订单用 |
| `timingPromise` | String | 服务身份标识 |
| `sourceName` | String | 订单来源于哪里 分销系统里记为分销商name（不持久化） |
| `invoiceKind` | String | 发票种类（ 1 电子发票 2 纸质发票 |

#### trades.orders（订单商品明细）

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| `sysSkuPropertiesName` | String | 系统SKU的规格属性名称 |
| `discountRate` | Double | 折扣率 |
| `discountFee` | String | 优惠金额 |
| `payTime` | String | 付款时间 |
| `numIid` | String | 平台商品数字编号 |
| `num` | Integer | 子订单商品数量 |
| `source` | String | 订单来源 tb,tm,jd,sys |
| `shortTitle` | String | 商品简称 |
| `sysTitle` | String | 系统商品的标题 |
| `type` | Integer | 0普通商品<br />1赠品 是否是赠品不能根据type来判断，而要根据giftNum&gt;0来判断<br />2套件商品<br />3组合商品<br />4加工商品 |
| `tid` | String | 所属订单的平台编号 |
| `isPresell` | Integer | 是否为预售订单<br />0:正常订单，<br />1：是预售；<br />2预售转正常；<br />3：系统预售 |
| `consignTime` | String | 子订单发货时间 |
| `uniqueCode` | String | 订单商品唯一码 |
| `outerSkuId` | String | outer_sku_id |
| `sysSkuPropertiesAlias` | String | 系统SKU规格属性别名 |
| `price` | String | 商品销售价 |
| `updTime` | String | 数据更新时间 |
| `giftNum` | Integer | 赠品的order数量 |
| `stockNum` | Integer | 分配的库存数量 |
| `stockStatus` | String | 当前子订单的库存状态,如库存正常(NORMAL),库存不足(INSUFFICIENT) |
| `modified` | String | 子订单平台的修改时间 |
| `payment` | String | 实付金额,公式:实付金额 =应付金额 -优惠金额 |
| `id` | Long | 子订单系统编号 |
| `adjustFee` | String | 手工调整金额 |
| `skuId` | String | 平台规格编号 |
| `created` | String | 下单时间 |
| `insufficientCanceled` | Integer | 是否取消库存缺货异常（INSUFFICIENT,EMPTY,EXCEP）：<br />0否，1是 |
| `taobaoId` | Long | 订单店铺的平台ID |
| `diffStockNum` | Integer | 缺货数量=num-stockNum（不需要持久化） |
| `sysSkuRemark` | String | 系统规格备注 |
| `sysOuterId` | String | 系统商家编码，如果是商品则为商品的商家编码，如果为SKU则为SKU的商家编码 |
| `saleFee` | String | 分销金额 |
| `exceptions` | String | 子订单异常信息 |
| `volume` | Double | 单个商品体积 |
| `picPath` | String | 平台商品图片链接 |
| `sysItemRemark` | String | 系统规商品备注 |
| `companyId` | Long | 公司编号 |
| `unit` | String | 系统商品数量单位 |
| `netWeight` | Double | 子订单中单个商品净重 |
| `osGiftCount` | String | 前N有礼赠品数量 |
| `oldStatus` | String | 子订单旧的平台状态，不做持久化，一般用于订单同步更新时的判断比较 |
| `warehouseId` | Long | 子订单商品库存操作时的仓库ID,要保证与所属trade中的warehouseId一致 |
| `isVirtual` | Integer | 是否虚拟商品，虚拟商品不需要申请库存，发货时也不需要消费库存、归还库存 |
| `status` |  | 子订单平台状态 |
| `sysConsigned` | Integer | 是否在系统发货 1是，0否 |
| `soid` | String | 子订单平台编号（由于某些平台的子订单号为字符类型，需要用此字段保存，后续可将oid修改为String类型） |
| `refundStatus` | String | 子订单退款状态 |
| `oid` | Long | 子订单平台编号(淘宝有, 京东没有) |
| `itemSysId` | Long | 匹配到的系统商品ID |
| `title` | String | 商品标题 |
| `sid` | Long | 所属主订单的系统编号 |
| `forcePackNum` | Integer | 强制验货数量 |
| `acPayment` | String | 不变的实付金额,进来后不变 |
| `sysStatus` | String | 订单系统状态 |
| `sysItemOuterId` | String | 系统主商家编码 |
| `osSortNum` | String | 前N有礼中奖名次，获得奖品的订单才会有该字段 |
| `skuPropertiesName` | String | 规格属性名 |
| `skuUnit` | String | 系统规格计量单位 |
| `cost` | Double | 商品成本价 |
| `isCancel` | Integer | 是否作废，未发货的子订单与所属的trade保持一致 |
| `salePrice` | String | 分销价格 |
| `oldPrice` | String | 原商品销售价，在套件转单品去匹配赠品时候使用 |
| `identCode` | String | 识别码 |
| `combineId` | Long | 如果是套件单品,则该字段的值为其所属的套件子订单的id,否则为0 |
| `userId` | Long | 订单所属店铺用户ID |
| `ptConsignTimeString` | String | 平台发货时间 |
| `totalFee` | String | 应付金额,公式:应付金额 =商品数量 商品单价 +手工调整价 |
| `sysPicPath` | String | 系统商品图片链接 |
| `skuSysId` | Long | 匹配到的系统规格ID |
| `outerId` | String | 商家编码，不做持久化，仅仅只是为了系统订单添加商品使用 |
| `endTime` | String | 子订单的交易结束时间 |
| `estimateConTime` | String | 预计发货时间 |
| `refundId` | String | 平台退款编号 |
| `postFee` | String | 单笔订单运费 |
| `authorId` | string | 达人id |
| `actualPostFee` | string | 实际运费 |
| `splitType` | int | 拆单类型 -1:未拆单 1:拆单 |
| `splitSid` | long | 如果splitType等于1。则对应拆单的主单的sid。否则为-1 |
| `endTime` | string | 完结时间 |
| `templateId` | long | 快递模板id |
| `templateName` | string | 快递模板名称 |
| `isPackage` | integer | 订单是否打包 0.未打包 1.打包 |
| `sellerFlag` | integer | 平台上的卖家旗帜 0.灰 1.红 2.橙 3.绿 4.蓝 5紫 |
| `payAmount` | String | 商品买家已付金额 |

#### trades.tradeTags（订单自定义标签）

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| `bgColor` | String | 标签背景颜色 |
| `remark` | String | 标签备注 |
| `id` | Long | 标签id |
| `tagName` | String | 标签名称 |
| `fontColor` | String | 标签前景颜色 |

### 原文说明

`trades.orders.status` 的类型在原文中为空；`trades.orders.endTime` 在原文中出现两次，分别为 `String`（子订单的交易结束时间）和 `string`（完结时间）。以上均按原文保留。

---

## 奇门售后单查询（列表）

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E5%A5%87%E9%97%A8%E5%94%AE%E5%90%8E%E5%8D%95%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/1800-%E5%A5%87%E9%97%A8%E5%94%AE%E5%90%8E%E5%8D%95%E6%9F%A5%E8%AF%A2.md

# 奇门售后单查询（列表）

查询售后单列表。本文根据《快麦ERP奇门自定义接口V2.6.docx》整理。

### 接入说明

调用前请先阅读[奇门自定义接口接入说明](./1700-奇门自定义接口接入说明.md)，配置 `target_app_key`、`customerId` 和 `warehouseCode`。

### 请求地址

| 环境 | 服务地址 |
| --- | --- |
| 正式环境 | `http://z29932hpkn.api.taobao.com/router/qm` |

### API接口地址

| 参数名 | 值 | 说明 |
| --- | --- | --- |
| `method` | `kuaimai.refund.list.query` | 查询售后单列表 |

### 请求参数

以下为接口业务参数；`false` 表示非必填。奇门系统参数和路由参数见[接入说明](./1700-奇门自定义接口接入说明.md)。

| 名称 | 类型 | 是否必须 | 描述 |
| --- | --- | --- | --- |
| `pageNo` | Integer | false | 页码 |
| `pageSize` | Integer | false | 页面大小（每页数据条数） |
| `refundType` | Integer | false | 类型<br />1：退款；<br />2：退货；<br />3：补发；<br />4：换货；<br />5:  发货前的退款 |
| `asVersion` | Integer | false | 售后版本<br />1：旧版<br />2：新版（默认） |
| `startTime` | String | false | 开始时间（yyyy-MM-dd HH:mm:ss）<br />（默认更新时间） |
| `endTime` | String | false | 结束时间（yyyy-MM-dd HH:mm:ss）（默认更新时间） |
| `userId` | Long | false | 店铺编号 |
| `warehouseId` | Long | false | 订单分仓id |
| `tid` | string | false | 平台订单号 |
| `id` | long | false | 售后工单号 |
| `suiteSingle` | integer | false | 是否返回套件信息 0:不返回套件信息，1：返回套件信息，默认0 |

### 响应参数

以下按原文的字段层级展示，各子表标题表示字段所属的对象路径。

#### 顶层字段

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| `total` | Long | 总数 |
| `pageNo` | Integer | 页码 |
| `hasNextPage` | Boolean | 是否有下一页,默认否 |
| `workOrders` | List | 售后工单明细 |

#### workOrders（售后工单明细）

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| `textReason` | String | 原订单平台备注 |
| `reason` | String | 售后原因<br />1:退运费<br />2:收到商品破损<br />3:商品错发/漏发<br />4:商品需要维修<br />5:发票问题<br />6:收到商品与描述不符<br />7:我不想要了<br />8:商品质量问题<br />9:未按约定时间发货 |
| `shortId` | Long | 售后工单短号 |
| `refundExpressId` | String | 退回快递单号 |
| `refundWarehouseId` | Long | 退货仓库ID |
| `refundRemindTimeout` | String | 超时日期 |
| `shopName` | String | 店铺名称 |
| `remark` | String | 工单备注 |
| `source` | String | 工单来源 |
| `wangwangNum` | String | 买家旺旺号 |
| `refundPostFee` | String | 应退运费 |
| `tid` | String | 平台订单号 |
| `sid` | Long | 系统订单编号 |
| `storageProgress` | Integer | 退货进度 |
| `id` | Long | 售后工单号 |
| `afterSaleType` | Integer | 类型<br />1：退款；<br />2：退货；<br />3：补发；<br />4：换货<br />5:发货前的退款 |
| `refundWarehouseName` | String | 退货仓库名称 |
| `created` | String | 生成时间 |
| `finished` | String | 完成时间 |
| `refundMoney` | Double | 退款金额 |
| `platformStatus` | Integer | 平台状态 |
| `buyerName` | String | 买家姓名 |
| `userId` | Long | 店铺ID |
| `reissueSid` | Long | 补发或换货时生成的trade(订单)的sid |
| `buyerPhone` | String | 买家手机号 |
| `goodStatus` | Integer | 货物状态 |
| `refundExpressCompany` | String | 退回快递公司 |
| `dealResult` | Integer | 处理结果 |
| `status` | Integer | 工单状态<br />1:未分配<br />2:未解决<br />3:优先退款<br />4:同意<br />5:拒绝<br />6:确认退货<br />7:确认发货<br />8:确认退款<br />9:处理完成<br />10:作废 |
| `explains` | string | 售后说明 |
| `rawRefundMoney` | string | 平台实退金额 |
| `receiveGoodsTime` | String | 入仓时间 |
| `refundableMoney` | Long | 系统应退金额 |
| `items` | List | 售后工单商品明细集合 |

#### workOrders.items（售后工单商品明细）

| 名称 | 类型 | 描述 |
| --- | --- | --- |
| `goodItemCount` | Integer | 良品数（销退入库时使用） |
| `receiveGoodsOperatorNames` | String | 入仓操作员名 |
| `badItemCount` | Integer | 次品数 （销退入库时使用） |
| `refundMoney` | String | 退款金额 |
| `remark` | String | 备注 |
| `type` | Integer | 售后类型（商品级别）<br />1:退货商品 2:补发商品 |
| `title` | String | 商品名称 |
| `propertiesName` | String | 商品规格 |
| `receivableCount` | Integer | 申请数量 |
| `isMatch` | Integer | 商品状态（匹配/未匹配）<br />0：匹配 1：未匹配 |
| `receiveGoodsTime` | String | 入仓时间 |
| `picPath` | String | 商品图片 |
| `mainOuterId` | String | 主商家编码 |
| `itemRealQty` | Integer | 实退数量 |
| `price` | Double | 销售价 |
| `outerId` | String | 商家编码 |
| `payment` | String | 实付金额 |
| `suite` | integer | 是否是套件商品：0=普通商品，1=套件 |
| `suiteSingle` | integer | 是否是套件单品：0=套件本身，1=套件下单品 |
| `combineId` | long | 套件组id,同一套件下套件本身和套件下单品相同 |
| `rawRefundMoney` | long | 平台实退金额 |
| `refundableMoney` | Long | 系统应退金额 |

---

## 订单操作日志

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E8%AE%A2%E5%8D%95%E6%93%8D%E4%BD%9C%E6%97%A5%E5%BF%97
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/200-%E8%AE%A2%E5%8D%95%E6%93%8D%E4%BD%9C%E6%97%A5%E5%BF%97.md

# 订单操作日志

**请求方法:** POST

### 系统相关界面
"界面路径：【交易】----【订单操作日志】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.trace.list | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sids | string | 系统订单号,多个逗号隔开,最多支持200组 |  | 
 | operators | string | 操作人,多个逗号隔开,最多支持20组 |  | 
 | action | string | 操作类型(自定义文本) |  | 
 | content | string | 操作备注 |  | 
 | operateTimeStart | long | 操作起始时间（时间戳） |  | 
 | operateTimeEnd | long | 操作截止时间（时间戳） |  | 
 | pageNo | integer | 页码 |  | 
 | pageSize | integer | 每页条数,最大支持200条,默认50条 |  | 

 

### 请求示例
示例一：

```` 
{
  "sids":"string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | 示例：1434184596594470321 | 必填 | 
 | list | array | 数据列表 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | page | object | 数据字典 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | operateTime | long | 操作时间 | 必填 | 
 | action | string | 操作名称 | 必填 | 
 | operator | string | 操作员名称 | 必填 | 
 | content | string | 操作内容 | 必填 | 
 | sid | long | 系统单号 | 必填 | 

# subTable: page
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | startRow | integer | 起始行 | 必填 | 
 | offsetRow | integer | 结束行 | 必填 | 
 | pageNo | integer | 页码 | 必填 | 
 | pageSize | integer | 每页条数 | 必填 | 

 

### 响应示例
```
{
  "traceId": "xxxxxxxxx",
  "list": [
    {
      "operateTime": xxxxxxx,
      "action": "xxxxxxx",
      "operator": "xxxxxxx",
      "content": "xxxxxxxxx",
      "sid": xxxxxxxx
    }
  ],
  "success": true,
  "page": {
    "startRow": 0,
    "offsetRow": 50,
    "pageNo": 1,
    "pageSize": 50
  }
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|20009|系统订单号格式不正确|检查参数是否正确|
|20020|系统订单号数量最大支持200组|超过单次请求最大数|
|20021|订单操作日志操作人最大支持20组|超过单次请求最大数|
|20001|页码为空或不符合规定|页码参数不正确|
|20002|页数为空或不符合规定|页数参数不正确|

---

## 修改订单收货地址

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E6%94%B6%E8%B4%A7%E5%9C%B0%E5%9D%80
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/250-%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E6%94%B6%E8%B4%A7%E5%9C%B0%E5%9D%80.md

# 修改订单收货地址

**请求方法:** POST

### 接口描述
此接口只允许修改系统状态为‘待审核’的订单的收货地址

### 系统相关界面
"界面路径：【交易】----【订单管理】----【收获人信息】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.receiver.info.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | long | 系统编号(平台单号二选一) |  | 
 | tid | string | 平台单号(系统编号二选一) |  | 
 | receiverName | string | 收货人姓名 | 必填 | 
 | receiverMobile | string | 收货人手机号码(收货人电话二选一) |  | 
 | receiverPhone | string | 收货人电话(收货人手机号码二选一) |  | 
 | receiverZip | string | 收件邮编 |  | 
 | receiverState | string | 收件省份 | 必填 | 
 | receiverCity | string | 收件市 | 必填 | 
 | receiverDistrict | string | 收件区县 | 必填 | 
 | receiverStreet | string | 收件街道 | 必填 | 
 | receiverAddress | string | 收货详细地址 | 必填 | 

 

### 请求示例
```json
{
	"sid": 1,
	"receiverAddress": "收货详细地址",
	"receiverName": "收货人姓名",
	"receiverMobile": "收货人手机号码",
	"receiverPhone": "收货人电话",
	"receiverZip": "收件邮编",
	"receiverState": "收件省份",
	"receiverCity": "收件市",
	"receiverDistrict": "收件区县"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | string | 状态 | 必填 | 
 | traceId | long | traceId | 必填 | 

 

### 响应示例
```json
{
  "success": true,
  "traceId": 1
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.receiver.info.update:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|9|业务异常|请根据返回的错误信息进行处理|
|25|服务方法(erp.trade.receiver.info.update:1.0)的签名无效|签名参数错误|
|33|修改订单收货信息失败,参数异常!|合单或者拆单不允许修改地址|
|33|详细收货地址字符长度不能超过228个|请检查该参数的值是否规范|
|50|收货人姓名不能为空！|请检查该参数的值是否规范|
|50|收件省份不能为空!|请检查该参数的值是否规范|
|50|收件市不能为空!	|请检查该参数的值是否规范|
|50|收件区县不能为空!|请检查该参数的值是否规范|
|50|收货人手机号码/电话不能为空!|请检查该参数的值是否规范|
|50|系统单号/平台单号不能为空!|请检查该参数的值是否规范|
|50|收件详细地址不能为空!|请检查该参数的值是否规范|

---

## 修改订单卖家备注与旗帜

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E5%8D%96%E5%AE%B6%E5%A4%87%E6%B3%A8%E4%B8%8E%E6%97%97%E5%B8%9C
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/300-%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E5%8D%96%E5%AE%B6%E5%A4%87%E6%B3%A8%E4%B8%8E%E6%97%97%E5%B8%9C.md

# 修改订单卖家备注与旗帜

**请求方法:** POST

### 系统相关界面
"界面路径：【交易】----【订单管理】----【卖家备注】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.seller.memo.upload | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | long | 系统编号(平台订单号二选一) |  | 
 | tid | string | 平台订单号(系统编号二选一) |  | 
 | sellerMemo | string | 卖家备注(旗帜二选一必填) |  | 
 | flag | long | 旗帜(卖家备注二选一必填) 系统旗帜 0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红 |  | 

 

### 请求示例
```json
{
"sid": "long",
"sellerMemo":"卖家备注",
"flag": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | traceId | 必填 | 
 | success | boolean | 状态 | 必填 | 

 

### 响应示例
```json
{
    "traceId": "1292052721336675873",
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.seller.memo.upload:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.trade.seller.memo.upload:1.0)的签名无效|签名参数错误|
|50|系统单号/平台单号不能为空!|请检查该参数的值是否规范				|
|50|卖家备注与旗帜二选一必填！|请检查该参数的值是否规范				|

---

## 批量修改订单标签

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E6%89%B9%E9%87%8F%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E6%A0%87%E7%AD%BE
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/350-%E6%89%B9%E9%87%8F%E4%BF%AE%E6%94%B9%E8%AE%A2%E5%8D%95%E6%A0%87%E7%AD%BE.md

# 批量修改订单标签

**请求方法:** POST

### 系统相关界面
"界面路径：【交易】----【订单管理】----【订单标记】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.tag.batch.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | tids | string | 平台id,多个用逗号分隔，最多支持20组！(与sids 二选一必填) | 必填 | 
 | tagIds | string | 标签id,多个用逗号分隔(通过erp.trade.query.tag.list获取) | 必填 | 
 | type | integer | 类型 1=新增，2=删除 | 必填 | 
 | sids | string | 系统订单id,多个用逗号分隔，最多支持20组！(与tids 二选一必填) | 必填 | 

 

### 请求示例
```json
{
"type": "int",
"tagIds": "string",
"tids": "string",
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | successIds | array | 成功id集合 |  | 
 | failedIds | array | 失败id集合 |  | 
 | traceId | long | traceId |  | 

 

### 响应示例
```json
{
    "traceId": "1434044374502291936",
    "successIds": [
        "3733125600156609"
    ],
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.tag.batch.update:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.trade.tag.batch.update:1.0)的签名无效|签名参数错误|

---

## 订单作废接口

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E8%AE%A2%E5%8D%95%E4%BD%9C%E5%BA%9F%E6%8E%A5%E5%8F%A3
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/400-%E8%AE%A2%E5%8D%95%E4%BD%9C%E5%BA%9F%E6%8E%A5%E5%8F%A3.md

# 订单作废接口

**请求方法:** POST

### 接口描述
订单作废接口,作废订单状态范围:待付款,待审核,等待财审,等待人工审核,审核完成,待打印快递单,待打印发货单,待打包,待称重,待发货,待供销商发货

### 系统相关界面
"界面路径：【交易】----【订单管理】----【作废订单】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.cancel | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sids | string | 系统订单号,多个逗号隔开，选填:平台订单号二选一，优先系统订单号 |  | 
 | tids | string | 平台订单号,多个逗号隔开，选填:系统订单号二选一，优先系统订单号 |  | 

 

### 请求示例
示例一：

````
{
  sids:"1,2,3"
}
````

示例二：

````
{
  tids:"1,2,3"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | successIds | long\[\] | 成功id集合 |  | 
 | failedIds | long\[\] | 失败id集合 |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 

 

### 响应示例
```
{
  "successIds": long[],
  "failedIds": long[],
  "success": "boolean",
  "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.cancel:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|系统订单号数量最大支持20组！|20005|参数过长||
|系统订单号数量最大支持20组!|20009|参数过长||
|系统订单号和平台订单号不能同时为空!|20010|||
|系统订单号格式不正确！|20009|检查参数是否合法||
|平台订单号格式不正确|20010|检查参数是否合法||
|订单作废失败|30079|请根据返回的错误信息进行处理||

---

## 订单发货拦截接口

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E8%AE%A2%E5%8D%95%E5%8F%91%E8%B4%A7%E6%8B%A6%E6%88%AA%E6%8E%A5%E5%8F%A3
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/450-%E8%AE%A2%E5%8D%95%E5%8F%91%E8%B4%A7%E6%8B%A6%E6%88%AA%E6%8E%A5%E5%8F%A3.md

# 订单发货拦截接口

**请求方法:** POST

### 接口描述
订单发货拦截接口(只能拦截待审核,待财审订单，将订单作废)

### 系统相关界面
"界面路径：【交易】----【订单发货】----【扫描发货】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.send.goods.intercept | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sids | string | 系统订单号,多个逗号隔开 | 必填 | 

 

### 请求示例
示例一：

````
{
  "sids":"1,2,3"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | successIds | long \[ \] | 成功id集合 |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 | failedIds | long \[ \] | 失败id集合 |  | 

 

### 响应示例
```
{
    "successIds":[1,2],
    "failedIds":[3],
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.send.goods.intercept:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|30003|系统订单号不能为空|系统订单号不能为空|
|30004|系统订单号格式不正确|系统订单号格式不规范，请按规范填写|
|30005|系统订单号最多支持20组！|请检查系统订单号是否超过20组|
|30006|订单发货拦截失败|请根据返回的错误信息进行处理|

---

## 创建系统手工单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E5%88%9B%E5%BB%BA%E7%B3%BB%E7%BB%9F%E6%89%8B%E5%B7%A5%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/50-%E5%88%9B%E5%BB%BA%E7%B3%BB%E7%BB%9F%E6%89%8B%E5%B7%A5%E5%8D%95.md

# 创建系统手工单

**请求方法:** POST

### 接口描述
创建系统手工单，原名为‘创建订单’

### 系统相关界面
"界面路径：【交易】----【订单管理】----【新建订单】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.create | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | userId | long | 店铺编号 | 必填 |  | 
 | warehouseId | long | 仓库ID | 必填 |  | 
 | orders | array | 订单商品明细集合 | 必填 |  | 
 | postFee | string | 运费（单位：元） |  |  | 
 | payment | string | 实付金额（例如1.00）（单位：元） | 必填 |  | 
 | tid | string | 平台订单号(相同tid只能推送一次) |  |  | 
 | receiverName | string | 收件人姓名 | 必填 |  | 
 | receiverState | string | 收件省份 | 必填 |  | 
 | receiverCity | string | 收件市 | 必填 |  | 
 | receiverDistrict | string | 收件区县 | 必填 |  | 
 | receiverStreet | string | 收件街道 | 必填 |  | 
 | receiverAddress | string | 收件详细地址 | 必填 |  | 
 | receiverZip | string | 收件邮编 |  |  | 
 | receiverMobile | string | 收件人手机号（收件人手机号和收件人固话至少需要设置一个） |  |  | 
 | receiverPhone | string | 收件人固话（收件人手机号和收件人固话至少需要设置一个） |  |  | 
 | mobileTail | string | 手机后四位尾号 |  |  | 
 | payTime | string | 付款时间 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | force | boolean | 新建订单库存不足时是否强制生成  true是   false否 |  | false | 
 | expressCode | string | 快递公司的编码，详情查看快递编码对应表 |  |  | 
 | buyerNick | string | 平台订单上的买家昵称 |  |  | 
 | sellerMemo | string | 平台上的卖家备注 |  |  | 
 | sellerFlag | long | 订单旗帜 0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红 |  |  | 
 | sysMemo | string | 订单系统备注 |  |  | 
 | totalFee | string | 总额 |  |  | 
 | warehouseName | string | 仓库名称 |  |  | 
 | discountFee | string | 优惠金额 |  |  | 
 | adjustFee | string | 手工调整订单价格 |  |  | 
 | saleFee | string | 分销金额 |  |  | 
 | invoiceKind | string | 发票种类（ 1 电子发票 2 纸质发票 ） |  |  | 
 | invoiceName | string | 发票抬头 |  |  | 
 | buyerTaxNo | string | 买家税号 |  |  | 
 | invoiceType | string | 发票类型 1普通 2增值 |  |  | 
 | invoiceRemark | string | 发票备注 |  |  | 
 | needInvoice | integer | 需要开具发票 1开启，0关闭 |  |  | 
 | invoiceFormat | integer | 发票类型 1普通 2增值 |  |  | 
 | isUrgent | integer | 是否是加急订单    1.是    0.否 |  |  | 
 | isPresell | integer | 是否为预售订单：0:正常订单，1：是预售；2预售转正常；3：系统预售 |  |  | 
 | templateType | integer | 快递模版类型，0表示普通快递，1表示电子面单快递 |  | 0 | 
 | timeoutActionTime | string | 平台订单超时到期时间。格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | sysOuterId | string | 订单下第一个匹配系统商品的子订单的系统商家编码，若都没有匹配，则直接取第一个商品的平台商家编码 |  |  | 
 | receiverCountry | string | 收件国家，跨境订单使用 |  |  | 
 | subSource | string | 次来源地 jd 保存订单来源 |  |  | 
 | taxFee | string | 税费 |  |  | 
 | hasSuit | boolean | 是否含有套件    true.是   false.否 |  | false | 
 | packmaCost | double | 包材成本 |  |  | 
 | isHandlerMemo | integer | 是否处理卖家备注： 0：未处理 1：已处理 |  |  | 
 | isHandlerMessage | integer | 是否处理买家留言： 0：未处理 1：已处理 |  |  | 
 | timingPromise | string | 时效服务身份，如tmallPromise代表天猫时效承诺 |  |  | 
 | promiseService | string | 承诺服务类型，会有多个服务值，以英文半角逗号","切割，其中 tmallpromise.arrival.timing 代表到货承诺时效 tmallpromise.consign.timing代表发货承诺时效 |  |  | 
 | paymentDiff | string | 订单差额=系统实付金额-平台实收金额 区间值 |  |  | 
 | actualPostFee | string | 实际运费 |  |  | 
 | theoryPostFee | double | 理论运费 |  |  | 
 | tradePurchaseAmount | double | 订单实收金额 |  |  | 
 | platformPaymentAmount | double | 平台支付金额 |  |  | 
 | manualPaymentAmount | double | 手工支付金额 |  |  | 
 | grossProfit | double | 毛利润 |  |  | 
 | wlbTemplateType | integer | 供销订单用 |  |  | 
 | cancelFrom | integer | 供销订单使用,分销作废来源 0,取消分销属性 1，分销订单作废 |  |  | 
 | fxIsUpload | integer | 分销订单是否在系统上传（供销订单用） |  |  | 
 | isCancelDistributorAttribute | integer | 是否是取消分销属性触发的订单同步，如果是1，则不需要匹配供应商，因为是取消分销属性 0-否 |  |  | 
 | auditMatchRule | integer | 智能审核规则匹配结果 |  |  | 
 | type | string | 订单类型 21:客户订单 cod:货到付款|  |  | 
 | logisticsCompanyId | long | 用户物流公司ID |  |  | 

# subTable: orders
 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | outerId | string | 商家编码(系统主商品/规格ID二选一) |  |  | 
 | title | string | 商品标题 |  |  | 
 | outerSkuId | string | 规格商家编码 |  |  | 
 | sysSkuPropertiesName | string | 系统SKU的规格属性名称 |  |  | 
 | num | integer | 子订单商品数量(大于0) | 必填 |  | 
 | price | string | 商品销售价（单位：元） | 必填 |  | 
 | payment | string | 实付金额（单位：元）, 公式: 实付金额 = 应付金额(销售价) - 优惠金额  | 必填 |  | 
 | discountRate | double | 折扣率 |  |  | 
 | discountFee | string | 优惠金额 |  |  | 
 | salePrice | string | 分销价格 |  |  | 
 | theoryPostFee | double | 理论运费 |  |  | 
 | oid | long | 子订单平台编号 |  |  | 
 | saleFee | string | 分销金额 |  |  | 
 | picPath | string | 平台商品图片链接 |  |  | 
 | isVirtual | integer | 是否是虚拟商品，1：是虚拟商品，0:不是虚拟商品（虚拟商品不需要申请库存，发货时也不需要消费库存、归还库存） |  |  | 
 | customGiftType | long | 自定义赠品类型，暂定0 原有逻辑，1手工新增赠品 |  |  | 
 | itemSysId | long | 匹配到的系统主商品ID( 如指定了skuSysId非必填， 否则与商家编码二选一)   |  |  | 
 | skuSysId | long | 系统商品skuID   （未指定outerId时，非纯商品必填） |  |  | 
 | skuId | string | 平台skuID |  |  | 

 

### 请求示例
示例一：

````
{
    "receiverName": "XXXXXX",
    "sysMemo": "null",
    "receiverMobile": "XXXXXX",
    "receiverCity": "杭州市",
    "userId": "XXXXXX",
    "tid": "13356",
    "receiverAddress": "XXXXXX",
    "warehouseId": "XXXXX",
    "receiverDistrict": "杭州市",
    "receiverState": "浙江省",
    "force": "true",
    "orders": "[{\"num\":2,\"outerSkuId\":\"XXXXXX\",\"payment\":\"165.00\",\"price\":\"165.00\",\"title\":\"XXXXXXXX\"}]",
    "payment": "260"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 
 | sid | long | 系统订单号 | 必填 | 

 

### 响应示例
```
{
    "sid":"string",
	"success": "boolean",
	"trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.create:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|50|快递模版类型不合法！[0（普通快递）；1（电子面单快递）]|请检查该参数的值是否规范|
|50|发票种类类型不合法！[1（电子发票）；2（纸质发票）]|请检查该参数的值是否规范|
|50|需要开具发票类型不合法！[0（关闭）；1（开启）]|请检查该参数的值是否规范|
|50|发票类型不合法！[1（普通）；2（增值）]|请检查该参数的值是否规范|
|50|是否为预售订单类型不合法！[0（正常订单）；1（是预售）；2（预售转正常）；3（系统预售）]|请检查该参数的值是否规范|
|50|是否处理买家留言类型不合法！[0（未处理）；1（已处理）]|请检查该参数的值是否规范|
|50|是否处理卖家备注类型不合法！[0（未处理）；1（已处理）]|请检查该参数的值是否规范|
|50|分销作废来源类型不合法！[0（取消分销属性）；1（分销订单作废）]|请检查该参数的值是否规范|
|50|旗帜类型不合法！0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红 |请检查该参数的值是否规范|
|50|是否是取消分销属性触发的订单同步类型不合法！[0（非取消分销属性）；1（取消分销属性）]|请检查该参数的值是否规范|
|50|订单类型值不合法|请检查该参数的值是否规范|
|30051|店铺编号不能为空|请检查店铺编号是否有值|
|30052|订单商品明细集合不能为空|订单商品明细集合不能为空|
|30053|收件人姓名不能为空|请检查该字段是否有值|
|30055|收件省份不能为空|请检查该字段是否有值|
|30056|收件市不能为空|请检查该字段是否有值|
|30057|收件详细地址不能为空|请检查该字段是否有值|
|30058|收件区县不能为空|请检查该字段是否有值|
|30059|实付金额不能为空|请检查该字段是否有值|
|30060|邮费不能为空|请检查该字段是否有值|
|30061|orders参数传入有误，解析失败|请检查该字段是否有值|
|30062|自定义赠品类型值不合法|请检查该参数的值是否规范|
|30063|是否是虚拟商品类型值不合法|请检查该参数的值是否规范|
|30069|商品销售价格式错误|请检查该参数的值是否规范|

---

## 多快递单号查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E5%A4%9A%E5%BF%AB%E9%80%92%E5%8D%95%E5%8F%B7%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/500-%E5%A4%9A%E5%BF%AB%E9%80%92%E5%8D%95%E5%8F%B7%E6%9F%A5%E8%AF%A2.md

# 多快递单号查询

**请求方法:** POST

### 接口描述
多快递单号查询，仅支持订单为一单多包时查询

### 系统相关界面
"界面路径：【交易】----【订单查询】----【快递单号】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.multi.packs.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | long | 系统单号(系统单号或运单号二选一) |  | 
 | outSid | string | 快递单号(系统单号或运单号二选一) |  | 

 

### 请求示例
示例一：

```` 
{
  "sid":long
}
```` 
示例二：

```` 
{
  "outSid":"String"
}
```` 
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | cpCode | string | 快递公司编码 | 必填 | 
 | outSids | list | 订单所有快递单号 | 必填 | 
 | expressName | string | 快递公司中文名称 | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 
 | success | boolean | 示例：true | 必填 | 

 

### 响应示例
```
{
    "cpCode": "string",
    "outSids": "list",
    "expressName": "string",
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.multi.packs.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.trade.multi.packs.query:1.0)的签名无效|签名参数错误|

---

## 上传发货

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E4%B8%8A%E4%BC%A0%E5%8F%91%E8%B4%A7
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/550-%E4%B8%8A%E4%BC%A0%E5%8F%91%E8%B4%A7.md

# 上传发货

**请求方法:** POST

### 系统相关界面
"界面路径：【交易】----【订单管理】----【订单发货】"
### 接口说明
1. 支持在快麦ERP中将【已审核】订单操作发货，上传平台的节点根据快麦中的设置生效，请求参数只需要传sids/tid和consignType；
2. 支持传入快递编码与运单号操作发货，
    1. 如果该订单为平台订单，则不扣系统里的库存，为其他ERP发货；
    2.  如果订单为手工单，系统状态会更新为【卖家已发货】

注意，
1. 调用该接口前需要先在快麦中配置好对应的物流公司及编码，使传入的快递编码可以自动绑定快递模版，如果快递编码匹配出多个快递模版，则只会任意匹配任一快递模版；
2. 非在快麦中获取的快递公司与快递单号，直接上传平台时可能会出现上传失败、或风控异常的风险，需谨慎使用；
3. 如果在上传平台时出现了上传异常，则需在快麦里操作【取消异常】才能重新调用接口推送；
4. 不支持拆单发货，线上平台的订单状态会因为子订单发货而整个订单会变成已发货。
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.consign | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sids | string | 系统订单号,多个逗号隔开，选填:平台订单号二选一，优先系统订单号 | 必填 | 
 | consignType | string | 发货类型 DUMMY："无需物流发货",OFFLINE: "自己联系物流发货",ONLINE:"在线订单发货",ONLINE_CONFIRM:"确认发货通知",RESEND:"修改物流公司和运单号并重新发货" 不填默认为OFFLINE |  | 
 | tid | string | 平台订单号，选填:系统订单号二选一，优先系统订单号 |  | 
 | expressCode | string | 快递公司编码 |  | 
 | outSid | string | 运单号 |  | 
 | operateType | string | 操作类型，不填operateType但是填了运单号和快递公司编码会仅上传平台，如果consignType传RESEND则不用传operateType；  1:仅系统发货 ；2:系统发货并上传平台 ,6 系统发货 并上传 且会返回上传失败的信息| 非必填 | 

 

### 请求示例
示例一：

````
{
    sids: "string",
    outSid: string,
    consignType: string,
    expressCode: string,
    tid: string
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 唯一码列表 |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 | total | long | 总数 |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | templateType | integer | 订单快递模版类型，0表示普通，1表示电子面单 |  | 
 | source | string | 订单来自哪个平台   sys:系统 jd：京东 tb：淘宝 tm：天猫 tjb：淘宝特价版 1688：阿里巴巴 |  | 
 | templateId | long | 订单快递模版ID |  | 
 | warehouseName | string | 仓库名称 |  | 
 | tid | string | 平台订单号 |  | 
 | sid | long | 系统订单号 |  | 
 | isError | integer | 上传平台是否发生异常 1是 0否 |  | 
 | logisticsExceptType | string | 物流异常类型 |  | 
 | orderIds | string | 本次发货时参与发货的子订单ID,以逗号分割. 一笔订单发货时,有些子订单处于已发货或已发货之后的状态这些子订单不再参与发货 |  | 
 | tradePay | long | 订单付款时间快照 |  | 
 | consigned | long | 订单发货时间 |  | 
 | logisticsModified | long | 物流最近更新时间 |  | 
 | errorDesc | string | 上传失败的异常信息 |  | 
 | consignType | string | 发货类型 OFFLINE ONLINE DUMMY |  | 
 | created | long | 当前记录创建时间 |  | 
 | retryCount | integer | 重试次数 |  | 
 | retryTime | long | 重试时间 |  | 
 | uploadTime | long | 最近一次上传时间 |  | 
 | userId | long | 订单所属店铺的用户ID |  | 
 | mergeSid | long | 合单的订单设置主单的sid |  | 
 | outSid | string | 运单号 |  | 
 | companyId | long | 公司编号 |  | 
 | wlySubscribeFlag | integer | 物流云订阅状态 默认0 未订阅 1已订阅 2订阅失败 |  | 
 | templateName | string | 当时的快递模版名称 |  | 
 | warehouseId | long | 仓库ID |  | 
 | buyType | integer | 发货时用户的订购类型     默认0, 按单付费为1 |  | 
 | logisticsStatus | string | 物流状态 |  | 

 

### 响应示例
```
{
    "list":[{
	"templateType": "int",
	"source": "string",
	"templateId": long,
	"warehouseName": "string",
	"tid": "string",
	"sid": long,
	"isError": integer,
	"logisticsExceptType": "string",
	"orderIds": "string",
	"tradePay": long,
	"consigned": long,
	"logisticsModified": long,
	"errorDesc": "string",
	"consignType": "string",
	"created": long,
	"retryCount": "int",
	"retryTime": long,
	"uploadTime": long,
	"userId": "int",
	"mergeSid": "int",
	"outSid": "string",
	"scalping": "int",
	"companyId": "int",
	"wlySubscribeFlag": "int",
	"templateName": "string",
	"warehouseId": "int",
	"buyType": "int",
	"enableStatus": "int",
	"logisticsStatus": "string"
}],
	"success": "boolean",
	"trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.consign:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 异常示例二
````
{
    "traceId": "2750170478828000000",
    "msg": "系统订单号和平台订单号不能同时为空!",
    "code": "20010",
    "success": false
}
````
### 异常示例三
````
{
    "msg": "订单发货上传失败:java.lang.IllegalArgumentException: 非审核成功订单[4415538908555951]不能无需物流发货",
    "traceId": "2753180604479142137",
    "code": "30078",
    "success": false
}
````
### 异常示例四
````
{
    "traceId": "2750174470969300000",
    "success": true,
    "list": [
        {
            "templateType": 0,
            "source": "tb",
            "templateId": -1,
            "warehouseName": "默认仓库",
            "tid": "55176155600000",
            "sid": 4414073450100000,
            "isError": 1,
            "tradePay": 1691391790000,
            "consigned": 1691391986592,
            "errorDesc": "缺少运单号",
            "consignType": "OFFLINE",
            "userId": 32941,
            "mergeSid": -1,
            "warehouseId": 13821,
            "buyType": 2,
            "enableStatus": 1
        }
    ]
}
````
### 异常示例五
````
{
    "traceId": "2750186668676500000",
    "success": true,
    "list": [
        {
            "templateType": 0,
            "source": "tb",
            "templateId": 53813,
            "warehouseName": "默认仓库",
            "tid": "551761556331008",
            "sid": 4414073450146551,
            "isError": 1,
            "tradePay": 1691391790000,
            "consigned": 1691392349466,
            "errorDesc": "异常订单",
            "consignType": "OFFLINE",
            "userId": 32941,
            "mergeSid": -1,
            "outSid": "888888990000",
            "templateName": "德邦快递德邦测试模板",
            "warehouseId": 13821,
            "buyType": 2,
            "enableStatus": 1
        }
    ]
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||||
|非法参数!|50|检查参数类型等是否合法||||
|系统订单号和平台订单号不能同时为空!|20010|检查系统订单号或平台订单号是否已填写||||
|系统订单号格式不正确！|20009|检查参数是否合法||||
|系统订单号数量最大支持10组！|20003|参数过长||||
|发货类型枚举值不合法！[DUMMY：无需物流发货OFFLINE: 自己联系物流发货ONLINE：在线订单发货ONLINE_CONFIRM：确认发货通知RESEND：修改物流公司和运单号并重新发货]|50|检查参数是否合法|
|订单发货上传失败|30078|根据失败详细检查订单是否满足条件|
| "errorDesc": "缺少运单号"||检查运单号或快递公司编码是否已填写||||
| "errorDesc": "异常订单"||检查订单是否已被标记异常||||

---

## 上传备注与旗帜

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E4%B8%8A%E4%BC%A0%E5%A4%87%E6%B3%A8%E4%B8%8E%E6%97%97%E5%B8%9C
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/600-%E4%B8%8A%E4%BC%A0%E5%A4%87%E6%B3%A8%E4%B8%8E%E6%97%97%E5%B8%9C.md

# 上传备注与旗帜

**请求方法:** POST

### 系统相关界面
"界面路径：【交易】----【订单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.upload.memo.flag | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | memo | string | 备注 | 必填 | 
 | flag | long | 旗帜 系统旗帜 0:灰, 1:红, 2:黄, 3:绿, 4:蓝, 5:紫, 6:橙, 7:浅蓝, 8:浅粉, 9:深绿, 10:桃红 | 必填 | 
 | userId | long | 店铺编号 | 必填 | 
 | tid | string | 平台订单号 | 必填 | 

 

### 请求示例
示例一：

````
{
  "tid":"string",
  "userId":"long",
  "flag":"long",
  "memo":"string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

 

### 响应示例
```
{ 
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.upload.memo.flag:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|50|旗帜类型不合法！[0（灰）；1（红）；2（橙）；3（绿）；4（蓝）；5（紫）]|请检查该参数是否有值|
|30009|上传备注与旗帜缺少必要参数|请检查入参是否有值|
|30010|上传备注与旗帜失败|请根据返回的错误信息进行处理|

---

## 包装验货

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E5%8C%85%E8%A3%85%E9%AA%8C%E8%B4%A7
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/650-%E5%8C%85%E8%A3%85%E9%AA%8C%E8%B4%A7.md

# 包装验货

**请求方法:** POST

### 接口描述
参数运单号与订单号需要传其中一个,如果都传的情况,以运单号为准,有强唯一码商品的订单,验货需要传入快麦系统生成的唯一码对应!

### 系统相关界面
"界面路径：【交易】----【包装验货】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.pack | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | uniqueCodes | string | 唯一码信息,逗号隔开 |  | 
 | sid | string | 系统订单号 |  | 
 | orderIdIdentCodes | string | 子订单与识别码的对应参数 |  | 
 | orderScanInfos | string | 包装验货扫描信息(json字符串)例如:\[\{"scanCode":"abc", "num":1\},\{"scanCode":"def", "num":3\}\] |  | 
 | canForce | boolean | 是否支持强制      支持true/不支持false | 必填 | 
 | outSid | string | 运单号 |  | 

 

### 请求示例
示例一：

```
{
    "uniqueCodes": "032131231,04324232534";
    "packmaOuterIds": "string";
    "staffId": number;
    "orderScanInfos": "string";
    "sid": string;
    "orderIdIdentCodes": string;
    "canForce": true;
}
```
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 

 

### 响应示例
```
{
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.pack:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释

| 错误码 |错误信息|解决方案|
|-|-|-|
|30000|扫描数量不规范，不能小于0|扫描数量不规范，不能小于0|
|30001|扫码类型不规范，请按规范填写|扫码类型不规范，请按规范填写|
|30002|包装验货失败|请根据返回的错误信息进行处理|

---

## 波次手动拣选

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E6%B3%A2%E6%AC%A1%E6%89%8B%E5%8A%A8%E6%8B%A3%E9%80%89
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/700-%E6%B3%A2%E6%AC%A1%E6%89%8B%E5%8A%A8%E6%8B%A3%E9%80%89.md

# 波次手动拣选

**请求方法:** POST

### 系统相关界面
"界面路径：【交易】----【拣货领单】----【波次领单】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.wave.pick.hand | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string |  波次ID，可多个，逗号拼接，最大100个 |  | 

 

### 请求示例

```` 
{
  "ids":"1,2,3"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | successIds | array | 成功id集合 | 必填 | 
 | failedIds | array | 失败id集合 | 必填 | 
 | failedMessages | array | 失败信息集合 | 必填 | 

 

### 响应示例
```
{
    "successIds":  [1,2],
    "failedIds":  [3],
    "failedMessages":  ["波次号3，波次不存在"],
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.wave.pick.hand:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 订单唯一码收货

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E8%AE%A2%E5%8D%95%E5%94%AF%E4%B8%80%E7%A0%81%E6%94%B6%E8%B4%A7
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/750-%E8%AE%A2%E5%8D%95%E5%94%AF%E4%B8%80%E7%A0%81%E6%94%B6%E8%B4%A7.md

# 订单唯一码收货

**请求方法:** POST

### 系统相关界面
"界面路径：【交易】----【验货出库/到货扫描】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.unique.code.receive | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | uniqueCode | string | 唯一码号 | 必填 | 

 

### 请求示例
示例一：

````
{
  "uniqueCode":"string"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | uniqueCodeVO | object | uniqueCodeVO |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 

# subTable: uniqueCodeVO
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysSkuId | long | 系统商品skuID（注意，纯商品是-1） |  | 
 | uniqueCode | string | 唯一码 |  | 
 | codeType | string | 默认0；1（单）；2（多）；3（备） |  | 
 | orderId | long | 商品子订单ID |  | 
 | sysItemId | long | 系统主商品ID  |  | 
 | refundStatus | string | WAIT_SELLER_AGREE --待卖家同意退款 WAIT_BUYER_RETURN_GOODS--待买家退货 WAIT_SELLER_CONFIRM_GOODS--待卖家确认收货 SELLER_REFUSE_BUYER--卖家同意退款 CLOSED--退款关闭 SUCCESS--退款成功 NO_REFUND--未退款 |  | 
 | outerId | string | 平台商家编码 |  | 
 | positionNo | string | 分拣货位 |  | 
 | positionStockRegion | string | 分拣库区 |  | 
 | printTime | long | 打印时间 |  | 
 | sid | long | 系统订单号 |  | 
 | status | integer | 唯一码状态 1-等待采购, 2-等待拣选, 3-已拣选, 4-等待收货, 5-已收货, 6-已出库, 7-已取消, 8-已下架, 9-已出库未收货, 10-待入库, 11-在库, 12-已作废, 13-已验货唯一码状态 1-等待采购, 2-等待拣选, 3-已拣选, 4-等待收货, 5-已收货, 6-已出库, 7-已取消, 8-已下架, 9-已出库未收货, 10-待入库, 11-在库, 12-已作废, 13-已验货, 14-已退回, 15-已采退 |  | 
 | created | long | 创建时间 | 必填 | 
 | modified | long | 修改时间 | 必填 |
 | isExcep | integer | 订单异常状态 0-无异常, 1-有异常 |  |
 | exceptions | array | 系统异常标签 |  |
 | exceptNames | array | 自定义异常 |  |

 

### 响应示例
```
{
   "uniqueCodeVO":[{    
    "sysSkuId": long,
    "uniqueCode": "string",
    "codeType": "number",
    "orderId": long,
    "sysItemId": long,
    "refundStatus": "string",
    "outerId": "string",
    "positionNo": "string",
    "positionStockRegion": "string",
    "printTime": long,
    "sid": long,
    "status": integer,
    "created": long,
    "modified": long,
    "isExcep": integer,
    "exceptions": [string, string],
    "exceptNames": [string, string]
    }]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.unique.code.receive:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|30007|唯一码号不能为空|请检查该参数是否有值|
|30008|订单唯一码收货失败|请根据返回的错误信息进行处理|

---

## 查询唯一码

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E6%9F%A5%E8%AF%A2%E5%94%AF%E4%B8%80%E7%A0%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/850-%E6%9F%A5%E8%AF%A2%E5%94%AF%E4%B8%80%E7%A0%81.md

# 查询唯一码

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【唯一码管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.item.unique.code.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | sids | string | 系统订单号,多个逗号隔开，最多支持20组 |  |  | 
 | shortIds | string | 内部单号,多个逗号隔开，最多支持20组 |  |  | 
 | afterSaleOrderCodes | string | 售后单号,多个逗号隔开，最多支持20组 |  |  | 
 | uniqueCodes | string | 唯一码号,多个逗号隔开，最多支持20组 |  |  | 
 | updateStart | string | 波次唯一码更新时间-起始 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | updateEnd | string | 波次唯一码更新时间-截止 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | consignStart | string | 订单发货时间-起始 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | consignEnd | string | 订单发货时间-截止 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | receiveTimeStart | string | 波次唯一码更新时间-起始 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | receiveTimeEnd | string | 波次唯一码更新时间-截止 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | noNeedTotal | boolean | 是否不需要查询总数（默认为false会查询总数。分页调取时，除了第一次调用需要总数，后面的几次都不需要再获取总数，可以传true，接口速度会更快） |  |  | 
 | codeType | integer | 唯一码类型 1（单）；2（多）；3（备） |  |  | 
 | createStart | string | 波次唯一码创建时间-起始 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | createEnd | string | 波次唯一码创建时间-截止 格式:yyyy-MM-dd HH:mm:ss |  |  | 
 | waveId | long | 波次号 |  |  | 
 | type | integer | 唯一码类型，0 波次唯一码；1（订单唯一码）；2（商品唯一码） |  |  | 
 | pageSize | int | 页数, 默认40，最大支持500 |  |  | 
 | pageNo | int | 页码 |  |  | 

 

### 请求示例
示例一：

````
{
 "pageNo":1,
 "pageSize":40
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 唯一码列表 |  | 
 | success | boolean | 示例：true |  | 
 | trace_id | string | 示例：3553483395407017 |  | 
 | total | long | 总数 |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | codeType | integer | 默认0；1（单）；2（多）；3（备） |  | 
 | orderId | long | 子订单id |  | 
 | created | long | 创建时间 |  | 
 | sysItemId | long | 系统主商品ID  |  | 
 | refundStatus | string | WAIT_SELLER_AGREE --待卖家同意退款 WAIT_BUYER_RETURN_GOODS--待买家退货 WAIT_SELLER_CONFIRM_GOODS--待卖家确认收货 SELLER_REFUSE_BUYER--卖家同意退款 CLOSED--退款关闭 SUCCESS--退款成功 NO_REFUND--未退款 |  | 
 | positionStockRegion | string | 分拣库区 |  | 
 | sid | long | 系统订单号 |  | 
 | sysSkuId | long | 系统商品skuID （注意，纯商品是-1） |  | 
 | uniqueCode | string | 唯一码 |  | 
 | modified | long | 修改时间 |  | 
 | outerId | string | 平台商家编码 |  | 
 | positionNo | string | 分拣货位 |  | 
 | printTime | long | 打印时间 |  | 
 | status | integer | 唯一码状态 1-等待采购, 2-等待拣选, 3-已拣选, 4-等待收货, 5-已收货, 6-已出库, 7-已取消, 8-已下架, 9-已出库未收货, 10-待入库, 11-在库, 12-已作废, 13-已验货, 14-已退回, 15-已采退 |  | 
 | waveId | long | 波次号 | 必填 | 
 | ICCID | string | iccid编码 | 必填 | 
 | serialNumberStr | string | 唯一码流水号 | 必填 | 
 | mainOuterId | string | 主商家编码 | 必填 | 
 | skuOuterId | string | 规格商家编码 | 必填 | 
 | sellingPrice | double | 销售价 | 必填 | 
 | costPrice | double | 成本价 | 必填 | 
 | weight | double | 重量 | 必填 | 
 | itemBatchNo | string | 商品批次号 | 必填 | 
 | productionDate | date | 效期 | 必填 | 
 | itemPeriodCast | string | 主商品保质期 | 必填 | 
 | skuPeriodCast | string | 规格商品保质期 | 必填 | 
 | warehouseId | long | 仓库id | 必填 | 
 | stockPosition | integer | 库存位置 | 必填 | 
 | goodsSectionId | long | 货位id | 必填 | 
 | goodsSectionCode | string | 货位编码 | 必填 | 
 | boxCode | string | 箱码 | 必填 | 
 | printNum | integer | 打印次数 | 必填 | 
 | customPrintTime | date | 自定义打印时间 | 必填 | 
 | afterSaleOrderCode | string | 售后工单编号 | 必填 | 
 | saleReturnOrderCode | string | 销退入库单编号 | 必填 | 
 | warehouseEntryCode | string | 关联收货单 | 必填 | 
 | purchaseReturnCode | string | 采退单 | 必填 | 
 | businessCode | string | 采购单 | 必填 | 
 | otherWarehousingOrderCode | string | 其他入库单编号 | 必填 | 
 | otherOutboundOrderCode | string | 其他出库单编号 | 必填 | 

 

### 响应示例
```
{
    "traceId": "3669319614952014527",
    "list": [
        {
            "iCCID": "ICCID",
            "codeType": 3,
            "orderId": 0,
            "sysItemId": 607817348897280,
            "num": 1,
            "goodsSectionId": 0,
            "sellingPrice": 0.0,
            "productionDate": 1718726400000,
            "uniqueCode": "baolsOpen124",
            "modified": 946656000000,
            "boxCode": "boxCode",
            "serialNumberStr": "33-3",
            "printNum": 0,
            "created": 1718784620000,
            "costPrice": 0.0,
            "waveId": 0,
            "itemPeriodCast": "0",
            "stockPosition": 2,
            "itemBatchNo": "itemBatchNo",
            "sysSkuId": 0,
            "mainOuterId": "baolsOpen1",
            "warehouseId": 69583,
            "outerId": "baolsOpen1",
            "status": 5
        }
    ],
    "total": 1,
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.item.unique.code.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法||
|非法参数!|50|检查参数类型等是否合法||
|系统订单号数量最大支持20组！|20003|参数过长||
|内部单号数量最大支持20组！|20005|参数过长||
|售后单号数量最大支持20组！|20006|参数过长||
|唯一码类型不合法！[1（单）；2（多）；3（备）]|50|枚举值不合法||
|是否查询总数枚举值不合法！[true/false]|50|枚举值不合法||
|系统订单号格式不正确！|20009|检查参数是否合法||
|内部订单号格式不正确|20011|检查参数是否合法||
|售后单号格式不正确|20012|检查参数是否合法||

---

## 波次信息查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E6%B3%A2%E6%AC%A1%E4%BF%A1%E6%81%AF%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/900-%E6%B3%A2%E6%AC%A1%E4%BF%A1%E6%81%AF%E6%9F%A5%E8%AF%A2.md

# 波次信息查询

**请求方法:** POST

### 系统相关界面
"界面路径：【交易】----【波次打印】----【波次管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.waves.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | pageNo | int | 页码 |  | 
 | pageSize | int | 页数, 默认20 |  | 
 | start | string | 创建开始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | end | string | 创建结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | pickStartTime | string | 拣选完成开始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | pickEndTime | string | 拣选完成结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | status | int | 波次状态 1 未完成 3已完成 4已取消 |  | 

 

### 请求示例
示例一：

```` 
{
  "outerId":"string"
}
````
示例二：

````
{
  "sysItemId":long
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | 链路id | 必填 | 
 | list | array | 波次数据列表 | 必填 | 
 | total | int | 总数 | 必填 | 
 | success | boolean | 示例：true | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | tradesCount | int | 订单数量 | 必填 | 
 | code | string | 波次号 | 必填 | 
 | warehouseId | int | 仓库id | 必填 | 
 | id | int | 波次id | 必填 | 
 | list | array | 订单列表 | 必填 | 
 | status | int | 波次状态 1 未完成 3已完成 4已取消 | 必填 | 
 | itemCount | int | 商品数量 | 必填 | 
 | pickEndTime | long | 拣选完成时间 | 必填 | 

# subTable: list/list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | int | 系统单号 | 必填 | 
 | positionNo | int | 位置号 | 必填 | 
 | tradeWaveStatus | int | 波次订单状态 0：未完结，1：已完结，2：已剔出 | 必填 | 
 | waveId | int | 波次号 | 必填 | 

 

### 响应示例
```
{
    "traceId": "2477213974865246250",
    "list": [
        {
            "tradesCount": 2,
            "code": "2428",
            "warehouseId": 69936,
            "id": 2428,
            "list": [
                {
                    "sid": 3743020828089104,
                    "matchedStatus": 0,
                    "packStaffId": 0,
                    "positionNo": 1,
                    "id": 235995,
                    "tradeWaveStatus": 0,
                    "waveId": 2428,
                    "packTime": 946656000000,
                    "printTimes": 0
                },
                {
                    "sid": 3752942399761523,
                    "matchedStatus": 0,
                    "packStaffId": 0,
                    "positionNo": 2,
                    "id": 235996,
                    "tradeWaveStatus": 0,
                    "waveId": 2428,
                    "packTime": 946656000000,
                    "printTimes": 0
                }
            ],
            "status": 1,
            "itemCount": 2
        }
    ],
    "total": 8,
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 波次分拣信息查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BA%A4%E6%98%93/%E6%B3%A2%E6%AC%A1%E5%88%86%E6%8B%A3%E4%BF%A1%E6%81%AF%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/20-%E4%BA%A4%E6%98%93/950-%E6%B3%A2%E6%AC%A1%E5%88%86%E6%8B%A3%E4%BF%A1%E6%81%AF%E6%9F%A5%E8%AF%A2.md

# 波次分拣信息查询

**请求方法:** POST

### 系统相关界面
"界面路径：【交易】----【波次打印】----【波次管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.trade.wave.sorting.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | waveId | long | 波次号 | 必填 | 

 

### 请求示例
示例一：

````
{
  "waveId":1111
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | object |  |  | 
 | total | long | 总数 |  | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | positionNo | long | 位置号 |  | 
 | details | object |  |  | 

# subTable: list/details
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商品商家编码 | 必填 | 
 | title | string | 商品title | 必填 | 
 | propertiesName | string | 商品规格名称 |  | 
 | multiCodes | array | 商品多码 |  | 
 | itemNum | integer | 商品数量 | 必填 | 
 | pickedNum | integer | 已拣选数量 | 必填 | 
 | matchedNum | integer | 已播种数量 | 必填 | 

 # subTable: list/details/multiCodes
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 |  | string |  | 必填 | 

### 响应示例

```{
  "traceId": "2475324223614742509",
  "list": [
    {
      "positionNo": 1,
      "details": [
        {
          "itemNum": 1,
          "multiCodes": [
                        "139108436810453230"
                    ],
          "title": "milk",
          "propertiesName":"MN-milk",
          "matchedNum": 0,
          "outerId": "MN-milk",
          "pickedNum": 1
        }
      ]
    },
    {
      "positionNo": 2,
      "details": [
        {
          "itemNum": 1,
          "multiCodes": [
                        "139108436810453230"
                    ],
          "title": "milk",
          "propertiesName":"MN-milk",
          "matchedNum": 0,
          "outerId": "MN-milk",
          "pickedNum": 1
        }
      ]
    }
  ],
  "total": 2,
  "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.trade.wave.sorting.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.trade.multi.packs.query:1.0)的签名无效|签名参数错误|

---

## 创建售后工单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E5%88%9B%E5%BB%BA%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/0-%E5%88%9B%E5%BB%BA%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95.md

# 创建售后工单

**请求方法:** POST

### 系统相关界面
【售后】--- 【售后工单新版】---【新建售后工单】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息（即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.workorder.create | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | refundWarehouseId | long | 退货仓库id | 必填 | 
 | reason | string | 售后原因 ，可自定义（例如:退运费、收到商品破损、商品错发/漏发、商品需要维修、发票问题、收到商品与描述不符、我不想要了、商品质量问题、未按约定时间发货) | 必填 | 
 | hasOwner | int | 是否有主 1 有主 2 无主 默认为2 |  | 
 | sid | long | 系统订单编号(系统销售订单号 1个订单号对应多个工单号),hasOwner为1时必填 | 必填 | 
 | tid | string | 平台订单号 |  | 
 | userId | long | 店铺编码(填写了sid或者tid时店铺编码必传) |  | 
 | afterSaleType | int | 售后类型 1:已发货仅退款；2:退货；3:补发；4:换货；5:未发货仅退款；7:拒收退货；8:档口退货；9:维修 | 必填 | 
 | reissueOrRefundList | array | 补发或退货列表（类型为换货/补发需要同时传入退货商品和换货商品信息） | 必填 | 
 | platformId | string | 平台工单号 |  | 
 | refusePicAddress | string | 拒绝退货时的上传图片路径 |  | 
 | remark | string | 系统备注 |  | 
 | oid | long | 子订单信息 |  | 
 | wangwangNum | string | 买家旺旺号 |  | 
 | buyerName | string | 买家姓名 |  | 
 | buyerPhone | string | 买家手机号 |  | 
 | refundPostFee | string | 应退运费（元) |  | 
 | reasonId | long | 售后原因的id |  | 
 | shopId | long | 店铺编号 |  | 
 | explains | string | 售后说明 |  | 
 | operateName | string | 操作人的名称，平台or系统 |  | 
 | urlPics | string | 图片地址（多个图片以;分割） |  | 
 | urlVideo | string | 视频地址 |  | 
 | refundVersion | long | 退款版本号（时间戳） |  | 
 | refundMoney | double | 系统实退金额（单位：分） |  | 
 | msgPicAddress | string | 售后凭证（图片地址,多个图片以;分割） |  | 
 | force | boolean | 库存不足时是否强制生成发货单 true 是 false 否 |  | 
 | dealResult | int | 处理结果 1  |  | 
 | type | int | 是否支持‘创建并解决’ 默认0否 1是 |  | 
 | isOpenPlatform | int | 是否强制生成换货/补发订单 默认0否 1是 （必须是选择type为1 创建并解决的情况下才会生效）（注意：如果要强制生成换货或者补发订单，需要传入店铺编码、详细收件信息、换货/补发的商品信息） |  | 
 | useTradeReceiveInfo | boolean | 未传收货信息时是否使用订单收货信息 默认false true 使用 false 不使用 |  | 
 
# subTable: reissueOrRefundList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | type | int | 类型  1:退货商品    2:补发商品 | 必填 | 
 | wareHouseId | int | 发货或退货仓库编号 |  | 
 | itemSnapshot | array | 商品列表 | 必填 | 
 | remark | string | 备注 |  | 
 | reissueRemark | string | 补发备注 |  | 
 | receiveProvince | string | 收货省份 |  | 
 | receiveCity | string | 收货城市 |  | 
 | receiveDistrict | string | 收货区县 |  | 
 | receiveTown | string | 收货街道 |  | 
 | receiveAddress | string | 收货人地址/退货地址 |  | 
 | receiveName | string | 收货人 |  | 
 | receivePhone | string | 收货人联系手机 |  | 
 | reissueWay | int | 退货方式   1:直接先发货  2:收到退货再发货 |  | 
 | expressName | string | 退回快递公司名称 |  | 
 | expressId | string | 退货/补发时的快递单号 |  | 
 | contactId | int | 地址库的Id |  | 

# subTable: reissueOrRefundList/itemSnapshot
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码 | 必填 | 
 | receivableCount | int | 申请数量，应收数量 |  | 
 | goodItemCount | int | 良品数（销退入库时使用） |  | 
 | badItemCount | int | 次品数 （销退入库时使用） |  | 
 | count | int | 商品数量 实收数量(isOpenPlatform为1 时必填) |  | 
 | sysSkuId | int | 系统商品规格skuID(如果商品为规格商品时填写) |  | 
 | sysItemId | int | 系统主商品ID |  | 
 | title | string | 商品名称 |  |
 | id | Long | 商品id |  |
 | remark |string | 商品备注 |  |
 | refundMoney |string | 系统实退金额(单位：元) |  |

 

### 请求示例
```json
{ "refundWarehouseId": 0,
  "reason": "售后原因",
  "hasOwner": 2,
  "sid": 0,
  "tid": "平台订单号",
  "userId": 0,
  "afterSaleType": 2,
  "reissueOrRefundList":"[{\"type\": 1,\"itemSnapshot\":[{\"outerId\":\"0010\"}]}]",
  "reissueWay": 1,
  "expressName": "退回快递公司名称",
  "expressId": "退货/补发时的快递单号",
  "contactId": 0,
  "platformId": "平台工单号",
  "refusePicAddress": "拒绝退货时的上传图片路径",
  "remark": "系统备注",
  "oid": 0,
  "wangwangNum": "买家旺旺号",
  "buyerName": "买家姓名",
  "buyerPhone": "买家手机号",
  "refundFeePost": "应退运费",
  "reasonId": 0,
  "shopId": 0,
  "explains": "售后说明",
  "operateName": "操作人的名称",
  "urlPics": "图片地址",
  "urlVideo": "视频地址",
  "refundVersion": 0,
  "refundMoney": 0.0,
  "msgPicAddress": "售后凭证",
  "force": true,
  "dealResult": 1,
  "type": 0,
  "isOpenPlatform": 0}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 错误码 | 必填 | 
 | id | int | 工单号 | 必填 | 
 | msg | string | 错误信息 | 必填 | 

 

### 返回示例
````
{
	"msg": "",
	"code": "",
	"id": 3553483395407017
}
````
### 注意事项

---

## 作废售后工单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E4%BD%9C%E5%BA%9F%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/100-%E4%BD%9C%E5%BA%9F%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95.md

# 作废售后工单

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.workorder.cancel | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | workOrerIds | String | 售后工单id | 必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | errorMsg | String | 错误信息 |  | 
 | reportKey | String | 响应参数 |  | 
 | isSuc | Boolean | 仅返回false表示失败 |  |

---

## 解决售后工单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E8%A7%A3%E5%86%B3%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/150-%E8%A7%A3%E5%86%B3%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95.md

# 解决售后工单

**请求方法:** POST

### 系统关联页面
【售后】--- 【解决工单】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.workorder.resolve | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | workOrderIds | String | ERP售后工单号(多个逗号分隔) |  | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | errors | Array\[Object\] | 失败结果 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

# subTable: errors
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | workOrderId | Long | 售后工单号 | 必填 | 
 | errorMsg | String | 失败原因 | 必填 | 

 

### 响应示例
```
{
    "errors": {
        "workOrderId": 282838282111211,
        "errorMsg": "该工单已是完结状态，不支持退货入仓"
    },
    "success": true,
    "trace_id": "3553483395423660"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````

---

## 售后工单退货入仓

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E9%80%80%E8%B4%A7%E5%85%A5%E4%BB%93
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/200-%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E9%80%80%E8%B4%A7%E5%85%A5%E4%BB%93.md

# 售后工单退货入仓

**请求方法:** POST

### 系统关联页面
【售后】--- 【退货登记】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.workorder.goods.received | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | warehouseId | long | ERP仓库Id |  | 
 | externalWarehouseCode | String | 外部仓库编码 |  | 
 | receivedAsOrders | Array\[Object\] | 收货工单信息Json串 | 必填 | 

# subTable: receivedAsOrders
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | workOrderId | Long | 售后工单号 | 必填 | 
 | items | Array\[Object\] | 收货商品信息 | 必填 | 

# subTable: receivedAsOrders/items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | String | 收货商品编码 | 必填 | 
 | goodItemCount | int | 收货良品数 | 必填 | 
 | badItemCount | int | 收货次品数 | 必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | results | Array\[Object\] | 失败结果 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

# subTable: results
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | workOrderId | Long | 售后工单号 | 必填 | 
 | errorMsg | String | 失败原因 | 必填 | 

 

### 响应示例
```
{
    "results": {
        "workOrderId": 282838282111211,
        "errorMsg": "该工单已是完结状态，不支持退货入仓"
    },
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````

---

## 更新售后工单标记

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E6%9B%B4%E6%96%B0%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E6%A0%87%E8%AE%B0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/250-%E6%9B%B4%E6%96%B0%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E6%A0%87%E8%AE%B0.md

# 更新售后工单标记

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.workorder.tag.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | type | string | 类型 1=新增，2=删除 ,3=覆盖 | 必填 | 
 | workOrderId | long | 售后工单ID | 必填 | 
 | tagNames | string | 售后工单标记名称 ,多个以“,”隔开( 与tagIds 二选一 必填) | 必填 | 
 | tagIds | string | 售后工单标记ID ,多个以“,”隔开( 与tagNames 二选一 必填) | 必填 | 

 

### 请求示例
示例一：

```` 
{
  "outerId":"string"
}
````
示例二：

````
{
  "sysItemId":long
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 
 | unMatchTagIds | list | 不存在的标记ID列表 | 必填 | 
 | unMatchTagNames |  | 不存在的订单标记集合 | 必填 | 

 

### 响应示例
```
{
    "traceId": "2149645746320391807",
    "success": true
}
```
### 异常示例
````
{
    "traceId": "2149644406290593199",
    "code": "33",
    "unMatchTagNames": [
        "同意退"
    ],
    "success": false
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 更新售后单售后说明

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E6%9B%B4%E6%96%B0%E5%94%AE%E5%90%8E%E5%8D%95%E5%94%AE%E5%90%8E%E8%AF%B4%E6%98%8E
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/300-%E6%9B%B4%E6%96%B0%E5%94%AE%E5%90%8E%E5%8D%95%E5%94%AE%E5%90%8E%E8%AF%B4%E6%98%8E.md

# 更新售后单售后说明

**请求方法:** POST

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.workorder.explains.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | workOrderId | Long | 售后工单id | 必填 | 
 | explains | string | 售后工单售后说明 | 必填 | 
 | isAppend | Integer | 0 追加更新 1 覆盖更新 | 必填 | 

 

### 响应示例
异常：
```
{
    "msg": "当前售后说明长度为2135超出预设长度512，修改售后说明失败",
    "traceId": "3422714055466965597",
    "code": "33",
    "success": false
}
```
正常：
```
{
    "traceId": "3422747623465538712",
    "success": true
}
```
### 响应示例

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | traceId | string | 示例：3422747623465538712 | 必填 | 
 | msg | string | 当前售后说明长度为2135超出预设长度512，修改售后说明失败 | 必填 |

---

## 批量修改售后类型

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E6%89%B9%E9%87%8F%E4%BF%AE%E6%94%B9%E5%94%AE%E5%90%8E%E7%B1%BB%E5%9E%8B
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/350-%E6%89%B9%E9%87%8F%E4%BF%AE%E6%94%B9%E5%94%AE%E5%90%8E%E7%B1%BB%E5%9E%8B.md

# 批量修改售后类型

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.workorder.batchChangeType | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | workOrderIds | String | 售后工单id，用‘,’隔开多个售后工单 | 必填 | 
 | changeType | Integer | 售后类型 7:拒收退货； | 必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | errorMsg | String | 错误信息 |  | 
 | reportKey | String | 响应参数 |  | 
 | isSuc | Boolean | 仅返回false表示失败 |  |

---

## 修改售后工单退货仓库

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E4%BF%AE%E6%94%B9%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E9%80%80%E8%B4%A7%E4%BB%93%E5%BA%93
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/360-%E4%BF%AE%E6%94%B9%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E9%80%80%E8%B4%A7%E4%BB%93%E5%BA%93.md

# 修改售后工单退货仓库

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | Content-Type | string | multipart/form-data | 必填 |

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method | string | erp.aftersale.workorder.refundWarehouse.update | 必填 |

### 适用条件

- 工单状态必须为"未解决"
- 工单类型必须为以下之一：
  - 已发货仅退款(1)
  - 退货(2)
  - 换货(4)
  - 维修(9)
- 卖家未收到退货（货物状态不是"卖家已收到退货"）
- 工单未推送三方仓成功

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | workOrderIds | String | ERP售后工单号，多个工单号用‘,’分隔，最多支持50个 | 必填 |
 | warehouseId | Long | ERP仓库ID，与externalWarehouseCode二选一，至少传一个 | 否 |
 | externalWarehouseCode | String | 外部仓库编码，与warehouseId二选一，至少传一个 | 否 |

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | code | String | 错误码，成功时不返回 |  |
 | msg | String | 错误信息，成功时不返回 |  |
 | errors | List | 失败工单列表，成功时不返回 |  |

#### errors 字段说明

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | workOrderId | Long | 失败的售后工单ID |  |
 | errorMsg | String | 失败原因 |  |

### 注意事项

1. 本接口支持批量操作，建议单次传入工单数量不超过50个
2. 部分工单失败不影响其他工单的修改，失败工单信息会在errors中返回
3. 修改成功后会记录操作日志
4. 工单类型"拒收退货(7)"不支持修改退货仓库

---

## 销退入库单查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E9%94%80%E9%80%80%E5%85%A5%E5%BA%93%E5%8D%95%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/400-%E9%94%80%E9%80%80%E5%85%A5%E5%BA%93%E5%8D%95%E6%9F%A5%E8%AF%A2.md

# 销退入库单查询

**请求方法:** POST

### 系统相关界面
【售后】---【销退入库】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口名

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.refund.warehouse.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | userIds | string | 店铺ID |  | 
 | warehouseIds | string | 仓库ID |  | 
 | ids | string | 销退入库工单号 |  | 
 | workOrderIds | string | 售后工单号工单号 |  | 
 | status | integer | 状态 1：等待收货，2：上架完成，3:等待上架，4：已作废, 5：部分上架 |  | 
 | pageSize | integer | 每页数量 |  | 
 | pageNo | integer | 页码 |  | 
 | timeType | string | createTime :创建时间, modifyTime:修改时间,endTime:完成时间,receiveGoodsTime:收货时间,disposeSuc:工单完成时间 | 必填 | 
 | startTime | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endTime | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | buyerName | string | 买家姓名 |  | 
 | wangwangNum | string | 买家旺旺 |  | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | msg | string | msg | 必填 | 
 | traceId | string | traceId | 必填 | 
 | total | long | 总条数 | 必填 | 
 | code | string | code | 必填 | 
 | solution | string | solution | 必填 | 
 | subCode | string | subCode | 必填 | 
 | subMsg | string | subMsg | 必填 | 
 | body | string | body | 必填 | 
 | forbiddenField | string | forbiddenField | 必填 | 
 | list | array | 数据列表 | 必填 | 

# subTable: msg
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | expiresIn | long | 到期时间 | 必填 | 
 | companyId | long | 关联的企业ID | 必填 | 
 | userId | long | 关联的用户ID | 必填 | 
 | accessToken | string | 会话Token | 必填 | 
 | refreshToken | string | 用来刷新会话的Token | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sid | Long | 系统订单编号 | 必填 | 
 | tid | string | 平台订单号 | 必填 | 
 | userId | string | 店铺编码 | 必填 | 
 | created | string | 生成时间（时间戳） | 必填 | 
 | version | integer | 版本号 | 必填 | 
 | receiveUser | string | 收货人 | 必填 | 
 | receiveGoodsTime | string | 收货时间（时间戳） | 必填 | 
 | expressName | string | 退回快递的快递名称 （数据库不持久化）同ReissueOrRefund的expressName | 必填 | 
 | remarkInfo | string | 留言信息 | 必填 | 
 | isExtra | integer | 是否是扩展的 | 必填 | 
 | reissueOrRefundId | long | 退货或补发的id 这里特指退货id（只有退货才会生成销退入库单） | 必填 | 
 | modified | string | 修改时间（时间戳） | 必填 | 
 | id | long | 入库单号 | 必填 | 
 | workOrderId | long | 售后工单号 | 必填 | 
 | endTime | string | 收货完成时间（时间戳） ， 即status为2时，将该时间记录到数据库中 | 必填 | 
 | items | array | 退货商品信息 | 必填 | 
 | isPda | integer | 是否曾用pda入库过，0 没有 1 有 默认为0 （已经被pda入库过就不能在pc端入库） | 必填 | 
 | status | integer | 1：等待收货，2：上架完成，3:等待上架，4：已作废，5：部分上架 | 必填 | 
 | expressId | string | 退回快递的快递编号 （数据库不持久化）同ReissueOrRefund的expressId | 必填 | 
 | wareHouseId | Long | 收货仓库编号 | 必填 | 
 | wareHouseName | String | 收货仓库名称  | 必填 | 
 | wareHouseCode | String | 收货仓编码 | 必填 | 
 | disposeSuc | Long | 工单完成时间（时间戳） | 必填 | 
 | afterSaleType | integer | 售后类型 0:其他,1:已发货仅退款,2:退货,3:补发,4:换货,5:未发货仅退款,6:补款,7:拒收退货,8:档口退货,9:维修,10:仅退款 | 必填 | 
 | afterSaleTypeName | String | 售后类型名称 | 必填 | 
 | sourceId | Long | 分销商id | 必填 | 
 | sourceName | String | 分销商名称 | 必填 | 
 | remark | String | 售后工单备注 | 必填 | 
 | tradeRemark | String | 原订单平台备注 | 必填 | 
 | tradeSysMemo | String | 原订单系统备注 | 必填 | 
 | buyerName | String | 买家姓名 | 必填 | 
 | wangwangNum | String | 买家旺旺 | 必填 | 

# subTable: list/items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | goodItemCount | integer | 良品数（销退入库时使用） | 必填 | 
 | badItemCount | integer | 次品数 （销退入库时使用） | 必填 | 
 | type | integer | 售后类型（商品级别） 1:退货商品 2:补发商品 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | title | string | 商品名称 | 必填 | 
 | picPath | string | 商品图片 | 必填 | 
 | isMatch | integer | 商品状态（匹配/未匹配） 0：匹配 1：未匹配 | 必填 | 
 | itemRealQty | integer | 实退数量 | 必填 | 
 | price | double | 销售价（元） | 必填 | 
 | rawRefundMoney | BigDecimal | 平台实退金额（元） | 必填 | 
 | refundMoney | BigDecimal | 商品系统实退金额（元） | 必填 | 
 | isGift | integer | 是否赠品：0 不是赠品； 1 是赠品 | 必填 | 
 | remark | string | 商品备注 | 必填 | 
 | itemSnapshotId | Long | 原售后工单商品id | 必填 | 
 | batchProductDates | array | 批次效期信息 | 必填 | 
 | itemUniqueCodes | array | 商品唯一码信息 | 必填 | 

# subTable: list/items/batchProductDates
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | productDate | string | 生产日期 | 必填 | 
 | expireDate | string | 到期日期 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | qualityType | Integer | 质量类型：1.良品 2.次品 | 必填 | 
 | count | Integer | 数量 | 必填 | 

 

### 返回示例
````
{
    "traceId": "42142313213",
    "list": [
        {
            "tid": "12321324",
            "sid": 2142424321,
            "modified": 1659502709000,
            "wareHouseOutCode": "XXX",
            "wareHouseId": 8010,
            "wareHouseName": "XX仓",
            "id": 3212421324123213,
            "isPda": 0,
            "wareHouseCode": "XXX",
            "created": 1659502709000,
            "userId": 321321,
            "receiveUser": "小五",
            "receiveGoodsTime": 1659502709000,
            "isExtra": 0,
            "reissueOrRefundId": 382130238219423,
            "workOrderId": 382412389204812,
            "endTime": 946656000000,
            "items": [
                {
                    "goodItemCount": 3,
                    "badItemCount": 2,
                    "title": "巧克力",
                    "type": 1,
                    "isMatch": 0,
                    "picPath": "https://xxx.jpg",
                    "itemRealQty": 3,
                    "price": 0.0,
                    "outerId": "010-2131"
                }
            ],
            "status": 3
        }
    ],
    "total": 1,
    "success": true
}
````
### 注意事项

---

## 登记补款查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E7%99%BB%E8%AE%B0%E8%A1%A5%E6%AC%BE%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/450-%E7%99%BB%E8%AE%B0%E8%A1%A5%E6%AC%BE%E6%9F%A5%E8%AF%A2.md

# 登记补款查询

**请求方法:** POST

### 系统相关界面
【售后】---【登记补款】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.replenish.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | userIds	 | string | 店铺ID |  | 
 | tid | string | 平台订单号 |  | 
 | id	 | long | 售后工单号 |  | 
 | status | integer | 状态 未解决：2， 已解决：9 ， 已作废：10 |  | 
 | pageSize | integer | 每页条数 |  | 
 | pageNo | integer | 页码 |  | 
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | integer | total |  | 
 | list | array | list |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | textReason | string | 原订单平台备注 |  | 
 | reason | string | 售后原因 (1:退运费 2:收到商品破损 3:商品错发/漏发 4:商品需要维修 5:发票问题 6:收到商品与描述不符 7:我不想要了 8:商品质量问题 9:未按约定时间发货) |  | 
 | shortId | long | 售后工单短号 |  | 
 | refundExpressId | string | 退回快递单号 |  | 
 | refundWarehouseId | long | 退货仓库ID |  | 
 | refundRemindTimeout | string | 超时日期 |  | 
 | shopName | string | 店铺名称 |  | 
 | remark | string | 工单备注 |  | 
 | source | string | 工单来源 |  | 
 | wangwangNum | string | 买家旺旺号 |  | 
 | refundPostFee | string | 应退运费 |  | 
 | tid | string | 平台订单号 |  | 
 | sid | long | 系统订单编号 |  | 
 | urgency | string | 补款单 紧急程度 |  | 
 | sysMaker | string | 创建人 |  | 
 | id | long | 售后工单号 |  | 
 | processingPeriod | integer | 处理期限(小时) |  | 
 | afterSaleType | integer | 售后类型 1：退款；2：退货；3：补发；4：换货 5:发货前的退款 |  | 
 | refundWarehouseName | string | 退货仓库名称 |  | 
 | created | string | 生成时间 |  | 
 | refundMoney | double | 补款金额 |  | 
 | platformStatus | integer | 平台状态 |  | 
 | buyerName | string | 买家姓名 |  | 
 | userId | long | 店铺ID |  | 
 | responsiblePerson | string | 补款单 责任人 |  | 
 | replenishRemark | string | 补款单 备注说明 |  | 
 | buyerPhone | string | 买家手机号 |  | 
 | goodStatus | integer | 货物状态 |  | 
 | refundExpressCompany | string | 退回快递公司 |  | 
 | dealResult | integer | 处理结果 |  | 
 | items | array | 商品明细集合 |  | 

# subTable: list/items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | payTime | string | 付款时间 |  | 
 | receiverName | string | 收货人 |  | 
 | num | integer | 商品数量 |  | 
 | sysMemo | string | 系统备注 |  | 
 | receiverMobile | string | 联系方式 |  | 
 | memo | string | 工单备注 |  | 
 | title | string | 商品标题 |  | 
 | tid	 | string | 订单编号 |  | 
 | receiverAddress | string | 收货地址 |  | 
 | outSid | string | 运单号 |  | 
 | mainOuterId | string | 商家编码 |  | 
 | buyerMessage | string | 买家留言 |  | 
 | consignTime | string | 发货时间 |  | 
 | price | string | 单价 |  | 
 | sysPicPath | string | 图片 |  | 
 | expressCode | string | 快递公司的编码 |  | 
 | outerId | string | Sku商家编码 |  | 
 | payment | string | 订单实付金额（含运费） |  | 
 | status | integer | 工单状态 1:未分配 2:未解决 3:优先退款 4:同意 5:拒绝 6:确认退货 7:确认发货 8:确认退款 9:处理完成 10:作废 |  | 

 

### 返回示例
```
{
  "total": 1,
  "list": [
    {
      "textReason": "zhangsan",
      "reason": "zhangsan",
      "shortId": 12345,
      "refundExpressId": "zhangsan",
      "refundWarehouseId": 12345,
      "refundRemindTimeout": "@date",
      "shopName": "zhangsan",
      "remark": "zhangsan",
      "source": "zhangsan",
      "wangwangNum": "zhangsan",
      "refundPostFee": "zhangsan",
      "tid": "zhangsan",
      "sid": 12345,
      "urgency": "zhangsan",
      "sysMaker": "zhangsan",
      "id": 12345,
      "processingPeriod": 1,
      "afterSaleType": 1,
      "refundWarehouseName": "zhangsan",
      "created": "@date",
      "refundMoney": 10000,
      "platformStatus": 1,
      "buyerName": "zhangsan",
      "list": [
        {
          "payTime": "@date",
          "receiverName": "zhangsan",
          "num": 1,
          "sysMemo": "zhangsan",
          "receiverMobile": "zhangsan",
          "memo": "zhangsan",
          "title": "zhangsan",
          "tid": "zhangsan",
          "receiverAddress": "zhangsan",
          "outSid": "zhangsan",
          "mainOuterId": "zhangsan",
          "buyerMessage": "zhangsan",
          "consignTime": "@date",
          "price": "zhangsan",
          "sysPicPath": "zhangsan",
          "expressCode": "zhangsan",
          "outerId": "zhangsan",
          "payment": "zhangsan"
        }
      ],
      "userId": 12345,
      "responsiblePerson": "zhangsan",
      "replenishRemark": "zhangsan",
      "buyerPhone": "zhangsan",
      "goodStatus": 1,
      "refundExpressCompany": "zhangsan",
      "dealResult": 1,
      "status": 1
    }
  ]
}
```

---

## 售后工单查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/50-%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E6%9F%A5%E8%AF%A2.md

# 售后工单查询

**请求方法:** POST

### 系统相关界面
【售后】--- 【售后工单新版】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | userIds | string | 店铺ID |  | 
 | warehouseIds | string | 仓库ID |  | 
 | tid | string | 平台订单号 |  | 
 | id | long	 | 售后工单号 |  | 
 | pageSize | integer | pageSize（不传默认为1，范围是1-200条） |  | 
 | pageNo | integer | 页码 |  | 
 | asVersion | integer | 售后版本 1：旧版， 2：新版（默认） |  | 
 | startModified | string | 起始修改时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endModified | string | 结束修改时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | startApplyTime | string | 起始申请时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endApplyTime | string | 结束申请时间 格式:yyyy-MM-dd HH:mm:ss |  |
 | afterSaleType | string | 售后类型 0:其他；1:已发货仅退款；2:退货；3:补发；4:换货；5:未发货仅退款；7:拒收退货；8:档口退货；9:维修 |  | 
 | suiteSingle | integer | 是否返回套件信息 0:不返回套件信息，1：返回套件信息，默认0 |  | 
 | ids | String | 售后工单id批量查询 |  | 
 | tids | String | 平台订单号批量查询 |  | 
 | reissueSid | Long | 换货/补发订单号 |  | 
 | platformId | String | 平台售后单号 |  | 
 | expressIds | String | 退回快递单号，多个逗号隔开，最多只支持50个 |  | 
 | startFinished | string | 起始完结时间，需和endFinished字段一起使用 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endFinished | string | 结束完结时间，需和startFinished字段一起使用 格式:yyyy-MM-dd HH:mm:ss |  |
 | startPlatformCompleteTime | string | 起始平台售后完成时间，需和endPlatformCompleteTime字段一起使用 格式:yyyy-MM-dd HH:mm:ss |  |
 | endPlatformCompleteTime | string | 结束平台售后完成时间，需和startPlatformCompleteTime字段一起使用 格式:yyyy-MM-dd HH:mm:ss |  |
 | extraWarehouseStatus | Integer | 三方仓推送状态 0:未推送 1:已推送 2:推送失败 |  |
 | status | string | 工单状态 (2:未解决 9:已解决 10:已作废 11:已合并 12:解决中)，多个逗号隔开 |  |
 | goodStatus | string | 货物状态(1:买家未收到货;2:买家已收到货;3:买家已退货;4:卖家已收到退货) ，多个逗号隔开|  |

### 请求示例

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | integer | total |  | 
 | list | array | list |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 售后工单号 |  | 
 | orderType | string | 工单来源 1:平台，2:手工 |  | 
 | tid | string | 平台订单号 |  | 
 | sid | long | 系统订单编号 |  | 
 | created | string | 生成时间，时间戳格式：1640966400000 |  | 
 | afterSaleType | integer | 售后类型 0:其他；1:已发货仅退款；2:退货；3:补发；4:换货；5:未发货仅退款；7:拒收退货；8:档口退货；9:维修 |  | 
 | buyerName | string | 买家姓名 |  | 
 | buyerPhone | string | 买家手机号 |  | 
 | wangwangNum | string | 买家旺旺号 |  | 
 | goodStatus | integer | 货物状态(1:买家未收到货;2:买家已收到货;3:买家已退货;4:卖家已收到退货) |  | 
 | status | integer | 工单状态 2:未解决 9:已解决 10:已作废 11:已合并 12:解决中 |  | 
 | rawRefundMoney | string | 平台实退金额（单位：元） |  | 
 | refundMoney | double	 | 系统实退金额（单位：元） |  | 
 | refundPostFee | string | 应退运费 |  | 
 | reason | string | 售后原因 (1:退运费 2:收到商品破损 3:商品错发/漏发 4:商品需要维修 5:发票问题 6:收到商品与描述不符 7:我不想要了 8:商品质量问题 9:未按约定时间发货) |  | 
 | textReason | string | 原订单平台备注 |  | 
 | refundWarehouseId | long | 退货仓库ID |  | 
 | refundWarehouseName | string | 退货仓库名称 |  | 
 | refundExpressCompany | string | 退回快递公司 |  | 
 | refundExpressId | string | 退回快递单号 |  | 
 | remark | string | 工单备注 |  | 
 | dealResult | integer | 处理结果 |  | 
 | platformStatus | integer | 平台状态 |  | 
 | refundRemindTimeout | string | 超时日期 |  | 
 | shortId | long | 售后工单短号 |  | 
 | storageProgress | integer | 退货进度:0:未入库,1:部分入库,2:全部入库 |  |
 | shopName | string | 店铺名称 |  |
 | shopShortTitle | string | 店铺简称 |  |
 | shopTitle | string | 店铺名称 真实的店铺名称（ shopName 可能是处理后的名称 可能是简称）|  |
 | source | string | 工单来源具体平台，例如 tb(淘宝或者天猫平台),jd(京东平台),pdd(拼多多)等 |  | 
 | finished | string | 完成时间 |  | 
 | userId | long | 店铺ID |  | 
 | reissueSid | long | 补发或换货时生成的trade(订单)的sid |  | 
 | items | array | 售后工单商品明细集合 |  | 
 | explains | string | 售后说明 |  | 
 | tagList | array | 售后标记 |  | 
 | refundWarehouseCode | string | 退货仓库编码 |  | 
 | refundableMoney | Long | 系统应退金额（单位：元） |  | 
 | modified | Long | 修改时间 |  | 
 | applyDate | Long | 申请时间 | 必填 | 
 | sourceId | Long | 分销商id | 必填 | 
 | masterId | Long | 主单（被拆分售后单）ID | | 
 | sourceName | string | 分销商名称 | 必填 | 
 | receiveGoodsTime | long | 退货到货时间 | 必填 | 
 | advanceStatus | Integer | 退款状态 （未申请:-1;平台未申请:0;退款先行垫付申请中:1;垫付完成:2;卖家拒绝收货:3;垫付关闭:4;垫付分账成功:5） | 必填 | 
 | advanceStatusText | String | 退款状态名称 | 必填 | 
 | platformId | String  | 外部平台售后单号 | 必填 | 
 | tradeSysMemo | String | 客服备注 | 必填 | 
 | handlerStatus | Integer | 自动化售后处理状态（待处理:-1;处理中:0;处理成功:1;处理失败:2） | 必填 | 
 | handlerStatusText | String | 自动化售后处理状态文本 | 必填 | 
 | tradeWarehouseName | String | 原订单发货仓库名称 | 必填 | 
 | tradeWarehouseId | Long | 原订单发货仓库ID | 必填 | 
 | tradeWarehouseCode | string | 原订单发货仓库编码 | 必填 | 
 | tradeOutSid | string | 原运单号 | 必填 |  
 | afterSaleApplicationTime | Long | 售后申请时间 | 必填 | 
 | onlineStatus | Integer | 线上状态(空:1;待卖家同意:2;待买家退货:3;待卖家确认收货:4;卖家拒绝退款:5;退款关闭:6;退款成功:7;待发出换货商品:8;待买家收货:9;换货关闭:10;换货成功:11) | 必填 | 
 | onlineStatusText | String | 线上状态对应文案 | 必填 | 
 | labelNames | array | 售后标签 |  |
 | platformCompleteTime | Long | 平台售后完成时间 | |
 | extraWarehouseStatus | Integer | 三方仓推送状态 0:未推送 1:已推送 2:推送失败 | |
 | rawPlatformTid | string | 原订单原始平台单号 |  |
 | tradePaymentDate | Long | 原订单支付时间 |  |
 | tradeCreatedDate | Long | 原订单下单时间 |  |

# subTable: list/items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | goodItemCount | integer | 良品数（销退入库时使用） |  | 
 | receiveGoodsOperatorNames | string | 入仓操作员名 |  | 
 | badItemCount | integer | 次品数 （销退入库时使用） |  | 
 | refundMoney | string | 商品系统实退金额 |  | 
 | remark | string | 备注 |  | 
 | type | integer | 售后类型（商品级别） 1:退货商品 2:补发商品 |  | 
 | title | string | 商品名称 |  | 
 | propertiesName	 | string | 商品规格 |  | 
 | receivableCount | integer | 申请数量 |  | 
 | isMatch | integer | 商品状态（匹配/未匹配） 0：匹配 1：未匹配 |  | 
 | receiveGoodsTime | string | 入仓时间 |  | 
 | picPath | string | 商品图片 |  | 
 | mainOuterId | string | 主商家编码 |  | 
 | itemRealQty | integer | 实退数量 |  | 
 | price | double | 销售价（单位：元） |  | 
 | outerId | string | 商家编码 |  | 
 | payment | string | 实付金额（单位：元） |  | 
 | suite | integer | 是否是套件商品：0=普通商品，1=套件 |  | 
 | suiteSingle | integer | 是否是套件单品：0=套件本身，1=套件下单品 |  | 
 | combineId | long | 套件组id,同一套件下套件本身和套件下单品相同 |  | 
 | rawRefundMoney | long | 平台实退金额（单位：分） |  | 
 | refundableMoney | Long | 商品维度系统应退金额（单位：元） |  | 
 | itemSnapshotId | Long | 商品id |  | 
 | sysItemId | integer | 系统主商品ID |  | 
 | sysSkuId | integer | 系统商品规格skuID |  | 
 | isGift | integer | 是否为赠品 0:否 1:是 | 必填 | 
 | batchProductDates | array | 批次效期信息 | 必填 | 
 | numIid | string | 平台商品id | 必填 | 
 | skuId | string | 平台skuId | 必填 | 
 | suits | array | 套件、加工、组合商品的子商品 | 必填 | 

# subTable: list/items/batchProductDates
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | productDate | string | 生产日期 | 必填 | 
 | expireDate | string | 到期日期 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | qualityType | integer | 质量类型：1.良品 2.次品 | 必填 | 
 | count | integer | 数量 | 必填 | 

# subTable: list/items/suits
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemSnapshotId | Long | 售后商品记录ID | 必填 | 
 | sysOuterId | string | 系统商家编码，如果是商品则为商品的商家编码，如果为SKU则为SKU的商家编码 | 必填 | 
 | suiteRatio | integer | 套件、组合里的单品的数量分摊比例，需固化。不会因商品组合、套件比例修改改变 | 必填 | 
 |suiteType   |integer  |组合类型，0普通商品，1套件本身，2套件本身，不转单品，3套件下单品，4组合本身，5组合子商品品，6加工商品本身，7加工子商品|必填|

# subTable: list/tagList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 |  | string |  | 必填 | 
 
# subTable: list/labelNames
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 |  | string |  | 必填 | 

 

### 响应示例

### 异常示例
````

````
### 错误码解释

---

## 维修单列表查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E7%BB%B4%E4%BF%AE%E5%8D%95%E5%88%97%E8%A1%A8%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/500-%E7%BB%B4%E4%BF%AE%E5%8D%95%E5%88%97%E8%A1%A8%E6%9F%A5%E8%AF%A2.md

# 维修单列表查询

**请求方法:** POST

### 系统相关界面
【售后】---【维修单管理】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口名

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.repair.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | repairStatus | string | 维修状态  0待审核1待收货2待维修3待寄出4已完成-1已作废 |  | 
 | pageSize | integer | 每页数量 |  | 
 | pageNo | integer | 页码 |  | 
 | timeType | string | createTime :创建时间, returnTime:退回时间, modified:更新时间 |  | 
 | timeStart | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | timeEnd | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | queryType | string | 查询类型 (repairOrderNum-维修单号,contactInfo-联系方式,returnLogisticsCode-退回快递单号,sendLogisticsCode-寄出快递单号,identificationCodes-识别码,receiverName-收件人姓名) |  | 
 | queryText | string | 查询请求值(对应queryType的具体查询参数) |  | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | traceId | 必填 | 
 | total | long | 总条数 | 必填 | 
 | success | string | true/false | 必填 | 
 | list | array | 数据列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | Long | 维修单ID | 必填 | 
 | repairOrderNum | string | 维修单号 | 必填 | 
 | createTime | String | 生成时间 格式:yyyy-MM-dd HH:mm:ss | 必填 | 
 | userNick | string | 用户昵称 | 必填 | 
 | sid | Long | 系统订单号 | 必填 | 
 | tid | String | 平台订单号 | 必填 | 
 | userId | Long | 店铺编码 | 必填 | 
 | shopName | String | 店铺名称 | 必填 | 
 | companyId | Long | 企业ID | 必填 | 
 | wangwangNum | String | 买家旺旺号 | 必填 | 
 | contactInfo | string | 联系方式 | 必填 | 
 | repairStatus | Integer | 维修状态 ：0待审核1待收货2待维修3待寄出4已完成-1已作废 | 必填 | 
 | hasFee | Integer | 是否需要付费 0不需要 1需要 | 必填 | 
 | payedStatus | Integer | 支付状态 0未付款 1部分付款 2已付款 | 必填 | 
 | repairMoney | Double | 维修费用 | 必填 | 
 | payedMoney | Double | 已付金额 | 必填 | 
 | repairWarehouseId | Long | 维修仓库ID | 必填 | 
 | repairWarehouseName | String | 维修仓库名称 | 必填 | 
 | identificationCodes | String | 商品识别码 (多个,分隔) | 必填 | 
 | problemDescription | String | 问题描述 | 必填 | 
 | failureCause | String | 故障原因 | 必填 | 
 | remark | String | 备注 | 必填 | 
 | repairRemark | String | 维修备注 | 必填 | 
 | fullyOutlook | Integer | 外观是否完好 0 是 1 否 | 必填 | 
 | fullyEquipped | Integer | 设备是否齐全 0 是 1 否 | 必填 | 
 | fullyProtected | Integer | 是否过保 0 是，1否 | 必填 | 
 | createUser | String | 维修单创建人 | 必填 | 
 | returnTime | String | 退回时间,格式:yyyy-MM-dd | 必填 | 
 | returnWarehouseId | Long | 退回仓库ID | 必填 | 
 | returnWarehouseName | String | 退回仓库名称 | 必填 | 
 | returnLogisticsName | String | 退回快递名称 | 必填 | 
 | returnLogisticsCode | String | 退回快递单号 | 必填 | 
 | sendTime | String | 寄出时间 | 必填 | 
 | sendLogisticsCode | String | 寄出快递单号 | 必填 | 
 | sendLogisticsName | String | 寄出快递名称 | 必填 | 
 | sendRemark | String | 寄出备注 | 必填 | 
 | receiverName | String | 收件人姓名 | 必填 | 
 | receiverPhone | String | 收件人电话 | 必填 | 
 | province | String | 省 | 必填 | 
 | city | String | 市 | 必填 | 
 | area | String | 区 | 必填 | 
 | receiverAddress | String | 收件人地址 | 必填 | 
 | receiverDescription | String | 收件人备注 | 必填 | 
 | accessoryUrl | String | 维修附件 | 必填 | 
 | repairItemInfos | String | 商品明细 （多个,分割) | 必填 | 
 | itemInfos | String\[\] | 商品信息 | 必填 | 
 | tradeReceiveName | String | 订单收货人 | 必填 | 
 | tradeReceiveMobile | String | 订单收货联系人 | 必填 | 
 | source | String | 店铺来源 | 必填 | 
 | flag | String | 店铺标记 | 必填 | 
 | finishTime | String | 完成时间 | 必填 | 
 | photoPathStr | String | 图片 | 必填 | 
 | workOrderId | Long | 售后工单号 | 必填 | 
 | sendExpressCompanyId | Long | 寄出快递公司id | 必填 | 
 | shortId | Long | 售后工单短号 | 必填 | 

 

### 返回示例
```
{
    "traceId": "2451667440669289674",
    "list": [
        {
            "contactInfo": "13777366666",
            "hasFee": 0,
            "source": "tm",
            "tid": "518816123781632",
            "receiverPhone": "13777366666",
            "fullyProtected": 1,
            "province": "浙江省",
            "id": 111383,
            "fullyOutlook": 0,
            "area": "滨江区",
            "repairStatus": 1,
            "payedStatus": 0,
            "returnTime": "2023-02-02",
            "returnLogisticsName": "ZxZx",
            "receiverAddress": "江南大道588号恒鑫大厦10F光云科技",
            "companyId": 28591,
            "flag": "2",
            "city": "杭州市",
            "repairMoney": 0.0,
            "shopName": "懒洋洋睡觉店铺",
            "returnWarehouseName": "yyh专属",
            "wangwangNum": "AAHk5d-EAAeGwJedwSFu0XXX",
            "sid": 4150517578391252,
            "payedMoney": 0.0,
            "userNick": "刘明剑s3aRA",
            "repairItemInfos": "|||sky海台开启批次001|||3|||",
            "repairOrderNum": "4150850984280576",
            "fullyEquipped": 0,
            "receiverName": "刘明剑s3aRA",
            "problemDescription": "41324134",
            "repairWarehouseName": "yyh专属",
            "returnLogisticsCode": "314141324",
            "userId": 85127,
            "returnWarehouseId": 41531,
            "createTime": "2023-02-02 16:00:06",
            "repairWarehouseId": 41531
        },
        {
            "contactInfo": "13777366666",
            "hasFee": 0,
            "source": "tm",
            "tid": "518816123781632",
            "receiverPhone": "13777366666",
            "fullyProtected": 1,
            "province": "浙江省",
            "id": 111738,
            "fullyOutlook": 0,
            "area": "滨江区",
            "repairStatus": 2,
            "payedStatus": 0,
            "returnTime": "2023-02-06",
            "returnLogisticsName": "天天快递",
            "receiverAddress": "江南大道588号恒鑫大厦10F光云科技",
            "companyId": 28591,
            "flag": "2",
            "city": "杭州市",
            "repairMoney": 0.0,
            "shopName": "懒洋洋睡觉店铺",
            "returnWarehouseName": "yyh专属",
            "wangwangNum": "AAHk5d-EAAeGwJedwSFu0XXX",
            "sid": 4150517578391252,
            "payedMoney": 0.0,
            "userNick": "刘明剑s3aRA",
            "repairItemInfos": "|||sky海台开启批次001|||2|||",
            "repairOrderNum": "4156624732881408",
            "fullyEquipped": 0,
            "receiverName": "刘明剑s3aRA",
            "problemDescription": "41341324",
            "repairWarehouseName": "yyh专属",
            "failureCause": "test",
            "returnLogisticsCode": "431431241",
            "userId": 85127,
            "returnWarehouseId": 41531,
            "createTime": "2023-02-06 17:53:28",
            "repairWarehouseId": 41531
        },
        {
            "contactInfo": "13777366666",
            "hasFee": 0,
            "source": "tm",
            "tid": "521102154717696",
            "receiverPhone": "13777366666",
            "fullyProtected": 1,
            "province": "浙江省",
            "id": 113266,
            "fullyOutlook": 0,
            "area": "滨江区",
            "repairStatus": 1,
            "tradeReceiveName": "13777366666",
            "payedStatus": 0,
            "returnTime": "2023-02-13",
            "returnLogisticsName": "天天快递",
            "receiverAddress": "江南大道588号恒鑫大厦10F光云科技",
            "companyId": 28591,
            "flag": "2",
            "city": "杭州市",
            "repairMoney": 1.0,
            "shopName": "懒洋洋睡觉店铺",
            "returnWarehouseName": "test-2021/4/30",
            "wangwangNum": "AAHk5d-EAAeGwJedwSFu0XXX",
            "sid": 4167913574918882,
            "payedMoney": 0.0,
            "userNick": "刘明剑YAtFJ",
            "repairItemInfos": "https://img.alicdn.com/bao/uploaded/i3/65343260/TB20GORzhxmpuFjSZFNXXXrRXXa_!!65343260.jpg|||毛线衣|||1|||",
            "repairOrderNum": "4180230195511808",
            "fullyEquipped": 0,
            "receiverName": "刘明剑YAtFJ",
            "problemDescription": "141324",
            "repairWarehouseName": "test-2021/4/30",
            "returnLogisticsCode": "41341324132",
            "userId": 85127,
            "returnWarehouseId": 39528,
            "tradeReceiveMobile": "13777366666",
            "createTime": "2023-02-23 10:06:11",
            "repairWarehouseId": 39528
        },
        {
            "contactInfo": "13777366666",
            "hasFee": 0,
            "source": "tm",
            "tid": "521102154717696",
            "receiverPhone": "13777366666",
            "fullyProtected": 1,
            "province": "浙江省",
            "repairRemark": "434",
            "id": 113270,
            "fullyOutlook": 0,
            "area": "滨江区",
            "repairStatus": 3,
            "tradeReceiveName": "13777366666",
            "payedStatus": 0,
            "returnTime": "2023-02-16",
            "returnLogisticsName": "ZxZx",
            "receiverAddress": "江南大道588号恒鑫大厦10F光云科技",
            "companyId": 28591,
            "flag": "2",
            "city": "杭州市",
            "repairMoney": 0.0,
            "shopName": "懒洋洋睡觉店铺",
            "returnWarehouseName": "test-2021/4/30",
            "wangwangNum": "AAHk5d-EAAeGwJedwSFu0XXX",
            "sid": 4167913574918882,
            "payedMoney": 0.0,
            "userNick": "刘明剑YAtFJ",
            "repairItemInfos": "https://img.alicdn.com/bao/uploaded/i3/65343260/TB20GORzhxmpuFjSZFNXXXrRXXa_!!65343260.jpg|||毛线衣|||1|||",
            "repairOrderNum": "4180243413008896",
            "fullyEquipped": 0,
            "receiverName": "刘明剑YAtFJ",
            "problemDescription": "411324",
            "repairWarehouseName": "test-2021/4/30",
            "failureCause": "故障",
            "returnLogisticsCode": "412413241324",
            "userId": 85127,
            "returnWarehouseId": 39528,
            "tradeReceiveMobile": "13777366666",
            "createTime": "2023-02-23 10:19:37",
            "repairWarehouseId": 39528
        }
    ],
    "total": 4,
    "success": true
}
```
### 注意事项

---

## 维修单详情查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E7%BB%B4%E4%BF%AE%E5%8D%95%E8%AF%A6%E6%83%85%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/550-%E7%BB%B4%E4%BF%AE%E5%8D%95%E8%AF%A6%E6%83%85%E6%9F%A5%E8%AF%A2.md

# 维修单详情查询

**请求方法:** POST

### 系统相关界面
【售后】--- 【维修单管理】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.repair.detail.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | repairOrderNum | 维修单号 | 维修单号 |  | 

 

### 请求示例

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | integer | total |  | 
 | list | array | list |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemList | array | 维修商品list |  | 
 | feeList | array | 维修费用list |  | 
 | partsList | array | 维修配件list |  | 
 | order | Object | 维修单基础信息 |  | 

# subTable: list/itemList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | Long | 维修商品ID |  | 
 | itemId | Long | 商品ID |  | 
 | skuId | Long | SKU ID |  | 
 | companyId | Long | 企业ID |  | 
 | repairItemCode | String | 维修商品编号 |  | 
 | repairItemName | String | 维修商品名称 |  | 
 | repairItemImageUrl | String | 商品图片地址 |  | 
 | repairOrderNum | String | 维修单号 |  | 
 | specification | String | 规格 |  | 
 | identificationCode | String | 识别码 |  | 
 | repairQuantity | Integer | 维修数量 |  | 
 | problemDescription | String | 商品问题描述 |  | 

# subTable: list/feeList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | Long | 维修费用ID |  | 
 | companyId | Long | 企业ID |  | 
 | repairOrderNum | String | 维修单号 |  | 
 | receivedTime | String | 入账时间 |  | 
 | receivedWay | String | 入账途径 |  | 
 | currentPrice | Double | 本次费用 |  | 
 | tradeNumber | String | 交易流水号 |  | 
 | operatorName | String | 操作人 |  | 
 | operatorTime | String | 操作时间 |  | 

# subTable: list/partsList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | Long | 维修配件ID |  | 
 | companyId | Long | 企业ID |  | 
 | repairPartsCode | String | 维修配件编号 |  | 
 | repairPartsName | String | 维修配件名称 |  | 
 | repairPartsImageUrl | String | 配件图片地址 |  | 
 | repairOrderNum | String | 维修单号 |  | 
 | specification | String | 规格 |  | 
 | costPrice | Double | 成本价 |  | 
 | salePrice | Double | 销售价 |  | 
 | consumedQuantity | Integer | 消耗数量 |  | 
 | itemId | Long | itemId |  | 
 | skuId | Long | skuId |  | 

# subTable: list/order
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | returnWarehouseName | string | 退回仓库名称 |  | 
 | returnTime | string | 退回时间 |  | 
 | returnLogisticsCode | string | 退回快递单号 |  | 
 | returnLogisticsName | string | 退回快递名称 |  | 
 | photoPathList | string | 图片 |  | 
 | repairMoney | string | 维修费用 |  | 
 | payedMoney | string | 已付金额 |  | 
 | priceList | string | 报价单 |  | 
 | repairRemark | string | 维修备注 |  | 
 | hasFee | Integer | 是否需要付费 0不需要 1需要 |  | 
 | accessoryUrl | string | 维修附件和报价单是一个 不需要用priceList |  | 
 | failureCause | string | 故障原因 |  | 
 | sendLogisticsCode | string | 寄出快递单号 |  | 
 | sendLogisticsName | string | 寄出快递名称 |  | 
 | sendExpressCompanyId | string | 寄出快递公司 |  | 
 | sendTime | string | 寄出时间 |  | 
 | sendRemark | string | 寄出备注 |  | 
 | receiverName | string | 收件人姓名 |  | 
 | receiverPhone | string | 收件人电话 |  | 
 | receiverDescription | string | 收件人备注 |  | 
 | receiverAddress | string | 收件人地址 |  | 
 | templateId | Long | 快递模板ID |  | 
 | isWlb | integer | 快递模板类型 |  | 

 

### 响应示例

### 异常示例
```
{
    "traceId": "2451712211408313772",
    "success": true,
    "itemList": [
        {
            "repairQuantity": 2,
            "itemId": 0,
            "companyId": 28591,
            "id": 128036,
            "enableStatus": 1,
            "repairItemCode": "M",
            "skuId": 0,
            "repairItemName": "sky海台开启批次001",
            "table": "repair_item",
            "repairOrderNum": "4156624732881408"
        }
    ],
    "order": {
        "contactInfo": "13777366666",
        "hasFee": 0,
        "templateId": 0,
        "tid": "518816123781632",
        "receiverPhone": "13777366666",
        "fullyProtected": 1,
        "province": "浙江省",
        "id": 111738,
        "fullyOutlook": 0,
        "area": "滨江区",
        "repairStatus": 2,
        "payedStatus": 0,
        "returnTime": "2023-02-06",
        "returnLogisticsName": "天天快递",
        "receiverAddress": "浙江省杭州市滨江区江南大道588号恒鑫大厦10F光云科技",
        "companyId": 28591,
        "city": "杭州市",
        "repairMoney": 0.0,
        "returnWarehouseName": "yyh专属",
        "wangwangNum": "AAHk5d-EAAeGwJedwSFu0XXX",
        "sid": 4150517578391252,
        "payedMoney": 0.0,
        "userNick": "刘明剑s3aRA",
        "isWlb": 0,
        "table": "repair_order",
        "repairOrderNum": "4156624732881408",
        "fullyEquipped": 0,
        "receiverName": "刘明剑s3aRA",
        "problemDescription": "41341324",
        "repairWarehouseName": "yyh专属",
        "failureCause": "test",
        "returnLogisticsCode": "431431241",
        "userId": 85127,
        "returnWarehouseId": 41531,
        "createTime": "2023-02-06 17:53:28",
        "repairWarehouseId": 41531
    }
}
```
### 错误码解释

---

## 维修单处理

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E7%BB%B4%E4%BF%AE%E5%8D%95%E5%A4%84%E7%90%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/600-%E7%BB%B4%E4%BF%AE%E5%8D%95%E5%A4%84%E7%90%86.md

# 维修单处理

**请求方法:** POST

### 系统相关界面
【售后】---【维修单管理】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.repair.order.process | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | repairOrderNum	 | string | 维修单号 | 必填 | 
 | hasFee | integer | 是否需要付费 0不需要 1需要 | 必填 | 
 | failureCause | string | 故障原因（维修单管理页面设置故障原因） | 必填 | 
 | repairRemark | string | 维修备注 |  | 
 | accessoryUrl | String | 维修附件 |  | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | integer | total |  | 
 | list | array | list |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | textReason | string | 原订单平台备注 |  | 
 | reason | string | 售后原因 (1:退运费 2:收到商品破损 3:商品错发/漏发 4:商品需要维修 5:发票问题 6:收到商品与描述不符 7:我不想要了 8:商品质量问题 9:未按约定时间发货) |  | 
 | shortId | long | 售后工单短号 |  | 
 | refundExpressId | string | 退回快递单号 |  | 
 | refundWarehouseId | long | 退货仓库ID |  | 
 | refundRemindTimeout | string | 超时日期 |  | 
 | shopName | string | 店铺名称 |  | 
 | remark | string | 工单备注 |  | 
 | source | string | 工单来源 |  | 
 | wangwangNum | string | 买家旺旺号 |  | 
 | refundPostFee | string | 应退运费 |  | 
 | tid | string | 平台订单号 |  | 
 | sid | long | 系统订单编号 |  | 
 | urgency | string | 补款单 紧急程度 |  | 
 | sysMaker | string | 创建人 |  | 
 | id | long | 售后工单号 |  | 
 | processingPeriod | integer | 处理期限(小时) |  | 
 | afterSaleType | integer | 售后类型 1：退款；2：退货；3：补发；4：换货 5:发货前的退款 |  | 
 | refundWarehouseName | string | 退货仓库名称 |  | 
 | created | string | 生成时间 |  | 
 | refundMoney | double | 补款金额 |  | 
 | platformStatus | integer | 平台状态 |  | 
 | buyerName | string | 买家姓名 |  | 
 | userId | long | 店铺ID |  | 
 | responsiblePerson | string | 补款单 责任人 |  | 
 | replenishRemark | string | 补款单 备注说明 |  | 
 | buyerPhone | string | 买家手机号 |  | 
 | goodStatus | integer | 货物状态 |  | 
 | refundExpressCompany | string | 退回快递公司 |  | 
 | dealResult | integer | 处理结果 |  | 
 | items | array | 商品明细集合 |  | 

# subTable: list/items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | payTime | string | 付款时间 |  | 
 | receiverName | string | 收货人 |  | 
 | num | integer | 商品数量 |  | 
 | sysMemo | string | 系统备注 |  | 
 | receiverMobile | string | 联系方式 |  | 
 | memo | string | 工单备注 |  | 
 | title | string | 商品标题 |  | 
 | tid	 | string | 订单编号 |  | 
 | receiverAddress | string | 收货地址 |  | 
 | outSid | string | 运单号 |  | 
 | mainOuterId | string | 商家编码 |  | 
 | buyerMessage | string | 买家留言 |  | 
 | consignTime | string | 发货时间 |  | 
 | price | string | 单价 |  | 
 | sysPicPath | string | 图片 |  | 
 | expressCode | string | 快递公司的编码 |  | 
 | outerId | string | Sku商家编码 |  | 
 | payment | string | 订单实付金额（含运费） |  | 
 | status | integer | 工单状态 1:未分配 2:未解决 3:优先退款 4:同意 5:拒绝 6:确认退货 7:确认发货 8:确认退款 9:处理完成 10:作废 |  | 

 

### 返回示例
```
{
    "traceId": "2451718973865691601",
    "success": true
}
```

---

## 维修单修改费用

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E7%BB%B4%E4%BF%AE%E5%8D%95%E4%BF%AE%E6%94%B9%E8%B4%B9%E7%94%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/650-%E7%BB%B4%E4%BF%AE%E5%8D%95%E4%BF%AE%E6%94%B9%E8%B4%B9%E7%94%A8.md

# 维修单修改费用

**请求方法:** POST

### 系统相关界面
【售后】---【维修单管理】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.repair.order.edit.repairMoney | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | repairOrderNum | String | 维修单号 | 必填 | 
 | repairMoney | Double | 维修费用 | 必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | integer | total |  | 
 | list | array | list |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | textReason | string | 原订单平台备注 |  | 
 | reason | string | 售后原因 (1:退运费 2:收到商品破损 3:商品错发/漏发 4:商品需要维修 5:发票问题 6:收到商品与描述不符 7:我不想要了 8:商品质量问题 9:未按约定时间发货) |  | 
 | shortId | long | 售后工单短号 |  | 
 | refundExpressId | string | 退回快递单号 |  | 
 | refundWarehouseId | long | 退货仓库ID |  | 
 | refundRemindTimeout | string | 超时日期 |  | 
 | shopName | string | 店铺名称 |  | 
 | remark | string | 工单备注 |  | 
 | source | string | 工单来源 |  | 
 | wangwangNum | string | 买家旺旺号 |  | 
 | refundPostFee | string | 应退运费 |  | 
 | tid | string | 平台订单号 |  | 
 | sid | long | 系统订单编号 |  | 
 | urgency | string | 补款单 紧急程度 |  | 
 | sysMaker | string | 创建人 |  | 
 | id | long | 售后工单号 |  | 
 | processingPeriod | integer | 处理期限(小时) |  | 
 | afterSaleType | integer | 售后类型 1：退款；2：退货；3：补发；4：换货 5:发货前的退款 |  | 
 | refundWarehouseName | string | 退货仓库名称 |  | 
 | created | string | 生成时间 |  | 
 | refundMoney | double | 补款金额 |  | 
 | platformStatus | integer | 平台状态 |  | 
 | buyerName | string | 买家姓名 |  | 
 | userId | long | 店铺ID |  | 
 | responsiblePerson | string | 补款单 责任人 |  | 
 | replenishRemark | string | 补款单 备注说明 |  | 
 | buyerPhone | string | 买家手机号 |  | 
 | goodStatus | integer | 货物状态 |  | 
 | refundExpressCompany | string | 退回快递公司 |  | 
 | dealResult | integer | 处理结果 |  | 
 | items | array | 商品明细集合 |  | 

# subTable: list/items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | payTime | string | 付款时间 |  | 
 | receiverName | string | 收货人 |  | 
 | num | integer | 商品数量 |  | 
 | sysMemo | string | 系统备注 |  | 
 | receiverMobile | string | 联系方式 |  | 
 | memo | string | 工单备注 |  | 
 | title | string | 商品标题 |  | 
 | tid	 | string | 订单编号 |  | 
 | receiverAddress | string | 收货地址 |  | 
 | outSid | string | 运单号 |  | 
 | mainOuterId | string | 商家编码 |  | 
 | buyerMessage | string | 买家留言 |  | 
 | consignTime | string | 发货时间 |  | 
 | price | string | 单价 |  | 
 | sysPicPath | string | 图片 |  | 
 | expressCode | string | 快递公司的编码 |  | 
 | outerId | string | Sku商家编码 |  | 
 | payment | string | 订单实付金额（含运费） |  | 
 | status | integer | 工单状态 1:未分配 2:未解决 3:优先退款 4:同意 5:拒绝 6:确认退货 7:确认发货 8:确认退款 9:处理完成 10:作废 |  | 

 

### 返回示例
```
{
    "traceId": "2451721900854572636",
    "msg": "是否需要付费参数不能为空",
    "code": "33",
    "success": false
}
```

---

## 维修单付款

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E7%BB%B4%E4%BF%AE%E5%8D%95%E4%BB%98%E6%AC%BE
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/700-%E7%BB%B4%E4%BF%AE%E5%8D%95%E4%BB%98%E6%AC%BE.md

# 维修单付款

**请求方法:** POST

### 系统相关界面
【售后】---【维修单管理】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.repair.order.pay | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | repairOrderNum | string | 维修单号 | 必填 | 
 | receivedTime | string | 入账时间 | 必填 | 
 | receivedWay | string | 入账途径 |  | 
 | currentPrice | Double | 本次费用 | 必填 | 
 | tradeNumber | string | 交易流水号 |  | 
 | operatorName | string | 操作人 |  | 
 | operatorTime | string | 操作时间 |  | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | integer | total |  | 
 | list | array | list |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | textReason | string | 原订单平台备注 |  | 
 | reason | string | 售后原因 (1:退运费 2:收到商品破损 3:商品错发/漏发 4:商品需要维修 5:发票问题 6:收到商品与描述不符 7:我不想要了 8:商品质量问题 9:未按约定时间发货) |  | 
 | shortId | long | 售后工单短号 |  | 
 | refundExpressId | string | 退回快递单号 |  | 
 | refundWarehouseId | long | 退货仓库ID |  | 
 | refundRemindTimeout | string | 超时日期 |  | 
 | shopName | string | 店铺名称 |  | 
 | remark | string | 工单备注 |  | 
 | source | string | 工单来源 |  | 
 | wangwangNum | string | 买家旺旺号 |  | 
 | refundPostFee | string | 应退运费 |  | 
 | tid | string | 平台订单号 |  | 
 | sid | long | 系统订单编号 |  | 
 | urgency | string | 补款单 紧急程度 |  | 
 | sysMaker | string | 创建人 |  | 
 | id | long | 售后工单号 |  | 
 | processingPeriod | integer | 处理期限(小时) |  | 
 | afterSaleType | integer | 售后类型 1：退款；2：退货；3：补发；4：换货 5:发货前的退款 |  | 
 | refundWarehouseName | string | 退货仓库名称 |  | 
 | created | string | 生成时间 |  | 
 | refundMoney | double | 补款金额 |  | 
 | platformStatus | integer | 平台状态 |  | 
 | buyerName | string | 买家姓名 |  | 
 | userId | long | 店铺ID |  | 
 | responsiblePerson | string | 补款单 责任人 |  | 
 | replenishRemark | string | 补款单 备注说明 |  | 
 | buyerPhone | string | 买家手机号 |  | 
 | goodStatus | integer | 货物状态 |  | 
 | refundExpressCompany | string | 退回快递公司 |  | 
 | dealResult | integer | 处理结果 |  | 
 | items | array | 商品明细集合 |  | 

# subTable: list/items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | payTime | string | 付款时间 |  | 
 | receiverName | string | 收货人 |  | 
 | num | integer | 商品数量 |  | 
 | sysMemo | string | 系统备注 |  | 
 | receiverMobile | string | 联系方式 |  | 
 | memo | string | 工单备注 |  | 
 | title | string | 商品标题 |  | 
 | tid	 | string | 订单编号 |  | 
 | receiverAddress | string | 收货地址 |  | 
 | outSid | string | 运单号 |  | 
 | mainOuterId | string | 商家编码 |  | 
 | buyerMessage | string | 买家留言 |  | 
 | consignTime | string | 发货时间 |  | 
 | price | string | 单价 |  | 
 | sysPicPath | string | 图片 |  | 
 | expressCode | string | 快递公司的编码 |  | 
 | outerId | string | Sku商家编码 |  | 
 | payment | string | 订单实付金额（含运费） |  | 
 | status | integer | 工单状态 1:未分配 2:未解决 3:优先退款 4:同意 5:拒绝 6:确认退货 7:确认发货 8:确认退款 9:处理完成 10:作废 |  | 

 

### 返回示例
```
{
    "traceId": "2451728429204886499",
    "msg": "是否需要付费参数不能为空",
    "code": "33",
    "success": false
}
```

---

## 修改售后工单备注

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E4%BF%AE%E6%94%B9%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E5%A4%87%E6%B3%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/750-%E4%BF%AE%E6%94%B9%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E5%A4%87%E6%B3%A8.md

# 修改售后工单备注

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.workorder.remark.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | remark | string | 备注信息 | 必填 | 
 | workOrderId | long | 工单ID不能为空 | 必填 | 

 

### 请求示例

```` 
{
"workOrderId":1243545435435354,
  "remark": "备注"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

 

### 响应示例
```
{
    
    "success": true,
    "trace_id": "3553483395423660"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.aftersale.workorder.remark.update:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 售后日志查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E6%9F%A5%E8%AF%A2%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E6%97%A5%E5%BF%97
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/800-%E6%9F%A5%E8%AF%A2%E5%94%AE%E5%90%8E%E5%B7%A5%E5%8D%95%E6%97%A5%E5%BF%97.md

# 售后日志查询

**请求方法:** POST

### 系统相关界面
【售后】--- 【售后工单新版】
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.aftersale.operate.log.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | workOrderId | long	 | 售后工单号 |  | 

### 请求示例

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | integer | total |  | 
 | list | array | list |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 日志id |  | 
 | key | long | 售后工单号 |  | 
 | companyId | long | 公司ID |  | 
 | content | string | 操作内容 |  | 
 | operateTime | date | 操作时间 |  | 
 | staffName | string | 操作人账号名称 |  | 
 | staffId | long | 操作人ID |  | 
 | enableStatus | int | 逻辑删除字段 |  | 
 | operateName | string | 操作人名称，可能有系统和平台 |  | 
 | operateType | string | 操作类型 |  | 

 

### 响应示例

### 异常示例
````

````
### 错误码解释

---

## 更新工单平台实退金额

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E6%9B%B4%E6%96%B0%E5%B7%A5%E5%8D%95%E5%B9%B3%E5%8F%B0%E5%AE%9E%E9%80%80%E9%87%91%E9%A2%9D
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/850-%E6%9B%B4%E6%96%B0%E5%B7%A5%E5%8D%95%E5%B9%B3%E5%8F%B0%E5%AE%9E%E9%80%80%E9%87%91%E9%A2%9D.md

# 更新工单平台实退金额

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | Content-Type | string | multipart/form-data | 必填 |

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method | string | erp.aftersale.update.platformRefundMoney | 必填 |

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | id | Long | 售后工单id | 必填 |
 | platformRefundMoney | Long | 平台实退金额-单位分（数值需大于等于0或者小于100000000） | 必填 |
 | itemSnapshot | array | 商品列表 |  | 
 
# subTable: itemSnapshot
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | Long | 商品id |  |
 | refundMoney |string | 平台实退金额-单位分 |  |

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | code | String | 错误code |  |
 | msg | String | 错误信息 |  |
 | success | Boolean | 示例：true |  |

---

## 更新工单退货快递信息

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E6%9B%B4%E6%96%B0%E5%B7%A5%E5%8D%95%E9%80%80%E8%B4%A7%E5%BF%AB%E9%80%92%E4%BF%A1%E6%81%AF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/860-%E6%9B%B4%E6%96%B0%E5%B7%A5%E5%8D%95%E9%80%80%E8%B4%A7%E5%BF%AB%E9%80%92%E4%BF%A1%E6%81%AF.md

# 更新工单退货快递信息

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | Content-Type | string | multipart/form-data | 必填 |

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method | string | erp.aftersale.update.express | 必填 |

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | id | Long | 售后工单id（id和platformId必须至少传一个） | 非必填 |
 | platformId | String | 平台工单号(platformId和id必须至少传一个) | 非必填 |
 | expressName | String | 快递公司 | 非必填 |
 | expressId | String | 快递单号 | 非必填 |

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | code | String | 错误code |  |
 | msg | String | 错误信息 |  |
 | success | Boolean | 示例：true |  |

---

## 新增工单商品

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E6%96%B0%E5%A2%9E%E5%B7%A5%E5%8D%95%E5%95%86%E5%93%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/870-%E6%96%B0%E5%A2%9E%E5%B7%A5%E5%8D%95%E5%95%86%E5%93%81.md

# 新增工单商品

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 |

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method | string | erp.aftersale.workorder.item.add | 必填 |

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | workOrderId | long | 售后工单ID | 必填 |
 | type | int | 商品类型 1-退货商品 2-补发商品 | 必填 |
 | itemList | string | 商品列表JSON字符串 | 必填 |

# subTable: itemList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | outerId | string | 商家编码 | 必填 |
 | count | int | 商品数量（必须大于0） | 必填 |
 | goodItemCount | int | 良品数量（销退入库时使用） |  |
 | badItemCount | int | 次品数量（销退入库时使用） |  |
 | remark | string | 商品备注 |  |

### 请求示例
```json
{
  "workOrderId": 1234567890,
  "type": 1,
  "itemList": "[{\"outerId\":\"SKU001\",\"count\":1,\"goodItemCount\":1,\"badItemCount\":0,\"remark\":\"商品备注\"}]"
}
```
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | code | string | 错误码 | 必填 |
 | msg | string | 错误信息 | 必填 |
 | itemIds | array | 新增成功的商品ID列表 | 必填 |
 | trace\_id | string | 示例：3553483395407017 | 必填 |

### 响应示例
```
{
    "code": "",
    "msg": "",
    "itemIds": [1001, 1002],
    "trace_id": "3553483395423660"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.aftersale.workorder.item.add:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

### 注意事项
1. 商品数量(count)必须大于0
2. 良品数量(goodItemCount) + 次品数量(badItemCount) 必须等于商品数量(count)
3. 商品类型(type)必须为1(退货商品)或2(补发商品)

---

## 删除工单商品

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E5%88%A0%E9%99%A4%E5%B7%A5%E5%8D%95%E5%95%86%E5%93%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/880-%E5%88%A0%E9%99%A4%E5%B7%A5%E5%8D%95%E5%95%86%E5%93%81.md

# 删除工单商品

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 |

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method | string | erp.aftersale.workorder.item.delete | 必填 |

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | workOrderId | long | 售后工单ID | 必填 |
 | type | int | 商品类型 1-退货商品 2-补发商品 | 必填 |
 | outerIds | string | 商家编码列表，多个用逗号分隔 | 必填 |

### 请求示例
```json
{
  "workOrderId": 1234567890,
  "type": 1,
  "outerIds": "SKU001,SKU002,SKU003"
}
```
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | code | string | 错误码 | 必填 |
 | msg | string | 错误信息 | 必填 |
 | reports | array | 操作结果报告列表 | 必填 |
 | trace\_id | string | 示例：3553483395407017 | 必填 |

# subTable: reports
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | isSuc | boolean | 是否成功 | 必填 |
 | errorMsg | string | 错误信息（失败时返回） |  |
 | reportKey | string | 报告标识（商家编码） | 必填 |

### 响应示例
```
{
    "code": "",
    "msg": "",
    "reports": [
        {
            "isSuc": true,
            "reportKey": "SKU001"
        },
        {
            "isSuc": true,
            "reportKey": "SKU002"
        },
        {
            "isSuc": false,
            "errorMsg": "商品不存在",
            "reportKey": "SKU003"
        }
    ],
    "trace_id": "3553483395423660"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.aftersale.workorder.item.delete:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

### 注意事项
1. 商家编码列表不能包含空值
2. 商品类型(type)必须为1(退货商品)或2(补发商品)
3. 删除结果通过reports数组返回，每个商品对应一个执行结果报告

---

## 修改工单商品

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%94%AE%E5%90%8E/%E4%BF%AE%E6%94%B9%E5%B7%A5%E5%8D%95%E5%95%86%E5%93%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/30-%E5%94%AE%E5%90%8E/890-%E4%BF%AE%E6%94%B9%E5%B7%A5%E5%8D%95%E5%95%86%E5%93%81.md

# 修改工单商品

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 |

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method | string | erp.aftersale.workorder.item.update | 必填 |

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | workOrderId | long | 售后工单ID | 必填 |
 | type | int | 商品类型 1-退货商品 2-补发商品 | 必填 |
 | itemList | string | 商品修改列表JSON字符串 | 必填 |

# subTable: itemList
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | outerId | string | 商家编码（作为商品标识） | 必填 |
 | count | int | 修改后的数量（必须大于0） |  |
 | goodItemCount | int | 修改后的良品数量 |  |
 | badItemCount | int | 修改后的次品数量 |  |
 | refundMoney | double | 修改后的系统实退金额（单位：元） |  |
 | receivableCount | int | 修改后的申请数量 |  |
 | remark | string | 修改后的备注 |  |

### 请求示例
```json
{
  "workOrderId": 1234567890,
  "type": 1,
  "itemList": "[{\"outerId\":\"SKU001\",\"count\":2,\"goodItemCount\":1,\"badItemCount\":1,\"refundMoney\":10.50,\"receivableCount\":1,\"remark\":\"修改备注\"}]"
}
```
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | code | string | 错误码 | 必填 |
 | msg | string | 错误信息 | 必填 |
 | reports | array | 操作结果报告列表 | 必填 |
 | trace\_id | string | 示例：3553483395407017 | 必填 |

# subTable: reports
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | isSuc | boolean | 是否成功 | 必填 |
 | errorMsg | string | 错误信息（失败时返回） |  |
 | reportKey | string | 报告标识（商家编码） | 必填 |

### 响应示例
```
{
    "code": "",
    "msg": "",
    "reports": [
        {
            "isSuc": true,
            "reportKey": "SKU001"
        },
        {
            "isSuc": false,
            "errorMsg": "商品不存在",
            "reportKey": "SKU002"
        }
    ],
    "trace_id": "3553483395423660"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.aftersale.workorder.item.update:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

### 注意事项
1. 商家编码(outerId)为必填项，作为商品标识
2. 商品数量(count)如果传入，必须大于0
3. 如果传入了数量(count)，且良品或次品有值，则良品数量(goodItemCount) + 次品数量(badItemCount) 必须等于商品数量(count)
4. 商品类型(type)必须为1(退货商品)或2(补发商品)
5. 修改结果通过reports数组返回，每个商品对应一个执行结果报告

---

## 查询调拨单列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E5%8D%95%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/0-%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E5%8D%95%E5%88%97%E8%A1%A8.md

# 查询调拨单列表

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.allocate.task.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | status | String | 状态 REATED：待审核 OUTING：出库中 AUDITED：已审核 ALLOCATE：调拨中 ALLOCATE_IN：调入中 FINISHED: 已完成 CANCELED：作废 MIXED：(待审核和出库中并且已拣选完成) |  | 
 | code | String | 业务单据号 |  | 
 | startModified | String | 修改时间 开始 code为空时必填 | 必填 | 
 | endModified | String | 修改时间 结束 |  | 
 | labelName | String | 标签 |  | 
 | pageNo | int |  |  | 
 | pageSize | int | 不能为空或者小于20 |  | 

 

### 请求示例
示例一：

```` 
{
  "status":"AUDITED",
  "startModified":"2022-06-01 00:00:00",
  "pageSize":40
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 数据列表 | 必填 | 
 | traceId | string |  | 必填 | 
 | total | int | 示例：3 | 必填 | 
 | success | boolean | 示例：true | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | shortId | int | 短号 | 必填 | 
 | code | string | 单号 | 必填 | 
 | inWarehouseName | string | 调入仓名称 | 必填 | 
 | outLocation | int | 12345:货位、入库暂存区、销退暂存区、次品暂存区、通用暂存区 | 必填 | 
 | outWarehouseName | string | 调出仓名称 | 必填 | 
 | outNum | int | 申请调拨总数 | 必填 | 
 | creatorName | string | 创建人名称 | 必填 | 
 | creatorId | int | 创建人Id | 必填 | 
 | outTotalAmount | Double | 调拨总金额（元） | 必填 | 
 | receiverCity | string | 城市 | 必填 | 
 | outWarehouseId | int | 调出仓id | 必填 | 
 | inWarehouseId | int | 调入仓id | 必填 | 
 | outPostFee | Double | 总运费（元） | 必填 | 
 | receiverDistrict | string | 区 | 必填 | 
 | modified | int | 修改时间 | 必填 | 
 | inNum | int | 调入数量 | 必填 | 
 | id | int |  | 必填 | 
 | inTotalAmount | Double | 调入金额（元） | 必填 | 
 | receiverName | string | 联系人 | 必填 | 
 | created | int | 创建时间 | 必填 | 
 | receiverMobile | string | 电话 | 必填 | 
 | diffNum | int | 差异数 | 必填 | 
 | diffAmount | Double | 差异金额（元） | 必填 | 
 | actualOutTotalAmount | Double | 调出总金额（元） | 必填 | 
 | receiverAddress | string | 详细地址 | 必填 | 
 | actualOutNum | int | 调出总数 | 必填 | 
 | receiverState | string | 省 | 必填 | 
 | status | string | 状态      REATED：待审核 OUTING：出库中 AUDITED：已审核 ALLOCATE：调拨中  FINISHED: 已完成 CANCELED：作废 MIXED：(待审核和出库中并且已拣选完成) | 必填 | 
 | labelName | string | 标签 | 必填 |
 | refundNum | int | 总拒收数 | 必填 |
 | actualRefundNum | int | 已退回总数 | 必填 |

 

### 响应示例
```
{
    "item": {
        "sysItemId": long,
        "barcode": "string",
        "picPath": "string",
        "activeStatus": long,
        "title": "string",
        "outerId": "string",
        "type": "string",
        "typeTag": long,
        "catId": "string",
        "unit": "string",
        "isSkuItem": long,
        "isVirtual": long,
        "hasSupplier": long,
        "makeGift": boolean,
        "created": long,
        "modified": long,
        "sellerCids": "string",
        "sellerCats": [
            {
                "id": long,
                "cid": long,
                "name": "string"
            }
        ]
    },
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询调拨入库单列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E5%85%A5%E5%BA%93%E5%8D%95%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/100-%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E5%85%A5%E5%BA%93%E5%8D%95%E5%88%97%E8%A1%A8.md

# 查询调拨入库单列表

**请求方法:** POST

### 系统相关界面
"界面路径：【库存】----【库存调拨】----【调拨入库】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | allocate.in.task.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss（单据修改时间） |  | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss（单据修改时间） |  | 
 | status | string | 入库状态 单据状态 CREATED :已创建，ALLOCATE_OUT:收货完成，SHELVED：已上架，FINISHED :已完成，CANCELED :作废 |  | 
 | code | string | 单据号(收货单号) 如:DR2022432423423 |  | 
 | customType | string | 单据类型（调拨入库拒收类型：ALLOCATE_REFUND） |  | 

 

### 请求示例
```json
{
"pageNo": "integer",
"startModified": "string",
"pageSize": "integer",
"endModified": "string",
"fields": "string",
"status": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 调拨入库单编号 | 必填 | 
 | taskOutId | string | 调拨出库单id | 必填 | 
 | inWarehouseName | string | 调入仓库名称 | 必填 | 
 | created | integer | 创建时间 | 必填 | 
 | outWarehouseName | string | 调出仓库名称 | 必填 | 
 | actualInNum | string | 实际调入数 | 必填 | 
 | remark | string | 备注：拒收退回等 | 必填 | 
 | taskShortId | string | 调拨任务短号 | 必填 | 
 | taskOutCode | string | 调拨出库单据号 | 必填 | 
 | outWarehouseId | string | 调出仓库id | 必填 | 
 | actualInTotalAmount | string | 实际调入金额 | 必填 | 
 | inWarehouseId | string | 调入仓库id | 必填 | 
 | taskCode | string | 调拨单据号 | 必填 | 
 | remainInNum | string | 待收货数 | 必填 | 
 | modified | integer | 修改时间 | 必填 | 
 | id | string | 调拨入库单id | 必填 | 
 | inNum | string | 调入数量 | 必填 | 
 | taskId | string | 调拨单据id | 必填 | 
 | inTotalAmount | string | 调入金额 | 必填 | 
 | status | string | 状态 单据状态 CREATED :已创建，ALLOCATE_OUT:收货完成，SHELVED：已上架，FINISHED :已完成，CANCELED :作废 | 必填 | 
 | details | object | 详情 | 必填 | 
 | receiveTime | int | 入库时间 | 必填 | 
 | customType | string | 单据类型（ALLOCATE_REFUND为调拨拒收入库类型） | 必填 | 

# subTable: list/details
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | amount | int | 入库金额 | 必填 | 
 | sysItemId | int | 主商品id | 必填 | 
 | count | int | 调入数量 | 必填 | 
 | sysSkuId | int | 规格商品id | 必填 | 
 | price | int | 单价 | 必填 | 
 | itemOuterId | string | 主商家编码 | 必填 | 
 | outerId | string | 规格商家编码 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "containerNo": "zhangsan",
      "code": "zhangsan",
      "taskOutId": 12345,
      "inWarehouseName": "zhangsan",
      "created": "@date",
      "outWarehouseName": "zhangsan",
      "details":{
        "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "@date",
      "goodNum": 12345
      },
      "outNum": 12345,
      "actualInNum": 12345,
      "remark": "zhangsan",
      "outTotalAmount": 10000,
      "taskShortId": 12345,
      "taskOutCode": "zhangsan",
      "outWarehouseId": 12345,
      "actualInTotalAmount": 10000,
      "inWarehouseId": 12345,
      "taskCode": "zhangsan",
      "remainInNum": 12345,
      "modified": "@date",
      "id": 12345,
      "inNum": 12345,
      "taskId": 12345,
      "inTotalAmount": 10000,
      "status": "zhangsan"
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(allocate.in.task.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(allocate.in.task.query:1.0)的签名无效|签名参数错误|

---

## 查询下架单列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E4%B8%8B%E6%9E%B6%E5%8D%95%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1000-%E6%9F%A5%E8%AF%A2%E4%B8%8B%E6%9E%B6%E5%8D%95%E5%88%97%E8%A1%A8.md

# 查询下架单列表

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【下架单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.wms.unshelve.order.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | startModified | string | 示例：起始时间 格式:yyyy-MM-dd HH:mm:ss（创建时间） |  | 
 | endModified | string | 示例：结束时间 格式:yyyy-MM-dd HH:mm:ss（创建时间） |  | 
 | pageNo | string | 示例：页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | string | 示例：每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | code | string | 单据号 |  | 

 

### 请求示例
```json
{
"startModified": "string",
"endModified": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | array | 数据列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | int | id | 必填 | 
 | code | string | 单号 | 必填 | 
 | billDate | int | 创建时间 | 必填 | 
 | warehouseId | int | 仓库id | 必填 | 
 | warehouseName | string | 仓库名称 | 必填 | 
 | status | int | 状态 1草稿 2待下架 3下架中 4已下架 5已作废 | 必填 | 
 | targetLocation | int | 下架位置 出库位置,货位/入库暂存区/销退暂存区/次品暂存区/通用暂存区/拣选暂存区 1/2/3/4/5/6 | 必填 | 
 | num | int | 总数 | 必填 | 
 | waitQuantity | int | 待下架数 | 必填 | 

 

### 响应示例
```
{
    "list": [
        {
            "id": 147,
            "code": "XJD147",
            "billDate": 1649659871000,
            "warehouseId": 12162,
            "warehouseName": "默认仓库",
            "status": 4,
            "targetLocation": 5,
            "num": 1,
            "waitQuantity": 0
        }
    ],
    "total": 147,
    "success": true,
    "trace_id": "3730499297335821"
}
```
### 异常示例
```
{
    "code": "25",
    "msg": "服务方法(erp.wms.unshelve.order.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.wms.unshelve.order.query:1.0)的签名无效|签名参数错误|

---

## 查询下架单明细

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E4%B8%8B%E6%9E%B6%E5%8D%95%E6%98%8E%E7%BB%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1050-%E6%9F%A5%E8%AF%A2%E4%B8%8B%E6%9E%B6%E5%8D%95%E6%98%8E%E7%BB%86.md

# 查询下架单明细

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【下架单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.wms.unshelve.order.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 下架单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | array | 数据列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemOuterId | string | 主商家编码 | 必填 | 
 | count | int | 数量 | 必填 | 
 | sysItemId | int | 商品id | 必填 | 
 | sysSkuId | int | sku id | 必填 | 
 | goodsSectionCode | string | 货位编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 

 

### 响应示例
```json
{
    "list": [
        {
            "itemOuterId": "A5576",
            "count": 1,
            "sysItemId": 458157522512384,
            "sysSkuId": 0,
            "goodsSectionCode": "111-3-3-3"
        }
    ],
    "total": 1,
    "success": true,
    "trace_id": "3730499297336279"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.wms.unshelve.order.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.wms.unshelve.order.get:1.0)的签名无效|签名参数错误|

---

## 查询调拨入库单明细

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E5%85%A5%E5%BA%93%E5%8D%95%E6%98%8E%E7%BB%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/110-%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E5%85%A5%E5%BA%93%E5%8D%95%E6%98%8E%E7%BB%86.md

# 查询调拨入库单明细

**请求方法:** POST

### 系统相关界面
"界面路径：【库存】----【库存调拨】----【调拨入库】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | allocate.in.task.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 示例：调拨入库单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | inTotalAmount | string | 入库金额（单位是分） | 必填 | 
 | sysItemId | string | 系统商品Id | 必填 | 
 | count | string | 数量 | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | price | string | 单价（单位是分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productDate | Date | 生产日期 | 必填 | 
 | expireDate | Date | 到期日期 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "@date",
      "goodNum": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(allocate.in.task.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(allocate.in.task.get:1.0)的签名无效|签名参数错误|

---

## 下架单下架

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E4%B8%8B%E6%9E%B6%E5%8D%95%E4%B8%8B%E6%9E%B6
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1100-%E4%B8%8B%E6%9E%B6%E5%8D%95%E4%B8%8B%E6%9E%B6.md

# 下架单下架

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【下架单管理】----【批量审核】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.wms.unshelve.order.unshelve | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 下架单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | int | 下架单id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.wms.unshelve.order.unshelve:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.wms.unshelve.order.unshelve:1.0)的签名无效|签名参数错误|

---

## 货位库存查询列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E8%B4%A7%E4%BD%8D%E5%BA%93%E5%AD%98%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1150-%E8%B4%A7%E4%BD%8D%E5%BA%93%E5%AD%98%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8.md

# 货位库存查询列表

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【货位库存】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | asso.goods.section.sku.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | startModified | string | 示例：起始时间 格式:yyyy-MM-dd HH:mm:ss（修改时间） |  | 
 | endModified | string | 示例：结束时间 格式:yyyy-MM-dd HH:mm:ss（修改时间） |  | 
 | pageNo | integer | 示例：页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 示例：每页条数 取值范围:大于零的整数;最大值：1000；默认值：40 |  | 
 | noNeedTotal | boolean | 是否不需要查询总数（默认为false会查询总数。分页调取时，除了第一次调用需要总数，后面的几次都不需要再获取总数，可以传true，接口速度会更快） |  | 

 

### 请求示例
```json
{
"pageNo": "integer",
"startModified": "string",
"pageSize": "integer",
"endModified": "string",
"fields": "string",
"status": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 数据列表 | 必填 | 
 | total | int | 总数 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | int | 货位库存id | 必填 | 
 | companyId | int | 公司id | 必填 | 
 | warehouseId | int | 仓库id | 必填 | 
 | stockRegionId | int | 库区id | 必填 | 
 | stockRegionType | int | 库区类型 1拣货区2备货区3次品区 | 必填 | 
 | goodsSectionId | int | 货位id | 必填 | 
 | goodsSectionCode | string | 货位编码 | 必填 | 
 | sysItemId | int | 商品id | 必填 | 
 | sysSkuId | int | 规格id | 必填 | 
 | containerType | int | 容器类型 0货位 | 必填 | 
 | totalNum | int | 数量 | 必填 | 
 | created | int | 创建时间 | 必填 | 
 | stockRegionName | string | 库区名称 | 必填 | 
 | outerId | string | 商品编码 | 必填 | 
 | batchNo | string | 批次 |  |
 | productDate | int | 生产日期 |  |
 | expireDate | int | 到期日期 |  |
 | periodCast | int | 保质期 |  |

 

### 响应示例
```json
{
    "list": [
        {
            "id": 12565839,
            "companyId": 10438,
            "warehouseId": 12162,
            "stockRegionId": 2080,
            "stockRegionType": 1,
            "goodsSectionId": 947381,
            "goodsSectionCode": "Z1区Z排Z列Z层Z格",
            "sysItemId": 451271496325632,
            "sysSkuId": 451271496335872,
            "containerType": 0,
            "totalNum": 0,
            "created": 1642324412000,
            "stockRegionName": "Z1区"
        }
    ],
    "total": 410500,
    "success": true,
    "trace_id": "3682225264290956"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(asso.goods.section.sku.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(asso.goods.section.sku.query:1.0)的签名无效|签名参数错误|

---

## 调拨入库单收货

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E8%B0%83%E6%8B%A8%E5%85%A5%E5%BA%93%E5%8D%95%E6%94%B6%E8%B4%A7
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/120-%E8%B0%83%E6%8B%A8%E5%85%A5%E5%BA%93%E5%8D%95%E6%94%B6%E8%B4%A7.md

# 调拨入库单收货

**请求方法:** POST

### 系统相关界面
"界面路径：【库存】----【库存调拨】----【调拨入库】----【收货单】----【收货】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | allocate.in.task.receive | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 示例：调拨入库单id | 必填 | 
 | weSourceId | String | 外部单号 | 非必填 | 
 | receiveDetails | String | 示例：传入JSON数组 示例：  \[     \{         "outerId": "U", // 商家编码，必填         "goodNum": "1", // 良品数，良品数次品数二选一         "badNum": 0, // 次品数         "batchNo": "" // 批次号 ，非必填     \} \] | 必填 | 

 

### 请求示例
```json
{
"id": "long",
"receiveDetails":[
     {         
        "outerId": "U", // 商家编码，必填         
        "goodNum": "1", // 良品数，良品数次品数二选一                     
        "badNum": 0, // 次品数         
        "batchNo": "" // 批次号 ，非必填     
        }
    ]
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | Long | id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(allocate.in.task.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(allocate.in.task.get:1.0)的签名无效|签名参数错误|

---

## 货位库存删除数据列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E8%B4%A7%E4%BD%8D%E5%BA%93%E5%AD%98%E5%88%A0%E9%99%A4%E6%95%B0%E6%8D%AE%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1200-%E8%B4%A7%E4%BD%8D%E5%BA%93%E5%AD%98%E5%88%A0%E9%99%A4%E6%95%B0%E6%8D%AE%E5%88%97%E8%A1%A8.md

# 货位库存删除数据列表

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【货位库存】----【释放货位】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | asso.goods.section.sku.del.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | startModified | string | 示例：起始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endModified | string | 示例：结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | pageNo | integer | 示例：页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 示例：每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | noNeedTotal | boolean | 是否不需要查询总数（默认为false会查询总数。分页调取时，除了第一次调用需要总数，后面的几次都不需要再获取总数，可以传true，接口速度会更快） |  | 

 

### 请求示例
```json
{
"pageNo": "integer",
"startModified": "string",
"pageSize": "integer",
"endModified": "string",
"fields": "string",
"status": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 数据列表 | 必填 | 
 | total | int | 总数 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | assoGoodsSectionSkuId | int | 已删除的货位库存原表id | 必填 | 
 | companyId | int | 公司id | 必填 | 
 | warehouseId | int | 仓库id | 必填 | 
 | stockRegionId | int | 库区id | 必填 | 
 | stockRegionType | int | 库区类型 1拣货区2备货区3次品区 | 必填 | 
 | goodsSectionId | int | 货位id | 必填 | 
 | goodsSectionCode | string | 货位编码 | 必填 | 
 | sysItemId | int | 商品id | 必填 | 
 | sysSkuId | int | 规格id | 必填 | 
 | containerType | int | 容器类型 0货位 | 必填 | 
 | totalNum | int | 数量 | 必填 | 
 | created | int | 创建时间 | 必填 | 
 | stockRegionName | string | 库区名称 | 必填 | 
 | outerId | string | 商品编码 | 必填 | 
 | batchNo | string | 批次 |  |
 | productDate | int | 生产日期 |  |
 | expireDate | int | 到期日期 |  |
 | periodCast | int | 保质期 |  |

 

### 响应示例
```json
{
    "list": [
        {
            "id": 12565839,
            "companyId": 10438,
            "warehouseId": 12162,
            "stockRegionId": 2080,
            "stockRegionType": 1,
            "goodsSectionId": 947381,
            "goodsSectionCode": "Z1区Z排Z列Z层Z格",
            "sysItemId": 451271496325632,
            "sysSkuId": 451271496335872,
            "containerType": 0,
            "totalNum": 0,
            "created": 1642324412000,
            "stockRegionName": "Z1区"
        }
    ],
    "total": 410500,
    "success": true,
    "trace_id": "3682225264290956"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(asso.goods.section.sku.del.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(asso.goods.section.sku.del.query:1.0)的签名无效|签名参数错误|

---

## 查询加工单列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E5%8A%A0%E5%B7%A5%E5%8D%95%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1250-%E6%9F%A5%E8%AF%A2%E5%8A%A0%E5%B7%A5%E5%8D%95%E5%88%97%E8%A1%A8.md

# 查询加工单列表

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.stock.product.order.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | modifiedStart | string | 修改开始时间 |  | 
 | modifiedEnd | string | 修改结束时间 |  | 
 | productTimeStart | string | 加工时间（时分秒） 开始 |  | 
 | productTimeEnd | string | 加工时间（时分秒） 结束 |  | 
 | finishedTimeStart | string | 完成时间（时分秒） 开始 |  | 
 | finishedTimeEnd | string | 完成时间（时分秒） 结束 |  | 
 | createdStart | string | 创建时间（时分秒）开始 |  | 
 | createdEnd | string | 创建时间（时分秒）结束 |  | 
 | code | string | 加工单号 |  | 
 | type | string | 加工类型       加工：ITEM_PROCESS；反加工：TYPE_ITEM_REVERSE_PROCESS；改码：ITEM_BARTER；标准：TYPE_NORMAL_PROCESS；印花：TYPE_ITEM_PRINT_PROCESS |  | 
 | status | string | 加工状态      待审核: WAIT_VERIFY; 待加工: WAIT_PRODUCT; 加工中: PRODUCING; 已完成: FINISHED; 已作废: CLOSED |  | 
 | pageNo | integer |  |  | 
 | pageSize | integer |  |  | 

 

### 请求示例
示例：

```
{
  "modifiedStart": "2023-11-30 00:00:00",
  "modifiedEnd": "2023-11-30 23:59:59",
  "productTimeEnd": "2023-11-30 18:00:00",
  "productTimeStart": "2023-11-30 08:00:00",
  "finishedTimeEnd": "2023-11-30 23:59:59",
  "finishedTimeStart": "2023-11-30 00:00:00",
  "createdEnd": "2023-11-30 23:59:59",
  "createdStart": "2023-11-30 00:00:00",
  "code": "123456",
  "type": "ITEM_PROCESS",
  "status": "FINISHED"
}
```
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | 示例：3083234987791268223 | 必填 | 
 | list | array | 数据列表 | 必填 | 
 | total | int |  | 必填 | 
 | success | boolean | 示例：true | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 加工单code | 必填 | 
 | targetWaveStockType | string | 加工波次原料下架暂存区 | 必填 | 
 | materialWarehouseId | int | 原料仓库id | 必填 | 
 | productTime | int | 加工日期 | 必填 | 
 | type | string | 业务类型 | 必填 | 
 | stockRegionType | int | 示例：0 | 必填 | 
 | modified | int | 修改时间 | 必填 | 
 | id | int |  | 必填 | 
 | materialWarehouseName | string | 原料仓库名称 | 必填 | 
 | created | int | 创建时间 | 必填 | 
 | productWarehouseId | int | 成品仓库id | 必填 | 
 | waveId | int | 波次号 | 必填 | 
 | productWarehouseName | string | 成品仓库名称 | 必填 | 
 | materialUnShelvesPosition | int | 原材料扣减区，货位 ：0, 货位（拣货区）：1，货位（备货区）：2，货位（次品区）：3，通用暂存区：4，拣选暂存区：5, 货位（先拣货区再备货区）：6，货位（先备货区再拣货区）：7 | 必填 | 
 | createId | int | 制单人id | 必填 | 
 | finishedTime | int | 完成日期 | 必填 | 
 | enableStatus | int |  | 必填 | 
 | createName | string | 制单人姓名 | 必填 | 
 | status | string | 加工单状态 | 必填 | 

 

### 响应示例
```
{
    "traceId": "3083234987791268223",
    "list": [
        {
            "shortId": 1,
            "code": "JG569806611460608",
            "targetWaveStockType": "COMMON",
            "materialWarehouseId": 69583,
            "productTime": 1700202847000,
            "type": "ITEM_PROCESS",
            "stockRegionType": 0,
            "modified": 978278400000,
            "id": 4557695749677546,
            "table": "stock_product_order_vo",
            "orderPrintCount": 0,
            "uniqueCodePrintCount": 0,
            "materialWarehouseName": "默认仓库",
            "created": 1700202853000,
            "productWarehouseId": 69583,
            "waveId": 0,
            "productWarehouseName": "默认仓库",
            "materialUnShelvesPosition": 0,
            "companyId": 51330,
            "boxAllocate": 0,
            "totalNum": 4,
            "autoCalculateProductFee": false,
            "createId": 466259816571392,
            "finishedTime": 978278400000,
            "productShelvesPosition": 4,
            "enableStatus": 1,
            "createName": "超级管理员",
            "status": "WAIT_VERIFY"
        }
    ],
    "total": 1,
    "success": true
}
```
### 异常示例
```
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 平台商品批次效期库存查询列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E5%95%86%E5%93%81%E6%89%B9%E6%AC%A1%E6%95%88%E6%9C%9F%E5%BA%93%E5%AD%98%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1250-%E5%95%86%E5%93%81%E6%89%B9%E6%AC%A1%E6%95%88%E6%9C%9F%E5%BA%93%E5%AD%98%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8.md

# 平台商品批次效期库存查询列表

**请求方法:** POST

### 系统相关界面
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.wms.product.stock.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | skuIds | string | 示例：平台skuId 逗号拼接 格式:657225306755585,657225306755586 | 平台订单号 为空时，不可和numIids 同时为空 | 
 | numIids | string | 示例：平台numIid 逗号拼接 格式:657225306712576,657225306712577 |  平台订单号 为空时，不可和skuIds同时为空  | 
 | tids | string | 示例：平台订单号 逗号拼接 格式:5248307509112226,5248307509112227 | 平台订单号 | 
 | userId | integer | 示例：店铺id 格式:900017676 | 店铺ID，必填  | 
 | pageNo | integer | 示例：页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 示例：每页条数 取值范围:大于零的整数;最大值：1000；默认值：40 |  | 

 

### 请求示例
```json
{
"pageNo": "integer",
"skuIds": "string",
"pageSize": "integer",
"numIids": "string",
"userId": "integer",
"tids": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 数据列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | numIid | string | 平台商品numIid | 必填 | 
 | totalNum | int | 数量 | 必填 | 
 | skuId | string | 平台商品skuId | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productTime | string | 生产日期 | 必填 | 
 | expireDate | string | 到期日期 | 必填 | 
 | platformTitle | string | 商品名称 | 必填 | 
 | platformPropertiesName | string | 规格名称 | 必填 | 
 | periodCast | int | 保质期 | 必填 | 
 

### 响应示例
```json
{
    "traceId": "4483449095765605791",
    "list": [
        {
            "numIid": "903176533241",
            "totalNum": 5,
            "skuId": "5762171973741",
            "batchNo": "",
            "productTime": "",
            "expireDate": "",
            "platformTitle": "",
            "platformPropertiesName": "",
            "periodCast": 100,
        }
    ],
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.wms.product.stock.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.wms.product.stock.query:1.0)的签名无效|签名参数错误|

---

## 查询加工单明细

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E5%8A%A0%E5%B7%A5%E5%8D%95%E6%98%8E%E7%BB%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1300-%E6%9F%A5%E8%AF%A2%E5%8A%A0%E5%B7%A5%E5%8D%95%E6%98%8E%E7%BB%86.md

# 查询加工单明细

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.stock.product.order.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | productOrderId | long | 加工单Id |  | 

 

### 请求示例
示例一：

```` 
{
  "productOrderId": 4557695749677546
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | goodList | array | 成品列表 | 必填 | 
 | materialList | array | 原料列表 | 必填 | 
 | traceId | string |  | 必填 | 
 | success | boolean | 示例：true | 必填 | 

# subTable: goodList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | hasBatch | int | 示例：0 | 必填 | 
 | num | int | 成品数量 | 必填 | 
 | sysItemId | int | 系统item id | 必填 | 
 | productOrderId | int | 加工单id | 必填 | 
 | removeBatchNo | boolean | 清除批次效期 | 必填 | 
 | uniqueCodeType | int | 唯一码 | 必填 | 
 | actualUpNum | int | 实际上架数 | 必填 | 
 | modified | int | 修改时间 | 必填 | 
 | id | int |  | 必填 | 
 | created | int | 创建时间 | 必填 | 
 | unCompleteNum | int | 未完成加工数 | 必填 | 
 | picPath | string | 商品图片URL | 必填 | 
 | sysSkuId | int | 系统sku | 必填 | 
 | warehouseId | int | 仓库id | 必填 | 
 | enableStatus | int | 是否删除，0-未删除，1-已删除 | 必填 | 
 | hasProduct | int | 是否有效期，0-否，1-是 | 必填 | 
 | availableNum | int | 已上架数量，示例：0 | 必填 | 
 | title | string | 商品的标题 | 必填 | 
 | upNum | int | 上架数量 | 必填 | 
 | itemOuterId | string | 商品的商家编码 | 必填 | 
 | printBomNum | int | 已改码打印数 | 必填 | 
 | completeNum | int | 实际完成数 | 必填 | 
 | outerId | string | sku的商家编码 | 必填 | 
 | batchNo | string | 批次 | 不必填 | 
 | productTime | string | 生产日期 | 不必填 |	
 | productAmount | string | 加工费 | 不必填 | 
 | remark | string | 备注 | 不必填 | 
 | bomDetail| string | Bom明细 | 不必填 | 

# subTable: materialList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | int |  | 必填 | 
 | created | int | 创建时间 | 必填 | 
 | unCompleteNum | int | 未完成加工数 | 必填 | 
 | picPath | string | 商品图片URL | 必填 | 
  | warehouseId | int | 仓库id | 必填 | 
  | sysItemId | int | 系统item id | 必填 | 
   | sysSkuId | int | 系统sku | 必填 | 
 | outerId | string | sku的商家编码 | 必填 | 
 | batchNo | string | 批次 | 不必填 | 
 | productTime | string | 生产日期 | 不必填 |	
 | stockProductGoodNameAndNums | array | 拣选货位 | 必填 | 
 | stockOutNum | string | 实际消耗数量| 必填 | 
  | remark | string | 备注 | 不必填 | 

 

### 响应示例
```
{
    "item": {
        "sysItemId": long,
        "barcode": "string",
        "picPath": "string",
        "activeStatus": long,
        "title": "string",
        "outerId": "string",
        "type": "string",
        "typeTag": long,
        "catId": "string",
        "unit": "string",
        "isSkuItem": long,
        "isVirtual": long,
        "hasSupplier": long,
        "makeGift": boolean,
        "created": long,
        "modified": long,
        "sellerCids": "string",
        "sellerCats": [
            {
                "id": long,
                "cid": long,
                "name": "string"
            }
        ]
    },
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 暂存区批量上架

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9A%82%E5%AD%98%E5%8C%BA%E6%89%B9%E9%87%8F%E4%B8%8A%E6%9E%B6
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1350-%E6%9A%82%E5%AD%98%E5%8C%BA%E6%89%B9%E9%87%8F%E4%B8%8A%E6%9E%B6.md

# 暂存区批量上架

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.wms.upshelf.batch | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | shelveType | Integer | 暂存区类型。字典看下方暂存区类型字典 | 必填 | 
 | externalWarehouseCode | String | 仓库外部编码。编码和ID二选一必填 | 必填 | 
 | qualityType | Boolean | true：良品。false： 不良品。不传默认true |  | 
 | goodsSectionSkuVos | array | 商品明细 传jsonString | 必填 | 

# subTable: goodsSectionSkuVos
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 最小维度商家编码 | 必填 | 
 | num | int | 上架数 | 必填 | 
 | goodsSectionCode | string | 货位编码 | 必填 | 
 | batchNo | String | 批次 (开启批次的商品必传) |  | 
 | productTime | Date | 有效日期 (开启有效日期的商品必传) |  | 

 

### 请求示例
示例一：

```` 
{
    "shelveType": 2,
    "externalWarehouseCode": "A",
    "goodsSectionSkuVos": [
        {
            "outerId": "xnct1",
            "num": 1,
            "goodsSectionCode": "FF-1-1-1-1"
        },
        {
            "outerId": "质检001",
            "num": 1,
            "goodsSectionCode": "FF-1-1-1-1"
        }
    ]
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | 示例：3118655604459561094 | 必填 | 
 | success | boolean | 示例：true | 必填 | 

 

### 响应示例
```
{
    "traceId": "3118655604459561094",
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

### 暂存区类型字典
| shelveType类型值 | 是否良品 | 暂存类型              | 业务类型 | 跟踪操作                  |
| ---- | -------- | ---------------------- | -------- | ------------------------- |
 | 1    | 是       | 拣货暂存区             | 拣货     | 良品上架                  |
| 2    | 否       | 拣货暂存区             | 拣货     | 次品上架                  |
| 3    | 是       | 入库暂存区             | 入库     | 良品上架                  |
| 4    | 否       | 入库暂存区             | 入库     | 次品上架                  |
| 5    | 是       | 销退暂存区             | 销退     | 良品上架                  |
 | 6    | 否       | 销退暂存区             | 销退     | 次品上架                  |
 | 7    | 是       | 通用暂存区             | 通用     | 良品上架                  |
 | 8    | 否       | 通用暂存区             | 通用     | 次品上架                  |
 | 9    | 是       | 采退暂存区             | 采退     | 良品上架                  |
 | 10   | 否       | 采退暂存区             | 采退     | 次品上架                  |
| 11   | 是       | 次品暂存区-入库上架    | 次品入库 | 良品上架                  |
 | 12   | 否       | 次品暂存区-入库上架    | 次品入库 | 次品上架                  |
| 13   | 是       | 次品暂存区-销退上架    | 次品销退 | 良品上架                  |
 | 14   | 否       | 次品暂存区-销退上架    | 次品销退 | 次品上架                  |
 | 15   | 是       | 销退暂存区             | 销退     | 良品批量上架              |

---

## 货位进出记录查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E8%B4%A7%E4%BD%8D%E8%BF%9B%E5%87%BA%E8%AE%B0%E5%BD%95%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1400-%E8%B4%A7%E4%BD%8D%E8%BF%9B%E5%87%BA%E8%AE%B0%E5%BD%95%E6%9F%A5%E8%AF%A2.md

# 货位进出记录查询

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | goods.section.in.out.record.query | 必填 |

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | pageNo | Integer | 当前页 | 必填 |
 | pageSize | Integer | 每页数，默认40 | 必填 |
 | orderNumber | string | 单据编号 |  |
 | operateStartTime | string | 操作开始时间 格式为：yyyy-MM-dd HH:mm:ss |  |
 | operateEndTime | string | 操作结束时间 格式为：yyyy-MM-dd HH:mm:ss |  |

 

### 请求示例
示例一：

```` 
{
  "pageNo": 1,
  "pageSize": 40
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | 示例：3118655604459561094 | 必填 | 
 | hasNext | boolean | 示例：true 是否有下一页| 必填 |
 | list | array | 货位进出记录|  |

 # subTable: list
  | 参数名 | 类型 | 描述 | 必填 |
  | --- | --- | --- | --- |
  | id	| long	| 记录id，唯一| |
  | sysItemId	| long | 系统商品id | |
  | sysSkuId	| long	| 系统规格id | |
  | outerId	| string |	商家编码 | |
  | warehouseId	| long | 仓库id | |
  | warehouseName	| string | 仓库名称 | |
  | goodsSectionId	| long | 货位id | |
  | goodsSectionCode | string |	货位编码 | |
  | orderNumber	| string | 单据号 | |
  | operateTime	| date | 操作时间 | |
  | stockChange	| int |	数量 | |
  | qualityType	| boolean |	质量类型true：良品，false：次品 | |
  | batchNo	| string |	批次号 | |
  | productTime	| date | 生产日期 | |
  | expireDate	| date | 到期日期 | |
  | boxCode	| string | 箱码 | |
  | type	| int |	操作类型 | |
  | typeName  |	string	| 操作类型名称 | |
  | content	| string |	操作详情 | |
  | staffName  | string | 操作人名称 | |

 

### 响应示例
```
{
       "traceId": "4718011452490990110",
        "hasNext": true,
        "list": [
            {
                "goodsSectionCode": "FF-y-y-1-1",
                "orderNumber": "DC5151945389570050_8",
                "sysItemId": 620052882924032,
                "operateTime": 1736428612000,
                "typeName": "调拨出库",
                "goodsSectionId": 1810156,
                "type": 19,
                "warehouseName": "默认仓库",
                "content": "操作前数量:866,操作后数量:806",
                "sysSkuId": 0,
                "warehouseId": 69583,
                "staffName": "超级管理员",
                "outerId": "发票单品06",
                "qualityType": true,
                "id": 15658363,
                "stockChange": -60
            }
        ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 销售出库单查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E9%94%80%E5%94%AE%E5%87%BA%E5%BA%93%E5%8D%95%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1600-%E9%94%80%E5%94%AE%E5%87%BA%E5%BA%93%E5%8D%95%E6%9F%A5%E8%AF%A2.md

# 销售出库单查询

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】--【波次】--【销售出库单】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.wave.logistics.order.query | 必填 |

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 默认值 | 
 | --- | --- | --- | --- | --- | 
 | userIds | string | 店铺ID列表，多个用逗号分隔 | 否 |  | 
 | statusList | string | 销售出库单状态列表，多个用逗号分隔，10-待处理，20-预处理完成，30-发货中，50-已发货，70-已关闭，90-已作废 | 否 |  | 
 | timeType | integer | 时间类型，1-创建时间，2-发货时间，3-付款时间，4-下单时间，5-承诺时间，6-打印时间 系统单号、内部单号、平台单号、物流单号、波次号为空时，必须设置时间范围查询 | 否 |  |
 | timeBegin | long | 开始时间（时间戳，单位：毫秒）系统单号、内部单号、平台单号、物流单号、波次号为空时，必须设置时间范围查询 | 否 |  |
 | timeEnd | long | 结束时间（时间戳，单位：毫秒）系统单号、内部单号、平台单号、物流单号、波次号为空时，必须设置时间范围查询 | 否 |  |
 | sids | string | 系统单号列表，多个用逗号分隔，最多50个 | 否 |  | 
 | shortIds | string | 内部单号列表，多个用逗号分隔，最多50个 | 否 |  | 
 | tids | string | 平台单号列表，多个用逗号分隔，最多50个 | 否 |  | 
 | outSids | string | 物流单号列表，多个用逗号分隔，最多50个 | 否 |  | 
 | waveIds | string | 波次号列表，多个用逗号分隔，最多50个 | 否 |  | 
 | pageNo | integer | 页码 | 否 | 1 | 
 | pageSize | integer | 每页数量，最大200 | 否 | 40 | 

 

### 请求示例
示例一：

````
{
 "timeType": 2,
 "timeBegin": 1609459200000,
 "timeEnd": 1612137599000,
 "userIds": "123456,789012",
 "statusList": "10,20,30",
 "pageNo": 1,
 "pageSize": 40
}
````

示例二：

````
{
 "timeType": 2,
 "timeBegin": 1609459200000,
 "timeEnd": 1612137599000,
 "userIds": "123456,789012",
 "statusList": "10,20,30",
 "sids": "202401010001,202401010002",
 "shortIds": "SH001,SH002",
 "tids": "TB202401010001,TB202401010002",
 "outSids": "SF1234567890,SF0987654321",
 "waveIds": "1001,1002",
 "pageNo": 1,
 "pageSize": 40
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 销售出库单列表 |  | 
 | total | long | 总记录数 |  | 
 | pageNo | integer | 当前页码 |  | 
 | pageSize | integer | 每页数量 |  | 
 | success | boolean | 是否成功 |  | 
 | trace_id | string | 追踪ID |  | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 销售出库单id |  | 
 | userId | long | 店铺id |  | 
 | shopName | string | 店铺名称 |  | 
 | sid | string | 系统单号 |  | 
 | shortId | string | 内部单号 |  | 
 | tid | string | 平台单号 |  | 
 | outSid | string | 快递单号 |  | 
 | createTime | date | 创建时间 |  | 
 | modifyTime | date | 修改时间 |  | 
 | outTime | date | 出库时间 |  | 
 | payTime | date | 付款时间 |  | 
 | status | integer | 销售出库单状态，10-待处理，20-预处理完成，30-发货中，50-已发货，70-已关闭，90-已作废 |  | 
 | statusName | string | 销售出库单状态名称 |  | 
 | receiverCountry | string | 收件国家 |  | 
 | receiverState | string | 收件省 |  | 
 | receiverCity | string | 收件市 |  | 
 | receiverDistrict | string | 收件区 |  | 
 | receiverStreet | string | 收件街道 |  | 
 | receiverAddress | string | 收件地址 |  | 
 | receiverName | string | 收件人 |  | 
 | receiverMobile | string | 收件手机号 |  | 
 | receiverPhone | string | 收件固话 |  | 
 | buyerMessage | string | 买家留言 |  | 
 | sellerMemo | string | 卖家备注 |  | 
 | sysMemo | string | 系统备注 |  | 
 | payment | decimal | 订单应付金额 |  |
 | payAmount | decimal | 订单实付金额 |  |
 | discountFee | decimal | 订单优惠金额 |  |
 | logisticsCompanyId | long | 快递公司id |  |
 | logisticsCompanyName | string | 快递公司名称 |  | 
 | netWeight | string | 订单净重 |  | 
 | volume | string | 订单体积 |  | 
 | theoryPostFee | string | 理论运费 |  | 
 | actualPostFee | string | 实际运费 |  | 
 | warehouseId | long | 仓库id |  | 
 | warehouseName | string | 仓库名称 |  | 
 | waveId | long | 波次号 |  | 
 | itemNum | integer | 商品数量 |  | 
 | itemKindNum | integer | 商品种类数量 |  | 
 | tradeTagList | array | 订单标签列表 |  | 
 | details | array | 销售出库单明细列表 |  | 

# subTable: list/details
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | logisticsOrderId | long | 销售出库单id |  | 
 | itemOuterId | string | 主商品编码 |  | 
 | skuOuterId | string | 规格商家编码 |  | 
 | sysTitle | string | 商品名称 |  | 
 | sysSkuPropertiesName | string | 规格属性 |  | 
 | sysPicPath | string | 图片链接 |  | 
 | num | integer | 数量 |  | 
 | type | integer | 商品类型，1：普通商品，2：套件本身， 3：套件子商品，4：加工商品本身，5：加工子商品，6：组合商品本身，7：组合子商品，8：新版包材商品|  |
 | isGift | integer | 是否赠品，0-否，1-是 |  | 
 | isPick | integer | 是否拣选验货，0-免拣、免验，1-拣选、免验，2-拣选、验货，3-免拣、验货 |  |
 | isNonConsign | integer | 是否不发货，0-否，1-是 |  | 
 | isVirtual | integer | 是否虚拟商品，0-否，1-是 |  | 
 | weight | double | 重量 |  | 
 | volume | double | 体积 |  |
 | status | integer | 商品状态 1-交易关闭 0-“不显示” |  |
 | priceImport | double | 成本价 |  | 
 | relatedDetailId | long | 关联子订单id |  |
 | price | decimal | 商品销售单价 |  |
 | payment | decimal | 商品应付金额 |  |
 | payAmount | decimal | 商品实付金额 |  |
 | discountFee | decimal | 商品优惠金额 |  |
 | sysItemRemark | string | 商品备注 |  |

 

### 响应示例
```
{
    "traceId": "4115985342831359490",
    "success": true,
    "total": 100,
    "pageNo": 1,
    "pageSize": 40,
    "list": [
        {
            "id": 123456789,
            "userId": 100001,
            "shopName": "测试店铺",
            "sid": "202401010001",
            "shortId": "SH001",
            "tid": "TB202401010001",
            "outSid": "SF1234567890",
            "createTime": "2024-01-01 10:00:00",
            "modifyTime": "2024-01-01 11:00:00",
            "outTime": "2024-01-01 12:00:00",
            "payTime": "2024-01-01 09:00:00",
            "status": 30,
            "statusName": "发货中",
            "receiverCountry": "CN",
            "receiverState": "浙江省",
            "receiverCity": "杭州市",
            "receiverDistrict": "西湖区",
            "receiverStreet": "文三路",
            "receiverAddress": "文三路123号",
            "receiverName": "",
            "receiverMobile": "",
            "receiverPhone": "",
            "buyerMessage": "请尽快发货",
            "sellerMemo": "重要客户",
            "sysMemo": "系统备注",
            "payment": 199.00,
            "payAmount": 199.00,
            "discountFee": 0.00,
            "logisticsCompanyId": 1,
            "logisticsCompanyName": "顺丰速运",
            "netWeight": "1.5",
            "volume": "0.5",
            "theoryPostFee": "15.00",
            "actualPostFee": "15.00",
            "warehouseId": 10,
            "warehouseName": "杭州仓",
            "waveId": 1001,
            "itemNum": 2,
            "itemKindNum": 1,
            "tradeTagList": [],
            "details": [
                {
                    "logisticsOrderId": 123456789,
                    "itemOuterId": "ITEM001",
                    "skuOuterId": "SKU001",
                    "sysTitle": "测试商品",
                    "sysSkuPropertiesName": "颜色:红色;尺码:L",
                    "sysPicPath": "https://example.com/pic.jpg",
                    "num": 2,
                    "type": 0,
                    "isGift": 0,
                    "isPick": 1,
                    "isNonConsign": 0,
                    "isVirtual": 0,
                    "weight": 1.5,
                    "volume": 0.5,
                    "status": 0,
                    "priceImport": 100.00,
                    "price": 100.00,
                    "payment": 100.00,
                    "payAmount": 100.00,
                    "discountFee": 0.00,
                    "sysItemRemark": "商品备注"
                    "relatedDetailId": 987654321
                }
            ]
        }
    ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.wave.logistics.order.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````

````
{
    "code": "32",
    "msg": "请选择时间类型！",
    "success": false,
    "trace_id": "3553483395423661"
}
````

````
{
    "code": "33",
    "msg": "单页数量不能超过200！",
    "success": false,
    "trace_id": "3553483395423662"
}
````

````
{
    "code": "33",
    "msg": "波次号最多不能超过50个",
    "success": false,
    "trace_id": "3553483395423663"
}
````

````
{
    "code": "9",
    "msg": "销售出库单查询失败！",
    "success": false,
    "trace_id": "3553483395423664"
}
````
### 错误码解释
| 错误信息 |错误码|解决方案|
|-|-|-|
|资源异常,请联系管理员!|400|检查参数是否合法|
|销售出库单查询失败！|9|业务逻辑错误，请联系管理员|
|请选择时间类型！|32|未设置单号时，timeType参数必填|
|请输入开始时间！|32|未设置单号时，timeBegin参数必填且大于0|
|请输入结束时间！|32|未设置单号时，timeEnd参数必填且大于0|
|单页数量不能超过200！|33|pageSize参数最大值为200|
|波次号最多不能超过50个|33|waveIds参数最多不能超过50个|
|系统单号最多不能超过50个|33|sids参数最多不能超过50个|
|平台单号最多不能超过50个|33|tids参数最多不能超过50个|
|内部单号最多不能超过50个|33|shortIds参数最多不能超过50个|
|物流单号最多不能超过50个|33|outSids参数最多不能超过50个|

### 状态说明
**销售出库单状态（status）：**
- 10：待处理
- 20：预处理完成
- 30：发货中
- 50：已发货
- 70：已关闭
- 90：已作废

**时间类型（timeType）：**
- 1：创建时间
- 2：发货时间
- 3：付款时间
- 4：下单时间
- 5：承诺时间
- 6：打印时间

**商品类型（type）：**
- 1：普通商品
- 2：套件本身
- 3：套件子商品
- 4：加工商品本身
- 5：加工子商品
- 6：组合商品本身
- 7：组合子商品
- 8：新版包材商品

---

## 查询质检单列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E8%B4%A8%E6%A3%80%E5%8D%95%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1650-%E6%9F%A5%E8%AF%A2%E8%B4%A8%E6%A3%80%E5%8D%95%E5%88%97%E8%A1%A8.md

# 查询质检单列表

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | Content-Type | string | multipart/form-data | 必填 |

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method | string | check.sheet.query | 必填 |

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | purchaseOrderId | Long | 关联采购单Id | 采购单Id/采购单号/质检单Id/质检单号/完成时间不能同时为空 |
 | purchaseOrderCode | String | 关联采购单号 | 采购单Id/采购单号/质检单Id/质检单号/完成时间不能同时为空 |
 | status | String | 质检状态，1-草稿 2-待质检 3-质检中 4-质检完成 5-已作废，多个用逗号分隔 | 否 |
 | checkSheetId | Long | 质检单Id | 采购单Id/采购单号/质检单Id/质检单号/完成时间不能同时为空 |
 | checkSheetCode | String | 质检单号 | 采购单Id/采购单号/质检单Id/质检单号/完成时间不能同时为空 |
 | startModified | Date | 开始时间，格式：yyyy-MM-dd HH:mm:ss | 否 |
 | endModified | Date | 结束时间，格式：yyyy-MM-dd HH:mm:ss | 否 |
 | timeType | String | 时间种类 | 1-制单时间 2-审核时间 3-开始质检时间 4-完成质检时间 |

 | pageNo | int | 页码，默认1 | 否 |
 | pageSize | int | 每页条数，默认20，最大500 | 否 |

### 请求示例
示例一：按采购单Id + 时间范围查询

````
{
  "purchaseOrderId":"123",
  "startModified":"2026-06-01 00:00:00",
  "endModified":"2026-06-30 23:59:59",
  "pageNo":1,
  "pageSize":40
}
````

示例二：按质检单号查询

````
{
  "checkSheetCode":"QC20260602001",
  "pageNo":1,
  "pageSize":20
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | list | array | 数据列表 | 必填 |
 | traceId | string | 链路追踪Id | 必填 |
 | total | int | 总记录数，示例：3 | 必填 |
 | success | boolean | 是否成功，示例：true | 必填 |

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | id | Long | 质检单id | 必填 |
 | code | string | 质检单号 | 必填 |
 | warehouseId | Long | 仓库id | 必填 |
 | warehouseName | string | 仓库名称 | 必填 |
 | checkLocation | int | 质检位置 1=入库 2=通用 3=采退 4=拣选 5=销退 6=次品 | 必填 |
 | status | int | 质检状态 1=草稿 2=待质检 3=质检中 4=质检完成 5=已作废 | 必填 |
 | planCheckNum | Long | 计划质检总数 | 必填 |
 | checkNum | Long | 已质检总数 | 必填 |
 | sid | Long | 关联订单号 | 必填 |
 | purchaseOrderId | Long | 关联采购单id | 必填 |
 | purchaseOrderCode | string | 关联采购单号 | 必填 |
 | warehouseEntryCode | string | 关联收货单号 | 必填 |
 | purchaseReturnCode | string | 关联采退单号 | 必填 |
 | beginCheck | string | 开始质检时间，格式：yyyy-MM-dd HH:mm:ss | 必填 |
 | endCheck | string | 完成质检时间，格式：yyyy-MM-dd HH:mm:ss | 必填 |
 | created | string | 制单时间，格式：yyyy-MM-dd HH:mm:ss | 必填 |
 | createdName | string | 制单人 | 必填 |
 | audited | string | 审核时间，格式：yyyy-MM-dd HH:mm:ss | 必填 |
 | auditName | string | 审核人 | 必填 |
 | finished | string | 完成时间，格式：yyyy-MM-dd HH:mm:ss | 必填 |
 | finishName | string | 完成人 | 必填 |
 | remark | string | 备注 | 必填 |

### 响应示例
```
{
    "list": [
        {
            "id": 12345,
            "code": "QC20260602001",
            "warehouseId": 100,
            "warehouseName": "主仓库",
            "checkLocation": 1,
            "status": 4,
            "planCheckNum": 100,
            "checkNum": 100,
            "orderCode": "SO20260601001",
            "purchaseOrderId": 88001,
            "purchaseOrderCode": "PO20260601001",
            "warehouseEntryCode": "WE20260601001",
            "purchaseReturnCode": "",
            "beginCheck": "2026-06-01 10:00:00",
            "endCheck": "2026-06-01 15:00:00",
            "created": "2026-06-01 09:00:00",
            "createdName": "张三",
            "audited": "2026-06-01 09:30:00",
            "auditName": "赵六",
            "finished": "2026-06-01 15:00:00",
            "finishName": "李四",
            "remark": ""
        }
    ],
    "total": 1,
    "success": true,
    "traceId": "3553483395423660"
}
```
### 异常示例
```

{
    "code": "25",
    "msg": "采购单Id/采购单号/质检单Id/质检单号不能同时为空",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|参数校验失败|采购单Id/采购单号/质检单Id/质检单号不能同时为空|至少传入 purchaseOrderId、purchaseOrderCode、checkSheetId、checkSheetCode 中的一个|
|参数校验失败|采购单不存在|传入的 purchaseOrderId 在系统中未找到对应采购单|

---

## 查询质检单明细

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E8%B4%A8%E6%A3%80%E5%8D%95%E6%98%8E%E7%BB%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/1700-%E6%9F%A5%E8%AF%A2%E8%B4%A8%E6%A3%80%E5%8D%95%E6%98%8E%E7%BB%86.md

# 查询质检单明细

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | Content-Type | string | multipart/form-data | 必填 |

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method | string | check.sheet.detail.query | 必填 |

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | purchaseOrderId | Long | 关联采购单Id | 采购单Id/采购单号/质检单Id/质检单号不能同时为空 |
 | purchaseOrderCode | String | 关联采购单号 | 采购单Id/采购单号/质检单Id/质检单号不能同时为空 |
 | checkSheetId | Long | 质检单Id | 采购单Id/采购单号/质检单Id/质检单号不能同时为空 |
 | checkSheetCode | String | 质检单号 | 采购单Id/采购单号/质检单Id/质检单号不能同时为空 |
 | pageNo | int | 页码，默认1 | 否 |
 | pageSize | int | 每页条数，默认20，最大500 | 否 |

### 请求示例
示例一：按质检单号查询明细

````
{
  "checkSheetCode":"QC20260602001",
  "pageNo":1,
  "pageSize":50
}
````

示例二：按采购单Id查询关联的所有质检明细

````
{
  "purchaseOrderId":"123",
  "pageNo":1,
  "pageSize":20
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | list | array | 数据列表 | 必填 |
 | traceId | string | 链路追踪Id | 必填 |
 | total | int | 总记录数，示例：3 | 必填 |
 | success | boolean | 是否成功，示例：true | 必填 |

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | checkSheetId | Long | 质检单id | 必填 |
 | checkSheetCode | string | 质检单号 | 必填 |
 | sysItemId | Long | 系统商品id | 必填 |
 | itemOuterId | string | 主商家编码 | 必填 |
 | skuOuterId | string | 商家规格编码 | 必填 |
 | title | string | 商品名称 | 必填 |
 | sysSkuId | Long | 系统规格id | 必填 |
 | propertiesName | string | 规格名称（如：红色;XL） | 必填 |
 | planCheckNum | Long | 计划质检数 | 必填 |
 | goodCheckNum | Long | 良品质检数 | 必填 |
 | badCheckNum | Long | 次品质检数 | 必填 |
 | repairCheckNum | Long | 返修质检数 | 必填 |
 | remainCheckNum | Long | 剩余质检数（计划数 - 良品 - 次品 - 返修，最小为0） | 必填 |
 | overCheckNum | Long | 超出质检数（良品 + 次品 + 返修 - 计划数，最小为0） | 必填 |
 | checkName | string | 质检员名称 | 必填 |
 | beginCheck | string | 开始质检时间，格式：yyyy-MM-dd HH:mm:ss | 必填 |
 | endCheck | string | 完成质检时间，格式：yyyy-MM-dd HH:mm:ss | 必填 |
 | checkStatus | int | 质检进度 1=尚未质检 2=部分质检 3=完全质检 4=超量质检 | 必填 |

### 响应示例
```
{
    "list": [
        {
            "checkSheetId": 12345,
            "checkSheetCode": "QC20260602001",
            "sysItemId": 1001,
            "outerId": "SKU001",
            "skuOuterId": "SKU001-RED-XL",
            "title": "测试商品",
            "sysSkuId": 2001,
            "propertiesName": "红色;XL",
            "planCheckNum": 50,
            "goodCheckNum": 45,
            "badCheckNum": 3,
            "repairCheckNum": 2,
            "remainCheckNum": 0,
            "overCheckNum": 0,
            "checkName": "王五",
            "beginCheck": "2026-06-01 10:00:00",
            "endCheck": "2026-06-01 14:00:00",
            "checkStatus": 3
        }
    ],
    "total": 1,
    "success": true,
    "traceId": "3553483395423660"
}
```
### 异常示例
```

{
    "code": "25",
    "msg": "采购单Id/采购单号/质检单Id/质检单号不能同时为空",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|参数校验失败|采购单Id/采购单号/质检单Id/质检单号不能同时为空|至少传入 purchaseOrderId、purchaseOrderCode、checkSheetId、checkSheetCode 中的一个|
|业务校验失败|未找到关联的质检单|传入的采购单下没有关联任何质检单，请确认采购单号正确或质检单已生成|

---

## 新增完成的调拨单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%96%B0%E5%A2%9E%E5%AE%8C%E6%88%90%E7%9A%84%E8%B0%83%E6%8B%A8%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/20-%E6%96%B0%E5%A2%9E%E5%AE%8C%E6%88%90%E7%9A%84%E8%B0%83%E6%8B%A8%E5%8D%95.md

# 新增完成的调拨单

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | allocate.task.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outWarehouseCode | long | 调出仓库外部编码	 | 必填 | 
 | inWarehouseCode | long | 调入仓库外部编码 | 必填 | 
 | details | array | 调拨单明细 | 必填 | 
 | remark | string | 备注 |  | 

# subTable: details
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码 | 必填 | 
 | outNum | int | 申请调拨数 |  | 
 | actualOutNum | int | 实际调出数量 | 必填 | 
 | inNum | int | 实际调入数量 | 必填 | 

 

### 请求示例
```
{
"outWarehouseCode":"cangchucode1",
"inWarehouseCode":"cangchucode2",
"details":[ 
      {"actualOutNum":2,"inNum":1,"outerId":"ceshi","qualityType":true,"title":"光云台历2021"}]
}
```
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | errorMsg | string | 错误信息 | 必填 | 
 | allocateCode | String | 生成的调拨单单号 | 必填 | 
 | allocateId | Long | 生成的调拨单Id | 必填 | 

 

### 响应示例
```
{
    "item": {
        "sysItemId": long,
        "barcode": "string",
        "picPath": "string",
        "activeStatus": long,
        "title": "string",
        "outerId": "string",
        "type": "string",
        "typeTag": long,
        "catId": "string",
        "unit": "string",
        "isSkuItem": long,
        "isVirtual": long,
        "hasSupplier": long,
        "makeGift": boolean,
        "created": long,
        "modified": long,
        "sellerCids": "string",
        "sellerCats": [
            {
                "id": long,
                "cid": long,
                "name": "string"
            }
        ]
    },
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
```
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询调拨出库单列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E5%87%BA%E5%BA%93%E5%8D%95%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/210-%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E5%87%BA%E5%BA%93%E5%8D%95%E5%88%97%E8%A1%A8.md

# 查询调拨出库单列表

**请求方法:** POST

### 系统相关界面
"界面路径：【库存】----【库存调拨】----【调拨出库】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | allocate.out.task.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | status | string | 出库状态 CREATED,OUTING未出库，FINISHED已出库，CANCELED已完成 |  | 
 | code | string | 单据号 如:DC3911498093140480 |  | 
 | timeType | string | 查询时间类型 如: "create" 创建时间查询 "out" 出库时间查询 “gm_modified” 修改时间查询 不传默认根据修改时间查询 |  | 

 

### 请求示例
```json
{
"pageNo": "integer",
"startModified": "string",
"pageSize": "integer",
"endModified": "string",
"fields": "string",
"status": "string"
"timeType" : "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | templateType | string | 模板类型 | 必填 | 
 | code | string | 出库单号 | 必填 | 
 | pickerNames | string | 波次拣选员 | 必填 | 
 | inWarehouseName | string | 调入仓名称 | 必填 | 
 | outWarehouseName | string | 调出仓名称 | 必填 | 
 | outNum | string | 调出总数 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | actualOutTotalAmount | string | 调出总金额 | 必填 | 
 | templateId | string | 模板id | 必填 | 
 | taskShortId | string | 调拨任务短号 | 必填 | 
 | receiverCity | string | 城市 | 必填 | 
 | outWarehouseId | string | 调出仓id | 必填 | 
 | inWarehouseId | string | 调入仓id | 必填 | 
 | outOperatorName | string | 出库人名称 | 必填 | 
 | taskCode | string | 调拨任务编号 | 必填 | 
 | outPostFee | string | 总运费 | 必填 | 
 | receiverDistrict | string | 区 | 必填 | 
 | modified | string | 修改时间 | 必填 | 
 | id | string | id | 必填 | 
 | pickerIds | string | 波次拣选员Id | 必填 | 
 | created | string | 创建时间 | 必填 | 
 | receiverName | string | 联系人 | 必填 | 
 | receiverMobile | string | 电话 | 必填 | 
 | waveId | string | 波次号 | 必填 | 
 | actualOutTotalAmount | string | 实际调出金额 | 必填 | 
 | waveStatus | string | 波次状态 1：未拣选；2：拣选中；3：拣选完成 | 必填 | 
 | receiverAddress | string | 详细地址 | 必填 | 
 | outSid | string | 运单号 | 必填 | 
 | actualOutNum | string | 实际调出数 | 必填 | 
 | companyId | string | 公司id | 必填 | 
 | outOperatorId | string | 出库人Id | 必填 | 
 | receiverState | string | 省 | 必填 | 
 | taskId | string | 调拨任务id | 必填 | 
 | status | string | 出库状态 CREATED,OUTING未出库，FINISHED已出库，CANCELED已完成 | 必填 | 
 | outTime | int | 出库时间 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "templateType": 1,
      "code": "zhangsan",
      "pickerNames": "zhangsan",
      "inWarehouseName": "zhangsan",
      "outWarehouseName": "zhangsan",
      "outNum": 12345,
      "remark": "zhangsan",
      "outTotalAmount": 10000,
      "templateId": 12345,
      "taskShortId": 12345,
      "receiverCity": "zhangsan",
      "content": "zhangsan",
      "outWarehouseId": 12345,
      "inWarehouseId": 12345,
      "outOperatorName": "zhangsan",
      "taskCode": "zhangsan",
      "outPostFee": 10000,
      "receiverDistrict": "zhangsan",
      "modified": "@date",
      "id": 12345,
      "inNum": 12345,
      "allAllocate": true,
      "inTotalAmount": 10000,
      "remainOutNum": 12345,
      "pickerIds": "zhangsan",
      "created": "@date",
      "receiverName": "zhangsan",
      "receiverMobile": "zhangsan",
      "diffNum": 12345,
      "diffAmount": 10000,
      "waveId": 12345,
      "actualOutTotalAmount": 10000,
      "waveStatus": 1,
      "receiverAddress": "zhangsan",
      "outSid": "zhangsan",
      "actualOutNum": 12345,
      "companyId": 12345,
      "templateName": "zhangsan",
      "wlbTemplateType": "zhangsan",
      "outOperatorId": 12345,
      "receiverState": "zhangsan",
      "taskId": 12345,
      "status": "zhangsan"
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(allocate.out.task.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(allocate.out.task.query:1.0)的签名无效|签名参数错误|

---

## 查询调拨出库单明细

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E5%87%BA%E5%BA%93%E5%8D%95%E6%98%8E%E7%BB%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/220-%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E5%87%BA%E5%BA%93%E5%8D%95%E6%98%8E%E7%BB%86.md

# 查询调拨出库单明细

**请求方法:** POST

### 系统相关界面
"界面路径：【库存】----【库存调拨】----【调拨出库】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | allocate.out.task.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 调拨出库单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | count | string | 申请调拨数 | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | price | string | 单价（单位是分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productDate | Date | 生产日期 | 必填 | 
 | expireDate | Date | 到期日期 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "@date",
      "goodNum": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(allocate.out.task.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(allocate.out.task.get:1.0)的签名无效|签名参数错误|

---

## 调拨出库单直接出库

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E8%B0%83%E6%8B%A8%E5%87%BA%E5%BA%93%E5%8D%95%E7%9B%B4%E6%8E%A5%E5%87%BA%E5%BA%93
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/300-%E8%B0%83%E6%8B%A8%E5%87%BA%E5%BA%93%E5%8D%95%E7%9B%B4%E6%8E%A5%E5%87%BA%E5%BA%93.md

# 调拨出库单直接出库

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.allocate.out.task.out | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 调拨出库id | 必填 | 
 | prSourceId | String | 外部单号 | 非必填 | 
 | details | jsonString | 出库明细 | 必填 | 

# subTable: details
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | String | 商家编码 | 必填 | 
 | returnGoodNum | int | 良品出库数 | 必填 | 
 | returnBadNum | int | 次品出库数（调拨单选择了次品货位商品需要传） |  | 
 | batchNo | String | 开启批次商品必填 |  | 
 | productTime | Date | 开启生产日期商品必填 |  | 
 
 

 

### 请求示例
示例一：

```` 
{
  "id":1231231325,
  "details":"[{\"outerId\":\"6936274408850\",\"returnGoodNum\":30}]"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

 

### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询其他入库单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E5%85%B6%E4%BB%96%E5%85%A5%E5%BA%93%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/400-%E6%9F%A5%E8%AF%A2%E5%85%B6%E4%BB%96%E5%85%A5%E5%BA%93%E5%8D%95.md

# 查询其他入库单

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【其他入库单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | other.in.order.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerCode | string | 外部编号 |  | 
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss（修改时间为准） |  | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss（修改时间为准） |  | 
 | customTypeStr | string | 入库单类型，支持多个拼接 |  | 
 | status | string | 单据状态 NOT_FINISH :未完成，FINISHED :已完成，SHELVED :「已废弃」，CLOSED :已关闭 |  | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | code | string | 单据号 |  | 

 

### 请求示例
```json
{
"outerCode": "string",
"startModified": "string",
"endModified": "string",
"fields": "string",
"customTypeStr": "string",
"status": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | shortId | string | 短号 | 必填 | 
 | finisherName | string | 完成人名称 | 必填 | 
 | busyOutId | string | 业务出库单id | 必填 | 
 | cancelAmount | string | 作废金额（单位：分） | 必填 | 
 | outWarehouseName | string | 出库仓库名称 | 必填 | 
 | discountAmount | string | 折扣金额（单位：分） | 必填 | 
 | needCheck | string | 是否需要质检 0-不需要，1-需要 | 必填 | 
 | shelveTime | string | 上架时间 | 必填 | 
 | outWarehouseId | string | 出库仓库id | 必填 | 
 | weSourceId | string | 收货单对接平台外部单号 | 必填 | 
 | purchaseOrderCode | string | 采购单编号 | 必填 | 
 | busyId | string | 业务id | 必填 | 
 | modified | string | 修改时间 | 必填 | 
 | id | string | id | 必填 | 
 | outerCode | string | 外部编号 | 必填 | 
 | created | string | 创建时间 | 必填 | 
 | busyType | string | 业务类型 | 必填 | 
 | finished | string | 完成时间 完成人姓名 | 必填 | 
 | createrName | string | 制单人名称 | 必填 | 
 | pdaWeTaskStatus | string | pda收货状态，0：未进行pda收货 1：pda收货中 | 必填 | 
 | othersFee | string | 其他金额（单位：分） | 必填 | 
 | shelvedQuantity | string | 上架数 | 必填 | 
 | warehouseId | string | 仓库id | 必填 | 
 | purchaseOrderId | string | 采购单id | 必填 | 
 | purchaseQuantity | string | 采购总数 | 必填 | 
 | items | string | 商品种类数量 | 必填 | 
 | status | string | 入库状态 NOT_FINISH :未完成，FINISHED :已完成，SHELVED :「已废弃」，CLOSED :已关闭 | 必填 | 
 | containerNo | string | 容器号 | 必填 | 
 | code | string | 收货单编号 | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | badShelveFee | string | 次品上架金额（单位：分） | 必填 | 
 | freight | string | 运费（单位：分） | 必填 | 
 | remark | string | 备注 | 必填 | 
 | warehouseName | string | 仓库名 | 必填 | 
 | goodShelveFee | string | 良品上架金额（单位：分） | 必填 | 
 | waitShelveQuantity | string | 待上架数量 | 必填 | 
 | totalDetailFee | string | 总金额（单位：分） | 必填 | 
 | hasCheck | string | 质检状态 0-未质检，1-已质检 | 必填 | 
 | busyOutCode | string | 业务出库单单据号 | 必填 | 
 | supplierName | string | 供应商名 | 必填 | 
 | getBadNum | string | 已接收次品数 | 必填 | 
 | quantity | string | 数量 | 必填 | 
 | busyTypeDesc | string | 业务类型desc | 必填 | 
 | warehouseExternalCode | string | 仓库外部编号 | 必填 | 
 | cancelQuantity | string | 作废数量 | 必填 | 
 | receiveQuantity | string | 商品待代收数量(对应商品明细里的代收数) | 必填 | 
 | getGoodNum | string | 已接收良品数 | 必填 | 
 | feeShareType | string | 金额分摊方式 | 必填 | 
 | busyCode | string | 业务单据号 | 必填 | 
 | quantityCheck | string | 待质检数 | 必填 | 
 | logisticsType | string | 物流方式 | 必填 | 
 | customType | string | 出入库类型 | 必填 | 
 | labels | array | 标签列表 |  | 
 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "shortId": "zhangsan",
      "finisherName": "zhangsan",
      "busyOutId": 12345,
      "cancelAmount": 10000,
      "outWarehouseName": "zhangsan",
      "discountAmount": 10000,
      "needCheck": 1,
      "shelveTime": "zhangsan",
      "outWarehouseId": 12345,
      "weSourceId": "zhangsan",
      "purchaseOrderCode": "zhangsan",
      "busyId": 12345,
      "modified": "zhangsan",
      "id": 12345,
      "outerCode": "zhangsan",
      "created": "zhangsan",
      "busyType": "zhangsan",
      "finished": "zhangsan",
      "createrName": "zhangsan",
      "pdaWeTaskStatus": 1,
      "othersFee": 10000,
      "shelvedQuantity": 12345,
      "warehouseId": 12345,
      "purchaseOrderId": 12345,
      "purchaseQuantity": 12345,
      "items": 1,
      "status": "zhangsan",
      "containerNo": "zhangsan",
      "code": "zhangsan",
      "supplierId": 12345,
      "badShelveFee": 10000,
      "freight": 10000,
      "remark": "zhangsan",
      "warehouseName": "zhangsan",
      "goodShelveFee": 10000,
      "waitShelveQuantity": 12345,
      "totalDetailFee": 10000,
      "hasCheck": 1,
      "busyOutCode": "zhangsan",
      "supplierName": "zhangsan",
      "getBadNum": 12345,
      "quantity": 12345,
      "busyTypeDesc": "zhangsan",
      "warehouseExternalCode": "zhangsan",
      "cancelQuantity": 12345,
      "receiveQuantity": 12345,
      "getGoodNum": 12345,
      "feeShareType": 1,
      "busyCode": "zhangsan",
      "quantityCheck": 1,
      "logisticsType": 1,
      "customType" : "类型一"
      "labels": [
        {
          "name": "测试标签",
          "id": 8125
        }
      ]
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(other.in.order.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(other.in.order.query:1.0)的签名无效|签名参数错误|

---

## 查询其他入库单明细

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E5%85%B6%E4%BB%96%E5%85%A5%E5%BA%93%E5%8D%95%E6%98%8E%E7%BB%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/410-%E6%9F%A5%E8%AF%A2%E5%85%B6%E4%BB%96%E5%85%A5%E5%BA%93%E5%8D%95%E6%98%8E%E7%BB%86.md

# 查询其他入库单明细

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【其他入库单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | other.in.order.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | amount | string | 金额（单位：分） | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | code | string | 单据编号 | 必填 | 
 | sysItemId | string | 系统商品id | 必填 | 
 | count | string | 数量 | 必填 | 
 | supplierCode | string | 供应商代码 | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | unit | string | 单位 | 必填 | 
 | price | string | 单价（单位：分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | goodNum | number | 良品数量 | 必填 | 
 | badNum | number | 次品数量 | 必填 | 
  | batchNo | string | 批次 |  | 
 | productDate | Date | 效期 |  | 
 | expireDate | Date | 到期日期 |  | 
 | remark | string | 备注 |  |

 
 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "zhangsan",
      "goodNum": 12345
     
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(other.in.order.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(other.in.order.get:1.0)的签名无效|签名参数错误|

---

## 新增其他入库单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%96%B0%E5%A2%9E%E5%85%B6%E4%BB%96%E5%85%A5%E5%BA%93%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/420-%E6%96%B0%E5%A2%9E%E5%85%B6%E4%BB%96%E5%85%A5%E5%BA%93%E5%8D%95.md

# 新增其他入库单

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【其他入库单管理】----【新增入库单】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | other.in.order.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | weSourceId | string | 示例：外部单号 |  | 
 | customType | string | 示例：出入库类型 |  | 
 | remark | string | 示例：备注 |  | 
 | inLocation | string | 示例：入库位置,货位/入库暂存区/销退暂存区/次品暂存区/通用暂存区/采退暂存区/补货暂存区/拣货暂存区, 1/2/3/4/5/6/7/8 |  | 
 | items | string | 示例：商品列表json \[\{"outerId":"springday","quantity":1,"price":1,"remark":"备注"\}\],（price 单位：元） | 必填 | 
 | warehouseCode | string | 示例：仓库外部编码  | 必填 | 
 | status | integer | 示例：状态 0 草稿， 1 审核并入库，-1 待入库（已审核） |  | 
 | uniqueCodes | string | 唯一码 当type为1时传入 json \[\{"uniqueCode":123, "outerId":"商家编码1","supplierName":"张三供应商"\}\] 其中 uniqueCode字段必填。 当传入的唯一码在系统中不存在时，outerId和supplierName需要传入。supplierName不填则取商品对应的供应商 |  | 
 | type | integer | 类型 0或不传 普通， 1 唯一码 |  | 
 | code | string | 单据号 |  | 
 | labelIds | string | 标签id，多个用英文逗号隔开 |  | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码(最小粒度) | 必填 | 
 | quantity | long | 良品数量 |  | 
 | badNum | long | 次品数量 |  | 
 | price | number | 单价（单位：元） | 必填 | 
 | batchNo | string | 批次 |  | 
 | productDate | Date | 效期 |  | 
 | expireDate | Date | 到期日期 |  | 
 | remark | string | 备注 |  | 
 

### 请求示例
```json
{
"outerCode": "string",
"startModified": "string",
"endModified": "string",
"fields": "string",
"customTypeStr": "string",
"status": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(other.in.order.add:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(other.in.order.add:1.0)的签名无效|签名参数错误|

---

## 作废其他入库单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E4%BD%9C%E5%BA%9F%E5%85%B6%E4%BB%96%E5%85%A5%E5%BA%93%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/430-%E4%BD%9C%E5%BA%9F%E5%85%B6%E4%BB%96%E5%85%A5%E5%BA%93%E5%8D%95.md

# 作废其他入库单

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【其他入库单管理】----【批量操作】----【批量作废】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.other.in.order.cancel | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 示例：单据id，支持多个，逗号拼接 | 必填 | 

 

### 请求示例
```json
{
"ids": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | successCodes | string \[ \] | 成功的code | 必填 | 

 

### 响应示例
```json
{
  "successCodes": [
    "first",
    "second",
    "third"
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.other.in.order.cancel:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.other.in.order.cancel:1.0)的签名无效|签名参数错误|

---

## 审核其他入库单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E5%AE%A1%E6%A0%B8%E5%85%B6%E4%BB%96%E5%85%A5%E5%BA%93%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/440-%E5%AE%A1%E6%A0%B8%E5%85%B6%E4%BB%96%E5%85%A5%E5%BA%93%E5%8D%95.md

# 审核其他入库单

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【其他入库单管理】----【批量操作】----【批量审核】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.other.in.order.audit | 必填 |

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 示例：单据id，支持多个，逗号拼接 | 必填 | 

 

### 请求示例
```json
{
"ids": "3092312,3092262"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | successCodes | string \[ \] | 成功的code | 必填 | 

 

### 响应示例
```json
{
  "successCodes": [
    "first",
    "second",
    "third"
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.other.in.order.cancel:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.other.in.order.cancel:1.0)的签名无效|签名参数错误|

---

## 新增调拨单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%96%B0%E5%A2%9E%E8%B0%83%E6%8B%A8%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/50-%E6%96%B0%E5%A2%9E%E8%B0%83%E6%8B%A8%E5%8D%95.md

# 新增调拨单

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | allocate.task.status.create | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outWarehouseCode | long | 调出仓库外部编码	 | 必填 | 
 | inWarehouseCode | long | 调入仓库外部编码 | 必填 | 
 | outLocation | int | 出库位置 货位/入库暂存区/销退暂存区/次品暂存区/通用暂存区/拣选暂存区/补货暂存区  1/2/3/4/5/6/8 | 必填 | 
 | status | string | 调拨状态 CREATED：待审核,AUDITED：待调拨 | 必填 | 
 | platformOrderNumber | string | 外部单号 |  | 
 | details | array | 调拨单明细 | 必填 | 
 | remark | string | 备注 |  | 

# subTable: details
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码 | 必填 | 
 | outNum | int | 申请调拨数 | 必填 | 
 | batchNo | string | 批次 |  | 
 | productTime | date | 生产日期 |  | 
 | expireDate | date | 到期日期 |  | 

 

### 请求示例
```
{
"outWarehouseCode":"cangchucode1",
"inWarehouseCode":"cangchucode2",
"details":[ 
      {"outNum":2,"outerId":"ceshi","title":"光云台历2021"}]
}
```
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | errorMsg | string | 错误信息 | 必填 | 
 | allocateCode | String | 生成的调拨单单号 | 必填 | 
 | allocateId | Long | 生成的调拨单Id | 必填 | 

 

### 响应示例
```
{
    "item": {
        "sysItemId": long,
        "barcode": "string",
        "picPath": "string",
        "activeStatus": long,
        "title": "string",
        "outerId": "string",
        "type": "string",
        "typeTag": long,
        "catId": "string",
        "unit": "string",
        "isSkuItem": long,
        "isVirtual": long,
        "hasSupplier": long,
        "makeGift": boolean,
        "created": long,
        "modified": long,
        "sellerCids": "string",
        "sellerCats": [
            {
                "id": long,
                "cid": long,
                "name": "string"
            }
        ]
    },
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
```
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询其他出库单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E5%85%B6%E4%BB%96%E5%87%BA%E5%BA%93%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/600-%E6%9F%A5%E8%AF%A2%E5%85%B6%E4%BB%96%E5%87%BA%E5%BA%93%E5%8D%95.md

# 查询其他出库单

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【其他出库单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | other.out.order.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerCode | string | 外部编号 |  | 
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss（修改时间为准） |  | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss（修改时间为准） |  | 
 | customTypeStr | string | 出库类型，支持多个拼接 |  | 
 | status | integer | 单据状态 0 :已作废，1 :待出库，2 :已审核 「已废弃」，3 :已出库，4 :出库中，5：草稿 |  | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | code | string | 单据号:如:"QC3917302237225607" |  | 

 

### 请求示例
```json
{
"outerCode": "string",
"startModified": "string",
"endModified": "string",
"fields": "string",
"customTypeStr": "string",
"status": "integer"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | templateType | string | 示例：模板类型 | 必填 | 
 | stockRegionCodes | string | 示例：库区编码 | 必填 | 
 | discountAmount | string | 示例：折扣金额（单位：分） | 必填 | 
 | templateId | string | 示例：模版Id | 必填 | 
 | isAssignSection | string | 示例：是否指定货位 | 必填 | 
 | province | string | 示例：省 | 必填 | 
 | gmModified | string | 示例：修改时间 | 必填 | 
 | busyId | string | 示例：业务id | 必填 | 
 | actualReturnNum | string | 示例：实际退货数 | 必填 | 
 | payment | string | 示例：实付金额（含运费）（单位：分） | 必填 | 
 | id | string | 示例：id | 必填 | 
 | allAllocate | string | 示例：采退单明细是否全部配货 0：否；1：是 | 必填 | 
 | outerCode | string | 示例：外部编号 | 必填 | 
 | receiver | string | 示例：收货人 | 必填 | 
 | mergeId | string | 示例：关联的合单id | 必填 | 
 | returnSkuTypeNum | string | 示例：采退单中sku的种类数 | 必填 | 
 | splitBySupplier | string | 示例：是否按照供应商进行拆分生成采退单，PDA生成采退单可能需要按供应商拆分生成 0：否；1：是 | 必填 | 
 | busyType | string | 示例：业务类型 | 必填 | 
 | createrName | string | 示例：制单人名称 | 必填 | 
 | waveStatus | string | 示例：波次状态 | 必填 | 
 | outSid | string | 示例：采购退货单号 | 必填 | 
 | totalAmount | string | 示例：商品总金额（单位：分） | 必填 | 
 | companyId | string | 示例：公司id | 必填 | 
 | othersFee | string | 示例：其他金额（单位：分） | 必填 | 
 | prSourceId | string | 示例：采退单外部单号 | 必填 | 
 | warehouseId | string | 示例：退货仓库Id | 必填 | 
 | phone | string | 示例：手机 | 必填 | 
 | purchaseOrderId | string | 示例：采购单Id | 必填 | 
 | isMerge | string | 示例：是否合单 | 必填 | 
 | district | string | 示例：区 | 必填 | 
 | warehouseType | string | 示例：不持久化数据库 | 必填 | 
 | enableStatus | string | 示例：有效标记，1：有效 2：隐藏（合单隐藏单） | 必填 | 
 | outTime | string | 示例：出库时间 | 必填 | 
 | status | string | 示例：状态（待审核，待出库，已完成，已作废） | 必填 | 
 | code | string | 示例：出库单号 | 必填 | 
 | supplierId | string | 示例：供应商Id | 必填 | 
 | pickerNames | string | 示例：波次拣选员 | 必填 | 
 | inWarehouseName | string | 示例：调入仓库名称 | 必填 | 
 | city | string | 示例：市 | 必填 | 
 | outLocation | string | 示例：出库位置,货位/入库暂存区/销退暂存区/次品暂存区/通用暂存区/拣选暂存区 1/2/3/4/5/6 | 必填 | 
 | freight | string | 示例：运费不落库 | 必填 | 
 | remark | string | 示例：备注 | 必填 | 
 | totalCount | string | 示例：总数 | 必填 | 
 | warehouseName | string | 示例：仓库名称 | 必填 | 
 | wssType | string | 示例：暂存区类型 | 必填 | 
 | inWarehouseId | string | 示例：调入仓库id | 必填 | 
 | actualTotalAmount | string | 示例：实际总额 | 必填 | 
 | statusName | string | 示例：状态名称 | 必填 | 
 | supplierName | string | 示例：供应商名称 | 必填 | 
 | address | string | 示例：地址 | 必填 | 
 | warehouseExternalCode | string | 示例：仓库外部编号 | 必填 | 
 | pickerIds | string | 示例：波次拣选员Ids | 必填 | 
 | postFee | string | 示例：运费（单位：分） | 必填 | 
 | gmCreate | string | 示例：创建时间 | 必填 | 
 | mergeType | string | 示例：合并类型，v1/v2，默认值为0 ,v2版本设置为1 | 必填 | 
 | waveId | string | 示例：波次号 | 必填 | 
 | dbNo | string | 示例：分库号 | 必填 | 
 | feeShareType | string | 示例：金额分摊方式 | 必填 | 
 | busyCode | string | 示例：业务单据号 | 必填 | 
 | returnNum | string | 示例：退货数量 | 必填 | 
 | templateName | string | 示例：模板名称 | 必填 | 
 | sortType | string | 示例：排序类型 0:无，1：按商品排序 | 必填 | 
 | wlbTemplateType | string | 示例：面单模版类型 | 必填 | 
 | logisticsType | string | 示例：物流方式 | 必填 | 
 | customType | string | 示例：出入库类型 | 必填 | 
 | logisticsCompanyName | string | 示例：快递公司 |  | 
 | outSid | string | 示例：运单号 |  | 
 | labels | array | 标签列表 |  | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "templateType": 1,
      "stockRegionCodes": "zhangsan",
      "discountAmount": 10000,
      "templateId": 12345,
      "isAssignSection": true,
      "province": "zhangsan",
      "gmModified": "zhangsan",
      "busyId": 12345,
      "actualReturnNum": 12345,
      "payment": 10000,
      "id": 12345,
      "allAllocate": 1,
      "outerCode": "zhangsan",
      "receiver": "zhangsan",
      "mergeId": 12345,
      "returnSkuTypeNum": 1,
      "splitBySupplier": 1,
      "busyType": "zhangsan",
      "createrName": "zhangsan",
      "waveStatus": 1,
      "outSid": "zhangsan",
      "totalAmount": 10000,
      "companyId": 12345,
      "othersFee": 10000,
      "prSourceId": "zhangsan",
      "warehouseId": 12345,
      "phone": "zhangsan",
      "purchaseOrderId": 12345,
      "isMerge": 1,
      "district": "zhangsan",
      "warehouseType": 1,
      "enableStatus": 1,
      "outTime": "zhangsan",
      "status": 1,
      "code": "zhangsan",
      "supplierId": 12345,
      "pickerNames": "zhangsan",
      "inWarehouseName": "zhangsan",
      "city": "zhangsan",
      "outLocation": 1,
      "freight": 10000,
      "remark": "zhangsan",
      "totalCount": 1,
      "warehouseName": "zhangsan",
      "wssType": "zhangsan",
      "inWarehouseId": 12345,
      "actualTotalAmount": 10000,
      "statusName": "zhangsan",
      "supplierName": "zhangsan",
      "address": "zhangsan",
      "warehouseExternalCode": "zhangsan",
      "pickerIds": "zhangsan",
      "postFee": 10000,
      "gmCreate": "zhangsan",
      "mergeType": 1,
      "waveId": 12345,
      "dbNo": 1,
      "feeShareType": 1,
      "busyCode": "zhangsan",
      "returnNum": 12345,
      "templateName": "zhangsan",
      "sortType": 1,
      "wlbTemplateType": "zhangsan",
      "logisticsType": 1,
      "customType" : "类型一",
      "logisticsCompanyName" : "圆通速递",
      "outSid" : "K_739472217532928",
      "labels": [
        {
          "name": "测试标签",
          "id": 8125
        }
      ]
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(other.out.order.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(other.out.order.query:1.0)的签名无效|签名参数错误|

---

## 查询其他出库单明细

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E5%85%B6%E4%BB%96%E5%87%BA%E5%BA%93%E5%8D%95%E6%98%8E%E7%BB%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/610-%E6%9F%A5%E8%AF%A2%E5%85%B6%E4%BB%96%E5%87%BA%E5%BA%93%E5%8D%95%E6%98%8E%E7%BB%86.md

# 查询其他出库单明细

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【其他出库单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | other.out.order.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | amount | string | 金额（单位：分） | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | code | string | 单据编号 | 必填 | 
 | unit | string | 单位 | 必填 | 
 | sysItemId | string | 系统商品Id | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | count | string | 数量 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | supplierCode | string | 供应商代码 | 必填 | 
 | price | string | 单价（单位：分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | actualNum | string | 实际出库数量 | 必填 | 
 | goodNum | number | 良品数量 | 必填 | 
 | badNum | number | 次品数量 | 必填 | 
 | batchNo | string | 批次 |  | 
 | productDate | Date | 效期 |  | 
 | expireDate | Date | 到期日期 |  |

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "zhangsan",
      "goodNum": 12345,
    
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(other.out.order.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(other.out.order.get:1.0)的签名无效|签名参数错误|

---

## 新增其他出库单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%96%B0%E5%A2%9E%E5%85%B6%E4%BB%96%E5%87%BA%E5%BA%93%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/630-%E6%96%B0%E5%A2%9E%E5%85%B6%E4%BB%96%E5%87%BA%E5%BA%93%E5%8D%95.md

# 新增其他出库单

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【其他出库单管理】----【新增出库单】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | other.out.order.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | customType | string | 示例：出入库类型 |  | 
 | prSourceId | string | 示例：外部单号(不允许重复) |  | 
 | outLocation | string | 示例：出库位置,货位/入库暂存区/销退暂存区/次品暂存区/通用暂存区, 1/2/3/4/5 可以参考：采退的位置选择，字段的选择是一样, 不填 默认货位 |  | 
 | remark | string | 示例：备注 |  | 
 | items | string | 示例：商品列表 json \[\{"outerId":"springday","quantity":1,"price":1,"remark":"备注"\}\],（price 单位：元） | 必填 | 
 | warehouseCode | string | 示例：出库仓库(编码) - 仓库外部编码 | 必填 | 
 | status | integer | 示例：状态 0 草稿， 1 待出库，2 已出库 |  | 
 | uniqueCodes | string | 唯一码，逗号拼接。当type为1时传入 |  | 
 | type | integer | 类型 0或不传 普通， 1 唯一码 |  | 
 | receiver | string | 收件人 |  | 
 | phone | string | 手机号 |  | 
 | address | string | 详细地址 |  | 
 | province | string | 省 |  | 
 | city | string | 市 |  | 
 | district | string | 区 |  |
 | labelIds | string | 标签id，多个用英文逗号隔开 |  | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码(最小粒度) | 必填 | 
 | quantity | long | 良品数量 | 必填 | 
 | badNum | long | 次品数量 |  | 
 | price | number | 单价（单位：元） | 必填 | 
 | productDate | Date | 效期 |  | 
 | batchNo | string | 批次 |  | 
 | expireDate | Date | 到期日期 |  |
 | remark | string | 备注 |  | 

 

### 请求示例
```json
{
"customType": "string",
"prSourceId": "string",
"outLocation": "integer",
"remark": "string",
"items": "array",
"warehouseCode": "string",
"status": "integer"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
````
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(other.out.order.add:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(other.out.order.add:1.0)的签名无效|签名参数错误|

---

## 作废其他出库单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E4%BD%9C%E5%BA%9F%E5%85%B6%E4%BB%96%E5%87%BA%E5%BA%93%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/640-%E4%BD%9C%E5%BA%9F%E5%85%B6%E4%BB%96%E5%87%BA%E5%BA%93%E5%8D%95.md

# 作废其他出库单

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【其他出库单管理】----【批量操作】----【批量作废】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.other.out.order.cancel | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 示例：单据id，支持多个，逗号拼接 | 必填 | 

 

### 请求示例
```json
{
"ids": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | successCodes | string \[ \] | 成功的code | 必填 | 

 

### 响应示例
```json
{
  "successCodes": [
    "first",
    "second",
    "third"
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.other.out.order.cancel:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.other.out.order.cancel:1.0)的签名无效|签名参数错误|

---

## 审核其他出库单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E5%AE%A1%E6%A0%B8%E5%85%B6%E4%BB%96%E5%87%BA%E5%BA%93%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/650-%E5%AE%A1%E6%A0%B8%E5%85%B6%E4%BB%96%E5%87%BA%E5%BA%93%E5%8D%95.md

# 审核其他出库单

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【其他出库单管理】----【批量操作】----【批量审核】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.other.out.order.audit | 必填 |

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 示例：单据id，支持多个，逗号拼接 | 必填 | 

 

### 请求示例
```json
{
"ids": "3092312,3092262"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | successCodes | string \[ \] | 成功的code | 必填 | 

 

### 响应示例
```json
{
  "successCodes": [
    "first",
    "second",
    "third"
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.other.in.order.cancel:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.other.in.order.cancel:1.0)的签名无效|签名参数错误|

---

## 查询调拨单明细列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E6%98%8E%E7%BB%86%E6%8E%A5%E5%8F%A3
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/70-%E6%9F%A5%E8%AF%A2%E8%B0%83%E6%8B%A8%E6%98%8E%E7%BB%86%E6%8E%A5%E5%8F%A3.md

# 查询调拨单明细列表

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|

     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | allocate.task.detail.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | String | 业务单据号 |  | 
 | startModified | String | 修改时间 开始 code为空时必填 | 必填 | 
 | endModified | String | 修改时间 结束 |  | 
 | labelName | String | 标签 |  | 

 

### 请求示例
示例一：

```` 
{
  "labelName":"拒收",
  "startModified":"2022-06-01 00:00:00",
  "pageSize":40
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | list | array | 数据列表 | 必填 | 
 | total | int | 示例：3 | 必填 | 
 | success | boolean | 示例：true | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemOuterId | string | 主商家编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productTime | date | 生产日期 | 必填 | 
 | expireDate | date | 到期日期 | 必填 | 
 | outNum | int | 申请调拨数 | 必填 | 
 | price | double | 成本价 | 必填 | 
 | actualOutNum | int | 实际调出数 | 必填 | 
 | inNum | Double | 实际调入数 | 必填 | 
 | actualOutTotalAmount | double | 实际调出金额 | 必填 | 
 | inTotalAmount | double | 实际调入金额 | 必填 | 
 | diffNum | int | 差异数 | 必填 | 
 | diffAmount | double | 差异金额 | 必填 | 
 | refundNum | int | 拒收数 | 必填 | 
 | remark | string | 明细备注 | 必填 | 
 

### 响应示例
```
{
    "total":1,
    "list":[{
        "itemOuterId": string,
        "outerId": "string",
        "batchNo": "string",
        "productTime": date,
        "expireDate": "date",
        ...
    }],
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询盘点单列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E7%9B%98%E7%82%B9%E5%8D%95%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/800-%E6%9F%A5%E8%AF%A2%E7%9B%98%E7%82%B9%E5%8D%95%E5%88%97%E8%A1%A8.md

# 查询盘点单列表

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【盘点单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | inventory.sheet.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | pageNo | integer | 示例：页码 取值范围:大于零的整数。默认值为1 |  | 
 | startModified | string | 示例：起始时间 格式:yyyy-MM-dd HH:mm:ss（修改时间） |  | 
 | pageSize | integer | 示例：每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | endModified | string | 示例：结束时间 格式:yyyy-MM-dd HH:mm:ss（修改时间） |  | 
 | status | string | 示例：盘点状态 | 1-草稿状态,2-盘点中,3-盘点完成,4-已作废; 支持查询多个状态逗号拼接 | 
 | code | string | 单据号 |  | 

 

### 请求示例
```json
{
"code": "string",
"pageNo": "integer",
"startModified": "string",
"pageSize": "integer",
"endModified": "string",
"fields": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 示例：编码 | 必填 | 
 | created | string | 示例：创建时间 | 必填 | 
 | createdId | string | 示例：制单人 | 必填 | 
 | remark | string | 示例：备注 | 必填 | 
 | type | string | 示例：类型,12:普通/即时盘点 | 必填 | 
 | warehouseName | string | 示例：仓库名称 | 必填 | 
 | submitName | string | 示例：提交人 | 必填 | 
 | companyId | string | 示例：公司 | 必填 | 
 | submitted | string | 示例：提交时间 | 必填 | 
 | pdaShowStock | string | 示例：pda显示库存(12/显示/不显示) | 必填 | 
 | warehouseId | string | 示例：仓库 | 必填 | 
 | audditId | string | 示例：审核人 | 必填 | 
 | audditName | string | 示例：审核人 | 必填 | 
 | modified | string | 示例：修改时间 | 必填 | 
 | notInventoryToZero | string | 示例：未盘商品操作:(12:盘0/不动) | 必填 | 
 | createdName | string | 示例：创建人名称 | 必填 | 
 | id | string | 示例：id | 必填 | 
 | auddited | string | 示例：审核时间 | 必填 | 
 | status | string | 示例：状态(1234 草稿/盘点中/盘点完成/作废) | 必填 | 
 | submitId | string | 示例：提交人 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "code": "zhangsan",
      "created": "@date",
      "createdId": 12345,
      "remark": "zhangsan",
      "type": 1,
      "warehouseName": "zhangsan",
      "submitName": "zhangsan",
      "companyId": 12345,
      "submitted": "@date",
      "pdaShowStock": 1,
      "warehouseId": 12345,
      "audditId": 12345,
      "audditName": "zhangsan",
      "modified": "@date",
      "notInventoryToZero": 1,
      "createdName": "zhangsan",
      "id": 12345,
      "auddited": "@date",
      "status": 1,
      "submitId": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(inventory.sheet.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(inventory.sheet.query:1.0)的签名无效|签名参数错误|

---

## 查询盘点单明细

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%9F%A5%E8%AF%A2%E7%9B%98%E7%82%B9%E5%8D%95%E6%98%8E%E7%BB%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/810-%E6%9F%A5%E8%AF%A2%E7%9B%98%E7%82%B9%E5%8D%95%E6%98%8E%E7%BB%86.md

# 查询盘点单明细

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【盘点单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | inventory.sheet.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 示例：盘点单号 | 必填 | 
 | pageNo | integer | 示例：页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 示例：每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | startModified | string | 示例：起始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endModified | string | 示例：结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 

 

### 请求示例
```json
{
"code": "string",
"pageNo": "integer",
"startModified": "string",
"pageSize": "integer",
"endModified": "string",
"fields": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sheetCode | string | 示例：盘点单号 | 必填 | 
 | sysItemId | string | 示例：商品信息 | 必填 | 
 | goodsSectionId | string | 示例：货位id | 必填 | 
 | createdId | string | 示例：制单人 | 必填 | 
 | title | string | 示例：名称 | 必填 | 
 | afterNum | string | 示例：盘点后数量 | 必填 | 
 | matchStatus | string | 示例：是否匹配(针对于盘点过程中需要绑定的商品) 0/1/2:未匹配/匹配/临时 | 必填 | 
 | stockRegionType | string | 示例：库区类型(1/2/3:拣货/备货/次品) | 必填 | 
 | taskCode | string | 示例：盘点任务单号 | 必填 | 
 | differentStatus | string | 示例：差异状态(123:未盘/有/无差异/异常(针对计算的时候,实时数据对不上的情况)) | 必填 | 
 | inventoryName | string | 示例：盘点人 | 必填 | 
 | modified | string | 示例：修改时间 | 必填 | 
 | createdName | string | 示例：创建人 | 必填 | 
 | inventoryTime | string | 示例：盘点时间 | 必填 | 
 | id | string | 示例：id | 必填 | 
 | stockRegionId | string | 示例：库区id | 必填 | 
 | goodsSectionCode | string | 示例：货位编码/暂存区编码 | 必填 | 
 | beforeNum | string | 示例：盘点前数量 | 必填 | 
 | containerType | string | 示例：货位类型(0/1:货位/暂存区) | 必填 | 
 | created | string | 示例：创建时间 | 必填 | 
 | inventoryCount | string | 示例：盘点次数 | 必填 | 
 | propertiesName | string | 示例：规格 | 必填 | 
 | sysSkuId | string | 示例：规格 id | 必填 | 
 | assoGoodsSectionId | string | 示例：货位库存id | 必填 | 
 | companyId | string | 示例：公司 | 必填 | 
 | inventoryId | string | 示例：盘点人 | 必填 | 
 | outerId | string | 示例：主商家编码/sku商家编码,优先sku商家编码 | 必填 | 
 | differentAmount | string | 示例：差异金额 | 必填 | 
 | qualityType | string | 示例：质量(0/1:次/良) | 必填 | 
 | inventoryAgain | string | 示例：是否有复盘任务 | 必填 | 
 | enableStatus | string | 示例：状态(0/1:作废/正常) | 必填 | 
 | differentNum | string | 示例：盘盈盘亏 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "sheetCode": "zhangsan",
      "sysItemId": 12345,
      "goodsSectionId": 12345,
      "createdId": 12345,
      "title": "zhangsan",
      "afterNum": 12345,
      "matchStatus": 1,
      "stockRegionType": 1,
      "taskCode": "zhangsan",
      "differentStatus": 1,
      "inventoryName": "zhangsan",
      "modified": "@date",
      "createdName": "zhangsan",
      "inventoryTime": "@date",
      "id": 12345,
      "stockRegionId": 12345,
      "goodsSectionCode": "zhangsan",
      "beforeNum": 12345,
      "containerType": 1,
      "created": "@date",
      "inventoryCount": 1,
      "propertiesName": "zhangsan",
      "sysSkuId": 12345,
      "assoGoodsSectionId": 12345,
      "companyId": 12345,
      "inventoryId": 12345,
      "outerId": "zhangsan",
      "differentAmount": 10000,
      "qualityType": 1,
      "inventoryAgain": true,
      "enableStatus": 1,
      "differentNum": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(inventory.sheet.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(inventory.sheet.get:1.0)的签名无效|签名参数错误|

---

## 盘点单库存盘点

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E7%9B%98%E7%82%B9%E5%8D%95%E5%BA%93%E5%AD%98%E7%9B%98%E7%82%B9
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/820-%E7%9B%98%E7%82%B9%E5%8D%95%E5%BA%93%E5%AD%98%E7%9B%98%E7%82%B9.md

# 盘点单库存盘点

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【盘点单管理】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | inventory.sheet.batch.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | details | string |盘点商品清单 | 必填 | 
 | warehouseId | long | 仓库id | 必填 | 

# subTable: details
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 最小粒度商家编码 | 必填 | 
 | goodsSectionCode | string | 货位编码 | 必填 | 
 | changeNum | string | 盘点数量 | 必填 | 
 | sysItemId | string | 商品ID |  | 
 | sysSkuId | string | 商品SKUID |  | 
 | batchNo | string | 商品批次 |  | 
 | productTime | string | 商品生产日期 |  | 
 | expireDate | string | 商品到期日期 |  | 

 

### 请求示例
示例一：
```
{
    "details": "[{\"outerId\":\"123132\",\"goodsSectionCode\":\"\",\"changeNum\":\"15\"}]",
    "warehouseId": "123123"
}
```
每个都是必填！
### 响应示例
```
{
    true;
}
```
### 异常示例
```
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 新建/修改下架单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E4%BB%93%E5%82%A8/%E6%96%B0%E5%BB%BA%E4%BF%AE%E6%94%B9%E4%B8%8B%E6%9E%B6%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/40-%E4%BB%93%E5%82%A8/830-%E6%96%B0%E5%BB%BA%E4%BF%AE%E6%94%B9%E4%B8%8B%E6%9E%B6%E5%8D%95.md

# 新建/修改下架单

**请求方法:** POST

### 系统相关界面
"界面路径：【仓储】----【下架单管理】----【新增下架单/编辑】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.wms.unshelve.order.save | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 下架单id (修改时传入) |  | 
 | targetLocation | int | 下架位置 （默认通用暂存区）货位/入库暂存区/销退暂存区/次品暂存区/通用暂存区/拣选暂存区 1/2/3/4/5/6 |  | 
 | items | string | 下架的商品列表 json字符串  \[\{"outerId":"233357","quantity":1,"goodsSectionCode":"U-1-10-3"\}\] | 必填 | 
 | warehouseCode | string | 仓库外部编码 | 必填 | 
 | sourceId | string | 外部单号（不允许重复）,新建时传入 |  | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码(最小粒度) | 必填 | 
 | quantity | long | 数量 | 必填 | 
 | goodsSectionCode | string | 货位编码 | 必填 | 
 | batchNo | string | 批次 |  | 
 | productTime | Date | 效期 |  | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 下架单id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.wms.unshelve.order.save:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.wms.unshelve.order.save:1.0)的签名无效|签名参数错误|

---

## 新建/修改供应商

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%96%B0%E5%BB%BA%E4%BF%AE%E6%94%B9%E4%BE%9B%E5%BA%94%E5%95%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/0-%E6%96%B0%E5%BB%BA%E4%BF%AE%E6%94%B9%E4%BE%9B%E5%BA%94%E5%95%86.md

# 新建/修改供应商

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【供应商管理】----【新增/修改】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | supplier.addorupdate | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 供应商编码 | 必填 | 
 | name | string | 供应商名称 | 必填 | 
 | remark | string | 备注 |  | 
 | invoiceName | string | 发票抬头 |  | 
 | categoryName | string | 供应商分类 |  | 
 | accountBank | string | 开户行 |  | 
 | province | string | 省份 |  | 
 | city | string | 城市 |  | 
 | district | string | 区县 |  | 
 | fax | string | 传真 |  | 
 | email | string | 邮箱 |  | 
 | qq | string | QQ |  | 
 | zip | string | 邮编 |  | 
 | bankNumber | string | 银行账号 |  | 
 | address | string | 地址 |  | 
 | alipay | string | 支付宝 |  | 
 | contactName | string | 联系人名称 |  | 
 | webAddress | string | 网址 |  | 
 | billType | string | 账期(现结、半月结、月结和其他，默认现结) |  | 
 | mobile | string | 手机号码 |  | 
 | wechat | string | 微信 |  | 
 | tax | string | 税号 |  | 
 | planReceiveDay | string | 预计到货时长 默认0 |  | 
 | companyId | string | 公司编号 |  | 
 | phone | string | 固话号码 |  | 
 | taxId | string | 供应商税务ID |  | 
 | memoni | string | 助记符 |  | 
 | categoryId | string | 供应商分类ID |  | 
 | status | integer | 合作状态，1表示合作中，2表示停止合作 |  | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 供应商id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(supplier.addorupdate:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(supplier.addorupdate:1.0)的签名无效|签名参数错误|

---

## 新增采购单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%96%B0%E5%A2%9E%E9%87%87%E8%B4%AD%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/100-%E6%96%B0%E5%A2%9E%E9%87%87%E8%B4%AD%E5%8D%95.md

# 新增采购单

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采购单管理】----【新增采购单】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerCode | string | 外部采购订单号(不允许重复) |  | 
 | remark | string | 备注 |  | 
 | supplierCode | string | 供应商(编码) - 必填 | 必填 | 
 | deliveryDate | string | 交货日期 |  | 
 | items | string | 采购的商品列表 json \[\{"outerId":"springday","quantity":1,"price":1,"remark":"备注信息","deliveryDate":"明细交货日期"\}\] | 必填 |
 | warehouseCode | string | 仓库外部编码 | 必填 | 
 | status | string | 状态 WAIT_VERIFY （草稿）、VERIFYING(提交审核)、VERIFY（审核） |  |
 
# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | springday | 必填 | 
 | quantity | number | 采购数量 | 必填 | 
 | price | number | 采购单价（单位：分） | 必填 | 
 | remark | string | 备注信息 | 必填 |
 | deliveryDate | string | 明细交货日期 | 非必填 |

 

### 请求示例
```json
{
"outerCode": "string",
"remark": "string",
"supplierCode": "string",
"deliveryDate": "string",
"items": " [{"outerId":"springday","quantity":1,"price":1,"remark":"备注信息","deliveryDate":"1751472000000"}]",
"warehouseCode": "string",
"status": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：采购单id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.add:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.add:1.0)的签名无效|签名参数错误|

---

## 采购快速收货（即入即出）

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%87%87%E8%B4%AD%E5%BF%AB%E9%80%9F%E6%94%B6%E8%B4%A7%E5%8D%B3%E5%85%A5%E5%8D%B3%E5%87%BA
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1000-%E9%87%87%E8%B4%AD%E5%BF%AB%E9%80%9F%E6%94%B6%E8%B4%A7%E5%8D%B3%E5%85%A5%E5%8D%B3%E5%87%BA.md

# 采购快速收货（即入即出）

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采购快速收货】----【收货完成】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | warehouse.entry.fast.receive | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysOuterId | string | 商家编码 | 必填 | 
 | warehouseCode | string | 仓库外部编码 | 必填 | 
 | supplierCode | string | 供应商编码 |  | 
 | batchNo | string | 批次 | 可选 | 
 | productDate | Date | 生产日期，格式“2024-04-11 00:00:00” | 可选 | 
 | expireDate | Date | 到期日期，格式“2024-04-15 00:00:00” | 可选 | 
 

### 请求示例
```json
 {
"sysOuterId": "string",
"warehouseCode": "string",
"supplierCode": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 成功 | 必填 | 
 | trace_id | string | trace_id | 必填 | 
 | shipStatus | Integer | 是否可发 0不可发 1可发 | 必填 | 
 | id | Integer | 收货单id | 必填 | 

 

### 响应示例
```
{
   "id": 1,
    "shipStatus": 1
    "success": true,
    "trace_id": 11
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(warehouse.entry.fast.receive:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(warehouse.entry.fast.receive:1.0)的签名无效|签名参数错误|

---

## 上架单上架

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E4%B8%8A%E6%9E%B6%E5%8D%95%E4%B8%8A%E6%9E%B6
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1050-%E4%B8%8A%E6%9E%B6%E5%8D%95%E4%B8%8A%E6%9E%B6.md

# 上架单上架

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【上架单管理】----【上架】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.purchase.shelf.save | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：上架单id | 必填 | 
 | items | string | 商品列表 json \[\{"outerId":"springday","quantity":1,"quality":true,"goodsSectionCode":"A-1-1"\}\] | 必填 | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码 | 必填 | 
 | quantity | long | 数量 | 必填 | 
 | quality | boolen | 质量：true 良品，false 次品 | 必填 | 
 | goodsSectionCode | string | 货位 | 必填 | 
 | batchNo | string | 批次 |  | 
 | productDate | Date | 效期 |  | 

 

### 请求示例
```json
{
"id": "long",
"items": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.purchase.shelf.save:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.purchase.shelf.save:1.0)的签名无效|签名参数错误|

---

## 查询上架单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%9F%A5%E8%AF%A2%E4%B8%8A%E6%9E%B6%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1100-%E6%9F%A5%E8%AF%A2%E4%B8%8A%E6%9E%B6%E5%8D%95.md

# 查询上架单

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【上架单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.purchase.shelf.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
  | timeType | integer | 查询时间类型 1修改时间,2创建时间,3上架时间（默认为1） |  | 
 | startModified | string | 修改起始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endModified | string | 修改结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | weCode | string | 收货单编号(支持单号/外部单号) |  | 
 | status | integer | 状态 0 待上架 1 已完成 2已作废 |  | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 

 

### 请求示例
```json
{
"startModified": "string",
"endModified": "string",
"weCode": "string",
"fields": "string",
"status": "integer"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | waitQuantity | string | 示例：待上架数 | 必填 | 
 |  | string | 示例： |  | 
 | containerNo | string | 示例：容器号 | 必填 | 
 | code | string | 示例：编码 | 必填 | 
 | supplierId | string | 示例：供应商id | 必填 | 
 | weReceived | string | 示例：收货单收货时间 | 必填 | 
 | num | string | 示例：总上架数量 | 必填 | 
 | creatorId | string | 示例：创建人id | 必填 | 
 | outWarehouseName | string | 示例：调出仓库名称 | 必填 | 
 | remark | string | 示例：备注 | 必填 | 
 | type | string | 示例：上架类型 0:按单上架 1:快速上架 5:其他上架 | 必填 | 
 | shelveTime | string | 示例：上架时间 | 必填 | 
 | warehouseName | string | 示例：仓库名称 | 必填 | 
 | outWarehouseId | string | 示例：调出仓库id | 必填 | 
 | busyId | string | 示例：业务id | 必填 | 
 | weCreated | string | 示例：收货单创建时间 | 必填 | 
 | id | string | 示例：id | 必填 | 
 | weCode | string | 示例：收货单编码 | 必填 | 
 | supplierName | string | 示例：供应商name | 必填 | 
 | creator | string | 示例：创建人姓名 | 必填 | 
 | busyTypeDesc | string | 示例：业务类型desc | 必填 | 
 | shelverId | string | 示例：上架人 | 必填 | 
 | created | string | 示例：创建时间 | 必填 | 
 | shelverName | string | 示例：上架人名称 | 必填 | 
 | busyType | string | 示例：业务类型 | 必填 | 
 | receiveQuantity | string | 示例：收货数 | 必填 | 
 | companyId | string | 示例：公司id | 必填 | 
 | weShelveQuantity | string | 示例：收货单上架数 | 必填 | 
 | busyCode | string | 示例：业务单据号 | 必填 | 
 | warehouseId | string | 示例：仓库id | 必填 | 
 | purchaseOrderId | string | 示例：采购单 | 必填 | 
 | weId | string | 示例：收货单id | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "waitQuantity": 1,
      "containerNo": "zhangsan",
      "code": "zhangsan",
      "supplierId": "zhangsan",
      "weReceived": "zhangsan",
      "num": 1,
      "creatorId": 12345,
      "outWarehouseName": "zhangsan",
      "remark": "zhangsan",
      "type": 1,
      "shelveTime": "zhangsan",
      "warehouseName": "zhangsan",
      "outWarehouseId": 12345,
      "busyId": 12345,
      "weCreated": "zhangsan",
      "id": 12345,
      "weCode": "zhangsan",
      "supplierName": "zhangsan",
      "creator": "zhangsan",
      "busyTypeDesc": "zhangsan",
      "shelverId": 12345,
      "created": "zhangsan",
      "shelverName": "zhangsan",
      "busyType": "zhangsan",
      "receiveQuantity": 12345,
      "companyId": 12345,
      "weShelveQuantity": 12345,
      "busyCode": "zhangsan",
      "warehouseId": 12345,
      "purchaseOrderId": 12345,
      "weId": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.purchase.shelf.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.purchase.shelf.query:1.0)的签名无效|签名参数错误|

---

## 查询上架单详情

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%9F%A5%E8%AF%A2%E4%B8%8A%E6%9E%B6%E5%8D%95%E8%AF%A6%E6%83%85
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1150-%E6%9F%A5%E8%AF%A2%E4%B8%8A%E6%9E%B6%E5%8D%95%E8%AF%A6%E6%83%85.md

# 查询上架单详情

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【上架单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.purchase.shelf.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 上架单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | amount | string | 金额（单位是分） | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | code | string | 单据编号 | 必填 | 
 | sysItemId | string | 系统商品Id | 必填 | 
 | count | string | 数量 | 必填 | 
 | supplierCode | string | 供应商代码 | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | price | string | 单价（单位是分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productTime | Date | 效期 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "batchNo": "zhangsan",
      "goodsSectionCode": "zhangsan",
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "zhangsan",
      "goodNum": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.purchase.shelf.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.purchase.shelf.get:1.0)的签名无效|签名参数错误|

---

## 计算已售采购建议

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E8%AE%A1%E7%AE%97%E5%B7%B2%E5%94%AE%E9%87%87%E8%B4%AD%E5%BB%BA%E8%AE%AE
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1200-%E8%AE%A1%E7%AE%97%E5%B7%B2%E5%94%AE%E9%87%87%E8%B4%AD%E5%BB%BA%E8%AE%AE.md

# 计算已售采购建议

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【已售采购建议】----【查询】"
### 接口备注
该接口为异步接口，调用后会立刻返回，然后轮询调用【进度获取】接口(建议1秒一次)，当接口返回完成状态后，最后调用【查询已售采购建议】接口获取最终数据
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | sale.purchase.strategy.calculate | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | warehouseCode | string | 仓库外部编码 | 必填 | 
 | ignoreTradeOut | int | 过滤出库单  0不过滤，1过滤 |  | 
 | ignoreRefund | int | 过滤待发货退款中订单，0不过滤，1过滤 |  | 

 

### 请求示例
```json
{
"warehouseCode": "A"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | traceId | string | 示例：3770578279318642462 | 必填 | 
 | success | boolean | 示例：true | 必填 | 

 

### 响应示例
```json
{
    "traceId": "3770578279318642462",
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(sale.purchase.strategy.calculate:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(sale.purchase.strategy.calculate:1.0)的签名无效|签名参数错误|

---

## 进度获取

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E8%BF%9B%E5%BA%A6%E8%8E%B7%E5%8F%96
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1250-%E8%BF%9B%E5%BA%A6%E8%8E%B7%E5%8F%96.md

# 进度获取

**请求方法:** POST

### 系统相关界面
"界面路径：无"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.progress.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | progressType | int | 进度类型，4：已售采购建议 |  | 

 

### 请求示例
```json
{
"progressType": 4
}
```

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | executResult | string | 执行结果(已售采购建议的queryKey从这里获取) | 必填 | 
 | progress | int | 进度 0：未开始 1：进行中 2：完成 | 必填 | 

 

### 响应示例
```
{
    "traceId": "3770578351028396742",
    "executResult": "0202407241426978",
    "success": true,
    "progress": 2
}
```
### 异常示例
```
{
    "code": "25",
    "msg": "服务方法(purchase.progress.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.progress.query:1.0)的签名无效|签名参数错误|

---

## 查询已售采购建议

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%9F%A5%E8%AF%A2%E5%B7%B2%E5%94%AE%E9%87%87%E8%B4%AD%E5%BB%BA%E8%AE%AE
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1300-%E6%9F%A5%E8%AF%A2%E5%B7%B2%E5%94%AE%E9%87%87%E8%B4%AD%E5%BB%BA%E8%AE%AE.md

# 查询已售采购建议

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【已售采购建议】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | sale.purchase.strategy.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | queryKey | string | 查询key，从进度purchase.progress.query中获取 |  | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：500；默认值：40 |  | 

 

### 请求示例
```json
{
"queryKey": "0202407241426978",
"pageNo": 1,
"pageSize": 50
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | purchaseStrategyList | array | 数据列表 | 必填 | 
 | success | boolean | 成功失败 | 必填 | 

# subTable: purchaseStrategyList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | picPath | string | 图片 | 必填 | 
 | stockoutNum | int | 缺货数 | 必填 | 
 | itemOuterId | string | 主商家编码 | 必填 | 
 | outerId | string | 规格商家编码 | 必填 | 
 | purchaseStock | int | 建议采购数 | 必填 | 
 | itemCatName | string | 类目 | 必填 | 
 | propertiesName | string | 规格名称 | 必填 | 

 

### 响应示例
```json
{
    "traceId": "3770578842060549696",
    "purchaseStrategyList": [
        {
            "picPath": "https://t16img.yangkeduo.com/garner-api/cf67b68e5a084f72123248719706082a.jpeg",
            "itemPicPath": "https://t16img.yangkeduo.com/garner-api/cf67b68e5a084f72123248719706082a.jpeg",
            "stockoutNum": 1,
            "itemOuterId": "119119",
            "outerId": "119119",
            "purchaseStock": 1
        }
    ],
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(sale.purchase.strategy.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(sale.purchase.strategy.query:1.0)的签名无效|签名参数错误|

---

## 归档采购单查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E5%BD%92%E6%A1%A3%E9%87%87%E8%B4%AD%E5%8D%95%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1350-%E5%BD%92%E6%A1%A3%E9%87%87%E8%B4%AD%E5%8D%95%E6%9F%A5%E8%AF%A2.md

# 归档采购单查询

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【历史采购单】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.order.history.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | timeType | integer | 查询时间类型 1修改时间,2创建时间（默认为1） |  |
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss | 必填 | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss，起始时间和结束时间相差90天内 | 必填 | 
 | status | string | FINISHED 已完成, GOODS_CLOSED 已关闭 |  | 
 | id | integer | 采购单id |  | 
 | code | string | 采购单号 |  | 

 

### 请求示例
```json
{
"pageNo": "integer",
"startModified": "string",
"pageSize": "integer",
"endModified": "string",
"status": "string",
"id": "integer",
"code":"String"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | templateType | string | 模板类型 | 必填 | 
 | sourceKey | long | 对接平台 appKey | 必填 | 
 | sourceId | string | 对接平台外部单号outerCode | 必填 | 
 | shortId | long | 采购短号 | 必填 | 
 | advanceCharge | string | 预付款 | 必填 | 
 | cancelAmount | double | 作废金额（单位：分） | 必填 | 
 | pickWay | int | 拿货方式 0 为正常拿货 1 为小程序 命名仿照 erp-caigou queryWay | 必填 | 
 | receiveWarehouseId | string | 收货仓库编号,初期设计时，仓库编号可不填，但是仓库名称需要填写 | 必填 | 
 | discountAmount | double | 优惠金额（单位：分） | 必填 | 
 | templateId | string | 模板id | 必填 | 
 | financeAuditorDate | string | 财务审核日期 | 必填 | 
 | modified | string | 修改日期 | 必填 | 
 | id | long | 采购订单id | 必填 | 
 | createrId | string | 制单人编号 | 必填 | 
 | arriveRegisteredTime | string | 登记时间 | 必填 | 
 | arriveRegisteredBy | string | 登记人 | 必填 | 
 | itemNumType | string | 单多件标识 | 必填 | 
 | created | string | 制单日期 | 必填 | 
 | autoRemark | string | 是否自动填充备注 | 必填 | 
 | createrName | string | 制单人名称 | 必填 | 
 | outSid | string | 出库单号 | 必填 | 
 | totalAmount | double | 总金额，不包括优惠的金额（单位：分） | 必填 | 
 | companyId | long | 公司id | 必填 | 
 | otherAmount | string | 其他费用 | 必填 | 
 | auditorId | string | 审核人id | 必填 | 
 | financeAuditorId | long | 财务审核人编号 | 必填 | 
 | auditorRemark | string | 审核备注 | 必填 | 
 | receiveWarehouseName | string | 收货仓库名称 | 必填 | 
 | warehouseType | string | 仓库类型 0自有,1第三方,2门店仓库 | 必填 | 
 | enableStatus | int | 启用禁用 | 必填 | 
 | auditorDate | string | 审核日期 | 必填 | 
 | status | string | 采购状态 单据状态 WAIT_VERIFY 草稿,VERIFYING 待审核,GOODS_NOT_ARRIVED 未到货,GOODS_PART_ARRIVED 部分到货,FINISHED 已完成, GOODS_CLOSED 已关闭 | 必填 | 
 | getGoodsStatus | string | 拿货状态 STATUS_GOODS_NOT_GET 未拿货，STATUS_GOODS_PART_GET 部分拿货，STATUS_GOODS_FINISHED 已完成，GOODS_CLOSED  已关闭 | 必填 | 
 | sourceOrderId | string | 对接平台外部订单号 | 必填 | 
 | totalDetailAmount | string | 明细折前金额（单位：分） | 必填 | 
 | code | string | 单据号码 | 必填 | 
 | supplierId | string | 供应商编号 | 必填 | 
 | flag | string | 旗帜 | 必填 | 
 | freight | string | 运费（单位：分） | 必填 | 
 | actualReceiveNum | string | 示例：实收数量总数 | 必填 | 
 | remark | string | 示例：备注 | 必填 | 
 | supplierCode | string | 示例：供应商编码 | 必填 | 
 | purchaseType | string | 示例：采购类型 caigou：采购单 shouhuo：收货单 | 必填 | 
 | actualTotalAmount | string | 实际总额/采购总额（单位：分） | 必填 | 
 | financeAuditorRemark | string | 财务审核备注 | 必填 | 
 | expressCompany | string | 快递公司 | 必填 | 
 | printBy | string | 打印人 | 必填 | 
 | deliveryDate | string | 交货日期 | 必填 | 
 | auditorName | string | 审核人名称 | 必填 | 
 | purchaseReturnNum | string | 采退总数 | 必填 | 
 | supplierName | string | 供应商名称 | 必填 | 
 | isFinishProduct | string | 是否是成品采购 | 必填 | 
 | quantity | string | 采购数量 | 必填 | 
 | financeAuditorName | string | 财务审核人名称 | 必填 | 
 | warehouseExternalCode | string | 仓库外部编号 | 必填 | 
 | arrivedQuantity | int | 已到数量 | 必填 | 
 | billType | string | 账期 | 必填 | 
 | receivedAmount | double | 已到金额/已到总额（单位：分） | 必填 | 
 | cancelQuantity | string | 作废数 | 必填 | 
 | receiveQuantity | int | 已收数量 | 必填 | 
 | templateName | string | 模板名称 | 必填 | 
 | contractRemark | string | 合同备注 | 必填 | 
 | purchaseReturnWeNum | long | 采退收货总数 | 必填 | 
 | finishDate | string | 完成日期 | 必填 | 
 | suitStatus | string | 套件状态 0：无套件 1：有套件 2：有组合装 | 必填 | 
 | logisticsType | string | 物流方式 1 快递，2 物流，3 自提，4 其他 | 必填 | 
 | printTime | string | 打印时间 | 必填 | 
 | weFinishStatus | string | 是否存在已完成收货单 | 必填 | 
 | financeId | Long | 财务管理账户id | 必填 | 
 | financeName | String | 财务管理账户名称 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "templateType": 1,
      "sourceKey": 1,
      "sourceId": "zhangsan",
      "shortId": "zhangsan",
      "advanceCharge": 10000,
      "cancelAmount": 10000,
      "pickWay": 1,
      "receiveWarehouseId": 12345,
      "discountAmount": 10000,
      "receiveStatus": "zhangsan",
      "templateId": 12345,
      "supplierSort": 1,
      "financeAuditorDate": "@date",
      "financeId":123,
      "financeName":"财务管理账户名称",
      "modified": "@date",
      "id": 12345,
      "createrId": 12345,
      "arriveRegisteredTime": "@date",
      "arriveRegisteredBy": 12345,
      "itemNumType": 1,
      "deliveryDateType": 1,
      "created": "@date",
      "autoRemark": true,
      "createrName": "zhangsan",
      "outSid": "zhangsan",
      "totalAmount": 10000,
      "companyId": 12345,
      "otherAmount": 10000,
      "auditorId": 12345,
      "financeAuditorId": 12345,
      "oldStatus": "zhangsan",
      "auditorRemark": "zhangsan",
      "receiveWarehouseName": "zhangsan",
      "warehouseType": 1,
      "enableStatus": 1,
      "auditorDate": "@date",
      "status": "zhangsan",
      "getGoodsStatus": "zhangsan",
      "sourceOrderId": "zhangsan",
      "totalDetailAmount": 10000,
      "code": "zhangsan",
      "supplierId": 12345,
      "flag": 1,
      "freight": 10000,
      "actualReceiveNum": 12345,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "purchaseType": "zhangsan",
      "actualTotalAmount": 10000,
      "financeAuditorRemark": "zhangsan",
      "expressCompany": "zhangsan",
      "printBy": 12345,
      "deliveryDate": "@date",
      "auditorName": "zhangsan",
      "purchaseReturnNum": 12345,
      "supplierName": "zhangsan",
      "isFinishProduct": true,
      "quantity": 12345,
      "financeAuditorName": "zhangsan",
      "warehouseExternalCode": "zhangsan",
      "arrivedQuantity": 12345,
      "billType": "zhangsan",
      "receivedAmount": 10000,
      "cancelQuantity": 12345,
      "receiveQuantity": 12345,
      "receiveQuantityInc": 12345,
      "templateName": "zhangsan",
      "contractRemark": "zhangsan",
      "skuSizeSort": 1,
      "purchaseReturnWeNum": 12345,
      "finishDate": "@date",
      "suitStatus": 1,
      "logisticsType": 1,
      "printTime": "@date",
      "weFinishStatus": 1
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.order.history.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.order.history.query:1.0)的签名无效|签名参数错误|

---

## 归档采购单详情

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E5%BD%92%E6%A1%A3%E9%87%87%E8%B4%AD%E5%8D%95%E8%AF%A6%E6%83%85
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1400-%E5%BD%92%E6%A1%A3%E9%87%87%E8%B4%AD%E5%8D%95%E8%AF%A6%E6%83%85.md

# 归档采购单详情

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【历史采购单】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.order.history.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：采购单id | 必填 | 
 

### 请求示例
```json
{
"id": "long"
}
```

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | amount | BigDecimal | 不带修正的采购金额（单位：分），采购金额=数量*单价 | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | code | string | 单据编号 | 必填 | 
 | purchaseOrderId | long | 采购单ID | 必填 | 
 | sysItemId | string | 系统商品Id | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | ptSkuId | string | 平台sku ID | 必填 | 
 | count | string | 数量 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | caigouUrl | string | 采购外链 | 必填 | 
 | supplierCode | string | 供应商代码 | 必填 | 
 | price | string | 单价（单位：分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | deliveryDate | string | 交货日期 | 必填 | 
 | ptOrderId | string | 平台订单号 | 必填 | 
 | ptShopId | string | 平台店铺ID | 必填 | 
 | outSid | string | 快递单号 | 必填 | 
 | templateName | string | 物流公司名称 | 必填 | 
 | totalFee | BigDecimal | 带修正的采购金额（单位：分） | 必填 | 
 | amendAmount | BigDecimal | 修正金额totalFee-amount计算出来的（单位：分） | 必填 | 

 

### 响应示例
```
{
    "traceId": "1879873565469747141",
    "list": [
        {
            "code": "CG3941403339276288",
            "ptSkuId": "MN-milk",
            "sysItemId": 466267301308928,
            "remark": "备注信息",
            "price": 100.000,
            "itemOuterId": "MN-milk",
            "ptOrderId": "1122334455",
            "deliveryDate": 1662541137000,
            "caigouUrl": "采购链接",
            "amount": 100.000,
            "quantity": 1,
            "count": 1,
            "outSid": "88889999",
            "sysSkuId": 0,
            "ptShopId": 12345,
            "purchaseOrderId": 3941403339276289,
            "outerId": "MN-milk"
        }
    ],
    "total": 1,
    "success": true
}
```
### 异常示例
```
{
    "code": "25",
    "msg": "服务方法(purchase.order.history.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.order.history.get:1.0)的签名无效|签名参数错误|

---

## 归档收货单查询列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E5%BD%92%E6%A1%A3%E6%94%B6%E8%B4%A7%E5%8D%95%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1450-%E5%BD%92%E6%A1%A3%E6%94%B6%E8%B4%A7%E5%8D%95%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8.md

# 归档收货单查询列表

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【历史收货单】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | warehouse.entry.history.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss | 必填 | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss，起始时间和结束时间间隔不超过90天 | 必填 | 
 | timeType | integer | 查询时间类型 1修改时间,2创建时间（默认为1） | |
 | status | string | 单据状态  FINISHED :已完成  SHELVED：上架完成  CLOSED :已关闭 |  | 
 | code | string | 收货单号 |  | 
 | financeStatus | string | 财审状态  WAIT_FINANCE：待财审，FINANCED：已财审 |  | 
 

### 请求示例
```json
{
"page": "integer",
"pageSize":"integer",
"startModified":"string",
"endModified":"string",
"status":"string",
"code":"string",
"financeStatus":"string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | shortId | string | 短号 | 必填 |
 | finisherName | string | 完成人 | 必填 | 
 | busyOutId | string | 业务出库单id | 必填 | 
 | cancelAmount | string | 作废金额（单位：分） | 必填 | 
 | outWarehouseName | string | 出库仓库名称 | 必填 | 
 | discountAmount | string | 折扣金额（单位：分） | 必填 | 
 | shelveTime | string | 上架时间 | 必填 | 
 | outWarehouseId | string | 出库仓库id | 必填 | 
 | purchaseOrderCode | string | 采购单编号 | 必填 | 
 | busyId | string | 业务id | 必填 | 
 | modified | string | 修改时间 | 必填 | 
 | id | string | 收货单id | 必填 | 
 | outerCode | string | 外部编号 | 必填 | 
 | created | string | 创建时间 | 必填 | 
 | busyType | string | 业务类型，PURCHASE：采购收货；NO_PURCHASE：无单收货；PURCHASE_RETURN：采退收货；NO_BILL_ITEM_PURCHASE：错收收货 | 必填 | 
 | finished | string | 完成时间 完成人姓名 | 必填 | 
 | createrName | string | 制单人名称 | 必填 | 
 | pdaWeTaskStatus | string | pda收货状态，0：未进行pda收货 1：pda收货中 | 必填 | 
 | othersFee | string | 其他金额（单位：分） | 必填 | 
 | shelvedQuantity | string | 上架数 | 必填 | 
 | warehouseId | string | 仓库id | 必填 | 
 | purchaseOrderId | string | 采购单id | 必填 | 
 | purchaseQuantity | string | 采购总数 | 必填 | 
 | items | string | 商品种类数量 | 必填 | 
 | status | string | 单据状态 NOT_FINISH :未完成 STATUS_UNIQUE_CODE_RECEIVING:唯一码收货中  FINISHED :已完成 SHELVED：上架完成  CLOSED :已关闭 | 必填 | 
 | containerNo | string | 容器号 | 必填 | 
 | code | string | 收货单编号 | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | badShelveFee | string | 次品上架金额 | 必填 | 
 | freight | string | 运费（单位：分） | 必填 | 
 | remark | string | 备注 | 必填 | 
 | warehouseName | string | 仓库名 | 必填 | 
 | goodShelveFee | string | 良品上架金额（单位：分） | 必填 | 
 | waitShelveQuantity | string | 待上架数量 | 必填 | 
 | totalDetailFee | string | 总金额（单位：分） | 必填 | 
 | busyOutCode | string | 业务出库单单据号 | 必填 | 
 | supplierName | string | 供应商名 | 必填 | 
 | getBadNum | string | 已接收次品数 | 必填 | 
 | quantity | string | 数量 | 必填 | 
 | busyTypeDesc | string | 业务类型描述 | 必填 | 
 | warehouseExternalCode | string | 仓库外部编号 | 必填 | 
 | cancelQuantity | string | 取消数量 | 必填 | 
 | receiveQuantity | string | 已收数量 | 必填 | 
 | getGoodNum | string | 已接收良品数 | 必填 | 
 | feeShareType | string | 金额分摊方式 | 必填 | 
 | busyCode | string | 业务单据号 | 必填 | 
 | logisticsType | string | 物流方式 0 空，1 快递，2 物流，3 自提，4 其他 | 必填 | 
 | supplierCode | string | 供应商编码 | 必填 | 
 | labels | array | 标签集合 | 必填 | 
 | contractRemark | string | 合同备注 | 必填 | 
 | financeStatus | string | 财审状态      WAIT_FINANCE：待财审，FINANCED：已财审 | 必填 | 
 | flag | Integer | 旗帜：-1/空 无旗帜，0/1/2/3/4/5分别代表灰、红、橙、绿、蓝、紫 | 必填 | 

# subTable: list/labels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 标签ID | 必填 | 
 | name | string | 标签名称 | 必填 | 
 | style | string | 标签样式 | 必填 | 

 

### 响应示例
```json
{
    "traceId": "1",
    "list": [
        {
            "finisherName": "",
            "cancelAmount": 0.0,
            "discountAmount": 0.0,
            "needCheck": 0,
            "shelveTime": 1718865831000,
            "outWarehouseId": 0,
            "busyId": 0,
            "modified": 1718865831000,
            "id": 1,
            "created": 1718865821000,
            "busyType": "",
            "finished": 1718865831000,
            "createrName": "",
            "pdaWeTaskStatus": 0,
            "othersFee": 0.0,
            "shelvedQuantity": 1,
            "warehouseId": 36446,
            "purchaseQuantity": 0,
            "status": "",
            "financeStatus": "",
            "code": "",
            "supplierId": 306474,
            "flag": -1,
            "badShelveFee": 0.0,
            "freight": 0.0,
            "remark": "A-5",
            "supplierCode": "",
            "warehouseName": "",
            "goodShelveFee": 0.0,
            "waitShelveQuantity": 0,
            "totalDetailFee": 0.0,
            "hasCheck": 0,
            "getBadNum": 0,
            "supplierName": "abc1",
            "quantity": 1,
            "busyTypeDesc": "",
            "warehouseExternalCode": "A",
            "cancelQuantity": 0,
            "receiveQuantity": 1,
            "getGoodNum": 1,
            "feeShareType": 0,
            "quantityCheck": 0,
            "logisticsType": 1
        }
    ],
    "total": 1,
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(warehouse.entry.list.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(warehouse.entry.list.query:1.0)的签名无效|签名参数错误|

---

## 新建/修改采购单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%96%B0%E5%BB%BA%E4%BF%AE%E6%94%B9%E9%87%87%E8%B4%AD%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/150-%E6%96%B0%E5%BB%BA%E4%BF%AE%E6%94%B9%E9%87%87%E8%B4%AD%E5%8D%95.md

# 新建/修改采购单

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采购单管理v2】----【新增采购单/编辑】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.addorupdate | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerCode | string | 外部采购订单号(不允许重复) |  | 
 | remark | string | 备注 |  | 
 | id | long | 采购单id |  | 
 | supplierCode | string | 供应商(编码)  | 必填 | 
 | deliveryDate | string | 交货日期 |  | 
 | items | string | 采购的商品列表 json \[\{"outerId":"springday","quantity":1,"ptSkuId":"平台skuID","remark":"备注信息","price":1,"caigouUrl":"采购链接","deliveryDate":"1751472000000"\}\],（price 单位：元） | 必填 |
 | warehouseCode | string | 仓库外部编码 | 必填 | 
 | status | string | 状态 WAIT_VERIFY （草稿）、VERIFYING(提交审核)、VERIFY（审核） |  | 
 | sourceOrderId | string | 外部平台单号 |  |
 | templateName | string | 物流公司 |  | 
 | outSid | string | 物流单号 |  | 
 | logisticsCode | string | 物流编码 |  | 
 | virtualWarehouseCode | string | 虚拟仓库编码 |  |

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码(最小粒度) | 必填 | 
 | quantity | long | 采购数量 | 必填 | 
 | price | number | 采购单价（单位：元） | 必填 | 
 | remark | string | 备注信息 |  | 
 | ptSkuId | long | 平台skuID |  | 
 | caigouUrl | string | 采购链接 |  |
 | deliveryDate | string | 明细交货日期 |  |

 

### 请求示例
```json
{
"outerCode": "string",
"sourceOrderId": "string",
"remark": "string",
"id": "long",
"supplierCode": "string",
"deliveryDate": "string",
"items": "string",
"warehouseCode": "string",
"status": "string",
"virtualWarehouseCode":"string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：采购单id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.addorupdate:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.addorupdate:1.0)的签名无效|签名参数错误|

---

## 归档收货单详情

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E5%BD%92%E6%A1%A3%E6%94%B6%E8%B4%A7%E5%8D%95%E8%AF%A6%E6%83%85
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1500-%E5%BD%92%E6%A1%A3%E6%94%B6%E8%B4%A7%E5%8D%95%E8%AF%A6%E6%83%85.md

# 归档收货单详情

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【历史收货单】----【详情】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | warehouse.entry.history.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 收货单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | amount | string | 金额（单位：分） | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | code | string | 单据编号 | 必填 | 
 | sysItemId | string | 系统商品Id | 必填 | 
 | count | string | 数量 | 必填 | 
 | supplierCode | string | 供应商代码 | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | unit | string | 单位 | 必填 | 
 | price | string | 单价（单位：分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | brand | string | 品牌 | 必填 | 
 | goodNum | number | 良品数量 | 必填 | 
 | badNum | number | 次品数量 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productTime | Date | 效期 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "zhangsan",
      "goodNum": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(warehouse.entry.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(warehouse.entry.list.get:1.0)的签名无效|签名参数错误|

---

## 归档采退单查询列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E5%BD%92%E6%A1%A3%E9%87%87%E9%80%80%E5%8D%95%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1550-%E5%BD%92%E6%A1%A3%E9%87%87%E9%80%80%E5%8D%95%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8.md

# 归档采退单查询列表

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【历史采退单】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.return.history.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | timeType | integer | 查询时间类型 1修改时间,2创建时间（默认为1）|  |
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss | 必填 | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss，起始时间和结束时间相差90天内  | 必填 | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | status | string | 单据状态 0 :已作废 1 :待出库 3 :已出库 |  | 
 | code | string | 单据号 |  | 
 | financeStatus | string | 财审状态 待财审：WAIT_FINANCE，已财审：FINANCED |  | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | templateType | string | 模板类型 | 必填 | 
 | stockRegionCodes | string | 库区编码 | 必填 | 
 | discountAmount | string | 折扣金额（单位：分） | 必填 | 
 | templateId | string | 快递模板 | 必填 | 
 | isAssignSection | string | 是否指定货位 | 必填 | 
 | province | string | 省 | 必填 | 
 | gmModified | string | 修改时间 | 必填 | 
 | busyId | string | 业务id | 必填 | 
 | actualReturnNum | string | 实际退货数 | 必填 | 
 | payment | string | 实付金额（含运费）（单位：分） | 必填 | 
 | id | string | id | 必填 | 
 | allAllocate | string | 采退单明细是否全部配货 0：否；1：是 | 必填 | 
 | outerCode | string | 外部编号 | 必填 | 
 | receiver | string | 收货人 | 必填 | 
 | mergeId | string | 关联的合单id | 必填 | 
 | returnSkuTypeNum | string | 采退单中sku的种类数 | 必填 | 
 | splitBySupplier | string | 是否按照供应商进行拆分生成采退单，PDA生成采退单可能需要按供应商拆分生成 0：否；1：是 | 必填 | 
 | isActualReturnNum | string | 是否有实际退货数量 | 必填 | 
 | busyType | string | 业务类型 | 必填 | 
 | createrName | string | 制单人名称 | 必填 | 
 | waveStatus | string | 波次状态 | 必填 | 
 | outSid | string | 出库单号 | 必填 | 
 | totalAmount | string | 商品总金额（单位：分） | 必填 | 
 | companyId | string | 公司id | 必填 | 
 | othersFee | string | 其他金额（单位：分） | 必填 | 
 | prSourceId | string | 采退单外部单号 | 必填 | 
 | warehouseId | string | 退货仓库Id | 必填 | 
 | phone | string | 手机 | 必填 | 
 | purchaseOrderId | string | 采购单Id | 必填 | 
 | isMerge | string | 是否合单 | 必填 | 
 | district | string | 区 | 必填 | 
 | enableStatus | string | 有效标记，1：有效 2：隐藏（合单隐藏单） | 必填 | 
 | outTime | string | 出库时间 | 必填 | 
 | status | string | 单据状态 0 :已作废 1 :待出库 2 :已审核 「已废弃」 4 :出库中 3 :已出库 5:草稿 | 必填 | 
 | code | string | 采购退货单号 | 必填 | 
 | supplierId | string | 供应商Id | 必填 | 
 | pickerNames | string | 波次拣选员 | 必填 | 
 | inWarehouseName | string | 调入仓库名称 | 必填 | 
 | city | string | 市 | 必填 | 
 | outLocation | string | 出库位置,货位/入库暂存区/销退暂存区/次品暂存区/通用暂存区/拣选暂存区 1/2/3/4/5/6 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | totalCount | string | 数量 | 必填 | 
 | warehouseName | string | 仓库名称 | 必填 | 
 | wssType | string | 暂存区类型 | 必填 | 
 | inWarehouseId | string | 调入仓库id | 必填 | 
 | actualTotalAmount | string | 实际总额（单位：分） | 必填 | 
 | statusName | string | 状态名称 | 必填 | 
 | supplierName | string | 供应商名称 | 必填 | 
 | address | string | 地址 | 必填 | 
 | warehouseExternalCode | string | 仓库外部编号 | 必填 | 
 | pickerIds | string | 波次拣选员Ids | 必填 | 
 | postFee | string | 运费（单位：分） | 必填 | 
 | gmCreate | string | 创建时间 | 必填 | 
 | mergeType | string | 合并类型，v1/v2，默认值为0 ,v2版本设置为1 | 必填 | 
 | waveId | string | 波次号 | 必填 | 
 | feeShareType | string | 金额分摊方式 | 必填 | 
 | busyCode | string | 业务单据号 | 必填 | 
 | returnNum | string | 退货数量 | 必填 | 
 | templateName | string | 模板名称 | 必填 | 
 | sortType | string | 排序类型 0:无，1：按商品排序 | 必填 | 
 | logisticsType | string | 物流方式 | 必填 | 
 | supplierCode | string | 供应商编码 | 必填 | 
 | labels | array | 标签集合 | 必填 | 
 | financeStatus | string | 财审状态 待财审：WAIT_FINANCE，已财审：FINANCED | 必填 | 

# subTable: list/labels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 标签ID | 必填 | 
 | name | string | 标签名称 | 必填 | 
 | style | string | 标签样式 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "templateType": 1,
      "stockRegionCodes": "zhangsan",
      "discountAmount": 10000,
      "templateId": 12345,
      "isAssignSection": true,
      "province": "zhangsan",
      "gmModified": "@date",
      "busyId": 12345,
      "actualReturnNum": 12345,
      "payment": 10000,
      "id": 12345,
      "allAllocate": 1,
      "outerCode": "zhangsan",
      "receiver": "zhangsan",
      "mergeId": 12345,
      "returnSkuTypeNum": 1,
      "splitBySupplier": 1,
      "isActualReturnNum": true,
      "busyType": "zhangsan",
      "createrName": "zhangsan",
      "waveStatus": 1,
      "outSid": "zhangsan",
      "totalAmount": 10000,
      "companyId": 12345,
      "othersFee": 10000,
      "prSourceId": "zhangsan",
      "warehouseId": 12345,
      "phone": "zhangsan",
      "purchaseOrderId": 12345,
      "isMerge": 1,
      "district": "zhangsan",
      "warehouseType": 1,
      "enableStatus": 1,
      "outTime": "@date",
      "status": 1,
      "code": "zhangsan",
      "supplierId": 12345,
      "pickerNames": "zhangsan",
      "inWarehouseName": "zhangsan",
      "city": "zhangsan",
      "outLocation": 1,
      "freight": 10000,
      "remark": "zhangsan",
      "totalCount": 1,
      "warehouseName": "zhangsan",
      "wssType": "zhangsan",
      "inWarehouseId": 12345,
      "actualTotalAmount": 10000,
      "statusName": "zhangsan",
      "supplierName": "zhangsan",
      "address": "zhangsan",
      "warehouseExternalCode": "zhangsan",
      "pickerIds": "zhangsan",
      "postFee": 10000,
      "gmCreate": "@date",
      "mergeType": 1,
      "waveId": 12345,
      "dbNo": 1,
      "feeShareType": 1,
      "busyCode": "zhangsan",
      "returnNum": 12345,
      "templateName": "zhangsan",
      "sortType": 1,
      "wlbTemplateType": "zhangsan",
      "logisticsType": 1
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.return.history.list.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.return.list.history.query:1.0)的签名无效|签名参数错误|

---

## 归档采退单详情

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E5%BD%92%E6%A1%A3%E9%87%87%E9%80%80%E5%8D%95%E8%AF%A6%E6%83%85
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1600-%E5%BD%92%E6%A1%A3%E9%87%87%E9%80%80%E5%8D%95%E8%AF%A6%E6%83%85.md

# 归档采退单详情

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【历史采退单】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.return.history.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 采退单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | amount | string | 金额（单位：分） | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | code | string | 单据编号 | 必填 | 
 | sysItemId | string | 系统商品Id | 必填 | 
 | count | string | 数量 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | supplierCode | string | 供应商代码 | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | unit | string | 单位 | 必填 | 
 | price | string | 单价（单位：分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productTime | Date | 效期 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "@date",
      "goodNum": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.return.history.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.return.history.list.get:1.0)的签名无效|签名参数错误|

---

## 归档上架单查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E5%BD%92%E6%A1%A3%E4%B8%8A%E6%9E%B6%E5%8D%95%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1650-%E5%BD%92%E6%A1%A3%E4%B8%8A%E6%9E%B6%E5%8D%95%E6%9F%A5%E8%AF%A2.md

# 归档上架单查询

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【上架单管理】----【三个月前】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.purchase.shelf.history.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | timeType | integer | 查询时间类型 1修改时间,2创建时间,3上架时间（默认为1） |  | 
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss | 必填 | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss，起始时间和结束时间相差90天内  | 必填 | 
 | weCode | string | 收货单编号 |  | 
 | status | integer | 状态 0 待上架 1 已完成 2已作废 |  | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 

 

### 请求示例
```json
{
"startModified": "string",
"endModified": "string",
"weCode": "string",
"fields": "string",
"status": "integer"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | waitQuantity | string | 示例：待上架数 | 必填 | 
 | containerNo | string | 示例：容器号 | 必填 | 
 | code | string | 示例：编码 | 必填 | 
 | supplierId | string | 示例：供应商id | 必填 | 
 | weReceived | string | 示例：收货单收货时间 | 必填 | 
 | num | string | 示例：总上架数量 | 必填 | 
 | creatorId | string | 示例：创建人id | 必填 | 
 | outWarehouseName | string | 示例：调出仓库名称 | 必填 | 
 | remark | string | 示例：备注 | 必填 | 
 | type | string | 示例：上架类型 0:按单上架 1:快速上架 5:其他上架 | 必填 | 
 | shelveTime | string | 示例：上架时间 | 必填 | 
 | warehouseName | string | 示例：仓库名称 | 必填 | 
 | outWarehouseId | string | 示例：调出仓库id | 必填 | 
 | busyId | string | 示例：业务id | 必填 | 
 | weCreated | string | 示例：收货单创建时间 | 必填 | 
 | id | string | 示例：id | 必填 | 
 | weCode | string | 示例：收货单编码 | 必填 | 
 | supplierName | string | 示例：供应商name | 必填 | 
 | creator | string | 示例：创建人姓名 | 必填 | 
 | busyTypeDesc | string | 示例：业务类型desc | 必填 | 
 | shelverId | string | 示例：上架人 | 必填 | 
 | created | string | 示例：创建时间 | 必填 | 
 | shelverName | string | 示例：上架人名称 | 必填 | 
 | busyType | string | 示例：业务类型 | 必填 | 
 | receiveQuantity | string | 示例：收货数 | 必填 | 
 | companyId | string | 示例：公司id | 必填 | 
 | weShelveQuantity | string | 示例：收货单上架数 | 必填 | 
 | busyCode | string | 示例：业务单据号 | 必填 | 
 | warehouseId | string | 示例：仓库id | 必填 | 
 | purchaseOrderId | string | 示例：采购单 | 必填 | 
 | weId | string | 示例：收货单id | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "waitQuantity": 1,
      "containerNo": "zhangsan",
      "code": "zhangsan",
      "supplierId": "zhangsan",
      "weReceived": "zhangsan",
      "num": 1,
      "creatorId": 12345,
      "outWarehouseName": "zhangsan",
      "remark": "zhangsan",
      "type": 1,
      "shelveTime": "zhangsan",
      "warehouseName": "zhangsan",
      "outWarehouseId": 12345,
      "busyId": 12345,
      "weCreated": "zhangsan",
      "id": 12345,
      "weCode": "zhangsan",
      "supplierName": "zhangsan",
      "creator": "zhangsan",
      "busyTypeDesc": "zhangsan",
      "shelverId": 12345,
      "created": "zhangsan",
      "shelverName": "zhangsan",
      "busyType": "zhangsan",
      "receiveQuantity": 12345,
      "companyId": 12345,
      "weShelveQuantity": 12345,
      "busyCode": "zhangsan",
      "warehouseId": 12345,
      "purchaseOrderId": 12345,
      "weId": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.purchase.shelf.history.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.purchase.shelf.history.query:1.0)的签名无效|签名参数错误|

---

## 归档上架单详情查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E5%BD%92%E6%A1%A3%E4%B8%8A%E6%9E%B6%E5%8D%95%E8%AF%A6%E6%83%85%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1700-%E5%BD%92%E6%A1%A3%E4%B8%8A%E6%9E%B6%E5%8D%95%E8%AF%A6%E6%83%85%E6%9F%A5%E8%AF%A2.md

# 归档上架单详情查询

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【上架单管理】----【前三个月】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | erp.purchase.shelf.history.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 上架单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | amount | string | 金额（单位是分） | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | code | string | 单据编号 | 必填 | 
 | sysItemId | string | 系统商品Id | 必填 | 
 | count | string | 数量 | 必填 | 
 | supplierCode | string | 供应商代码 | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | price | string | 单价（单位是分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productTime | Date | 效期 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "batchNo": "zhangsan",
      "goodsSectionCode": "zhangsan",
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "zhangsan",
      "goodNum": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(erp.purchase.shelf.history.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.purchase.shelf.history.query:1.0)的签名无效|签名参数错误|

---

## 预约入库单新增

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%A2%84%E7%BA%A6%E5%85%A5%E5%BA%93%E5%8D%95%E6%96%B0%E5%A2%9E
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1750-%E9%A2%84%E7%BA%A6%E5%85%A5%E5%BA%93%E5%8D%95%E6%96%B0%E5%A2%9E.md

# 预约入库单新增

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【预约入库单】----【新增】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.pre.in.order.add | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerCode | string | 外部预约入库单号 | 必填 | 
 | purchaseOrderCode | string | 采购单号 | 必填 | 
 | supplierCode | string | 供应商编码 | 必填 | 
 | preinDate | string | 预计到货日期，格式:yyyy-MM-dd HH:mm:ss | |
 | warehouseCode | string | 仓库编码 | 必填 |
 | status | integer | 状态编码 （2-待审核，3-已审核） | 必填 |
 | remark | string | 备注 |  |
 | items | string | 采购的商品列表 json \[\{"outerId":"springday","quantity":1\}\] | 必填 | 

 # subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码(最小粒度) | 必填 | 
 | quantity | long | 本次预约数量 | 必填 | 

 

### 请求示例
```json
{
    "outerCode": "YY004",
    "supplierCode": "1",
    "preinDate": "2025-02-13 14: 39: 33",
    "warehouseCode": "A",
    "status": "3",
    "items": "",
    "purchaseOrderCode": ""
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 预约入库单id | 必填 | 
 | preinOrderCode | string | 预约入库单号 | 必填 | 

 

### 响应示例
```json
{
    "traceId": "4544978659809004816",
    "preinOrderCode": "YY77",
    "success": true,
    "id": 927
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.pre.in.order.add:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(erp.purchase.shelf.history.query:1.0)的签名无效|签名参数错误|

---

## 预约入库单修改

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%A2%84%E7%BA%A6%E5%85%A5%E5%BA%93%E5%8D%95%E4%BF%AE%E6%94%B9
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1800-%E9%A2%84%E7%BA%A6%E5%85%A5%E5%BA%93%E5%8D%95%E4%BF%AE%E6%94%B9.md

# 预约入库单修改

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【预约入库单】----【修改】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.pre.in.order.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 预约单号id | 必填 | 
 | preinDate | string | 预计到货日期，格式:yyyy-MM-dd HH:mm:ss | |
 | remark | string | 备注 |  |
 | items | string | 采购的商品列表 json \[\{"outerId":"springday","quantity":1\}\] | 必填 | 

 # subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码(最小粒度) | 必填 | 
 | quantity | long | 本次预约数量 | 必填 | 

### 请求示例
```json
{
    "id": "123",
    "preinDate": "2025-02-13 14:39:33",
    "remark":"备注",
    "items":"";
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 预约入库单id | 必填 | 

 

### 响应示例
```json
{
    "traceId": "2695278502560167389",
    "success": true,
    "id": 4387287189219907
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.pre.in.order.update:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.pre.in.order.updatey:1.0)的签名无效|签名参数错误|

---

## 预约入库单反审核

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%A2%84%E7%BA%A6%E5%85%A5%E5%BA%93%E5%8D%95%E5%8F%8D%E5%AE%A1%E6%A0%B8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/1850-%E9%A2%84%E7%BA%A6%E5%85%A5%E5%BA%93%E5%8D%95%E5%8F%8D%E5%AE%A1%E6%A0%B8.md

# 预约入库单反审核

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【预约入库单】----【批量打回】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.pre.in.order.anti.audit | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 预约单号id，逗号分割 | 必填 | 

### 请求示例
```json
{
    "id": "847,846,845,1111999, 843",
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | unSuccessIds | array | 错误信息列表 | 必填 | 

 # subTable: unSuccessIds
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 预约单号id | 必填 | 
 | errorMes | string | 错误信息 | 必填 | 

 

### 响应示例
```json
{
    "traceId": "4414231851618664305",
    "unSuccessIds": [
        {
            "errorMes": "单据不是已审核状态，不可打回",
            "id": 843
        },
        {
            "errorMes": "id未找到对应单据",
            "id": 1111999
        }
    ],
    "success": true
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.pre.in.order.anti.audit:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.pre.in.order.anti.audit:1.0)的签名无效|签名参数错误|

---

## 采购单查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%87%87%E8%B4%AD%E5%8D%95%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/200-%E9%87%87%E8%B4%AD%E5%8D%95%E6%9F%A5%E8%AF%A2.md

# 采购单查询

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采购单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.order.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerCode | string | 外部采购订单号 |  | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | timeType | integer | 查询时间类型 1修改时间（默认为1），2创建时间 |  |
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | status | string | 单据状态 WAIT_VERIFY 草稿,VERIFYING 待审核,GOODS_NOT_ARRIVED 未到货,GOODS_PART_ARRIVED 部分到货,FINISHED 已完成, GOODS_CLOSED 已关闭 |  | 
 | id | integer | 采购单id |  | 
 | code | string | 采购单号 |  | 

 

### 请求示例
```json
{
"outerCode": "string",
"pageNo": "integer",
"startModified": "string",
"pageSize": "integer",
"endModified": "string",
"fields": "string",
"status": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | templateType | string | 模板类型 | 必填 | 
 | sourceKey | long | 对接平台 appKey | 必填 | 
 | sourceId | string | 对接平台外部单号outerCode | 必填 | 
 | shortId | long | 采购短号 | 必填 | 
 | advanceCharge | string | 预付款 | 必填 | 
 | cancelAmount | double | 作废金额（单位：分） | 必填 | 
 | pickWay | int | 拿货方式 0 为正常拿货 1 为小程序 命名仿照 erp-caigou queryWay | 必填 | 
 | receiveWarehouseId | string | 收货仓库编号,初期设计时，仓库编号可不填，但是仓库名称需要填写 | 必填 | 
 | discountAmount | double | 优惠金额（单位：分） | 必填 | 
 | templateId | string | 模板id | 必填 | 
 | financeAuditorDate | string | 财务审核日期 | 必填 | 
 | supplier | string | 供应商 | 必填 | 
 | modified | string | 修改日期 | 必填 | 
 | id | long | 采购订单id | 必填 | 
 | createrId | string | 制单人编号 | 必填 | 
 | arriveRegisteredTime | string | 登记时间 | 必填 | 
 | arriveRegisteredBy | string | 登记人 | 必填 | 
 | itemNumType | string | 单多件标识 | 必填 | 
 | created | string | 制单日期 | 必填 | 
 | autoRemark | string | 是否自动填充备注 | 必填 | 
 | createrName | string | 制单人名称 | 必填 | 
 | outSid | string | 出库单号 | 必填 | 
 | totalAmount | double | 总金额，不包括优惠的金额（单位：分） | 必填 | 
 | companyId | long | 公司id | 必填 | 
 | otherAmount | string | 其他费用 | 必填 | 
 | auditorId | string | 审核人id | 必填 | 
 | financeAuditorId | long | 财务审核人编号 | 必填 | 
 | auditorRemark | string | 审核备注 | 必填 | 
 | receiveWarehouseName | string | 收货仓库名称 | 必填 | 
 | warehouseType | string | 仓库类型 0自有,1第三方,2门店仓库 | 必填 | 
 | enableStatus | int | 启用禁用 | 必填 | 
 | auditorDate | string | 审核日期 | 必填 | 
 | status | string | 采购状态 单据状态 WAIT_VERIFY 草稿,VERIFYING 待审核,GOODS_NOT_ARRIVED 未到货,GOODS_PART_ARRIVED 部分到货,FINISHED 已完成, GOODS_CLOSED 已关闭 | 必填 | 
 | getGoodsStatus | string | 拿货状态 STATUS_GOODS_NOT_GET 未拿货，STATUS_GOODS_PART_GET 部分拿货，STATUS_GOODS_FINISHED 已完成，GOODS_CLOSED  已关闭 | 必填 | 
 | sourceOrderId | string | 对接平台外部订单号 | 必填 | 
 | totalDetailAmount | string | 明细折前金额（单位：分） | 必填 | 
 | code | string | 单据号码 | 必填 | 
 | supplierId | string | 供应商编号 | 必填 | 
 | flag | string | 旗帜 | 必填 | 
 | freight | string | 运费（单位：分） | 必填 | 
 | actualReceiveNum | string | 示例：实收数量总数 | 必填 | 
 | remark | string | 示例：备注 | 必填 | 
 | supplierCode | string | 示例：供应商编码 | 必填 | 
 | purchaseType | string | 示例：采购类型 caigou：采购单 shouhuo：收货单 | 必填 | 
 | actualTotalAmount | string | 实际总额/采购总额（单位：分） | 必填 | 
 | financeAuditorRemark | string | 财务审核备注 | 必填 | 
 | expressCompany | string | 快递公司 | 必填 | 
 | printBy | string | 打印人 | 必填 | 
 | deliveryDate | string | 交货日期 | 必填 | 
 | auditorName | string | 审核人名称 | 必填 | 
 | purchaseReturnNum | string | 采退总数 | 必填 | 
 | supplierName | string | 供应商名称 | 必填 | 
 | isFinishProduct | string | 是否是成品采购 | 必填 | 
 | quantity | string | 采购数量 | 必填 | 
 | financeAuditorName | string | 财务审核人名称 | 必填 | 
 | warehouseExternalCode | string | 仓库外部编号 | 必填 | 
 | arrivedQuantity | int | 已到数量 | 必填 | 
 | billType | string | 账期 | 必填 | 
 | receivedAmount | double | 已到金额/已到总额（单位：分） | 必填 | 
 | cancelQuantity | string | 作废数 | 必填 | 
 | receiveQuantity | int | 已收数量 | 必填 | 
 | templateName | string | 模板名称 | 必填 | 
 | contractRemark | string | 合同备注 | 必填 | 
 | purchaseReturnWeNum | long | 采退收货总数 | 必填 | 
 | finishDate | string | 完成日期 | 必填 | 
 | suitStatus | string | 套件状态 0：无套件 1：有套件 2：有组合装 | 必填 | 
 | logisticsType | string | 物流方式 1 快递，2 物流，3 自提，4 其他 | 必填 | 
 | printTime | string | 打印时间 | 必填 | 
 | weFinishStatus | string | 是否存在已完成收货单 | 必填 | 
 | financeId | Long | 财务管理账户id | 必填 | 
 | financeName | String | 财务管理账户名称 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "templateType": 1,
      "sourceKey": 1,
      "sourceId": "zhangsan",
      "shortId": "zhangsan",
      "advanceCharge": 10000,
      "cancelAmount": 10000,
      "pickWay": 1,
      "receiveWarehouseId": 12345,
      "discountAmount": 10000,
      "receiveStatus": "zhangsan",
      "templateId": 12345,
      "supplierSort": 1,
      "financeAuditorDate": "@date",
      "financeId":123,
      "financeName":"财务管理账户名称",
      "supplier": {
        "code": "zhangsan",
        "invoiceName": "zhangsan",
        "city": "zhangsan",
        "modifierId": 12345,
        "remark": "zhangsan",
        "categoryName": "zhangsan",
        "accountBank": "zhangsan",
        "province": "zhangsan",
        "modified": "@date",
        "id": 12345,
        "createrId": 12345,
        "fax": "zhangsan",
        "email": "zhangsan",
        "qq": "zhangsan",
        "zip": "zhangsan",
        "bankNumber": "zhangsan",
        "address": "zhangsan",
        "alipay": "zhangsan",
        "contactName": "zhangsan",
        "webAddress": "zhangsan",
        "created": "@date",
        "billType": "zhangsan",
        "mobile": "zhangsan",
        "wechat": "zhangsan",
        "tax": "zhangsan",
        "createrName": "zhangsan",
        "planReceiveDay": 1,
        "companyId": 12345,
        "phone": "zhangsan",
        "taxId": "zhangsan",
        "memoni": "zhangsan",
        "district": "zhangsan",
        "name": "zhangsan",
        "modifierName": "zhangsan",
        "categoryId": "zhangsan",
        "status": 1
      },
      "modified": "@date",
      "id": 12345,
      "createrId": 12345,
      "arriveRegisteredTime": "@date",
      "arriveRegisteredBy": 12345,
      "itemNumType": 1,
      "deliveryDateType": 1,
      "created": "@date",
      "autoRemark": true,
      "createrName": "zhangsan",
      "outSid": "zhangsan",
      "totalAmount": 10000,
      "companyId": 12345,
      "otherAmount": 10000,
      "auditorId": 12345,
      "financeAuditorId": 12345,
      "oldStatus": "zhangsan",
      "auditorRemark": "zhangsan",
      "receiveWarehouseName": "zhangsan",
      "warehouseType": 1,
      "enableStatus": 1,
      "auditorDate": "@date",
      "status": "zhangsan",
      "getGoodsStatus": "zhangsan",
      "sourceOrderId": "zhangsan",
      "totalDetailAmount": 10000,
      "code": "zhangsan",
      "supplierId": 12345,
      "flag": 1,
      "freight": 10000,
      "actualReceiveNum": 12345,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "purchaseType": "zhangsan",
      "actualTotalAmount": 10000,
      "financeAuditorRemark": "zhangsan",
      "expressCompany": "zhangsan",
      "printBy": 12345,
      "deliveryDate": "@date",
      "auditorName": "zhangsan",
      "purchaseReturnNum": 12345,
      "supplierName": "zhangsan",
      "isFinishProduct": true,
      "quantity": 12345,
      "financeAuditorName": "zhangsan",
      "warehouseExternalCode": "zhangsan",
      "arrivedQuantity": 12345,
      "billType": "zhangsan",
      "receivedAmount": 10000,
      "cancelQuantity": 12345,
      "receiveQuantity": 12345,
      "receiveQuantityInc": 12345,
      "templateName": "zhangsan",
      "contractRemark": "zhangsan",
      "skuSizeSort": 1,
      "purchaseReturnWeNum": 12345,
      "finishDate": "@date",
      "suitStatus": 1,
      "logisticsType": 1,
      "printTime": "@date",
      "weFinishStatus": 1
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.order.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.order.query:1.0)的签名无效|签名参数错误|

---

## 采购单详情

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%87%87%E8%B4%AD%E5%8D%95%E8%AF%A6%E6%83%85
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/250-%E9%87%87%E8%B4%AD%E5%8D%95%E8%AF%A6%E6%83%85.md

# 采购单详情

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采购单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.order.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：采购单id |  | 
 | ptOrderId | string | 示例：平台订单号 |  | 

 

### 请求示例
```json
{
"id": "long",
"ptOrderId": "1122334455"
}
```

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | amount | BigDecimal | 不带修正的采购金额（单位：分），采购金额=数量*单价 | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | code | string | 单据编号 | 必填 | 
 | purchaseOrderId | long | 采购单ID | 必填 | 
 | sysItemId | string | 系统商品Id | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | ptSkuId | string | 平台sku ID | 必填 | 
 | count | string | 数量 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | caigouUrl | string | 采购外链 | 必填 | 
 | supplierCode | string | 供应商代码 | 必填 | 
 | price | string | 单价（单位：分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | deliveryDate | string | 交货日期 | 必填 | 
 | ptOrderId | string | 平台订单号 | 必填 | 
 | ptShopId | string | 平台店铺ID | 必填 | 
 | outSid | string | 快递单号 | 必填 | 
 | templateName | string | 物流公司名称 | 必填 | 
 | totalFee | BigDecimal | 带修正的采购金额（单位：分） | 必填 | 
 | amendAmount | BigDecimal | 修正金额totalFee-amount计算出来的（单位：分） | 必填 | 

 

### 响应示例
```
{
    "traceId": "1879873565469747141",
    "list": [
        {
            "code": "CG3941403339276288",
            "ptSkuId": "MN-milk",
            "sysItemId": 466267301308928,
            "remark": "备注信息",
            "price": 100.000,
            "itemOuterId": "MN-milk",
            "ptOrderId": "1122334455",
            "deliveryDate": 1662541137000,
            "caigouUrl": "采购链接",
            "amount": 100.000,
            "quantity": 1,
            "count": 1,
            "outSid": "88889999",
            "sysSkuId": 0,
            "ptShopId": 12345,
            "purchaseOrderId": 3941403339276289,
            "outerId": "MN-milk"
        }
    ],
    "total": 1,
    "success": true
}
```
### 异常示例
```
{
    "code": "25",
    "msg": "服务方法(purchase.order.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
```
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.order.get:1.0)的签名无效|签名参数错误|

---

## 采购单批量审核/完成/关闭

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%87%87%E8%B4%AD%E5%8D%95%E7%8A%B6%E6%80%81%E6%9B%B4%E6%96%B0
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/300-%E9%87%87%E8%B4%AD%E5%8D%95%E7%8A%B6%E6%80%81%E6%9B%B4%E6%96%B0.md

# 采购单批量审核/完成/关闭

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采购单管理】----【批量操作】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.status.update | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 采购单ID集合,逗号拼接 | 必填 | 
 | status | string | 状态 ，支持 VERIFY（审核）、FINISHED(完成)、CLOSED（关闭） | 必填 | 

 

### 请求示例
```json
{
"ids": "string",
"status": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 示例：采购单id | 必填 | 

 

### 响应示例
```json
{
  "ids": "zhangsan"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.status.update:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.status.update:1.0)的签名无效|签名参数错误|

---

## 更新采购单特殊字段

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%9B%B4%E6%96%B0%E9%87%87%E8%B4%AD%E5%8D%95%E7%89%B9%E6%AE%8A%E5%AD%97%E6%AE%B5
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/350-%E6%9B%B4%E6%96%B0%E9%87%87%E8%B4%AD%E5%8D%95%E7%89%B9%E6%AE%8A%E5%AD%97%E6%AE%B5.md

# 更新采购单特殊字段

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采购单管理】----【修改】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.update.ignore.status | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerCode | string | 对接平台外部订单号 |  | 
 | sourceOrderId | string | 对接平台外部订单号 |  | 
 | id | string | 采购单id | 必填 | 
 | templateName | string | 物流公司 |  | 
 | outSid | string | 物流单号 |  | 
 | logisticsCode | string | 物流编码 |  | 
 | supplierCode | string | 供应商编码 |  | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：采购单id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.update.ignore.status:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.update.ignore.status:1.0)的签名无效|签名参数错误|

---

## 采购单反审核

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%87%87%E8%B4%AD%E5%8D%95%E5%8F%8D%E5%AE%A1%E6%A0%B8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/400-%E9%87%87%E8%B4%AD%E5%8D%95%E5%8F%8D%E5%AE%A1%E6%A0%B8.md

# 采购单反审核

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.unAudit | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 采购单ID集合,逗号拼接 |  | 

 

### 请求示例
```json
{
"ids": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 示例：采购单id | 必填 | 

# subTable: ids
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | sysItemId | int | 系统商品编码 | 必填 | 
 | barcode | string | 条形码 | 必填 | 
 | picPath | string | 商品图片URL | 必填 | 
 | activeStatus | int | 数据的可用状态，0表示停用，1表示启用 | 必填 | 
 | title | string | 商品标题 | 必填 | 
 | outerId | string | 商品的商家编码 | 必填 | 
 | type | string | 商品类型 0-普通（含虚拟商品，用 isVirtual字段描述|组合装商品） 1-sku套件 2-纯套件 3-包材商品 | 必填 | 
 | typeTag | int | 基于type下的二级分类 type=0 : 0-正常商品，1-sku加工商品，2-纯加工商品 3-含sku组合装商品 4-不含sku组合装商品 | 必填 | 
 | catId | string | 商品类目 | 必填 | 
 | unit | string | 单位 | 必填 | 
 | isSkuItem | int | 是否是含有sku的商品，是：1，否：0 | 必填 | 
 | isVirtual | int | 是否是虚拟商品，是：1，否：0 | 必填 | 
 | hasSupplier | int | 是否关联供应商 是：1 否：0 | 必填 | 
 | makeGift | boolean | 是否标记为赠品 | 必填 | 
 | created | int | 创建时间 | 必填 | 
 | modified | int | 更新时间 | 必填 | 
 | sellerCids | string | 示例：-1 | 必填 | 
 | sellerCats | array | 数据列表 | 必填 | 

# subTable: ids/sellerCats
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | int | 示例：94385 | 必填 | 
 | cid | int | 示例：-1 | 必填 | 
 | name | string | 示例：未分类 | 必填 | 

 

### 响应示例
```json
{
    "traceId": "2135498370976573866",
    "success": true,
    "ids": "string"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.unAudit:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.unAudit:1.0)的签名无效|签名参数错误|

---

## 新建/修改采退单

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%96%B0%E5%BB%BA%E4%BF%AE%E6%94%B9%E9%87%87%E9%80%80%E5%8D%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/450-%E6%96%B0%E5%BB%BA%E4%BF%AE%E6%94%B9%E9%87%87%E9%80%80%E5%8D%95.md

# 新建/修改采退单

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采退单管理】----【新建采购退货/修改】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.return.save | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | prSourceId | string | 外部单号(不允许重复) |  | 
 | purchaseOrderId | long | 采购单ID |  | 
 | id | long | 采退单id(修改时传入) |  | 
 | supplierCode | string | 供应商(编码) - 必填 | 必填 | 
 | items | string | 采购的商品列表 json \[\{"outerId":"springday","quantity":1,"price":1,"goodsSectionCode":"A-1-1"\}\] | 必填 | 
 | warehouseCode | string | 仓库外部编码 | 必填 | 
 | remark | string | 备注 |  | 
 | virtualWarehouseCode | string | 虚拟仓库编号 |  | 
 | contractNo | string | 合同单号 |  | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码 | 必填 | 
 | quantity | long | 数量 | 必填 | 
 | price | long | 采退单价（单位：元） | 必填 | 
 | productDate | string | 生产日期，格式“2024-04-11” |  | 
 | batchNo | string | 批次 |  | 
 | remark | string | 备注 |  | 
 | goodsSectionCode | string | 货位 |  | 
 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：采退单id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.return.save:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.return.save:1.0)的签名无效|签名参数错误|

---

## 查询供应商列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%9F%A5%E8%AF%A2%E4%BE%9B%E5%BA%94%E5%95%86%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/50-%E6%9F%A5%E8%AF%A2%E4%BE%9B%E5%BA%94%E5%95%86%E5%88%97%E8%A1%A8.md

# 查询供应商列表

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【供应商管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | supplier.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | pageNo | integer | 示例：页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 示例：每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | status | string | 示例：合作状态，1表示合作中，2表示停止合作 |  | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | code | string | 示例：供应商编码 | 必填 | 
 | invoiceName | string | 示例：发票抬头 | 必填 | 
 | city | string | 示例：城市 | 必填 | 
 | modifierId | string | 示例：修改人编号 | 必填 | 
 | remark | string | 示例：备注 | 必填 | 
 | categoryName | string | 示例：供应商分类 | 必填 | 
 | accountBank | string | 示例：开户行 | 必填 | 
 | province | string | 示例：省份 | 必填 | 
 | modified | string | 示例：修改日期 | 必填 | 
 | id | string | 示例：供应商编号 | 必填 | 
 | createrId | string | 示例：建档者，也就是员工的编号 | 必填 | 
 | fax | string | 示例：传真 | 必填 | 
 | email | string | 示例：邮箱 | 必填 | 
 | qq | string | 示例：QQ | 必填 | 
 | zip | string | 示例：邮编 | 必填 | 
 | bankNumber | string | 示例：银行账号 | 必填 | 
 | address | string | 示例：地址 | 必填 | 
 | alipay | string | 示例：支付宝 | 必填 | 
 | contactName | string | 示例：联系人名称 | 必填 | 
 | webAddress | string | 示例：网址 | 必填 | 
 | created | string | 示例：建档日期 | 必填 | 
 | billType | string | 示例：账期(天) | 必填 | 
 | mobile | string | 示例：手机号码 | 必填 | 
 | wechat | string | 示例：微信 | 必填 | 
 | tax | string | 示例：税号 | 必填 | 
 | createrName | string | 示例：建档者名称 | 必填 | 
 | planReceiveDay | string | 示例：预计到货时长 默认0 | 必填 | 
 | companyId | string | 示例：公司id | 必填 | 
 | phone | string | 示例：固话号码 | 必填 | 
 | taxId | string | 示例：供应商税务ID | 必填 | 
 | memoni | string | 示例：助记符 | 必填 | 
 | district | string | 示例：区县 | 必填 | 
 | name | string | 示例：名称 | 必填 | 
 | modifierName | string | 示例：修改人名称 | 必填 | 
 | categoryId | string | 示例：供应商分类ID | 必填 | 
 | status | string | 示例：合作状态，1表示合作中，2表示停止合作 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "code": "zhangsan",
      "invoiceName": "zhangsan",
      "city": "zhangsan",
      "modifierId": 12345,
      "remark": "zhangsan",
      "categoryName": "zhangsan",
      "accountBank": "zhangsan",
      "province": "zhangsan",
      "modified": "@date",
      "id": 12345,
      "createrId": 12345,
      "fax": "zhangsan",
      "email": "zhangsan",
      "qq": "zhangsan",
      "zip": "zhangsan",
      "bankNumber": "zhangsan",
      "address": "zhangsan",
      "alipay": "zhangsan",
      "contactName": "zhangsan",
      "webAddress": "zhangsan",
      "created": "@date",
      "billType": "zhangsan",
      "mobile": "zhangsan",
      "wechat": "zhangsan",
      "tax": "zhangsan",
      "createrName": "zhangsan",
      "planReceiveDay": 1,
      "companyId": 12345,
      "phone": "zhangsan",
      "taxId": "zhangsan",
      "memoni": "zhangsan",
      "district": "zhangsan",
      "name": "zhangsan",
      "modifierName": "zhangsan",
      "categoryId": "zhangsan",
      "status": 1
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(supplier.list.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(supplier.list.query:1.0)的签名无效|签名参数错误|

---

## 采退单查询列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%87%87%E9%80%80%E5%8D%95%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/500-%E9%87%87%E9%80%80%E5%8D%95%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8.md

# 采退单查询列表

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采退单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.return.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerCode | string | 外部采购订单号 |  | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | timeType | integer | 查询时间类型 1修改时间（默认为1），2创建时间 |  |
 | startModified | string | 起始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endModified | string | 结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | status | string | 单据状态 0 :已作废 1 :待出库 2 :已审核 「已废弃」 4 :出库中 3 :已出库 5:草稿 |  | 
 | code | string | 单据号 |  | 
 | tagName | string | 标签名称 | 必填 | 
 | financeStatus | string | 财审状态 待财审：WAIT_FINANCE，已财审：FINANCED | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | templateType | string | 模板类型 | 必填 | 
 | stockRegionCodes | string | 库区编码 | 必填 | 
 | discountAmount | string | 折扣金额（单位：分） | 必填 | 
 | templateId | string | 快递模板 | 必填 | 
 | isAssignSection | string | 是否指定货位 | 必填 | 
 | province | string | 省 | 必填 | 
 | gmModified | string | 修改时间 | 必填 | 
 | busyId | string | 业务id | 必填 | 
 | actualReturnNum | string | 实际退货数 | 必填 | 
 | payment | string | 实付金额（含运费）（单位：分） | 必填 | 
 | id | string | id | 必填 | 
 | allAllocate | string | 采退单明细是否全部配货 0：否；1：是 | 必填 | 
 | outerCode | string | 外部编号 | 必填 | 
 | receiver | string | 收货人 | 必填 | 
 | mergeId | string | 关联的合单id | 必填 | 
 | returnSkuTypeNum | string | 采退单中sku的种类数 | 必填 | 
 | splitBySupplier | string | 是否按照供应商进行拆分生成采退单，PDA生成采退单可能需要按供应商拆分生成 0：否；1：是 | 必填 | 
 | isActualReturnNum | string | 是否有实际退货数量 | 必填 | 
 | busyType | string | 业务类型 | 必填 | 
 | createrName | string | 制单人名称 | 必填 | 
 | waveStatus | string | 波次状态 | 必填 | 
 | outSid | string | 出库单号 | 必填 | 
 | totalAmount | string | 商品总金额（单位：分） | 必填 | 
 | companyId | string | 公司id | 必填 | 
 | othersFee | string | 其他金额（单位：分） | 必填 | 
 | prSourceId | string | 采退单外部单号 | 必填 | 
 | warehouseId | string | 退货仓库Id | 必填 | 
 | phone | string | 手机 | 必填 | 
 | purchaseOrderId | string | 采购单Id | 必填 | 
 | isMerge | string | 是否合单 | 必填 | 
 | district | string | 区 | 必填 | 
 | enableStatus | string | 有效标记，1：有效 2：隐藏（合单隐藏单） | 必填 | 
 | outTime | string | 出库时间 | 必填 | 
 | status | string | 单据状态 0 :已作废 1 :待出库 2 :已审核 「已废弃」 4 :出库中 3 :已出库 5:草稿 | 必填 | 
 | code | string | 采购退货单号 | 必填 | 
 | supplierId | string | 供应商Id | 必填 | 
 | pickerNames | string | 波次拣选员 | 必填 | 
 | inWarehouseName | string | 调入仓库名称 | 必填 | 
 | city | string | 市 | 必填 | 
 | outLocation | string | 出库位置,货位/入库暂存区/销退暂存区/次品暂存区/通用暂存区/拣选暂存区 1/2/3/4/5/6 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | totalCount | string | 数量 | 必填 | 
 | warehouseName | string | 仓库名称 | 必填 | 
 | wssType | string | 暂存区类型 | 必填 | 
 | inWarehouseId | string | 调入仓库id | 必填 | 
 | actualTotalAmount | string | 实际总额（单位：分） | 必填 | 
 | statusName | string | 状态名称 | 必填 | 
 | supplierName | string | 供应商名称 | 必填 | 
 | address | string | 地址 | 必填 | 
 | warehouseExternalCode | string | 仓库外部编号 | 必填 | 
 | pickerIds | string | 波次拣选员Ids | 必填 | 
 | postFee | string | 运费（单位：分） | 必填 | 
 | gmCreate | string | 创建时间 | 必填 | 
 | mergeType | string | 合并类型，v1/v2，默认值为0 ,v2版本设置为1 | 必填 | 
 | waveId | string | 波次号 | 必填 | 
 | feeShareType | string | 金额分摊方式 | 必填 | 
 | busyCode | string | 业务单据号 | 必填 | 
 | returnNum | string | 退货数量 | 必填 | 
 | templateName | string | 模板名称 | 必填 | 
 | sortType | string | 排序类型 0:无，1：按商品排序 | 必填 | 
 | logisticsType | string | 物流方式 | 必填 | 
 | supplierCode | string | 供应商编码 | 必填 | 
 | labels | array | 标签集合 | 必填 | 
 | financeStatus | string | 财审状态 待财审：WAIT_FINANCE，已财审：FINANCED | 必填 | 

# subTable: list/labels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 标签ID | 必填 | 
 | name | string | 标签名称 | 必填 | 
 | style | string | 标签样式 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "templateType": 1,
      "stockRegionCodes": "zhangsan",
      "discountAmount": 10000,
      "templateId": 12345,
      "isAssignSection": true,
      "province": "zhangsan",
      "gmModified": "@date",
      "busyId": 12345,
      "actualReturnNum": 12345,
      "payment": 10000,
      "id": 12345,
      "allAllocate": 1,
      "outerCode": "zhangsan",
      "receiver": "zhangsan",
      "mergeId": 12345,
      "returnSkuTypeNum": 1,
      "splitBySupplier": 1,
      "isActualReturnNum": true,
      "busyType": "zhangsan",
      "createrName": "zhangsan",
      "waveStatus": 1,
      "outSid": "zhangsan",
      "totalAmount": 10000,
      "companyId": 12345,
      "othersFee": 10000,
      "prSourceId": "zhangsan",
      "warehouseId": 12345,
      "phone": "zhangsan",
      "purchaseOrderId": 12345,
      "isMerge": 1,
      "district": "zhangsan",
      "warehouseType": 1,
      "enableStatus": 1,
      "outTime": "@date",
      "status": 1,
      "code": "zhangsan",
      "supplierId": 12345,
      "pickerNames": "zhangsan",
      "inWarehouseName": "zhangsan",
      "city": "zhangsan",
      "outLocation": 1,
      "freight": 10000,
      "remark": "zhangsan",
      "totalCount": 1,
      "warehouseName": "zhangsan",
      "wssType": "zhangsan",
      "inWarehouseId": 12345,
      "actualTotalAmount": 10000,
      "statusName": "zhangsan",
      "supplierName": "zhangsan",
      "address": "zhangsan",
      "warehouseExternalCode": "zhangsan",
      "pickerIds": "zhangsan",
      "postFee": 10000,
      "gmCreate": "@date",
      "mergeType": 1,
      "waveId": 12345,
      "dbNo": 1,
      "feeShareType": 1,
      "busyCode": "zhangsan",
      "returnNum": 12345,
      "templateName": "zhangsan",
      "sortType": 1,
      "wlbTemplateType": "zhangsan",
      "logisticsType": 1
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.return.list.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.return.list.query:1.0)的签名无效|签名参数错误|

---

## 采退单详情

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%87%87%E9%80%80%E5%8D%95%E8%AF%A6%E6%83%85
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/550-%E9%87%87%E9%80%80%E5%8D%95%E8%AF%A6%E6%83%85.md

# 采退单详情

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采退单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.return.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 采退单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | amount | string | 金额（单位：分） | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | code | string | 单据编号 | 必填 | 
 | sysItemId | string | 系统商品Id | 必填 | 
 | count | string | 数量 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | supplierCode | string | 供应商代码 | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | unit | string | 单位 | 必填 | 
 | price | string | 单价（单位：分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productTime | Date | 效期 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "remark": "zhangsan",
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "@date",
      "goodNum": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.return.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.return.list.get:1.0)的签名无效|签名参数错误|

---

## 采退单出库

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%87%87%E9%80%80%E5%8D%95%E5%87%BA%E5%BA%93
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/600-%E9%87%87%E9%80%80%E5%8D%95%E5%87%BA%E5%BA%93.md

# 采退单出库

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采退单管理】----【批量操作】----【批量出库】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.return.out | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 采退单id  | 必填 | 

 

### 请求示例
```
{
appKey:8620150
session:zeT2TFjGCPlxtrjJbg6PtYmdNLam9f0s
format:json
version:1.0
timestamp:2022-09-16 14:39:33
method:purchase.return.out
id:186057
sign:DE4BC8D3D52F483E467CD6006344FD7A
}
```
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 采退单id  | 必填 | 
 | items | string | 出库商品列表| 必填 | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码 | 必填 | 
 | quantity | long | 退货数量 | 必填 | 
 | actualReturnNum | long | 实际退货数量 | 必填 | 

 

### 响应示例
```
{
    "id": 186786,
    "success": true,
    "trace_id": "3724702727957489"
}
```
### 异常示例
```
{
    "code": "33",
    "msg": "商品[aacaigou003 次品]没有关联货位！",
    "success": false,
    "trace_id": "3724702727957385"
}
```
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.return.out:1.0)的签名无效|签名参数错误|

---

## 采退单作废

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E9%87%87%E9%80%80%E5%8D%95%E4%BD%9C%E5%BA%9F
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/650-%E9%87%87%E9%80%80%E5%8D%95%E4%BD%9C%E5%BA%9F.md

# 采退单作废

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【采退单管理】----【批量操作】----【批量作废】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | purchase.return.cancel | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 采退单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 采退单id | 必填 | 

 

### 响应示例
```json
{
  "id": 12345
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(purchase.return.cancel:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(purchase.return.cancel:1.0)的签名无效|签名参数错误|

---

## 收货单新增/修改

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%94%B6%E8%B4%A7%E5%8D%95%E6%96%B0%E5%A2%9E%E4%BF%AE%E6%94%B9
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/700-%E6%94%B6%E8%B4%A7%E5%8D%95%E6%96%B0%E5%A2%9E%E4%BF%AE%E6%94%B9.md

# 收货单新增/修改

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【收货单管理】----【新增收货单/修改】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | warehouse.entry.addorupdate | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | purchaseOrderId | long | 采购单ID |  | 
 | weOuterCode | string | 收货单外部单号(不允许重复) |  | 
 | id | long | 收货单id(编辑时必填) |  | 
 | supplierCode | string | 供应商(编码) - 必填 | 必填 | 
 | items | string | 采购的商品列表 json \[\{"outerId":"springday","quantity":1,"price":1\}\],（price 单位：元） | 必填 | 
 | warehouseCode | string | 仓库外部编码 | 必填 | 
 | status | integer | 状态，支持传入 NOT_FINISH （未完成）、FINISHED(已完成) | 必填 | 

# subTable: items
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerId | string | 商家编码(最小粒度) | 必填 | 
 | quantity | long | 数量 | 必填 | 
 | price | number | 单价（单位：元） | 必填 | 
 | batchNo | string | 批次 | 可选 | 
 | productDate | Date | 生产日期，格式“2024-04-11 00:00:00” | 可选 | 
 | expireDate | Date | 到期日期，格式“2024-04-15 00:00:00” | 可选 | 

 

### 请求示例
```
{
appKey:1124664101
format:json
version:1.0
timestamp:2023-09-16 14:39:33
session:a4958627c07b4f0eb9f255b81234c2a8
method:warehouse.entry.addorupdate
sign_method:md5
supplierCode:0003
warehouseCode:A
status:NOT_FINISH
items: [{"outerId":"批次效期测试商品","quantity":1,"price":10,"batchNo":"20230718","productTime":1742887853000,"expireDate":1742974253000}]
sign:32B28DA9EBDB1D605014D8E60F062338
}
```
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：收货单id | 必填 | 

 

### 响应示例
```
{
    "traceId": "2695278502560167389",
    "success": true,
    "id": 4387287189219907
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(warehouse.entry.addorupdate:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(warehouse.entry.addorupdate:1.0)的签名无效|签名参数错误|

---

## 收货单查询列表

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%94%B6%E8%B4%A7%E5%8D%95%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/750-%E6%94%B6%E8%B4%A7%E5%8D%95%E6%9F%A5%E8%AF%A2%E5%88%97%E8%A1%A8.md

# 收货单查询列表

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【收货单管理】----【查询】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | warehouse.entry.list.query | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outerCode | string | 外部采购订单号(不允许重复) |  | 
 | pageNo | integer | 页码 取值范围:大于零的整数。默认值为1 |  | 
 | pageSize | integer | 每页条数 取值范围:大于零的整数;最大值：200；默认值：40 |  | 
 | startModified | string | 修改起始时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | endModified | string | 修改结束时间 格式:yyyy-MM-dd HH:mm:ss |  | 
 | status | string | 单据状态 NOT_FINISH :未完成 STATUS_UNIQUE_CODE_RECEIVING:唯一码收货中  FINISHED :已完成  SHELVED：上架完成  CLOSED :已关闭 |  | 
 | code | string | 收货单号 |  | 
 | financeStatus | string | 财审状态  WAIT_FINANCE：待财审，FINANCED：已财审 |  | 
 | tagName | string | 标签名称 |  | 
 | flag | integer | 旗帜：-1/空 无旗帜，0/1/2/3/4/5分别代表灰、红、橙、绿、蓝、紫 |  | 
 | preinOrderId | long | 预约入库单id |  |
 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | finisherName | string | 完成人 | 必填 | 
 | busyOutId | string | 业务出库单id | 必填 | 
 | cancelAmount | string | 作废金额（单位：分） | 必填 | 
 | outWarehouseName | string | 出库仓库名称 | 必填 | 
 | discountAmount | string | 折扣金额（单位：分） | 必填 | 
 | shelveTime | string | 上架时间 | 必填 | 
 | outWarehouseId | string | 出库仓库id | 必填 | 
 | purchaseOrderCode | string | 采购单编号 | 必填 | 
 | busyId | string | 业务id | 必填 | 
 | modified | string | 修改时间 | 必填 | 
 | id | string | 收货单id | 必填 | 
 | outerCode | string | 外部编号 | 必填 | 
 | created | string | 创建时间 | 必填 | 
 | busyType | string | 业务类型，PURCHASE：采购收货；NO_PURCHASE：无单收货；PURCHASE_RETURN：采退收货；NO_BILL_ITEM_PURCHASE：错收收货 | 必填 | 
 | finished | string | 完成时间 完成人姓名 | 必填 | 
 | createrName | string | 制单人名称 | 必填 | 
 | pdaWeTaskStatus | string | pda收货状态，0：未进行pda收货 1：pda收货中 | 必填 | 
 | othersFee | string | 其他金额（单位：分） | 必填 | 
 | shelvedQuantity | string | 上架数 | 必填 | 
 | warehouseId | string | 仓库id | 必填 | 
 | purchaseOrderId | string | 采购单id | 必填 | 
 | purchaseQuantity | string | 采购总数 | 必填 | 
 | items | string | 商品种类数量 | 必填 | 
 | status | string | 单据状态 NOT_FINISH :未完成 STATUS_UNIQUE_CODE_RECEIVING:唯一码收货中  FINISHED :已完成 SHELVED：上架完成  CLOSED :已关闭 | 必填 | 
 | containerNo | string | 容器号 | 必填 | 
 | code | string | 收货单编号 | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | badShelveFee | string | 次品上架金额 | 必填 | 
 | freight | string | 运费（单位：分） | 必填 | 
 | remark | string | 备注 | 必填 | 
 | warehouseName | string | 仓库名 | 必填 | 
 | goodShelveFee | string | 良品上架金额（单位：分） | 必填 | 
 | waitShelveQuantity | string | 待上架数量 | 必填 | 
 | totalDetailFee | string | 总金额（单位：分） | 必填 | 
 | busyOutCode | string | 业务出库单单据号 | 必填 | 
 | supplierName | string | 供应商名 | 必填 | 
 | getBadNum | string | 已接收次品数 | 必填 | 
 | quantity | string | 数量 | 必填 | 
 | busyTypeDesc | string | 业务类型描述 | 必填 | 
 | warehouseExternalCode | string | 仓库外部编号 | 必填 | 
 | cancelQuantity | string | 取消数量 | 必填 | 
 | receiveQuantity | string | 已收数量 | 必填 | 
 | getGoodNum | string | 已接收良品数 | 必填 | 
 | feeShareType | string | 金额分摊方式 | 必填 | 
 | busyCode | string | 业务单据号 | 必填 | 
 | logisticsType | string | 物流方式 0 空，1 快递，2 物流，3 自提，4 其他 | 必填 | 
 | supplierCode | string | 供应商编码 | 必填 | 
 | labels | array | 标签集合 | 必填 | 
 | contractRemark | string | 合同备注 | 必填 | 
 | financeStatus | string | 财审状态      WAIT_FINANCE：待财审，FINANCED：已财审 | 必填 | 
 | flag | Integer | 旗帜：-1/空 无旗帜，0/1/2/3/4/5分别代表灰、红、橙、绿、蓝、紫 | 必填 | 
 | preinOrderId | long | 关联预约入库单id |  | 
 | preinOrderCode | string | 关联预约入库单单号 |  | 
 | proofInfoList | array | 附件列表 |  | 

# subTable: list/labels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 标签ID | 必填 | 
 | name | string | 标签名称 | 必填 | 
 | style | string | 标签样式 | 必填 | 

 # subTable: list/proofInfoList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | proofUrl | string | 附件地址 | 必填 | 
 | proofName | string | 附件名称 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "shortId": "zhangsan",
      "finisherName": "zhangsan",
      "busyOutId": 12345,
      "cancelAmount": 10000,
      "outWarehouseName": "zhangsan",
      "discountAmount": 10000,
      "needCheck": 1,
      "shelveTime": "zhangsan",
      "outWarehouseId": 12345,
      "purchaseOrderCode": "zhangsan",
      "busyId": 12345,
      "modified": "zhangsan",
      "id": 12345,
      "outerCode": "zhangsan",
      "created": "zhangsan",
      "busyType": "zhangsan",
      "finished": "zhangsan",
      "createrName": "zhangsan",
      "pdaWeTaskStatus": 1,
      "othersFee": 10000,
      "shelvedQuantity": 12345,
      "warehouseId": 12345,
      "purchaseOrderId": 12345,
      "purchaseQuantity": 12345,
      "items": 1,
      "status": "zhangsan",
      "containerNo": "zhangsan",
      "code": "zhangsan",
      "supplierId": 12345,
      "badShelveFee": 10000,
      "freight": 10000,
      "remark": "zhangsan",
      "warehouseName": "zhangsan",
      "goodShelveFee": 10000,
      "waitShelveQuantity": 12345,
      "totalDetailFee": 10000,
      "hasCheck": 1,
      "busyOutCode": "zhangsan",
      "supplierName": "zhangsan",
      "getBadNum": 12345,
      "quantity": 12345,
      "busyTypeDesc": "zhangsan",
      "warehouseExternalCode": "zhangsan",
      "cancelQuantity": 12345,
      "receiveQuantity": 12345,
      "getGoodNum": 12345,
      "feeShareType": 1,
      "busyCode": "zhangsan",
      "quantityCheck": 1,
      "logisticsType": 1
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(warehouse.entry.list.query:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(warehouse.entry.list.query:1.0)的签名无效|签名参数错误|

---

## 收货单详情

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%94%B6%E8%B4%A7%E5%8D%95%E8%AF%A6%E6%83%85
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/800-%E6%94%B6%E8%B4%A7%E5%8D%95%E8%AF%A6%E6%83%85.md

# 收货单详情

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【收货单管理】----【详情】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | warehouse.entry.list.get | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 收货单id | 必填 | 

 

### 请求示例
```json
{
"id": "long"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | total | string | 总数 | 必填 | 
 | list | object | 列表 | 必填 | 

# subTable: list
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierName | string | 供应商名称 | 必填 | 
 | amount | string | 金额（单位：分） | 必填 | 
 | supplierId | string | 供应商id | 必填 | 
 | code | string | 单据编号 | 必填 | 
 | sysItemId | string | 系统商品Id | 必填 | 
 | count | string | 数量 | 必填 | 
 | supplierCode | string | 供应商代码 | 必填 | 
 | sysSkuId | string | 系统规格id | 必填 | 
 | unit | string | 单位 | 必填 | 
 | price | string | 单价（单位：分） | 必填 | 
 | itemOuterId | string | 主商品编码 | 必填 | 
 | outerId | string | 商家编码 | 必填 | 
 | remark | string | 备注 | 必填 | 
 | brand | string | 品牌 | 必填 | 
 | goodNum | number | 良品数量 | 必填 | 
 | badNum | number | 次品数量 | 必填 | 
 | batchNo | string | 批次 | 必填 | 
 | productTime | Date | 生产日期 | 必填 | 
 | expireTime | Date | 到期日期 | 必填 | 

 

### 响应示例
```json
{
  "total": 12345,
  "list": [
    {
      "supplierName": "zhangsan",
      "badNum": 12345,
      "amount": 10000,
      "supplierId": 12345,
      "code": "zhangsan",
      "quantity": 12345,
      "sysItemId": 12345,
      "count": 12345,
      "shipNum": 1,
      "supplierCode": "zhangsan",
      "quality": true,
      "sysSkuId": 12345,
      "unit": "zhangsan",
      "price": 10000,
      "itemOuterId": "zhangsan",
      "outerId": "zhangsan",
      "deliveryDate": "zhangsan",
      "goodNum": 12345
    }
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(warehouse.entry.list.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(warehouse.entry.list.get:1.0)的签名无效|签名参数错误|

---

## 收货单作废

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%94%B6%E8%B4%A7%E5%8D%95%E4%BD%9C%E5%BA%9F
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/850-%E6%94%B6%E8%B4%A7%E5%8D%95%E4%BD%9C%E5%BA%9F.md

# 收货单作废

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【收货单管理】----【批量作废】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | warehouse.entry.cancel | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 收货单id，逗号隔开，最多20个 | 必填 | 

 

### 请求示例
```json
{
"ids": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 入库单id | 必填 | 

 

### 响应示例
```json
{
  "ids": "zhangsan"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(warehouse.entry.cancel:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(warehouse.entry.cancel:1.0)的签名无效|签名参数错误|

---

## 收货单打回

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%94%B6%E8%B4%A7%E5%8D%95%E6%89%93%E5%9B%9E
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/900-%E6%94%B6%E8%B4%A7%E5%8D%95%E6%89%93%E5%9B%9E.md

# 收货单打回

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【收货单管理】----【收货完成】----【打回待收货】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | warehouse.entry.finished.revert | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 收货单id,逗号拼接 | 必填 | 

 

### 请求示例
```json
{
"ids": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | ids | string | 收货单id集合 | 必填 | 

 

### 响应示例
```json
{
"ids": "string"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(warehouse.entry.finished.revert:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(warehouse.entry.finished.revert:1.0)的签名无效|签名参数错误|

---

## 收货单收货

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E9%87%87%E8%B4%AD/%E6%94%B6%E8%B4%A7%E5%8D%95%E6%94%B6%E8%B4%A7
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/50-%E9%87%87%E8%B4%AD/950-%E6%94%B6%E8%B4%A7%E5%8D%95%E6%94%B6%E8%B4%A7.md

# 收货单收货

**请求方法:** POST

### 系统相关界面
"界面路径：【采购】----【收货单管理】----【收货】"
### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境| https://gw.superboss.cc/router|

**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | multipart/form-data | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | warehouse.entry.receive | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | long | 收货单id | 必填 | 
 | items | string | 商品列表 json \[\{"outerId":"springday","quantity":1,"batchNo":"001","productDate":"2024-04-11 00:00:00","expireDate":"2024-04-15 00:00:00"\}\] | 必填 | 

 

### 请求示例
```json
 {
"id": "long",
"items": "string"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | id | string | 示例：收购单id | 必填 | 
 | splitWeId | list | 部分收货后拆分收货单id |  | 

 

### 响应示例
```json

 {
  "id": 12345,
  "splitWeId":[
    12346
  ]
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(warehouse.entry.receive:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|25|服务方法(warehouse.entry.receive:1.0)的签名无效|签名参数错误|

---

## 快麦通登录

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E5%BF%AB%E9%BA%A6%E9%80%9A%E7%99%BB%E5%BD%95
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/0-%E5%BF%AB%E9%BA%A6%E9%80%9A%E7%99%BB%E5%BD%95.md

# 快麦通登录

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|正式环境|https://scm.superboss.cc/openapi/login.json|
|测试环境| https://scm3.superboss.cc/openapi/login.json|

### 公共参数

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/json | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | companyName | string | 公司名 | 必填 | 
 | userName | string | 分销商账号名	是 | 必填 | 
 | password | string | 密码 md5处理之后的 | 必填 | 

 

### 请求示例
示例一：

```` 
{
  "companyName":"公司名",
  "userName":"帐号",
  "password":"密码 md5处理之后的"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | result |  |  | 必填 | 
 | data |  |  | 必填 | 

# subTable: data
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | redirectUrl | string | 登录之后,前端跳转地址 | 必填 | 

 

### 响应示例
```
{
    "api_name": null,
    "clueId": "548387803427328767",
    "result": 1,
    "message": null,
    "data": {
        "redirectUrl": "https://scm.superboss.cc/openapi/doLogin.json?key=SCM_LOGIN_RESULT_KEY_511111111_1088810257567901"
    },
    "qtime": 51
}
```
### 异常示例
````
{
result: 500,
message: "登录过期",
data: null,
clueId: "548388442937856348"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 添加分销商品

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E6%B7%BB%E5%8A%A0%E5%88%86%E9%94%80%E5%95%86%E5%93%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/100-%E6%B7%BB%E5%8A%A0%E5%88%86%E9%94%80%E5%95%86%E5%93%81.md

# 添加分销商品

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | kmt.api.dms.add.distribution.item.fromsupplier | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | distributorCompanyId | long | 分销商公司id | 必填 | 
 | itemOuterId | string | 商品编码,只传商品编码表示把这个商品下所有sku都加入分销商品 | 必填 | 
 | itemSkuOuterIdList | array | sku编码，如果传入sku编码 表示把传入的sku加入分销商品 |  | 

 

### 请求示例
示例一：

```` 
{
  "supplierCompanyId":1,
  "distributorCompanyId":2,
  "itemOuterId": "KMT-0713"
}
````
示例二：

```` 
{
  "supplierCompanyId":1,
  "distributorCompanyId":2,
  "itemOuterId": "KMT-0713",
  "itemSkuOuterIdList": ["KMT-0713白xxl"]
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | itemOuterId | string | 示例：878dadaer | 必填 | 
 | itemSkuOuterIdList | array |  |  | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 
 | success | boolean | 示例：true | 必填 | 

 

### 响应示例
```
{
    "itemOuterId": "878dadaer",
    "itemSkuOuterIdList": [
        "987891-1"
    ],
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 注册分销商

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E6%B3%A8%E5%86%8C%E5%88%86%E9%94%80%E5%95%86
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/150-%E6%B3%A8%E5%86%8C%E5%88%86%E9%94%80%E5%95%86.md

# 注册分销商

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | kmt.api.dms.add.distributor | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | distributorCompanyName | string | 分销商公司名 | 必填 | 
 | versionNumber | string | 要给分销商公司 设置什么版本，请咨询对接业务员 |  | 
 | source | int | 来源 默认 0,请咨询对接业务员，各渠道改参数对应值 | 必填 | 
 | mainPhone | string | 主手机号 | 必填 | 
 | defaultUserName | string | 分销商 默认账号的用户名 | 必填 | 
 | defaultPassword | string | 分销商 默认帐号的密码 | 必填 | 

 

### 请求示例
示例一：

```` 
{
    "supplierCompanyId":1,
    "distributorCompanyName":"分销商公司名",
    "mainPhone":"分销商手机号",
    "source":1,
    "defaultPassword":"分销商默认帐号密码",
    "defaultUserName":"分销商默认帐号名"
}
````
示例二：

````
{
    "supplierCompanyId":1,
    "distributorCompanyName":"分销商公司名",
    "mainPhone":"分销商手机号",
    "versionNumber":"要给分销商公司 设置什么版本",
    "source":1,
    "defaultPassword":"分销商默认帐号密码",
    "defaultUserName":"分销商默认帐号名"
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | distributorCompanyId | long | 分销商公司id | 必填 | 
 | distributorCompanyName | string | 分销商公司名 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

 

### 响应示例
```
{
    "supplierCompanyId": 1,
    "distributorCompanyId": 2,
    "distributorCompanyName": "分销商公司名",
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 分页查询供销小店商品

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E5%88%86%E9%A1%B5%E6%9F%A5%E8%AF%A2%E4%BE%9B%E9%94%80%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/200-%E5%88%86%E9%A1%B5%E6%9F%A5%E8%AF%A2%E4%BE%9B%E9%94%80%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81.md

# 分页查询供销小店商品

**请求方法:** GET

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type |  | multipart/form-data | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method |  | kmt.api.dms.query.page.distributor.item | 必填 | 
 | distributorCompanyId | long | 分销商公司id | 必填 | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | outerIds | string | List\<String\> json格式 |  | 
 | skuOuterIds | string | List\<String\> json格式 |  | 
 | title | string |  |  | 
 | pageNo | int | 1 | 必填 | 
 | pageSize | int | 20 | 必填 | 
 | requestSource | int | 请求来源 1童商网 | 必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id |  | 示例：3553483395407017 | 必填 | 
 | data | object | 数据 | 必填 | 

# subTable: data
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | companyId | long | 公司id，示例：30482 | 必填 | 
 | baseItemId | string | KMT商品id，示例：3f00c32622d0000 | 必填 | 
 | mainImages | string | 主图，示例：\["https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1689588120849/5dc57269-cfef-4987-9b48-dd3db74d9bc2.jpeg.a.jpeg"\] | 必填 | 
 | outerId | string | 款编码，示例：20237170001纯商品123 | 必填 | 
 | title | string | 商品标题，示例：11fd53cc | 必填 | 
 | levelDistributionPrice | double | 分销价（如果是纯商品，没有sku，展示分销价取款维度的） | 必填 | 
 | specifications | string | 规格json | 必填 | 
 | distributorSkuList | array |  | 必填 | 

# subTable: data/distributorSkuList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | title | string | 商品标题，示例：11fd53cc | 必填 | 
 | companyId | long | 公司id，示例：30482 | 必填 | 
 | baseItemId | string | KMT商品id，示例：3f00c32622d0000 | 必填 | 
 | imageUrl | string | sku图片，示例：https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1690534513273/28.jpg | 必填 | 
 | id | long | KMT-SKU-ID，示例：28613 | 必填 | 
 | skuOuterId | string | SKU编码，示例：20237170001纯商品23s | 必填 | 
 | skuSpecifications | string | 规格json，示例：\[\{"checked":true,"imageUrl":"https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1690534513273/28.jpg","name":"颜色","nameKey":"颜色","value":"23","valueKey":"23"\},\{"checked":true,"name":"尺码","nameKey":"尺码","value":"s","valueKey":"s"\}\] | 必填 | 
 | levelDistributionPrice | double | 分销价 |  | 
 | stock | int | 库存 | 必填 | 
 | commissionPrice | double | 佣金 |  | 
 | weight | double | 重量kg | 必填 | 
 | commissionScale | string | 佣金比例0.0% |  | 

 

### 说明 / 示例
````
{
    "supplierCompanyId": "123",
    "distributorCompanyId": 456,
    "baseItemId": "5b8cea2b6497000"
}
````

---

## 查询供销小店商品详情

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E6%9F%A5%E8%AF%A2%E4%BE%9B%E9%94%80%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81%E8%AF%A6%E6%83%85
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/250-%E6%9F%A5%E8%AF%A2%E4%BE%9B%E9%94%80%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81%E8%AF%A6%E6%83%85.md

# 查询供销小店商品详情

**请求方法:** GET

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type |  | multipart/form-data | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method |  | kmt.api.dms.query.detail.distributor.item | 必填 | 
 | distributorCompanyId | long | 分销商公司id | 必填 | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | baseItemId | string | 分页接口返回的baseItemId | 必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id |  | 示例：3553483395407017 | 必填 | 
 | data | object | 数据 | 必填 | 

# subTable: data
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | companyId | long | 公司id，示例：30482 | 必填 | 
 | baseItemId | string | KMT商品id，示例：3f00c32622d0000 | 必填 | 
 | mainImages | string | 主图，示例：\["https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1689588120849/5dc57269-cfef-4987-9b48-dd3db74d9bc2.jpeg.a.jpeg"\] | 必填 | 
 | outerId | string | 款编码，示例：20237170001纯商品123 | 必填 | 
 | title | string | 商品标题，示例：11fd53cc | 必填 | 
 | levelDistributionPrice | double | 分销价（如果是纯商品，没有sku，展示分销价取款维度的） | 必填 | 
 | specifications | string | 规格json | 必填 | 
 | distributorSkuList | array |  | 必填 | 

# subTable: data/distributorSkuList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | title | string | 商品标题，示例：11fd53cc | 必填 | 
 | companyId | long | 公司id，示例：30482 | 必填 | 
 | baseItemId | string | KMT商品id，示例：3f00c32622d0000 | 必填 | 
 | imageUrl | string | sku图片，示例：https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1690534513273/28.jpg | 必填 | 
 | id | long | KMT-SKU-ID，示例：28613 | 必填 | 
 | skuOuterId | string | SKU编码，示例：20237170001纯商品23s | 必填 | 
 | skuSpecifications | string | 规格json，示例：\[\{"checked":true,"imageUrl":"https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1690534513273/28.jpg","name":"颜色","nameKey":"颜色","value":"23","valueKey":"23"\},\{"checked":true,"name":"尺码","nameKey":"尺码","value":"s","valueKey":"s"\}\] | 必填 | 
 | levelDistributionPrice | double | 分销价 | 必填 | 
 | stock | int | 库存 | 必填 | 
 | commissionPrice | double | 佣金 | 必填 | 
 | weight | double | 重量kg | 必填 | 
 | commissionScale | string | 佣金比例0.0% | 必填 | 

 

### 说明 / 示例
````
{
    "supplierCompanyId": "123",
    "distributorCompanyId": 456,
    "baseItemId": "5b8cea2b6497000"
}
````

---

## 供销商视角-分页供销小店商品

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E4%BE%9B%E9%94%80%E5%95%86%E8%A7%86%E8%A7%92-%E5%88%86%E9%A1%B5%E4%BE%9B%E9%94%80%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/300-%E4%BE%9B%E9%94%80%E5%95%86%E8%A7%86%E8%A7%92-%E5%88%86%E9%A1%B5%E4%BE%9B%E9%94%80%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81.md

# 供销商视角-分页供销小店商品

**请求方法:** GET

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type |  | multipart/form-data | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method |  | kmt.api.dms.query.page.distributor.item.supplier.view | 必填 | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | outerIds | string | List\<String\> json格式 |  | 
 | skuOuterIds | string | List\<String\> json格式 |  | 
 | title | string |  |  | 
 | pageNo | int | 1 | 必填 | 
 | pageSize | int | 20 | 必填 | 
 | requestSource | int | 请求来源 1童商网 渠道接入时咨询技术对接同学 | 必填 | 
 | shopId | Long | 店铺id | 必填 | 
 | updateTimeBegin | string | 开始时间  | 必填 | 
 | updateTimeEnd | string | 结束时间 | 必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id |  | 示例：3553483395407017 | 必填 | 
 | data | object | 数据 | 必填 | 

# subTable: data
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | companyId | long | 公司id，示例：30482 | 必填 | 
 | baseItemId | string | KMT商品id，示例：3f00c32622d0000 | 必填 | 
 | mainImages | string | 主图，示例：\["https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1689588120849/5dc57269-cfef-4987-9b48-dd3db74d9bc2.jpeg.a.jpeg"\] | 必填 | 
 | outerId | string | 款编码，示例：20237170001纯商品123 | 必填 | 
 | title | string | 商品标题，示例：11fd53cc | 必填 | 
 | levelDistributionPrice | double | 分销价（如果是纯商品，没有sku，展示分销价取款维度的） | 必填 | 
 | specifications | string | 规格json | 必填 | 
 | distributorSkuList | array |  | 必填 | 
 | itemFastModelAttr | string | 商品类目属性 json 示例：\[\{"attributeID":"p-6861561","attributeName":"填充物","isCustom":true,"value":\["白鸭绒"\]\}\]  attributeID 属性id attributeName 属性名 isCustom 属性值是否自定义 value 属性值列表,兼容多选 valueId 属性值id列表,兼容多选,但是复杂的层级属性值类型较难兼容 pic 属性附带图片|   
 | detailImages  | string | 商品详情图 | 必填 | 
 | videoInfo | string  | 视频详情 json里面字段的解释 （id 自增主键  ，companyId 公司ID ，videoId 视频ID ， videoRatio 视频比例4:3,16:9 ， originUrl  视频URL ， videoFormat 视频格式,mp4,avi  ， title 视频名称 ，videoSize 视频大小 ，  videoDuration 视频时长,单位秒 ， videoCover 视频封面， videoSort 视频排序码  ｜
 | platformItemId  | string | 平台商品id | 必填 |
 | createSourceDetail  | string | 来源平台的详情页 | 必填 |
 | createSourceCreateTime  | Date | 来源平台的创建时间 | 必填 ||
 
 
 
# subTable: data/distributorSkuList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | title | string | 商品标题，示例：11fd53cc | 必填 | 
 | companyId | long | 公司id，示例：30482 | 必填 | 
 | baseItemId | string | KMT商品id，示例：3f00c32622d0000 | 必填 | 
 | imageUrl | string | sku图片，示例：https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1690534513273/28.jpg | 必填 | 
 | id | long | KMT-SKU-ID，示例：28613 | 必填 | 
 | skuOuterId | string | SKU编码，示例：20237170001纯商品23s | 必填 | 
 | skuSpecifications | string | 规格json，示例：\[\{"checked":true,"imageUrl":"https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1690534513273/28.jpg","name":"颜色","nameKey":"颜色","value":"23","valueKey":"23"\},\{"checked":true,"name":"尺码","nameKey":"尺码","value":"s","valueKey":"s"\}\] | 必填 | 
 | levelDistributionPrice | double | 分销价 | 必填 | 
 | stock | int | 库存 | 必填 | 
 | commissionPrice | double | 佣金 |  | 
 | weight | double | 重量kg | 必填 | 
 | commissionScale | string | 佣金比例0.0% |  | 
 

 

### 说明 / 示例
````
{
    "supplierCompanyId": "123",
    "distributorCompanyId": 456,
    "baseItemId": "5b8cea2b6497000",
    "shopId":1234,
    "updateTimeBegin":"2024-07-01 00:00:00",
    "updateTimeEnd":"2024-07-02 00:00:00"
}
````

---

## 供销商视角-查询供销小店商品详情

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E4%BE%9B%E9%94%80%E5%95%86%E8%A7%86%E8%A7%92-%E6%9F%A5%E8%AF%A2%E4%BE%9B%E9%94%80%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81%E8%AF%A6%E6%83%85
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/350-%E4%BE%9B%E9%94%80%E5%95%86%E8%A7%86%E8%A7%92-%E6%9F%A5%E8%AF%A2%E4%BE%9B%E9%94%80%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81%E8%AF%A6%E6%83%85.md

# 供销商视角-查询供销小店商品详情

**请求方法:** GET

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type |  | multipart/form-data | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method |  | kmt.api.dms.query.detail.distributor.item.supplier.view | 必填 | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | baseItemId | string | 分页接口返回的baseItemId | 必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id |  | 示例：3553483395407017 | 必填 | 
 | data | object | 数据 | 必填 | 

# subTable: data
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | companyId | long | 公司id，示例：30482 | 必填 | 
 | baseItemId | string | KMT商品id，示例：3f00c32622d0000 | 必填 | 
 | mainImages | string | 主图，示例：\["https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1689588120849/5dc57269-cfef-4987-9b48-dd3db74d9bc2.jpeg.a.jpeg"\] | 必填 | 
 | outerId | string | 款编码，示例：20237170001纯商品123 | 必填 | 
 | title | string | 商品标题，示例：11fd53cc | 必填 | 
 | levelDistributionPrice | double | 分销价（如果是纯商品，没有sku，展示分销价取款维度的） | 必填 | 
 | specifications | string | 规格json | 必填 | 
 | distributorSkuList | array |  | 必填 | 

# subTable: data/distributorSkuList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | title | string | 商品标题，示例：11fd53cc | 必填 | 
 | companyId | long | 公司id，示例：30482 | 必填 | 
 | baseItemId | string | KMT商品id，示例：3f00c32622d0000 | 必填 | 
 | imageUrl | string | sku图片，示例：https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1690534513273/28.jpg | 必填 | 
 | id | long | KMT-SKU-ID，示例：28613 | 必填 | 
 | skuOuterId | string | SKU编码，示例：20237170001纯商品23s | 必填 | 
 | skuSpecifications | string | 规格json，示例：\[\{"checked":true,"imageUrl":"https://erp-storage-ram.oss-cn-hangzhou.aliyuncs.com/scm/30482/1690534513273/28.jpg","name":"颜色","nameKey":"颜色","value":"23","valueKey":"23"\},\{"checked":true,"name":"尺码","nameKey":"尺码","value":"s","valueKey":"s"\}\] | 必填 | 
 | levelDistributionPrice | double | 分销价 | 必填 | 
 | stock | int | 库存 | 必填 | 
 | commissionPrice | double | 佣金 | 必填 | 
 | weight | double | 重量kg | 必填 | 
 | commissionScale | string | 佣金比例0.0% | 必填 | 

 

### 说明 / 示例
````
{
    "supplierCompanyId": "123",
    "baseItemId": "5b8cea2b6497000"
}
````

---

## 提交分销小店商品的同步

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E6%8F%90%E4%BA%A4%E5%88%86%E9%94%80%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81%E7%9A%84%E5%90%8C%E6%AD%A5
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/400-%E6%8F%90%E4%BA%A4%E5%88%86%E9%94%80%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81%E7%9A%84%E5%90%8C%E6%AD%A5.md

# 提交分销小店商品的同步

**请求方法:** GET

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type |  | multipart/form-data | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method |  | kmt.api.dms.submit.sync.item | 必填 | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | shopId | Long | 店铺id | 必填 | 
 | itemType | string | 同步下载商品类型 默认是 1 选择多个用,隔开 1.出售中商品 2.违规下架的 3.等待所有上架  4.全部卖完 | 非必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id |  | 示例：3553483395407017 | 必填 | 
 | data | object | 数据 | 必填 | 

 

### 说明 / 示例
````
{
    "supplierCompanyId": "123",
    "shopId":1234
}
````

---

## 获取小店商品的同步状态

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E8%8E%B7%E5%8F%96%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81%E7%9A%84%E5%90%8C%E6%AD%A5%E7%8A%B6%E6%80%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/450-%E8%8E%B7%E5%8F%96%E5%B0%8F%E5%BA%97%E5%95%86%E5%93%81%E7%9A%84%E5%90%8C%E6%AD%A5%E7%8A%B6%E6%80%81.md

# 获取小店商品的同步状态

**请求方法:** GET

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type |  | multipart/form-data | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method |  | kmt.api.dms.sync.status.item | 必填 | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | shopId | Long | 店铺id | 必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id |  | 示例：3553483395407017 | 必填 | 
 | data | object | 数据 | 必填 | 

# subTable: data
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | status | int | 商品的同步状态 1.待同步 2.同步中 3.同步成功 4.同步失败 | 必填 | 
 | startTime | string | 开始同步时间 | 必填 | 
 | stopTime | string | 结束同步时间 | 必填 | 
 | errorMsg | string | 失败原因 | 必填 | 

 

### 说明 / 示例
````
{
    "supplierCompanyId": "123",
    "shopId":1234
}
````

---

## 增加分销余额

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E5%A2%9E%E5%8A%A0%E5%88%86%E9%94%80%E4%BD%99%E9%A2%9D
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/50-%E5%A2%9E%E5%8A%A0%E5%88%86%E9%94%80%E4%BD%99%E9%A2%9D.md

# 增加分销余额

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | kmt.api.dms.add.distributor.money | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | distributorCompanyId | long | 分销商公司id | 必填 | 
 | paymentType |  | 支付方式 aliPay 支付宝 wechat 微信 bankTransfer 银行转账 other 其他 | 必填 | 
 | amount | double | 金额 单位元 | 必填 | 

 

### 请求示例
示例一：

```` 
{
  "supplierCompanyId":1,
  "distributorCompanyId":2,
  "paymentType":"wechat",
  "amount":1
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | amount | double | 本次操作金额 | 必填 | 
 | paymentOrderNumber | string | 流水号 | 必填 | 
 | balance | double | 总余额 | 必填 | 
 | credit | double | 总授信金额 | 必填 | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id | string | 示例：3553483395407017 | 必填 | 

 

### 响应示例
```
{
  "traceId": "2689492941094372052",
  "success": true,
  "amount": 2.1,
  "paymentOrderNumber": "548058250865152",
  "paymentType": "微信",
  "balance": 104.3,
  "credit": 0.0
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 分销商信息查询

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E5%88%86%E9%94%80%E5%95%86%E4%BF%A1%E6%81%AF%E6%9F%A5%E8%AF%A2
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/500-%E5%88%86%E9%94%80%E5%95%86%E4%BF%A1%E6%81%AF%E6%9F%A5%E8%AF%A2.md

# 分销商信息查询

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | kmt.api.dms.query.distributor.list | 必填 |

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | modifiedTimeStart | string | 周期 开始时间 格式类型（yyyy-MM-dd hh:mm:ss,2018-01-01 17:02:07） | 非必填 |
 | modifiedTimeEnd | string | 周期 结束时间 格式类型（yyyy-MM-dd hh:mm:ss,2018-01-01 17:02:07） | 非必填 |
 | requestState | string | 全部/待审核/已生效/已作废/已拒绝 对应01234,支持多个状态查询 ,分隔 | 非必填 |
 | pageNo | int | 页码 | 必填 |
 | pageSize | int | 分页大小 | 必填 |

 

### 请求示例
示例一：

```` 
{
    "supplierCompanyId":1,
    "modifiedTimeStart":"2018-01-01 17:02:07",
    "modifiedTimeEnd":"2018-01-01 17:02:07",
    "pageNo":1,
    "pageSize":"20",
}
````
示例二：

````
{
    "supplierCompanyId":2,
    "modifiedTimeStart":"2018-01-01 17:02:07",
    "modifiedTimeEnd":"2018-01-01 17:02:07",
    "pageNo":1,
    "pageSize":"20",
}
````
### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | distributorCompanyId | long | 分销商公司id | 必填 |
 | distributorCompanyName | string | 分销商公司名 | 必填 |
 | remark | string | 备注 | 非必填 |
 | contactProvince | string | 详细地址-省，例如：浙江省 | 非必填 |
 | contactCity | string | 详细地址-市，例如：杭州市 | 非必填 |
 | contactDistrict | string | 详细地址-区，例如：滨江区 | 非必填 |
 | contactDetailAddress | string | 详细地址-详细地址，例如：坚塔路599号 | 非必填 |
 | aliasName | string | 简称 | 非必填 |
 | saleStaffId | string | 业务员id | 非必填 |
 | saleStaffName | string | 业务员姓名 | 非必填 |
 | showState | int | 合作状态 | 非必填 |
 | showStateName | string | 合作状态-名称 | 非必填 |
 | success | boolean | 示例：true | 必填 |
 | trace_id | string | 示例：3553483395407017 | 必填 | 

 

### 响应示例
```
{
    "remark": "备注",
    "distributorCompanyId": 2,
    "distributorCompanyName": "分销商公司名",
    "contactProvince": "浙江省",
    "contactCity": "杭州市",
    "contactDistrict": "滨江区",
    "contactDetailAddress": "坚塔路599号",
    "aliasName": "简称",
    "saleStaffId": "610659135834612",
    "saleStaffName": "张三",
    "success": boolean,
    "trace_id": "long"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(item.single.get:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 查询在线支付方式提示文案

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E6%9F%A5%E8%AF%A2%E5%9C%A8%E7%BA%BF%E6%94%AF%E4%BB%98%E6%96%B9%E5%BC%8F%E6%8F%90%E7%A4%BA%E6%96%87%E6%A1%88
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/550-%E6%9F%A5%E8%AF%A2%E5%9C%A8%E7%BA%BF%E6%94%AF%E4%BB%98%E6%96%B9%E5%BC%8F%E6%8F%90%E7%A4%BA%E6%96%87%E6%A1%88.md

# 查询在线支付方式提示文案

**请求方法:** POST

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | method |  | kmt.api.dms.pay.prompt | 必填 |
 | payType | string | 可选值: MY_BANK |  |

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | success | boolean | 示例：true | 必填 |
 | trace_id |  | 示例：3553483395407017 | 必填 |
 | data | object | 数据 | 必填 |

# subTable: data
 | 参数名 | 类型 | 描述 | 必填 |
 | --- | --- | --- | --- |
 | prompt | string | 温馨提示：因网商银行费率上调，2025年9月1日起在线支付将额外收取0.21%的技术服务费，敬请谅解。 | 必填 |

### 说明 / 示例
````
{
        "body": "",
        "code": "",
        "forbiddenField": "",
        "msg": "",
        "prompt": "温馨提示：因网商银行费率上调，2025年9月1日起在线支付将额外收取0.21%的技术服务费，敬请谅解。",
        "solution": "",
        "subCode": "",
        "subMsg": "",
        "success": true,
        "traceId": "689747674518016310"
}
````

---

## 获取最新的视频链接信息

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E8%8E%B7%E5%8F%96%E6%9C%80%E6%96%B0%E7%9A%84%E8%A7%86%E9%A2%91%E9%93%BE%E6%8E%A5%E4%BF%A1%E6%81%AF
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/600-%E8%8E%B7%E5%8F%96%E6%9C%80%E6%96%B0%E7%9A%84%E8%A7%86%E9%A2%91%E9%93%BE%E6%8E%A5%E4%BF%A1%E6%81%AF.md

# 获取最新的视频链接信息

**请求方法:** GET

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type |  | multipart/form-data | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method |  | kmt.api.dms.query.item.video.info | 必填 | 
 | supplierCompanyId | long | 供销商公司id | 必填 | 
 | baseItemId | string | 商品id | 必填 | 
 | videoId | string | 视频id | 必填 | 

 

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | 示例：true | 必填 | 
 | trace_id |  | 示例：3553483395407017 | 必填 | 
 | data | object | 数据 | 必填 | 

# subTable: data
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | videoCover | String | 视频封面 | 必填 | 
 | originUrl | string | 视频地址 | 必填 | 
 | videoRatio | string | 视频宽高比 | 必填 | 
 | title | string | 视频标题 | 必填 | 

 

### 说明 / 示例
````
{
    "supplierCompanyId":279902,
    "baseItemId":"682f508b0af2000",
    "videoId" :"500147475497"
}
````

---

## 快麦通商品中心-导入拼多多平台资料

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E5%BF%AB%E9%BA%A6%E9%80%9A%E5%95%86%E5%93%81%E4%B8%AD%E5%BF%83-%E5%AF%BC%E5%85%A5%E6%8B%BC%E5%A4%9A%E5%A4%9A%E5%B9%B3%E5%8F%B0%E8%B5%84%E6%96%99
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/650-%E5%BF%AB%E9%BA%A6%E9%80%9A%E5%95%86%E5%93%81%E4%B8%AD%E5%BF%83-%E5%AF%BC%E5%85%A5%E6%8B%BC%E5%A4%9A%E5%A4%9A%E5%B9%B3%E5%8F%B0%E8%B5%84%E6%96%99.md

# 快麦通商品中心-导入拼多多平台资料

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | kmt.api.scm.import.pdd.item.list | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | companyId | long | 公司ID（必须大于0） | 必填 | 
 | pddItems | string | 拼多多商品列表，JSON数组字符串，结构参见 pddItems 子表 | 必填 | 

# subTable: pddItems
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | userId | long | 店铺编号（单次请求传同一个） | 必填 | 
 | outerGoodsId | string | 商品外部编号（不可重复） | 必填 | 
 | goodsName | string | 商品名称 | 必填 | 
 | catId | long | 拼多多叶子类目ID | 必填 | 
 | marketPrice | long | 市场价（单位：分，例如 1999 表示 19.99元） | 必填 | 
 | baseItemLabelList | string | 商品标签列表，JSON数组字符串 |  | 
 | carouselGalleryList | string | 轮播图URL列表，JSON数组字符串 | 必填 | 
 | detailGalleryList | string | 商品详情图URL列表，JSON数组字符串 | 必填 | 
 | goodsPropertyList | array | 商品属性列表，结构参见 goodsPropertyList 子表 |  | 
 | skuList | array | SKU列表，结构参见 skuList 子表 | 必填 | 
 
# subTable: pddItems/goodsPropertyList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | refPid | long | 属性ID（拼多多类目属性ref_pid） | 必填 | 
 | vvalue | string | 属性值 | 必填 | 

# subTable: pddItems/skuList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | outSkuSn | string | SKU外部编号（商家编码） | 必填 | 
 | quantity | long | 库存数量 | 必填 | 
 | price | long | 单买价（单位：分，例如 1999 表示 19.99元） | 必填 | 
 | multiPrice | long | 拼团价（单位：分，例如 1599 表示 15.99元） | 必填 | 
 | thumbUrl | string | SKU缩略图URL | 必填 | 
 | spec | array | 规格列表，结构参见 spec 子表 | 必填 | 

# subTable: pddItems/skuList/spec
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | parentName | string | 规格名称（例如：颜色、尺码） | 必填 | 
 | specName | string | 规格值（例如：红色、XL） | 必填 | 

 

### 请求示例
示例一：

````
{
  "companyId": 123456,
  "pddItems": "[{\"outerGoodsId\":\"GOODS001\",\"goodsName\":\"测试商品\",\"catId\":20036,\"marketPrice\":1999,\"baseItemLabelList\":\"[\\\"测试标签1\\\",\\\"测试标签2\\\"]\",\"carouselGalleryList\":\"[\\\"https://img.pddpic.com/xxx.jpg\\\"]\",\"detailGalleryList\":\"[\\\"https://img.pddpic.com/yyy.jpg\\\"]\",\"goodsPropertyList\":[{\"refPid\":310,\"vvalue\":\"自有品牌\"}],\"skuList\":[{\"outSkuSn\":\"SKU001\",\"quantity\":100,\"price\":1999,\"multiPrice\":1599,\"thumbUrl\":\"https://img.pddpic.com/sku1.jpg\",\"spec\":[{\"parentName\":\"颜色\",\"specName\":\"红色\"},{\"parentName\":\"尺码\",\"specName\":\"L\"}]},{\"outSkuSn\":\"SKU002\",\"quantity\":200,\"price\":2999,\"multiPrice\":2599,\"thumbUrl\":\"https://img.pddpic.com/sku2.jpg\",\"spec\":[{\"parentName\":\"颜色\",\"specName\":\"红色\"},{\"parentName\":\"尺码\",\"specName\":\"XL\"}]}]}]"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 流水id | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(kmt.api.scm.import.pdd.item.list:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 快麦通商品中心-导入多平台资料

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E5%BF%AB%E9%BA%A6%E9%80%9A%E5%95%86%E5%93%81%E4%B8%AD%E5%BF%83-%E5%AF%BC%E5%85%A5%E5%A4%9A%E5%B9%B3%E5%8F%B0%E8%B5%84%E6%96%99
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/700-%E5%BF%AB%E9%BA%A6%E9%80%9A%E5%95%86%E5%93%81%E4%B8%AD%E5%BF%83-%E5%AF%BC%E5%85%A5%E5%A4%9A%E5%B9%B3%E5%8F%B0%E8%B5%84%E6%96%99.md

# 快麦通商品中心-导入多平台资料

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | kmt.api.scm.import.platform.item.list | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | companyId | long | 公司ID | 必填 | 
 | userId | long | 店铺编号 | 必填 | 
 | fastModels | string | 中间模型JSON数组字符串，结构参见 fastModels 子表 |  | 

# subTable: fastModels
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | platformItemId | string | 来源平台商品ID |  | 
 | mainImages | array | 主图URL列表 | 必填 | 
 | mainImages34 | array | 3:4主图URL列表 |  | 
 | detailImages | array | 详情图URL列表 | 必填 | 
 | packageLabelImages | array | 包装标签图URL列表 |  | 
 | baseItemLabelList | array | 商品标签列表 |  | 
 | description | string | 商品描述 |  | 
 | outerId | string | 商品款式编码 | 必填 | 
 | title | string | 商品名称 | 必填 | 
 | salesPrice | double | 销售价 | 必填 | 
 | marketPrice | double | 市场价 |  | 
 | purchasePrice | double | 成本价 |  | 
 | weight | double | 重量，单位：kg |  | 
 | stock | integer | 库存 | 必填 | 
 | easySpecifications | object | 规格信息值，key为规格名称，value结构参见 easySpecifications 子表 |  | 
 | catList | array | 目标平台类目列表，结构参见 catList 子表 | 必填 | 
 | catPropAttr | array | 来源平台类目属性列表，结构参见 catPropAttr 子表 |  | 
 | skuList | array | SKU列表，结构参见 skuList 子表 |  | 

# subTable: fastModels/easySpecifications
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | attributeName | string | SKU属性名 | 必填 | 
 | realValue | string | SKU属性真实值 | 必填 | 
 | value | string | SKU属性值 | 必填 | 
 | pic | string | 属性附带图片URL |  | 
 | note | string | SKU备注 |  | 

# subTable: fastModels/catList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | fromCid | long | 目标平台叶子类目ID | 必填 | 

# subTable: fastModels/catPropAttr
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | attributeID | string | 属性ID |  | 
 | attributeName | string | 属性名 | 必填 | 
 | valueId | array | 属性值ID列表，兼容多选 |  | 
 | value | array | 属性值列表，兼容多选 | 必填 | 
 | isCustom | boolean | 属性值是否自定义 |  | 
 | pic | string | 属性附带图片URL |  | 

# subTable: fastModels/skuList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | baseSkuId | long | 基础SKU ID |  | 
 | skuOuterId | string | SKU商品编码 | 必填 | 
 | salesPrice | double | 销售价 | 必填 | 
 | marketPrice | double | 市场价 |  | 
 | purchasePrice | double | 成本价 |  | 
 | stock | integer | 库存 | 必填 | 
 | weight | double | 重量，单位：kg |  | 
 | skuAttrUk | string | SKU规格信息唯一键 | 必填 | 
 | skuAttr | array | SKU规格信息，结构参见 skuAttr 子表 | 必填 | 
 | extraAttr | array | SKU其他属性，结构同 catPropAttr 子表 |  | 

# subTable: fastModels/skuList/skuAttr
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | attributeName | string | SKU属性名 | 必填 | 
 | realValue | string | SKU属性真实值 | 必填 | 
 | value | string | SKU属性值 | 必填 | 
 | pic | string | 属性附带图片URL |  | 
 | note | string | SKU备注 |  | 

 

### 请求示例
示例一：

````
{
  "companyId": 123456,
  "userId": 78910,
  "fastModels": "[{\"mainImages\":[\"https://img.example.com/main1.jpg\"],\"detailImages\":[\"https://img.example.com/detail1.jpg\"],\"packageLabelImages\":[\"https://img.example.com/pack1.jpg\"],\"description\":\"测试商品描述\",\"outerId\":\"GOODS001\",\"title\":\"测试商品\",\"salesPrice\":19.99,\"marketPrice\":29.99,\"purchasePrice\":10.00,\"weight\":0.5,\"stock\":100,\"easySpecifications\":{\"颜色\":[{\"attributeName\":\"颜色\",\"realValue\":\"红色\",\"value\":\"红色\",\"pic\":\"https://img.example.com/red.jpg\",\"note\":\"\"}],\"尺码\":[{\"attributeName\":\"尺码\",\"realValue\":\"L\",\"value\":\"L\",\"note\":\"\"}]},\"catList\":[{\"fromCid\":20036}],\"catPropAttr\":[{\"attributeID\":\"310\",\"attributeName\":\"品牌\",\"valueId\":[\"1001\"],\"value\":[\"自有品牌\"],\"isCustom\":false}],\"skuList\":[{\"skuOuterId\":\"SKU001\",\"salesPrice\":19.99,\"marketPrice\":29.99,\"purchasePrice\":10.00,\"stock\":50,\"weight\":0.5,\"skuAttrUk\":\"颜色红色尺码L\",\"skuAttr\":[{\"attributeName\":\"颜色\",\"realValue\":\"红色\",\"value\":\"红色\"},{\"attributeName\":\"尺码\",\"realValue\":\"L\",\"value\":\"L\"}],\"extraAttr\":[{\"attributeID\":\"skuProp1\",\"attributeName\":\"SKU属性\",\"value\":[\"属性值\"]}]}]}]"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 流水id | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(kmt.api.scm.import.platform.item.list:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 快麦通商品中心-更新拼多多铺货商品

URL: https://open.kuaimai.com/docs/api/API%E6%96%87%E6%A1%A3/%E5%BF%AB%E9%BA%A6%E9%80%9A/%E5%BF%AB%E9%BA%A6%E9%80%9A%E5%95%86%E5%93%81%E4%B8%AD%E5%BF%83-%E6%9B%B4%E6%96%B0%E6%8B%BC%E5%A4%9A%E5%A4%9A%E9%93%BA%E8%B4%A7%E5%95%86%E5%93%81
Markdown: https://open.kuaimai.com/__ai/markdown/api/20-API%E6%96%87%E6%A1%A3/60-%E5%BF%AB%E9%BA%A6%E9%80%9A/750-%E5%BF%AB%E9%BA%A6%E9%80%9A%E5%95%86%E5%93%81%E4%B8%AD%E5%BF%83-%E6%9B%B4%E6%96%B0%E6%8B%BC%E5%A4%9A%E5%A4%9A%E9%93%BA%E8%B4%A7%E5%95%86%E5%93%81.md

# 快麦通商品中心-更新拼多多铺货商品

**请求方法:** POST

### 请求地址
|环境|服务地址(HTTP/HTTPS)|
|-|-|
|V2正式环境（推荐）| https://gw.superboss.cc/router|
|V2测试环境| https://gw3.superboss.cc/router|
     
**2022年4月1日**以后申请的APP Key，统一使用V2正式环境的请求地址：**https://gw.superboss.cc/router**
### 公共参数
调用任何一个API都必须传入的参数，目前支持的公共参数有：

| 参数名称 | 参数类型 | 是否必须 | 参数描述 |
| --- | --- | --- | --- |
| method | string | 是 | API接口名称 |
| appKey | string | 是 | 分配给应用的AppKey |
| timestamp | string | 是 | 时间戳，时区为GMT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
| format | string | 否 | 响应格式。默认为json格式，可选值：json |
| version | string | 是 | API协议版本 可选值：1.0 |
| sign\_method | string | 否 | 签名的摘要算法(默认 hmac)，可选值为：hmac，md5，hmac-sha256。 |
| sign | string | 是 | 签名 |
| session | string | 是 | 授权会话信息 （即access_token，由系统分配） |

### 请求头

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | Content-Type | string | application/x-www-form-urlencoded;charset=UTF-8 | 必填 | 

 

### API接口地址

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | method | string | kmt.api.scm.update.pdd.distribution.item | 必填 | 

 

### 请求参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | companyId | long | 公司ID（必须大于0） | 必填 | 
 | platformItemId | string | 平台商品ID | 必填 | 
 | outerGoodsId | string | 快麦通商品款式编码 | 必填 | 
 | pddItem | string | 拼多多待更新商品信息，JSON对象字符串，结构参见 pddItem 子表 | 必填 | 

# subTable: pddItem
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | userId | long | 店铺编号 |  | 
 | outerGoodsId | string | 快麦通商品款式编码 |  | 
 | goodsName | string | 商品名称 |  | 
 | catId | long | 拼多多叶子类目ID |  | 
 | marketPrice | long | 市场价（单位：分，例如 1999 表示 19.99元） |  | 
 | baseItemLabelList | string | 商品标签列表，JSON数组字符串 |  | 
 | carouselGalleryList | string | 轮播图URL列表，JSON数组字符串 |  | 
 | detailGalleryList | string | 商品详情图URL列表，JSON数组字符串 |  | 
 | goodsPropertyList | array | 商品属性列表，结构参见 goodsPropertyList 子表 |  | 
 | skuList | array | SKU列表，结构参见 skuList 子表 |  | 
 
# subTable: pddItem/goodsPropertyList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | refPid | long | 属性ID（拼多多类目属性ref_pid） |  | 
 | vvalue | string | 属性值 |  | 

# subTable: pddItem/skuList
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | kmtSkuOuterId | string | 快麦通SKU编码；PDD SKU编码无法关联时用于强制绑定 |  | 
 | pddOutSkuSn | string | PDD平台商家SKU编码；优先用于关联已有铺货SKU |  | 
 | quantity | long | 库存数量 |  | 
 | price | long | 单买价（单位：分，例如 1999 表示 19.99元） |  | 
 | multiPrice | long | 拼团价（单位：分，例如 1599 表示 15.99元） |  | 
 | thumbUrl | string | SKU缩略图URL |  | 
 | spec | array | 规格列表，结构参见 spec 子表 |  | 

# subTable: pddItem/skuList/spec
 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | parentName | string | 规格名称（例如：颜色、尺码） |  | 
 | specName | string | 规格值（例如：红色、XL） |  | 

 

### 请求示例
示例一：

````
{
  "companyId": 123456,
  "platformItemId": "PDD123456789",
  "outerGoodsId": "GOODS001",
  "pddItem": "{\"userId\":78910,\"outerGoodsId\":\"GOODS001\",\"goodsName\":\"测试商品\",\"catId\":20036,\"marketPrice\":1999,\"baseItemLabelList\":\"[\\\"测试标签1\\\",\\\"测试标签2\\\"]\",\"carouselGalleryList\":\"[\\\"https://img.pddpic.com/xxx.jpg\\\"]\",\"detailGalleryList\":\"[\\\"https://img.pddpic.com/yyy.jpg\\\"]\",\"goodsPropertyList\":[{\"refPid\":310,\"vvalue\":\"自有品牌\"}],\"skuList\":[{\"kmtSkuOuterId\":\"KMT-SKU001\",\"pddOutSkuSn\":\"PDD-SKU001\",\"quantity\":100,\"price\":1999,\"multiPrice\":1599,\"thumbUrl\":\"https://img.pddpic.com/sku1.jpg\",\"spec\":[{\"parentName\":\"颜色\",\"specName\":\"红色\"},{\"parentName\":\"尺码\",\"specName\":\"L\"}]}]}"
}
````

### 响应参数

 | 参数名 | 类型 | 描述 | 必填 | 
 | --- | --- | --- | --- | 
 | success | boolean | true-成功，false-失败 | 必填 | 
 | trace_id | string | 流水id | 必填 | 

 

### 响应示例
```
{
    "success": true,
    "trace_id": "3533394037472595"
}
```
### 异常示例
````
{
    "code": "25",
    "msg": "服务方法(kmt.api.scm.update.pdd.distribution.item:1.0)的签名无效",
    "success": false,
    "trace_id": "3553483395423660"
}
````
### 错误码解释
| 错误码 |错误信息|解决方案|
|-|-|-|
|content1|content2|content3|

---

## 订单业务对接

URL: https://open.kuaimai.com/docs/api/API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/%E8%AE%A2%E5%8D%95%E4%B8%9A%E5%8A%A1%E5%AF%B9%E6%8E%A5
Markdown: https://open.kuaimai.com/__ai/markdown/api/30-API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/10-%E8%AE%A2%E5%8D%95%E4%B8%9A%E5%8A%A1%E5%AF%B9%E6%8E%A5.md

### 一. 对接流程图

此场景适用于商家自研商城、小程序商城、自建平台对接。以下统称为“自建平台”。

![](/img/self_built_platform_order.png)

### 二. 接口说明

1. 创建自建平台订单接口（erp.trade.create.new），自建平台请求该接口，在快麦ERP创建自建平台订单，数据方向为：从自建平台传到快麦ERP。
2. 订单查询接口（erp.trade.list.query）/销售出库订单接口（erp.trade.outstock.simple.query），自建平台请求该接口，可获取到订单的状态、快递公司和快递单号等信息，数据方向为：从快麦ERP到自建平台。
3. 创建自建平台订单接口（erp.trade.create.new），自建平台请求该接口，可在快麦ERP修改订单的状态为‘TRADE_FINISHED’，将订单改为交易成功。
4. 创建自建平台订单接口（erp.trade.create.new），自建平台请求该接口，可在快麦ERP修改订单的状态为‘TRADE_CLOSED’，将订单改为交易关闭。
5. 订单作废接口（erp.trade.cancle），自建平台请求该接口，可在快麦ERP将发货前的订单作废。

### 三. 注意事项
1. 自建平台的订单不需要通过商品对应表进行对应，创建订单前需要提前在快麦ERP中维护好系统商品，系统商品可直接在快麦里维护，也可通过接口同步商品资料。
2. 修改/新增普通商品接口（item.general.addorupdate），可在快麦ERP中增加和修改普通商品。
3. 快麦ERP系统自建平台的店铺建立，在【基础】--【店铺管理】--【新增店铺】，选择‘自建平台’店铺类型，填写店铺名称等信息，保存。

---

## 售后业务对接

URL: https://open.kuaimai.com/docs/api/API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/%E5%94%AE%E5%90%8E%E4%B8%9A%E5%8A%A1%E5%AF%B9%E6%8E%A5
Markdown: https://open.kuaimai.com/__ai/markdown/api/30-API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/20-%E5%94%AE%E5%90%8E%E4%B8%9A%E5%8A%A1%E5%AF%B9%E6%8E%A5.md

### 一. 对接流程图

此场景适用于商家自研商城、小程序商城、自建平台对接。以下统称为“自建平台”，自建平台订单如有售后，有两种对接方案：

**方案一**：不使用快麦ERP销退入库，自建平台自行处理销退入库，在快麦ERP将原始订单关闭或作废\
**方案二**：使用快麦ERP销退入库，在快麦ERP创建售后工单，在快麦ERP中操作退货入仓

#### 1. 方案一对接流程图
![](/img/self_built_platform_after_sale.png)

#### 2. 方案二对接流程图
![](/img/self_built_platform_after_sale2.png)

### 二. 接口说明

#### 1. 方案一接口说明
1. 创建自建平台订单接口（erp.trade.create.new），自建平台请求该接口，可在快麦ERP修改订单的状态为‘TRADE_CLOSED’，将订单改为交易关闭。
2. 订单作废接口（erp.trade.cancle），自建平台请求该接口，可在快麦ERP将发货前的订单作废。
				
#### 2. 方案二接口说明
1. 创建售后工单接口（erp.aftersale.workorder.create），自建平台请求该接口，可在快麦ERP创建售后工单，数据方向为：从自建平台传到快麦ERP。
2. 售后工单查询接口（erp.aftersale.list.query），自建平台请求该接口，可在快麦ERP查询售后工单的状态、详细信息，数据方向为：从快麦ERP传到自建平台。

### 三. 注意事项
1. 创建售后工单接口可以传的售后单类型：未发货仅退款、已发货仅退款、退货、补发、换货、拒收退货。
2. 补发类型的售后单在快麦ERP操作确认退货入仓之后，会创建补发类型的订单，自建平台如需获取补发单需要通过订单查询接口获取。
3. 换货类型的售后单在快麦ERP操作确认退货入仓之后，会创建换货类型的订单，自建平台如需获取换货单需要通过订单查询接口获取。创建售后工单时商品明细需要填写一条退货类型的商品明细填写一条换货类型的商品明细。

---

## 商品业务对接

URL: https://open.kuaimai.com/docs/api/API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/%E5%95%86%E5%93%81%E4%B8%9A%E5%8A%A1%E5%AF%B9%E6%8E%A5
Markdown: https://open.kuaimai.com/__ai/markdown/api/30-API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/30-%E5%95%86%E5%93%81%E4%B8%9A%E5%8A%A1%E5%AF%B9%E6%8E%A5.md

### 一. 对接流程图
此场景适用于商家自研商城、小程序商城、自建平台对接。以下统称为“自建平台”。

![](/img/self_built_platform_goods.png)

### 二. 接口说明

1. 修改/新增普通商品接口（item.general.addorupdate），自建平台请求该接口，在快麦ERP创建系统普通商品，数据方向为：从自建平台传到快麦ERP。
2. 商品相关查询接口，自建平台请求该接口，可获取到商品的详细信息，数据方向为：从快麦ERP传到自建平台。     
	* 查询商品列表（item.list.query）：支持获取商品列表，包括普通商品，套件商品、组合商品、加工商品；
	* 查询单个商品明细（item.single.get）：支持获取指定主商品下的sku商品信息，包括普通商品，套件商品、组合商品、加工商品；
	* 查询多个商品信息V2（erp.item.list.get）：支持获取指定多个主商品下的sku商品信息，包括普通商品，套件商品、组合商品、加工商品；
	* 获取商品SKU列表V2（erp.item.sku.list.get）：支持获取指定主商品下的sku商品列表信息，包括sku商品，含sku套件的套件商品；
	* 获取商品SKU信息（erp.item.single.sku.get）：支持获取指定sku的商品信息，包括sku商品，含sku套件的套件商品。
3. 修改/新增商品V2（erp.item.general.addorupdate）：自建平台请求该接口，在快麦ERP创建系统商品，包括普通商品、加工商品、套件商品、组合商品，数据方向为：从自建平台传到快麦ERP。

---

## 库存业务对接

URL: https://open.kuaimai.com/docs/api/API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/%E5%BA%93%E5%AD%98%E4%B8%9A%E5%8A%A1%E5%AF%B9%E6%8E%A5
Markdown: https://open.kuaimai.com/__ai/markdown/api/30-API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/40-%E5%BA%93%E5%AD%98%E4%B8%9A%E5%8A%A1%E5%AF%B9%E6%8E%A5.md

### 一. 对接流程图
此场景适用于商家自研商城、小程序商城、自建平台对接。以下统称为“自建平台”。

![](/img/self_built_platform_inventory.png)

### 二. 接口说明

1. 修改实际库存接口（erp.item.available.stock.update），自建平台请求该接口，可覆盖快麦ERP商品的实际库存，数据方向为：从自建平台传到快麦ERP。
	> 注意：仅支持快麦ERP的专业版，可以通过该接口修改快麦实际库存，同步更新可用库存。
2. 盘点单库存盘点接口（inventory.sheet.batch.update），自建平台请求该接口，可在快麦ERP创建盘点单进行自动库存盘点覆盖前库存，数据方向为：从自建平台传到快麦ERP。
	> 注意：快麦ERP企业版及以上版本一般建议通过出入仓库单据业务来做库存的增减，如果需要覆盖仓库库存，需要获取到快麦ERP的具体货位信息再调用该接口进行盘点。
3. 查询库存状态接口（stock.api.status.query），自建平台请求该接口，可获取快麦ERP的商品库存状态以及库存信息，数据方向为：从快麦ERP传到自建平台。
4. 查询仓库及商品库存信息接口（erp.item.warehouse.list.get），自建平台请求该接口，可获取商品各个仓库的库存，数据方向为：从快麦ERP传到自建平台。

---

## 库存上传主动通知

URL: https://open.kuaimai.com/docs/api/API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/%E5%BA%93%E5%AD%98%E4%B8%8A%E4%BC%A0%E4%B8%BB%E5%8A%A8%E9%80%9A%E7%9F%A5
Markdown: https://open.kuaimai.com/__ai/markdown/api/30-API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/50-%E5%BA%93%E5%AD%98%E4%B8%8A%E4%BC%A0%E4%B8%BB%E5%8A%A8%E9%80%9A%E7%9F%A5.md

### 一. 对接流程图
此场景适用于商家自研商城、小程序商城、自建平台店铺通过快麦ERP上传库存。以下统称为“自建平台”。

![](/img/self_built_platform_sync_inventory.png)

### 二. 操作说明
1. 导⼊平台商品接⼝：erp.tb.item.import”自建平台请求该接口，在快麦ERP创建自建平台店铺商品到快麦商品对应表，数据方向为：从自建平台传到快麦ERP。
2. ⾃建平台同步到商品对应表的平台商品编码/平台规格编码和快⻨商品档案⾥商品的主商家编码/规格商家编码⼀样即可⾃动匹配
3. ⾃建平台提供店铺商品库存上传链接，将该链接维护到快⻨店铺管理-⾃建平台店铺的“库存同步地址”，如下图所示

![](/img/sync_inventory_address.png)

4. 对接快麦库存上传主动通知接口

   请求头

     | 参数名 | 类型 | 描述 | 必填 |
     | --- | --- | --- | --- |
     | Content-Type | string | appication/json；| charset=utf-8 | 必填 |

   API 接口地址

     | 参数名 | 类型 | 描述 | 必填 |
     | --- | --- | --- | --- |
     | method | string | 取自店铺管理中的“库存同步地址” | 必填 |

   请求参数

     | 参数名 | 类型 | 描述 | 必填 |
     | --- | --- | --- | --- |
     | stockUploadRequestList | StockUploadRequest | 库存上传详情 | 可选 |
     | numIid | String | 商品 | id | 必填 |
     | skuId | String | 规格 | id | 必填 |
     | stockNum | Long | 库存数 | 必填 |

5. ⾃建平台将参数映射好，以上信息配置好即可将快⻨系统商品库存同步到⾃建平台店铺后台

---

## 订单发货主动通知

URL: https://open.kuaimai.com/docs/api/API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/%E8%AE%A2%E5%8D%95%E5%8F%91%E8%B4%A7%E4%B8%BB%E5%8A%A8%E9%80%9A%E7%9F%A5
Markdown: https://open.kuaimai.com/__ai/markdown/api/30-API%E5%9C%BA%E6%99%AF%E8%AF%B4%E6%98%8E/%E8%87%AA%E5%BB%BA%E5%B9%B3%E5%8F%B0/60-%E8%AE%A2%E5%8D%95%E5%8F%91%E8%B4%A7%E4%B8%BB%E5%8A%A8%E9%80%9A%E7%9F%A5.md

### 一. 对接流程图
此场景适用于商家自研商城、小程序商城等自建平台店铺订单在快麦ERP发货后，⽀持回调⾃建平台店铺预留的url，以主动通知的形式下通知⾃建平台订单发货通知消息。
![](/img/self_built_platform_order_sence.png)

### 二. 操作说明
1. ⾃建平台通过“创建⾃建平台订单接⼝：erp.trade.create.new”创建订单到快⻨ERP
2. ⾃建平台发货回调地址维护：⾃建平台店铺管理回调Url填写：把⾃建平台发货回调地址填写到⾃建平台店铺的物流同步地址处，如下图所示
![](/img/self_built_platform_xx.png)

3. ⾃建平台⾃⾏对接快⻨的发货消息通知接⼝：

	3.1 具体对接⽂档如下：

	POST 请求地址/router \
	公共参数\
	调⽤任何⼀个API都必须传⼊的参数，⽬前⽀持的公共参数有：

	| 参数名称       | 参数类型 | 是否必须 | 参数描述                                                                 |
	|----------------|----------|----------|--------------------------------------------------------------------------|
	| method         | string   | 是       | API接口名称                                                             |
	| appKey          | string   | 是       | 分配给应用的AppKey                                                     |
	| timestamp      | string   | 是       | 时间戳，时区为MT+8，例如：2020-09-21 16:58:00。API服务端允许客户端请求最大时间误差为10分钟 |
	| format         | string   | 否       | 响应格式。默认为json格式，可选值：json                                 |
	| version        | string   | 是       | API协议版本 可选值：1.0                                              |
	| sign_method     | string   | 否       | 签名的摘要算法(默认hmac)，可选值为：hmac，md5，hmac-sha256。              |
	| sign           | string   | 是       | 签名                                                                   |

	请求头

	| 参数名        | 类型    | 描述                  | 必填  |
	|---------------|---------|-----------------------|-------|
	| Content-Type   | string  | multipart/form-data | 必填  |

	API接⼝名

	| 参数名     | 类型   | 描述              | 必填 |
	|------------|--------|-------------------|------|
	| method      | string | open.token.refresh | 是   |
	| timestamp   | int    | 请求时间          | 是   |
	| sign        | string | 签名              | 是   |

	请求参数

	| 参数名          | 类型   | 描述                     | 必填 |
	|-----------------|--------|--------------------------|------|
	| sid             | long    | 快麦ERP系统订单号       | 是   |
	| tid             | string  | 平台订单号(创建接口)   | 是   |
	| logistics_out_sid | string  | 物流运单号             | 是   |
	| logistics_code   | string  | 物流编码               | 是   |
	| logistics_name    | string  | 物流公司名字           | 是   |
	| send_date         | string  | 发货时间               | 是   |
	| warehouse_id      | string  | 仓库编码               | 是   |
	| source            | string  | 订单来源               | 是   |
	| ext               | string  | 预留                   | 是   |
	| orders            | list    | 商品列表               | 是   |
	| oid               | long    | 平台⼦订单号           | 是   |
	| sku_outer_id     | string | 商品编码(平台商品编码)           | 是   |
	| sku_id          | string | 平台商品skuId                    | 是   |
	| number          | string | 数量                             | 是   |
	| name            | string | 商品名称                         | 是   |
	| tid             | string | 平台订单号                       | 是   |
	| order_id         | string | 快麦ERP生成的子订单号(逗号分隔) | 是   |

	响应参数

	| 参数名          | 类型   | 描述                     | 必填 |
	|-----------------|--------|--------------------------|------|
	| session         | object | session                | 是   |
	| expiresIn      | long    | 到期时间                 | 是   |
	| companyId      | long    | 关联的企业ID             | 是   |
	| userId         | long    | 关联的用户ID             | 是   |
	| accessToken    | string  | 会话Token                | 是   |
	| refreshToken   | string  | 用来刷新会话的Token       | 是   |

	返回示例
	```
	{
	"session": {
		"expiresIn": 12345,
		"companyId": 12345,
		"accessToken": "zhangsan",
		"userId": 12345,
		"refreshToken": "zhangsan",
		}
	}
	```
	注意事项
	每⼀个⼩时内最多刷新⼀次，不能频刷新，会话已经过期也不⽀持刷新了

4. ⾃建平台订单系统发货后⾃动上传发货通知到自建平台店铺

---

## 退出登录

URL: https://open.kuaimai.com/docs/cli/auth/logout
Markdown: https://open.kuaimai.com/__ai/markdown/cli/auth/logout.md

# 退出登录

```bash
kuaimai-cli auth logout system
kuaimai-cli auth logout open
kuaimai-cli auth logout all
```

会清除 `config.yaml` 中对应授权段。不删除整个 `~/.kuaimai-cli` 目录（域名等配置仍保留）。

---

## 开放平台授权

URL: https://open.kuaimai.com/docs/cli/auth/open
Markdown: https://open.kuaimai.com/__ai/markdown/cli/auth/open.md

# 开放平台授权

官方开放平台 API，凭证（邮件下发）：`appKey`、`appSecret`、`accessToken`、`refreshToken`。

```bash
kuaimai-cli auth login open \
  --app-key "<key>" \
  --app-secret "<secret>" \
  --access-token "<token>" \
  --refresh-token "<token>"
```

PowerShell：

```powershell
kuaimai-cli auth login open `
  --app-key "<key>" `
  --app-secret "<secret>" `
  --access-token "<token>" `
  --refresh-token "<token>"
```

**解锁：** `open call`、`open methods`、`open-base` / `open-item` / `open-trade` / `open-aftersale` / `open-warehouse` / `open-purchase` / `open-kmt` 等。

```bash
kuaimai-cli auth check open --output json
```

---

## 概览

URL: https://open.kuaimai.com/docs/cli/auth/overview
Markdown: https://open.kuaimai.com/__ai/markdown/cli/auth/overview.md

# 鉴权

双通道**分开登录**，命令面分离：

| 通道 | 登录 | 能力 |
|------|------|------|
| [系统授权](./system.md) | `auth login system` | `web call` / `erp-item` / `scm-item` / `api`（经 open-cli 网关） |
| [开放平台](./open.md) | `auth login open` | `open call` / `open-*`（直连开放平台网关） |

- [刷新开放平台会话](./refresh.md)  
- [退出登录](./logout.md)  

```bash
kuaimai-cli auth status --output json
kuaimai-cli auth check system --output json
kuaimai-cli auth check open --output json
```

**Agent 不能代你获取凭证。** 系统 token 请在 ERP **基础 → 权限管理 → 员工** 中自行生成（点击员工卡片钥匙 → **生成 Token**，详见 [系统授权](./system.md)；**以 ERP 实际界面为准**）；开放平台四件套按[接入指南](https://open.kuaimai.com/docs/api/API对接说明/接入指南)邮件下发。

权限模型要点：

- CLI 使用你提供的凭证调用后端，**不能绕过**该凭证在 ERP / 开放平台侧的权限  
- 系统 token 与员工/公司权限相关；通常仅超级管理员可生成；每名员工通常仅可拥有一个 Token  
- 不支持多账号切换；需要换人请 `logout` 后重新 `login`  
- Token 过期或怀疑泄露：在权限管理中删除并重新生成后，再执行 `auth login system`  
- 系统 token 所属 ERP 环境可能与默认 `erp1` 不同；登录/探测遇到 `user/info` `result=903` 时，CLI 会自动对齐 `erp-item.api_url` 与 `webcall_replace.erp`（见 [系统授权](./system.md)）

---

## 刷新授权

URL: https://open.kuaimai.com/docs/cli/auth/refresh
Markdown: https://open.kuaimai.com/__ai/markdown/cli/auth/refresh.md

# 刷新授权

开放平台会话可通过刷新延长（约 30 天；服务端有刷新频控）。

```bash
kuaimai-cli auth refresh open --output json
```

失败时：可能已过期或触发限流 → 重新 `auth login open`，或联系实施。系统授权无对称的 refresh 命令，过期后请在 ERP 权限管理重新生成 Token，再执行 `auth login system`（见 [系统授权](./system.md)）。

---

## 系统授权

URL: https://open.kuaimai.com/docs/cli/auth/system
Markdown: https://open.kuaimai.com/__ai/markdown/cli/auth/system.md

# 系统授权

对应 ERP **页面开放接口**（经 `open-cli` 网关转发）。

## 如何获取系统 accessToken

1. 使用有权限的账号登录快麦 ERP（通常需**超级管理员**）。
2. 进入 **基础 → 权限管理 → 员工**。
3. 在员工树中找到目标员工，点击卡片上的**钥匙**图标，打开「Token 管理」。
4. 点击右上角 **生成 Token**，设置**到期时间**后确认生成。
5. 复制 Token，在本地执行：

```bash
kuaimai-cli auth login system "<accessToken>"
```

入口示例：`https://erp1.superboss.cc/index.html#/base/power/?page=operate`  
（若登录后跳转到其他 ERP 域名，在对应环境打开同一菜单路径即可。）

:::caution
- Token 代表该员工身份，请勿转发或泄露；怀疑泄露请立即删除并重新生成。
- 界面提示通常为：仅超级管理员可操作；每名员工只能拥有一个 Token。
- **操作步骤与按钮文案以 ERP 实际界面为准。**
:::

## 登录与自检

```bash
kuaimai-cli auth login system "<accessToken>"
kuaimai-cli auth check system --output json
kuaimai-cli auth status --output json
```

登录成功后写入 `~/.kuaimai-cli/config.yaml`，并可能探测用户信息（公司 / 员工）。

**解锁：** `capabilities` / `schema` / `web call`、`erp-item`、`scm-item`、`api`。

凭证安全见 [安全说明](../security.md)。

---

## 更新日志

URL: https://open.kuaimai.com/docs/cli/changelog
Markdown: https://open.kuaimai.com/__ai/markdown/cli/changelog.md

# 更新日志

- 当前文档面向稳定版 **`@kuaimai-cli/cli@0.2.40`**（以 npm `latest` 为准）  
- 查看本地版本：`kuaimai-cli --version`  
- 检查更新：`kuaimai-cli upgrade --check-only --output json`  
- Release 与安装包： [Gitee Releases](https://gitee.com/kuaimai-cli/kuaimai-cli/releases)  

### 0.2.40

- 文档：系统 `accessToken` 获取方式改为登录 ERP → **基础 → 权限管理 → 员工** → 员工卡片钥匙 → **生成 Token**（**以 ERP 实际界面为准**）
- 已对齐：`docs/cli/auth/system.md`、quickstart / overview / troubleshooting / refresh / index

### 0.2.27

- `config get` 默认脱敏敏感字段，新增 `--reveal` 查看原文  
- 官网文档拆分为多级目录；明确通道为命令面分离、JSON 信封与退出码按真实行为说明

---

## 配置说明

URL: https://open.kuaimai.com/docs/cli/config
Markdown: https://open.kuaimai.com/__ai/markdown/cli/config.md

# 配置说明

## 路径

| 环境 | 路径 |
|------|------|
| macOS / Linux | `~/.kuaimai-cli/config.yaml` |
| Windows | `%USERPROFILE%\.kuaimai-cli\config.yaml` |

同目录还有 `registry/registry.json` 缓存。配置权限建议 `0600`；**不加密**，勿提交 Git。

## 常用命令

```bash
kuaimai-cli config init
kuaimai-cli config get --output json              # 默认脱敏
kuaimai-cli config get --reveal --output json     # 显示原文，慎用
kuaimai-cli config set <key> <value>
```

示例：

```bash
kuaimai-cli config set "domains.供应链.url" "https://scm3.superboss.cc/"
kuaimai-cli config set shortcuts.erp-item.api_url "https://erp1.superboss.cc/"
kuaimai-cli config set api.gateway_url "https://open-cli.kuaimai.com"
```

## 优先级与范围

- 业务请求使用本地配置中的网关、`domains.*.url`、`shortcuts.*.api_url`  
- `web call` 的 `targetHost`：**本地 domains 优先**，否则 registry `baseUrl`  
- **不支持**多公司 / 多账号 / 多环境切换（单机单套 `auth.system` + `auth.open`）  
- 环境变量：如 `KUAIMAI_CLI_SKIP_REGISTRY_SYNC=1`、安装相关的 `KUAIMAI_CLI_PREFER_MIRROR` 等（以帮助与安装文档为准）  

鉴权字段由 `auth login` / `auth logout` 维护，一般不要手改密钥。更完整的迁移说明见仓库文档 `docs/本地配置与升级迁移.md`。

---

## 全局参数

URL: https://open.kuaimai.com/docs/cli/global-flags
Markdown: https://open.kuaimai.com/__ai/markdown/cli/global-flags.md

# 全局参数

```bash
kuaimai-cli <command> --help
```

| 参数 | 说明 |
|------|------|
| `--output table\|json\|csv\|ndjson` | 输出格式，见 [输出协议](./output-protocol.md) |
| `--dry-run` | 写操作试跑，**不发送业务写请求**，返回预览 |
| `--verbose` | 调试日志（stderr）；请求体敏感字段会脱敏 |
| `--page-all` | 列表接口自动翻页（仅 `pageable:true`；否则忽略并提示） |
| `--page-limit` | `--page-all` 最大条数；`0` 表示不限条数（仍有页数硬上限） |
| `--page-confirm prompt\|yes\|no` | 达阈值时确认策略；非交互环境勿用默认 `prompt` 以免挂起 |

## 分页示例

```bash
kuaimai-cli erp-item +list \
  --page-all \
  --page-limit 5000 \
  --page-confirm yes \
  --output ndjson
```

- 默认不加 `--page-all` 时只取请求中的当前页  
- 硬上限约 **1000 页**；达 `--page-limit` 或阈值可能停止并说明原因  
- 全量拉取可能触发接口限流，生产环境谨慎使用  

## 写操作

```bash
kuaimai-cli erp-item update-title \
  --sys-item-id <id> \
  --title '新标题' \
  --dry-run \
  --output json
```

确认后再去掉 `--dry-run` 执行。规范见 [安全说明](./security.md)。

---

## 快麦CLI

URL: https://open.kuaimai.com/docs/cli
Markdown: https://open.kuaimai.com/__ai/markdown/cli/index.md

# 快麦 CLI

**kuaimai-cli** 面向人与 AI Agent，通过双通道授权操作快麦 ERP / 供应链：商品、铺货、仓储、交易、售后、报表等。

当前稳定版本：`@kuaimai-cli/cli@0.2.27`（以 [npm](https://www.npmjs.com/package/@kuaimai-cli/cli) latest 为准）

## 立即开始

```bash
npx @kuaimai-cli/cli@latest install
kuaimai-cli --version
kuaimai-cli auth login system "<accessToken>"
kuaimai-cli auth check system --output json
kuaimai-cli erp-item +list --body '{"pageNo":1,"pageSize":10}' --output json
```

完整说明（成功/失败现象、是否写业务数据）见 [5 分钟快速开始](./quickstart.md)。

也可用 Agent 安装：把下面指令发给 Cursor / Claude Code 等：

```text
帮我安装快麦 CLI：https://gitee.com/kuaimai-cli/kuaimai-cli/blob/main/docs/KUAIMAI_CLI_INSTALL_GUIDE_AGENT.md
```

## 选择授权通道

两套通道**分开登录、互不替代**，由**不同命令**调用，**不会自动改道**。

| 通道 | 是什么 | 登录后怎么用 | 典型场景 |
|------|--------|--------------|----------|
| **系统授权** | ERP 页面开放接口（与网页同一套后端能力）；Token 在 ERP「基础 → 权限管理 → 员工」生成（以界面为准） | `capabilities` / `schema` / `web call`、`erp-item`、`scm-item` | 商品档案、可铺货商品、铺货、订单审核等 |
| **快麦开放平台** | 官方开放平台 API（邮件下发凭证） | `open call`、`open-*` | 仓库、商品、交易、售后、采购、报表、快麦通等 |

- 只登系统 → 只能调系统侧命令  
- 只登开放平台 → 只能用 `open call` / `open-*`  
- 两边都登时：同类业务**优先选用**开放平台命令；系统侧能力仍走系统命令  
- 暂不支持多账号 / 多应用切换，也不提供 `--via` 强制切通道  

详见 [鉴权说明](./auth/overview.md)。

## 常见使用场景

| 用户意图 | 通道 | 做法 |
|----------|------|------|
| 登录 / 看授权状态 | — | `auth login` / `auth status` / `doctor` |
| 有哪些接口可用 | 系统 | `capabilities` → `schema` → `web call` |
| 查可铺货商品、铺货、铺货日志 | 系统 | `scm-item`（见 Skill） |
| 改 ERP 商品档案标题 | 系统 | `erp-item`（明确「商品档案」时） |
| 查仓库 / 拉开放接口订单 | 开放平台 | `open call` 或 `open-warehouse` / `open-trade` 等 |

## 安全提醒

- 凭证写入 `~/.kuaimai-cli/config.yaml`（权限 `0600`）；勿提交仓库、勿贴进工单或截图  
- 命令行传 token 可能进入 Shell 历史；用完可 `auth logout`  
- `config get` **默认脱敏**；原文需 `config get --reveal`  
- 写操作：定位 → `--dry-run` 预览 → 用户确认 → 再正式执行（Agent 须遵循；CLI 不强制交互确认）  

详见 [安全说明](./security.md)。

## 下一步

- [5 分钟快速开始](./quickstart.md)
- [安装与升级](./install.md)
- [鉴权](./auth/overview.md)
- [配置说明](./config.md)
- [输出格式与错误码](./output-protocol.md)
- [全局参数](./global-flags.md)
- [Agent Skills](./skills.md)
- [故障排查](./troubleshooting.md)
- [更新日志](./changelog.md)

---

## 安装与升级

URL: https://open.kuaimai.com/docs/cli/install
Markdown: https://open.kuaimai.com/__ai/markdown/cli/install.md

# 安装与升级

## 环境要求

- **操作系统**：macOS / Linux / Windows  
- **Node.js**：推荐 **20 或 22 LTS**；最低兼容 **16**（16 已停止安全维护，建议升级）  
- **npm**：随 Node 安装即可  

### 平台兼容矩阵

| 操作系统 | amd64 | arm64 | 备注 |
|----------|:-----:|:-----:|------|
| macOS | 支持 | 支持 | Intel 与 Apple Silicon |
| Linux | 支持 | 支持 | 常见发行版；依赖常规 glibc 环境 |
| Windows | 支持 | **不支持** | 当前仅提供 amd64；可用 WSL |

另支持：非交互 CI（跳过安装向导）、容器（需能下载二进制）、Windows 下 PowerShell / CMD。

## 安装

### 方式一：一键安装

```bash
npx @kuaimai-cli/cli@latest install
```

交互环境可能弹出授权向导（可稍后登录）。CI / 非 TTY 会跳过向导。

### 方式二：Agent 安装

```text
帮我安装快麦 CLI：https://gitee.com/kuaimai-cli/kuaimai-cli/blob/main/docs/KUAIMAI_CLI_INSTALL_GUIDE_AGENT.md
```

### 固定版本

```bash
npm install -g @kuaimai-cli/cli@0.2.27
```

## 升级

```bash
kuaimai-cli upgrade
# 仅检查是否有新版本
kuaimai-cli upgrade --check-only --output json
# 或
npx @kuaimai-cli/cli@latest install
```

查看版本：`kuaimai-cli --version`

## 卸载

```bash
npm uninstall -g @kuaimai-cli/cli
```

可选手动删除（先备份）：

```text
~/.kuaimai-cli/          # 配置与 registry 缓存
~/.agents/skills/        # 若曾安装到该目录
~/.cursor/skills/        # 若曾安装到 Cursor
```

默认不会自动清理上述目录。

## 网络依赖

安装时大致顺序：

1. 从 **Gitee Releases** 下载 Go 二进制  
2. Gitee 不可用时回退 **npmmirror**  
3. 校验 **checksum**  

可能访问的主机：

```text
registry.npmjs.org（或你配置的 npm registry）
gitee.com
registry.npmmirror.com
快麦 ERP / SCM 业务域名（运行时）
open-cli.kuaimai.com（系统网关 / registry）
gw.superboss.cc（开放平台）
```

企业网络需放行上述域名；可用代理时配置系统/ npm 代理。Gitee 失败时可试：

```bash
KUAIMAI_CLI_PREFER_MIRROR=1 npx @kuaimai-cli/cli@latest install
```

## Shell 补全

```bash
kuaimai-cli completion bash
kuaimai-cli completion zsh
kuaimai-cli completion powershell
```

将输出写入 shell 补全目录并重新加载（以本机 bash-completion / zsh fpath 习惯为准）。例如 zsh：

```bash
mkdir -p ~/.zfunc
kuaimai-cli completion zsh > ~/.zfunc/_kuaimai-cli
# 在 ~/.zshrc 中确保：fpath=($HOME/.zfunc $fpath) 且已 compinit
```

---

## 开放平台调用

URL: https://open.kuaimai.com/docs/cli/open-call
Markdown: https://open.kuaimai.com/__ai/markdown/cli/open-call.md

# 开放平台调用

需已 [开放平台授权](./auth/open.md)。

```bash
kuaimai-cli open call <method> --params '{}' --output json
kuaimai-cli open methods [--domain] --output json

# 示例
kuaimai-cli open call erp.warehouse.list.query --params '{}' --output json
kuaimai-cli open-base +erp-warehouse-list-query --params '{}' --output json
```

业务域 shortcuts 前缀：`open-base`、`open-item`、`open-trade`、`open-aftersale`、`open-warehouse`、`open-purchase`、`open-kmt` 等。

开放平台调用**不走** registry `web call`，与系统通道命令面分离。

---

## 输出格式与错误码

URL: https://open.kuaimai.com/docs/cli/output-protocol
Markdown: https://open.kuaimai.com/__ai/markdown/cli/output-protocol.md

# 输出格式与错误码

面向 Agent / 脚本时，请以 `--output json` 的信封为准。

## 输出格式

| 格式 | 适用场景 |
|------|----------|
| `table` | 人工查看（默认） |
| `json` | Agent、脚本 |
| `csv` | 导入 Excel |
| `ndjson` | 流式 / 大批量列表 |

```bash
kuaimai-cli auth status --output json
kuaimai-cli erp-item +list --body '{"pageNo":1,"pageSize":10}' --output ndjson
```

## JSON 信封（当前契约）

成功示例：

```json
{
  "ok": true,
  "data": { }
}
```

失败示例：

```json
{
  "ok": false,
  "error": "错误说明",
  "hint": "建议下一步"
}
```

| 字段 | 说明 |
|------|------|
| `ok` | `true` 成功 / `false` 失败 |
| `data` | 成功时的业务数据；失败时通常省略 |
| `error` | **字符串**错误信息（非对象） |
| `hint` | 可选建议 |
| `_notice` | 可选，升级等提示 |

兼容承诺：在未发重大版本说明前，保留 `ok` / `data` / `error` / `hint` 字段含义；`error` 保持为字符串。

列表分页字段随具体接口 `data` 结构返回（如 `pageNo` / `pageSize` / `total`），以 `schema` 与实际响应为准。

## 退出码

| 退出码 | 含义 |
|-------|------|
| `0` | 执行成功 |
| 非 `0` | 执行失败（常见为 `1`） |
| `2` | 可能为参数解析错误（依赖底层 flag 行为） |

当前**未**细分鉴权失败 / 网络错误等专用退出码。脚本请同时检查退出码与 JSON 的 `ok`。

## stdout / stderr

- **stdout**：业务输出（`--output json` 时应为可解析 JSON）  
- **stderr**：日志、友好提示、升级通知等  
- `--verbose` 的调试信息走日志通道，解析 JSON 时请只读 stdout  

## 分页相关全局参数

见 [全局参数](./global-flags.md)。

---

## 快速开始

URL: https://open.kuaimai.com/docs/cli/quickstart
Markdown: https://open.kuaimai.com/__ai/markdown/cli/quickstart.md

# 5 分钟快速开始

下列步骤可直接复制执行。前 4 步不产生业务写操作；第 5 步为**只读列表**查询。

## 1. 安装

```bash
npx @kuaimai-cli/cli@latest install
```

| | |
|--|--|
| **成功** | 终端出现安装完成；之后可执行 `kuaimai-cli` |
| **失败时检查** | 是否已装 Node.js（推荐 20/22 LTS，最低兼容 16）；网络能否访问 npm / Gitee / npmmirror；见 [安装与升级](./install.md)、[故障排查](./troubleshooting.md) |
| **下一步** | 确认版本 |

## 2. 确认版本

```bash
kuaimai-cli --version
```

| | |
|--|--|
| **成功** | 打印版本号（如 `0.2.27`） |
| **失败** | `command not found` → PATH / 重装；见故障排查 |
| **下一步** | 登录系统授权 |

## 3. 系统授权登录

在 ERP **基础 → 权限管理 → 员工** 中，点击目标员工卡片的**钥匙**图标，打开「Token 管理」，点击 **生成 Token**（设置到期时间后确认），复制 Token。完整步骤见 [系统授权](./auth/system.md)（**操作以 ERP 实际界面为准**）。

```bash
kuaimai-cli auth login system "<accessToken>"
```

| | |
|--|--|
| **成功** | 写入配置；可能自动探测公司/员工信息 |
| **失败** | token 无效/过期 → 回到权限管理重新生成后再登录；见 [系统授权](./auth/system.md) |
| **是否写业务数据** | 否，仅本地配置 + 探测用户信息 |
| **下一步** | 自检登录态 |

:::caution 凭证安全
命令行参数可能进入 Shell 历史与进程列表。用完后可 `kuaimai-cli auth logout system`。更多见 [安全说明](./security.md)。
:::

## 4. 检查系统授权

```bash
kuaimai-cli auth check system --output json
```

| | |
|--|--|
| **成功** | JSON 中 `ok: true`，含用户/公司信息 |
| **失败** | `ok: false`，读 `error` / `hint`；401/403 见故障排查 |
| **下一步** | 执行第一条只读命令 |

（可选）同时登录开放平台，见 [开放平台授权](./auth/open.md)。

## 5. 第一条命令（只读）

```bash
kuaimai-cli erp-item +list \
  --body '{"pageNo":1,"pageSize":10}' \
  --output json
```

| | |
|--|--|
| **成功** | `ok: true`，`data` 中含列表 |
| **失败** | 未登录 / 无权限 / 域名未配置 → `auth status`、`doctor`、[故障排查](./troubleshooting.md) |
| **是否写业务数据** | **否**（列表查询） |

PowerShell 续行请用反引号 `` ` ``，或写成单行。

## 常用自检

```bash
kuaimai-cli doctor --output json
kuaimai-cli auth status --output json
```

---

## 安全说明

URL: https://open.kuaimai.com/docs/cli/security
Markdown: https://open.kuaimai.com/__ai/markdown/cli/security.md

# 安全说明

## 凭证风险

`auth login` 将凭证写入 `~/.kuaimai-cli/config.yaml`（文件权限 `0600`）。通过命令行参数传入的 token / secret 可能出现在：

- Shell 历史  
- 本机进程列表  
- 终端截图与 Agent 会话记录  
- CI 日志  

请做到：

- 不要把凭证提交到代码仓库  
- 不要把真实凭证贴进工单或发给他人  
- 不要发送含完整凭证的截图  
- 工单可附带：`doctor` / `auth status`（脱敏后）与报错信息；**禁止**附带 `--reveal` 输出  

## 查看与清除

```bash
# 默认脱敏
kuaimai-cli config get --output json
kuaimai-cli auth status --output json

# 需要原文时（慎用）
kuaimai-cli config get --reveal --output json

# 退出并清除本地凭证
kuaimai-cli auth logout system
kuaimai-cli auth logout open
# 或
kuaimai-cli auth logout all
```

配置文件**当前不加密**（依赖本机文件权限）。`--verbose` 对请求体会做敏感字段脱敏，但仍避免在共享环境打开完整调试日志。

凭证泄露后：在 ERP / 开放平台侧**撤销或轮换** token / 应用密钥，并本地 `auth logout` 后重新登录。

## 写操作保护

| 类型 | 建议流程 |
|------|----------|
| 查询 | 可直接执行 |
| 写操作 | 定位目标 → 展示方案 → `--dry-run` 预览 → 用户确认 → 正式执行 → 查看成功/失败明细 |

- 带 `write:true` 的接口与写 shortcut 支持全局 `--dry-run`：试跑时**不发送业务写请求**，返回预览信息  
- Agent **应**二次确认；CLI **不**强制交互确认（便于 CI/脚本）  
- 部分业务可能部分成功；失败时按接口返回处理，必要时用只读命令核对状态  

不可逆操作（删除、正式铺货提交等）务必 dry-run 并人工确认。批量规模受接口与 `--page-limit` 等约束，避免一次过大。

## Agent 约定

详见仓库 Skill：`kuaimai-shared` / `kuaimai-erp-item` / `kuaimai-scm-item`。安装：`kuaimai-cli skill install`。

---

## Agent Skills

URL: https://open.kuaimai.com/docs/cli/skills
Markdown: https://open.kuaimai.com/__ai/markdown/cli/skills.md

# Agent Skills

Skill 是给 AI Agent 阅读的操作说明（安装、鉴权、商品/铺货等约定），不是另一套 API。

## 命令

```bash
kuaimai-cli skill list
kuaimai-cli skill install
kuaimai-cli skill install --if-stale
kuaimai-cli skill install --force
```

- 优先从 npm 包内置 `skills/` 复制，失败时回退 Gitee  
- `--force` 覆盖已有文件；升级 CLI 后建议 `skill install --force` 并**重开 Agent 会话**  
- 安装目录因 Agent 而异（如 `~/.cursor/skills/`、`~/.agents/skills/` 等，以实际安装输出为准）  

## 写操作

Skill 要求：写操作先 `--dry-run`，向用户展示方案并确认后再执行。CLI 本身不强制交互确认。

主要 Skill：`kuaimai-shared`、`kuaimai-erp-item`、`kuaimai-scm-item`。

---

## 故障排查

URL: https://open.kuaimai.com/docs/cli/troubleshooting
Markdown: https://open.kuaimai.com/__ai/markdown/cli/troubleshooting.md

# 故障排查

## 诊断命令

```bash
kuaimai-cli doctor --output json
kuaimai-cli auth status --output json
kuaimai-cli auth check system --output json
kuaimai-cli auth check open --output json
kuaimai-cli --verbose <command>
```

提交工单时建议附带：CLI 版本、`doctor` / `auth status` 的 JSON（**不要** `--reveal`）、报错原文、操作系统与 Node 版本。  
**禁止**提交：完整 accessToken、appSecret、refreshToken、含凭证的截图。

## 安装问题

| 现象 | 处理 |
|------|------|
| `kuaimai-cli: command not found` | 确认全局 npm bin 在 `PATH`；重新 `npx @kuaimai-cli/cli@latest install` |
| 未安装 Node / npm | 安装 Node.js（推荐 20/22 LTS） |
| Node 版本过低 | 升级到 ≥16，建议 20+ |
| 安装二进制失败 / Gitee 超时 | 检查网络；`KUAIMAI_CLI_PREFER_MIRROR=1` 优先镜像；见 [安装](./install.md) |
| checksum 失败 | 勿跳过校验；换网络重试或固定版本重装 |
| npm registry 异常 | 检查 `npm config get registry` |

## 鉴权问题

| 现象 | 处理 |
|------|------|
| 系统侧 401 | token 无效或过期 → 在 ERP「基础 → 权限管理 → 员工」重新生成 Token 后执行 `auth login system`（以界面为准） |
| 系统侧 403 | 账号无接口权限 → 在 ERP 调整员工/角色权限，或联系管理员 |
| 开放平台凭证错误 | 核对四件套；重新 `auth login open` |
| `auth refresh open` 失败 | 会话过期或触达刷新限流 → 重新登录或联系实施 |
| 不确定登了没 | `auth status` / `doctor` |

## 接口调用问题

| 现象 | 处理 |
|------|------|
| registry 拉取失败 | 检查 `registry.source` 与网络；`registry sync` |
| 找不到 apiId | `capabilities` 确认是否已发布；勿手写 URL |
| 参数格式错误 | `schema <apiId>` 核对后用 `--params` / `--body` |
| 成功但数据为空 | 核对筛选条件与权限；不一定是故障 |
| 代理 / 公司证书 | 配置系统信任证书与代理；`--verbose` 看请求失败原因 |

## 输出解析

若脚本解析 JSON 失败：确认使用了 `--output json`，且只解析 **stdout**（stderr 可能有提示）。见 [输出协议](./output-protocol.md)。

---

## 系统接口调用

URL: https://open.kuaimai.com/docs/cli/web-call
Markdown: https://open.kuaimai.com/__ai/markdown/cli/web-call.md

# 系统接口调用

需已 [系统授权](./auth/system.md)。

```bash
# 列出已发布 apiId
kuaimai-cli capabilities --output json

# 查看入参出参
kuaimai-cli schema <apiId> --output json

# 调用
kuaimai-cli web call <apiId> --params '{"k":"v"}'   # get_query
kuaimai-cli web call <apiId> --data '{"k":"v"}'    # post_json / post_form
kuaimai-cli web call <apiId> --body '{"k":"v"}'    # 按 contentType 路由

# 手动同步 registry
kuaimai-cli registry sync --output json
```

Curated shortcuts：`erp-item`、`scm-item`（商品档案 vs 可铺货商品口径以 Skill 为准）。

registry 未覆盖时可用 `kuaimai-cli api ...` 作为最后手段。跳过自动同步：`KUAIMAI_CLI_SKIP_REGISTRY_SYNC=1`。

---

## 关于快麦开放平台技术支持渠道调整的通知

URL: https://open.kuaimai.com/docs/question/%E7%B3%BB%E7%BB%9F%E5%85%AC%E5%91%8A/%E5%85%B3%E4%BA%8E%E5%BF%AB%E9%BA%A6%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0%E6%8A%80%E6%9C%AF%E6%94%AF%E6%8C%81%E6%B8%A0%E9%81%93%E8%B0%83%E6%95%B4%E7%9A%84%E9%80%9A%E7%9F%A5
Markdown: https://open.kuaimai.com/__ai/markdown/question/0-%E7%B3%BB%E7%BB%9F%E5%85%AC%E5%91%8A/%E5%85%B3%E4%BA%8E%E5%BF%AB%E9%BA%A6%E5%BC%80%E6%94%BE%E5%B9%B3%E5%8F%B0%E6%8A%80%E6%9C%AF%E6%94%AF%E6%8C%81%E6%B8%A0%E9%81%93%E8%B0%83%E6%95%B4%E7%9A%84%E9%80%9A%E7%9F%A5.md

# 关于快麦开放平台技术支持渠道调整的通知

## 📢 关于快麦开放平台技术支持渠道调整的通知

尊敬的合作伙伴：

您好！

感谢您长期以来对快麦开放平台的信任与支持。为持续提升服务质量与响应效率，现就技术支持渠道的调整事项通知如下，敬请知悉并配合。

### 一、渠道调整说明

为规范服务流程、保障问题处理的可追溯性与时效性，自本通知发布之日起，快麦开放平台的技术支持渠道将进行如下调整：

将启用快麦工单系统为您提供开放平台问题咨询服务

工单系统可实现问题的分类受理、进度可查、全程留档 ，为您提供更规范、更高效安全的服务体验。原钉钉服务群将在7月16日后逐步停止受理技术类咨询，敬请提前切换至工单平台，以免影响您的业务处理。

### 二、开发者中心使用指引

为便于您顺利完成账号注册与问题提交，特将开发者中心的使用流程说明如下：

1.  注册开放平台账号
    
    如您尚未注册开放平台账号，请在登录页点击【 注册 】，按页面指引完成账号创建。
    
2.  登录开发者中心
    
    注册完成后，请返回登录页面，使用注册账号与密码登录，即可进入开发者中心。
    
3.  提交工单获取技术支持
    

登录后，请点击【 提交新工单 】，并按提示填写以下内容，以便我们更高效地为您服务：

*   问题类型（接入咨询 / 异常反馈 / 功能建议等）
    
*   涉及接口或业务模块
    
*   问题描述及复现步骤
    
*   相关截图或日志（如有） 工单提交后，我们的技术团队将及时受理并跟进处理，您可在工单系统中实时查看处理进度。
    

### 三、温馨提示

*   即日起， 技术类问题请统一通过工单平台提交 ，以便集中受理与跟踪；
    
*   请妥善保管账号信息，避免账号外泄带来的安全风险；
    
*   如在切换过程中遇到任何问题，欢迎通过工单系统与我们联系。 我们将持续优化平台能力与服务体验，与您携手共建更加稳定、高效的开放生态。
    

再次感谢您的理解与支持！

快麦开放平台团队 敬启

---

## 拼多多订单信息开放改造公告

URL: https://open.kuaimai.com/docs/question/%E7%B3%BB%E7%BB%9F%E5%85%AC%E5%91%8A/%E6%8B%BC%E5%A4%9A%E5%A4%9A%E8%AE%A2%E5%8D%95%E4%BF%A1%E6%81%AF%E5%BC%80%E6%94%BE%E6%94%B9%E9%80%A0%E5%85%AC%E5%91%8A
Markdown: https://open.kuaimai.com/__ai/markdown/question/0-%E7%B3%BB%E7%BB%9F%E5%85%AC%E5%91%8A/%E6%8B%BC%E5%A4%9A%E5%A4%9A%E8%AE%A2%E5%8D%95%E4%BF%A1%E6%81%AF%E5%BC%80%E6%94%BE%E6%94%B9%E9%80%A0%E5%85%AC%E5%91%8A.md

# 拼多多订单信息开放改造公告

尊敬的快麦开放平台用户：

您好！

【拼多多】平台针对全部服务商推出最新安全规范，快麦已对订单查询及销售出库单接口进行改造。指导原则为erp产商不能通过自建开放平台透出通过拼多多开放平台接口抓取到的数据字段。如有相关更详细的需求，可以注册成为拼多多自研开发者。可参考拼多多开放平台对接指南注册后，通过拼多多开放平台获取相关订单数据：

拼多多注册指南跳转链接：[https://open.pinduoduo.com/application/document/browse?idStr=04DD98845AD2977D](https://open.pinduoduo.com/application/document/browse?idStr=04DD98845AD2977D)

| **接口名称** | **核心变更点** |
| --- | --- |
| erp.trade.list.query <br> **订单查询(非淘系,拼多多)** | 该接口不再返回拼多多平台所有数据 |
| erp.trade.outstock.simple.query <br> **销售出库查询** | 该接口针对拼多多平台将屏蔽和替换平台相关字段，详细数据可见下表：销售出库单接口字段改造列表 |

附件一：销售出库单接口改造字段列表

| **主表：list** |  |  |  |  |
| --- | --- | --- | --- | --- |
| **参数名** | **类型** | **描述** | **必填** | **改造说明** |
| receiverCountry | string | 收件国家，跨境订单使用（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| receiverState | string | 收件省份（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| receiverCity | string | 收件市（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| receiverDistrict | string | 收件区县（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| receiverStreet | string | 收件街道（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| receiverAddress | string | 收件详细地址（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| receiverZip | string | 收件邮编（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| receiverMobile | string | 收件人手机号（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| receiverName | string | 收件人姓名（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| receiverPhone | string | 收件人固话（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| buyerNick | string | 平台订单上的买家昵称（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| postFee | string | 邮费：合单的话，取的是主单的邮费（拼多多订单不返回） |  | 拼多多不返回该字段 |
| payment | string | 实付金额（单位：元）（拼多多订单不返回） |  | 拼多多不返回该字段 |
| buyerTaxNo | string | 买家税号 |  | 拼多多不返回该字段 |
| status | string | 订单的平台状态（拼多多订单不返回） |  | 拼多多不返回该字段 |
| paymentDiff | double | 订单差额 = 系统实付金额 - 平台实收金额 区间值（拼多多订单不返回） |  | 拼多多不返回该字段 |
| taxFee | string | 税费（拼多多订单不返回） |  | 拼多多不返回该字段 |
| buyerMessage | string | 平台订单上的买家留言（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| unifiedStatus | string | 各平台状态映射后的统一状态（拼多多订单不返回） |  | 拼多多不返回该字段 |
| modified | long | 订单在平台上的修改时间（拼多多订单不返回） |  | 拼多多不返回该字段 |
| ptConsignTime | long | 平台发货时间（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| tid | string | 平台订单号 |  | 拼多多不返回该字段 |
| invoiceName | string | 发票抬头（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| invoiceRemark | string | 发票备注（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| invoiceFormat | integer | 发票类型 1 普通 2 增值 |  | 拼多多不返回该字段 |
| invoiceType | string | 发票类型 |  | 拼多多不返回该字段 |
| invoiceKind | string | 发票种类（ 1 电子发票 2 纸质发票 ）（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| taobaoId | long | 平台的卖家账户（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| sellerMemo | string | 平台上的卖家备注（拼多多订单不返回） |  | 拼多多不返回该字段 |
| acPayment | string | 不变的实付金额（拼多多订单不返回） |  | 拼多多不返回该字段 |
| sellerFlag | long | 平台上的卖家旗帜：0: 灰，1: 红，2: 黄，3: 绿，4: 蓝，5: 紫，6: 橙，7: 浅蓝，8: 浅粉，9: 深绿，10: 桃红（拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| payAmount | string | 订单买家已付金额（单位：元）（拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| selfBuiltPaymentReceivable | string | 代收金额（拼多多订单不返回） |  | 拼多多不返回该字段 |
| selfBuiltDepositAmount | string | 定金（拼多多订单不返回） |  | 拼多多不返回该字段 |
| selfBuiltPayment | string | 货到付款总金额（拼多多订单不返回） |  | 拼多多不返回该字段 |
| tradeInvoice | object | 订单发票信息（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| govSubsidyInfo | object | 国补信息（拼多多订单不返回） |  | 拼多多不返回该字段 |
| subShop | object | 子店铺信息（拼多多订单不返回） |  | 拼多多不返回该字段 |
| **子表：list/subShop** |  |  |  |  |
| **参数名** | **类型** | **描述** | **必填** | **改造说明** |
| id | long | 子店铺 ID |  | 拼多多不返回该字段 |
| shopName | string | 店铺名称 |  | 拼多多不返回该字段 |
| platformCode | string | 所属平台编码 |  | 拼多多不返回该字段 |
| shopCode | string | 店铺编码 |  | 拼多多不返回该字段 |
| logisticsCode | string | 物流商编码 |  | 拼多多不返回该字段 |
| **子表：list/orders** |  |  |  |  |
| **参数名** | **类型** | **描述** | **必填** | **改造说明** |
| tid | string | 所属订单的平台编号 |  | 拼多多不返回该字段 |
| endTime | long | 子订单的交易结束时间 |  | 拼多多不返回该字段 |
| modified | long | 子订单平台的修改时间 |  | 拼多多不返回该字段 |
| numIid | string | 平台商品数字编号 |  | 拼多多替换为系统主商品 ID |
| payment | string | 实付金额，公式：实付金额 = 应付金额 - 优惠金额（单位：元） |  | 拼多多不返回该字段 |
| outerSkuId | string | outer\_sku\_id （拼多多替换为系统商品编码） |  | 拼多多替换为系统商品编码 |
| skuId | string | 平台规格编号 |  | 拼多多替换为系统SKUID |
| taobaoId | long | 订单店铺的平台 ID（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| picPath | string | 平台商品图片链接 |  | 拼多多替换为系统商品图片链接 |
| oldStatus | string | 子订单旧的平台状态，不做持久化，一般用于订单同步更新时的判断比较 （拼多多订单不返回） |  | 拼多多不返回该字段 |
| status | string | 子订单平台状态 （拼多多订单不返回） |  | 拼多多不返回该字段 |
| soid | string | 子订单平台编号（由于某些平台的子订单号为字符类型，需要用此字段保存，后续可将 oid 修改为 String 类型）（拼多多订单不返回） |  | 拼多多不返回该字段 |
| refundStatus | string | 子订单退款状态：CLOSED：退款关闭 NO\_REFUND：未退款 SELLER\_CONTINUE\_CONSIGN：卖家已发货退款 SELLER\_REFUSE\_BUYER：卖家拒绝退款 WAIT\_SELLER\_AGREE：待卖家同意退款 WAIT\_BUYER\_RETURN\_GOODS：待买家退货 WAIT\_SELLER\_CONFIRM\_GOODS：待卖家确认收货 SUCCESS：退款成功 |  | 拼多多不返回该字段 |
| oid | long | 子订单平台编号 (淘宝有，京东没有，拼多多不返回) |  | 拼多多不返回该字段 |
| title | string | 平台商品名称 |  | 拼多多替换为系统商品的标题 |
| acPayment | string | 不变的实付金额，进来后不变 |  | 拼多多不返回该字段 |
| postFee | string | 单笔订单运费（拼多多订单不返回） |  | 拼多多不返回该字段 |
| payAmount | string | 商品买家已付金额（单位：元）（拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| ptConsignTime | long | 平台发货时间（淘系、拼多多订单不返回） |  | 拼多多不返回该字段 |
| totalFee | string | 应付金额，公式：应付金额 = 商品数量 \* 商品单价 + 手工调整价 |  | 拼多多不返回该字段 |
| estimateConTime | long | 预计发货时间 （拼多多订单不返回） |  | 拼多多不返回该字段 |
| refundId | string | 平台退款编号 （拼多多订单不返回） |  | 拼多多不返回该字段 |
| divideOrderFee | string | 平台实付 (平台分摊之后的实付金额)（单位：元） | 必填 | 拼多多不返回该字段 |
| **子表：list/orders/suits** |  |  |  |  |
| **参数名** | **类型** | **描述** | **必填** | **改造说明** |
| numIid | string | 平台商品数字编号 |  | 拼多多替换为系统主商品 ID |
| outerSkuId | string | 外部 skuID | 必填 | 拼多多替换为系统SKUID |
| payAmount | string | 商品买家实付金额 （拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| tid | string | 所属订单的平台编号 | 必填 | 拼多多不返回该字段 |
| modified | long | 子订单平台的修改时间 | 必填 | 拼多多不返回该字段 |
| payment | string | 实付金额，公式：实付金额 = 应付金额 - 优惠金额（拼多多不返回） | 必填 | 拼多多不返回该字段 |
| skuId | string | 平台规格编号 | 必填 | 拼多多替换为系统SKUID |
| taobaoId | long | 订单店铺的平台 ID （拼多多不返回） | 必填 | 拼多多不返回该字段 |
| picPath | string | 平台商品图片链接 | 必填 | 拼多多替换为系统商品图片链接 |
| status | string | 子订单平台状态（拼多多不返回） | 必填 | 拼多多不返回该字段 |
| refundStatus | string | 子订单退款状态（拼多多不返回） | 必填 | 拼多多不返回该字段 |
| oid | long | 子订单平台编号 (淘宝有，京东没有、拼多多不返回）) | 必填 | 拼多多不返回该字段 |
| title | string | 商品标题 | 必填 | 拼多多替换系统商品标题 |
| divideOrderFee | string | 平台实付 (平台分摊之后的实付金额) | 必填 | 拼多多不返回该字段 |
| ptConsignTime | long | 平台发货时间 | 必填 | 拼多多不返回该字段 |
| totalFree | string | 应付金额，公式：应付金额 = 商品数量 \* 商品单价 + 手工调整价 | 必填 | 拼多多不返回该字段 |
| **子表：list/tradeInvoice** |  |  |  |  |
| **参数名** | **类型** | **描述** | **必填** | **改造说明** |
| invoiceType | string | 发票抬头类型：1 个人、2 企业（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| invoiceKind | string | 发票类型：发票种类 1 纸质普通 2 纸质专票 3 电子普通 4 电子专票（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| invoiceName | string | 发票抬头（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| buyerTaxNo | string | 买家税号（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| invoiceRemark | string | 发票备注（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| buyerAddress | string | 购方地址（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| buyerPhone | string | 购方电话（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| buyerBank | string | 购方开户行（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| buyerBankAccount | string | 购方开户行账号（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| invoiceAmount | string | 开票金额（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| email | string | 邮箱（淘系、拼多多订单不返回） | 必填 | 拼多多不返回该字段 |
| **子表：list/govSubsidyInfo** |  |  |  |  |
| **参数名** | **类型** | **描述** | **必填** | **改造说明** |
| subShopId | string | 子店铺 id（拼多多不返回） |  | 拼多多不返回该字段 |
| subShopName | string | 子店铺名称（拼多多不返回） |  | 拼多多不返回该字段 |
| govSubsidyAmount | string | 国家补贴金额（拼多多不返回） |  | 拼多多不返回该字段 |
| govSubsidyDetail | string | 订单国补详情数据（json 字符串存储，业务方根据平台不同逻辑自行解析取想要的字段做业务，拼多多不返回） |  | 拼多多不返回该字段 |

---

## 拼多多自研接口接入开放公告

URL: https://open.kuaimai.com/docs/question/%E7%B3%BB%E7%BB%9F%E5%85%AC%E5%91%8A/%E6%8B%BC%E5%A4%9A%E5%A4%9A%E8%87%AA%E7%A0%94%E6%8E%A5%E5%8F%A3%E6%8E%A5%E5%85%A5%E5%BC%80%E6%94%BE%E5%85%AC%E5%91%8A
Markdown: https://open.kuaimai.com/__ai/markdown/question/0-%E7%B3%BB%E7%BB%9F%E5%85%AC%E5%91%8A/%E6%8B%BC%E5%A4%9A%E5%A4%9A%E8%87%AA%E7%A0%94%E6%8E%A5%E5%8F%A3%E6%8E%A5%E5%85%A5%E5%BC%80%E6%94%BE%E5%85%AC%E5%91%8A.md

# 拼多多自研接口接入开放公告

尊敬的快麦开放平台用户：​

您好！​

因拼多多平台业务合规升级要求，现平台要求用户**获取快麦ERP里拼多多订单数据的唯一渠道**：需统一接入其 “方舟 ERP - 自研数据传输场景”。我方已完成该场景及配套接口的适配工作，现正式启动从原 ERP 开放平台到拼多多平台对接的切换，并向各位客户开放新对接通道。为避免影响拼多多订单信息正常获取，请当前有需求用户尽快切换对接。

拼多多平台公告跳转链接：(https://open.pinduoduo.com/application/document/announcement?id=350)

具体接入流程说明如下：

**（****1****）申请注册方舟开发者应用**

参考以下商家自研接入流程申请注册成为拼多多开发者账号：

商家自研接入流程链接：[https://open.pinduoduo.com/application/business/list?role=business&activeKey=1&alias=pop-registration](https://open.pinduoduo.com/application/business/list?role=business&activeKey=1&alias=pop-registration)

**（2）申请注册快麦开放平台appkey**

通过服务贵方的快麦实施或者快麦商务内部提交申请，申请通过后可在快麦开放平台值班群内找值班产品按“快麦开放平台appkey+client\_id提交信息

**（3）双向方舟client\_id绑定**

在快麦核实您的appkey及client\_id信息后，会给您快麦ERP拼多多放在的client\_id。您需要按【方舟 ERP-自研数据传输场景 接入指南】的说明，将快麦ERP拼多多client\_id绑定在您自身的拼多多方舟应用中。（同时快麦也会将您提交的client\_id绑定在快麦拼多多放在应用中）

方舟 ERP-自研数据传输场景 接入指南链接：[https://open.pinduoduo.com/application/document/browse?idStr=1E4B7F919EC480E8](https://open.pinduoduo.com/application/document/browse?idStr=1E4B7F919EC480E8)

**（4）方舟自研接口调用**

以上准备完毕后，您可以按【方舟数据传输接口】的请求说明进行数据请求联调。

方舟数据传输接口链接：

[https://open.pinduoduo.com/application/document/api?id=pdd.erp.order.list.get](https://open.pinduoduo.com/application/document/api?id=pdd.erp.order.list.get)

**（5）接入特殊说明：**

1.方舟传输接口-请求参数"sid"字段需按快麦加密方式，拼接加密签名填入。快麦会对该字段进行验签，验签通过的才会返回数据。

具体加密签名如下：

sid 传入appKey$session$sign

appKey, session ，appSecret 在快麦开放平台申请审核通过后颁发， 

sign 为 MD5(appSecret+appKey+timestamp+appSecret)

例：appKey=111， session =abc，appSecret=222 timestamp= 1761616517

sign = MD5(222111abc1761616517222)   MD5结果值：F959604193D19FF22606A935765FDC74

sid : 111$abc$F959604193D19FF22606A935765FDC74

2.订单列表查询接口，ERP订单状态需按快麦订单状态请求，请求枚举如下

erp\_order\_status ERP订单状态说明

| 状态 | 原ERP状态码 | 状态码 |
| --- | --- | --- |
| 待付款 | WAIT\_BUYER\_PAY | 10 |
| 待审核 | WAIT\_AUDIT | 20 |
| 等待财审 | WAIT\_FINANCE\_AUDIT | 21 |
| 等待人工审核 | WAIT\_MANUAL\_AUDIT | 22 |
| 审核完成 | FINISHED\_AUDIT | 29 |
| 待打印快递单 | WAIT\_EXPRESS\_PRINT | 30 |
| 待打印发货单 | WAIT\_DELIVERY\_PRINT | 31 |
| 待打包 | WAIT\_PACKAGE | 32 |
| 待称重 | WAIT\_WEIGHT | 33 |
| 待发货 | WAIT\_SEND\_GOODS | 40 |
| 卖家已发货 | SELLER\_SEND\_GOODS | 50 |
| 交易完成 | FINISHED | 60 |
| 交易关闭 | CLOSED | 70 |
| 交易作废 | CANCEL | 80 |

注：当前快麦开放平台已不支持返回拼多多平台订单数据，具体信息可参考【拼多多订单信息开放改造公告】

[https://open.kuaimai.com/docs/question/%E7%B3%BB%E7%BB%9F%E5%85%AC%E5%91%8A/%E6%8B%BC%E5%A4%9A%E5%A4%9A%E8%AE%A2%E5%8D%95%E4%BF%A1%E6%81%AF%E5%BC%80%E6%94%BE%E6%94%B9%E9%80%A0%E5%85%AC%E5%91%8A](https://open.kuaimai.com/docs/question/%E7%B3%BB%E7%BB%9F%E5%85%AC%E5%91%8A/%E6%8B%BC%E5%A4%9A%E5%A4%9A%E8%AE%A2%E5%8D%95%E4%BF%A1%E6%81%AF%E5%BC%80%E6%94%BE%E6%94%B9%E9%80%A0%E5%85%AC%E5%91%8A)

---

## 物流轨迹信息如何获取

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/1
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/1.md

# 物流轨迹信息如何获取

Q:物流轨迹信息如何获取？

A:开放平台没有物流轨迹信息接口，如有需要请自行对接快递助手或其他快递公司获取

---

## 店铺编码如何获取

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/10
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/10.md

# 店铺编码如何获取

Q：向快麦ERP推送单据时，如果请求参数涉及店铺编号，店铺编码如何获取？

A：店铺查询接口路径：基础API-->店铺查询（erp.shop.list.query）接口返回参数userId\
系统相关界面：【基础】--【店铺管理】的店铺编号

---

## 商品API中存在后缀为‘V2’的API接口，使用哪一个接口？

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/11
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/11.md

# 商品API中存在后缀为‘V2’的API接口，使用哪一个接口？

Q：商品模块中存在后缀为‘V2’的API接口，如‘添加商品供应商关系’与‘添加商品供应商关系V2’，使用哪一个接口？

A：使用‘添加商品供应商关系V2’，商品模块中存在后缀为V2的，都使用带V2后缀的商品接口；以前对接使用了不带V2的接口，可升级为带V2的商品接口。

---

## 请求地址使用问题

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/12
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/12.md

# 请求地址使用问题

Q：请求地址中有测试环境、正式环境、V2测试环境、V2正式环境，使用哪个地址？

A：接入方统一使用V2正式环境：https://gw.superboss.cc/router

---

## 创建自建平台订单，当传入‘WAITBUYERPAY’待付款的系统状态订单时，为什么在快麦系统中无法查询到该订单？

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/2
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/2.md

# 创建自建平台订单，当传入‘WAIT_BUYER_PAY’待付款的系统状态订单时，为什么在快麦系统中无法查询到该订单？

Q：创建自建平台订单，当传入‘WAIT_BUYER_PAY’待付款的系统状态订单时，为什么在快麦系统中无法查询到该订单？

A：如果需要同步待付款的订单，需要在【基础】-【系统配置】-【交易配置】-【订单配置】中的‘平台对接’勾选‘同步待付款订单’

---

## 创建自建平台订单时，提示"商品已停用或者已被删除,商品id:null"

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/3
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/3.md

# 创建自建平台订单时，提示"商品已停用或者已被删除,商品id:null"

Q：创建自建平台订单时，返回错误
```
{
	"code":"9",
	"msg":"商品已停用或者已被删除,商品id:null",
	"success":false,
	"trace_id":"3939521382425972"
}
```

A：检查传入的商品是否在快麦系统中存在，不存在需要新增商品

---

## 淘系平台包括哪些

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/4
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/4.md

# 淘系平台包括哪些

Q:淘系平台包括哪些？

A:淘系的平台包括：淘宝、淘宝特价版、淘宝供销平台、天猫超市、天猫国际、淘工厂、阿里巴巴、阿里健康、阿里巴巴国际站、天猫优品、速卖通、lazada

---

## 请求地址使用哪个环境地址

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/5
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/5.md

# 请求地址使用哪个环境地址

Q：请求地址使用哪个环境地址？

A：无论使用的是正式公司账号还是测试公司账号，一般建议使用‘V2正式环境地址’（ https://gw.superboss.cc/router ）, ‘V2测试环境地址’为内部测试环境地址

---

## 仓库外部编码如何设置

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/6
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/6.md

# 仓库外部编码如何设置

Q：仓库外部编码如何设置？

A：系统相关界面：【基础】--【仓库管理】，选择仓库，填写仓库外部编码。

---

## 商家自建平台店铺如何创建

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/7
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/7.md

# 商家自建平台店铺如何创建

Q：商家自建平台店铺如何创建？

A：系统界面：在【基础】--【店铺管理】--【新增店铺】，选择‘自建平台’店铺类型，填写店铺名称等信息，保存

---

## 订单的状态和快递信息如何获取

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/8
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/8.md

# 订单的状态和快递信息如何获取

Q：订单的状态和快递信息如何获取？

A：可通过订单查询（erp.trade.list.query）接口获取到订单的系统状态(status)、运单号(outSid)、快递公司名称(expressCompanyName)、快递公司编码(expressCode)等订单信息

---

## 仓库id或仓库编码如何获取

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/9
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/9.md

# 仓库id或仓库编码如何获取

Q：涉及到仓库id或仓库编码的，如何获取？

A：仓库查询接口路径：基础API-->仓库查询（erp.warehouse.list.query）返回参数id或code

---

## 热点问题

URL: https://open.kuaimai.com/docs/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E7%83%AD%E7%82%B9%E9%97%AE%E9%A2%98/index.md

# 热点问题

---

## 返回错误信息‘刷新的会话信息不存在’的原因

URL: https://open.kuaimai.com/docs/question/%E5%BA%94%E7%94%A8%E6%8E%88%E6%9D%83/1
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E5%BA%94%E7%94%A8%E6%8E%88%E6%9D%83/1.md

# 返回错误信息‘刷新的会话信息不存在’的原因

### 问题现象：
错误信息：
```
{ 
	"code": "invalid_session",
	"msg" : "刷新的会话信息不存在", 
	"success" : false,
	"traceId" : "1321338350981396071" 
}
```

 
### 问题原因：
会话信息已过期，联系技术或联系客服提交工单手动刷新会话。

 

### 解决方案：
联系技术或联系客服提交工单手动刷新会话，手动刷新后请尽快对接‘刷新会话’接口，否则30天后会话过期。

---

## 调用刷新会话接口返回"会话刷新太频繁了，请降低频次调用"

URL: https://open.kuaimai.com/docs/question/%E5%BA%94%E7%94%A8%E6%8E%88%E6%9D%83/2
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E5%BA%94%E7%94%A8%E6%8E%88%E6%9D%83/2.md

# 调用刷新会话接口返回"会话刷新太频繁了，请降低频次调用"

### 问题现象：
错误信息：
```
{
	"msg": "会话刷新太频繁了，请降低频次调用",
	"traceId": "3547544523273919566",
	"code": "refresh_frequently",
	"success": false
}
```

 
### 问题原因：
会话刷新太频繁了，刷新会话接口一小时内只能刷新一次

 

### 解决方案：
刷新成功后，在一小时后可重试

---

## 返回错误信息‘账号已经到期’的原因

URL: https://open.kuaimai.com/docs/question/%E5%BA%94%E7%94%A8%E6%8E%88%E6%9D%83/3
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E5%BA%94%E7%94%A8%E6%8E%88%E6%9D%83/3.md

# 返回错误信息‘账号已经到期’的原因

### 问题现象：
错误信息：
```
{
	code:"403"
	msg:"账号已经到期，请联系400-022-3932或联系匿名脚丫"
	success:false
	traceId:"2770728013373400000"
}
```

 
### 问题原因：
快麦ERP账号过期。

 

### 解决方案：
快麦ERP账号过期，请联系相关销售或实施同学解决。

---

## 应用授权

URL: https://open.kuaimai.com/docs/question/%E5%BA%94%E7%94%A8%E6%8E%88%E6%9D%83
Markdown: https://open.kuaimai.com/__ai/markdown/question/%E5%BA%94%E7%94%A8%E6%8E%88%E6%9D%83/index.md

# 应用授权

---