开放平台接口介绍
欢迎使用
入口地址
API Base Endpoints:
Env | country | Endpoint |
---|---|---|
Training | 泰国测试环境 | https://open-training.flashfulfillment.co.th/ |
Production | 泰国生产环境 | https://open.flashfulfillment.co.th/ |
Production | 印尼生产环境 | https://open.flashfulfillment.co.id/ |
Production | 马来西亚生产环境 | https://open.flashfulfillment.com.my/ |
Production | 菲律宾生产环境 | https://open.flashfulfillment.com.ph/ |
Production | 越南生产环境 | https://open.flashfulfillment.vn/ |
接口规范
基本规范
- 传输方式 为保证安全性, 采用 HTTPS 传输
- 提交方式 采用 POST 方法提交
- 数据格式 提交数据采用
application/x-www-form-urlencoded
格式, 返回数据采用json
格式 - 字符编码 统一采用 UTF-8 字符编码
- 签名算法 SHA256
- 签名要求 请求数据需要校验签名, 详细方法请参考安全规范-签名算法
返回数据基本结构
返回数据基本结构示例
{
"code": 1,
"message": "success",
"data": null
}
接口返回数据格式为 JSON, 接口返回数据的基本结构包含三个参数
名称 | 数据类型 | 说明 |
---|---|---|
code | integer | 返回码 |
message | string | 错误消息 |
data | object | 业务数据, 参考各个接口返回数据 |
国际化
国际化调用示例
POST /open/v1/ping HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Accept: application/json
Accept-Language: th
目前接口支持中文(zh-CN
)、英文(en
)和泰文(th
). 需要注意 目前行政区划数据不支持国际化,只支持泰文
可以通过添加 HTTP Request Header: Accept-Language
来切换语言
来源标识
调用示例
POST /open/v1/ping HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Accept: application/json
Accept-Language: th
FFM-Source-From: ERP_XXX
其他系统需要传递来源标识,请联系官方支持人员获取
可以通过添加 HTTP Request Header: FFM-Source-From
注意事项
安全规范
签名算法
第一种签名算法(继续维护,但不建议使用):
签名生成的通用步骤如下:
a. 假设传送的参数
mchId: 5a7bdfd22593414adb72df5f
nonceStr: yyv6YJP436wCkdpNdghC
body: test
b. 对参数按照key=value的格式,并按照参数名ASCII字典序排序如下:
stringA="body=test&mchId=5a7bdfd22593414adb72df5f&nonceStr=yyv6YJP436wCkdpNdghC"
c. 拼接 API密钥:
stringSignTemp=stringA+"&key=dd807a8e18b40153888e5a9864e70080" //注:key为平台预分配的密钥key
sign=sha256(stringSignTemp).toUpperCase()="BF46380E893F6B8F5486D2EDFE265BB8942C6A9BD5C897E34373734CE08B4B67" // 注:SHA256签名方式
d. 最终发送参数如:
mchId: 5a7bdfd22593414adb72df5f
nonceStr: yyv6YJP436wCkdpNdghC
body: test
sign: BF46380E893F6B8F5486D2EDFE265BB8942C6A9BD5C897E34373734CE08B4B67
第一步, 设所有发送或者接收到的数据为集合 M, 将集合 M 内非空参数值的参数按照参数名 ASCII 码从小到大排序(字典序), 使用 URL 键值对的格式 (即 key1=value1&key2=value2…
) 拼接成字符串 stringA.
特别注意以下重要规则:
- 参数名 ASCII 码从小到大排序(字典序)
- 如果参数的值为空不参与签名
- 参数名区分大小写
- 验证调用返回或主动通知签名时, 传送的 sign 参数不参与签名, 将生成的签名与该 sign 值作校验
- 接口可能增加字段, 验证签名时必须支持增加的扩展字段
第二步, 在 stringA 最后拼接上 key 得到 stringSignTemp 字符串, 并对 stringSignTemp 进行 SHA256 运算, 再将得到的字符串所有字符转换为大写, 得到 sign 值 signValue.
第二种签名算法(建议使用):
- POST 请求,发送 JSON 对象.
- url 拼接必须地查询参数:?mchId=C1000001&nonceStr=123456×tamp=1718096016&sign=your_sign.其中 timestamp 为当前时间戳,单位为秒.nonceStr 为随机字符串,长度不少于 6 位,由字母和数字组成.
- 签名计算方法:
a. 除 sign 之外的查询参数,按照字典顺序排序之后,拼接成字符串(str1 = kvkv...),如:str1 = mchIdC1000001nonceStr123456timestamp1718096016.
b. 将 str1 字符串拼接上 secret 和 json,str2 = secret + str1 + jsonBody + secret。其中 secret 为平台预分配的密钥key,jsonBody 为请求体中的 json 字符串. - 计算签名:使用 sha256 加密,转换成大写,如:sign = sha256(str2).toUpperCase()
- 生成的 sign 值,放在 url 查询参数中,如:?mchId=C1000001&nonceStr=123456×tamp=1718096016&sign=your_sign
- 请求头中,需要添加 Content-Type: application/json
- 请求体中,需要添加 json 对象,如:{ "name": "test" }
注意事项
传输空值是被允许的, 但不参与签名
/* 假设 body 为空值 */
body = " \t\n"
/* 则 body 不参与签名, 但是依然可以传输 */
body=%20%09%0A&mchId=5a7bdfd22593414adb72df5f&nonceStr=yyv6YJP436wCkdpNdghC&sign=E893F6B8F5486D2EDFE265BB8942C6A9BD5C897E34373734CE08B4B67BF46380
\u0009
水平制表符\t
\u000A
换行\n
\u000B
纵向制表符\u000C
换页\f
\u000D
回车\r
\u001C
文件分隔符\u001D
组分隔符\u001E
记录分隔符\u001F
单元分隔符
数据在签名完成后, 传输之前需要进行 urlencode
/* 假设 body 值如下 */
body = "param1¶m2"
/* 传输数据如下 */
body=%E4%B9%94%E5%B3%B0%26%E6%85%95%E5%AE%B9&mchId=5a7bdfd22593414adb72df5f&nonceStr=yyv6YJP436wCkdpNdghC&sign=E34373734CE08B4B67BF46380E893F6B8F5486D2EDFE265BB8942C6A9BD5C897
生成随机数算法
开放平台接口规范中包含字段 nonceStr
, 主要保证签名不可预测. 我们推荐生成随机数算法如下: 调用随机数函数生成, 将得到的值转换为字符串.
商品 API
添加商品 API
基本信息
HTTP
POST /open/add_goods HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
barCode: "EOS001",
name: "goodsName",
goodsCode: "s12",
specification: "盒",
isShelfLife: "1",
shelfLifeDay: "20",
shelfLifeWarning: "2",
encodeType: "0",
introduction: "简介",
remark: "remrak",
prepackWeight: "100",
length: "2",
width: "3",
height: "2",
weight: "10",
image: "",
costPrice: "100",
price: "10",
reserveBarcode: "EOS002,EOS003",
}
返回数据体示例
{
msg: "success",
code: 1,
data: []
}
Path: /open/add_goods
Method: POST
接口描述:
创建商品
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
barCode | text | 是 | barCode | 商品条形码 |
name | text | 是 | goodsName | 商品名称 |
goodsCode | text | 否 | TW0001 | 商品货号 |
specification | text | 否 | 黑色XXL | 商品规格 |
isShelfLife | text | 否 | 1 或 0 【 1】:开启保质期属性 【 0】:不开启保质期属性 | 是否启用商品的保质期属性 不传时默认为不开启 |
shelfLifeDay | text | 否 | 90 | 保质期天数 当开启保质期属性时此项为必填项 |
shelfLifeWarning | text | 否 | 15 | 保质期临期预警天数 当开启保质期属性时此项为必填项 此项的值不能大于保质期天数 |
shelfLifeLockUp | text | 否 | 10 | 临期禁售天数 当开启保质期属性时此项为必填项 此项的值不能大于保质期天数 |
encodeType | text | 否 | 1 或 0 【 1】:开启SN属性 【 0】:不开启SN属性 | 是否开启商品SN属性 不传时默认为不开启 SN属性不能和保质期属性同时开启 |
introduction | text | 否 | 我是商品的介绍 | 商品介绍 |
brandName | text | 否 | 海尔 | 商品品牌,枚举值为SCM系统内已创建的品牌 |
remark | text | 否 | 我是商品备注 | 备注信息 |
prepackWeight | text | 否 | 5 | 预打包重量 单位为 克 /g 不传默认为0 |
length | text | 否 | 10 | 长度 单位为mm 不传默认为0 |
width | text | 否 | 10 | 宽度 单位为mm 不传默认为0 |
height | text | 否 | 10 | 高度 单位为mm 不传默认为0 |
weight | text | 否 | 10 | 重量 单位为克/g 不传默认为 0 |
image | text | 否 | http://pic13.nipic.com/20110409/7119492_114440620000_2.jpg | 商品图片的真实链接 |
costPrice | text | 否 | 15000 | 成本价格 传值=实际价格x100,不支持传小数 |
price | text | 否 | 20000 | 售价 传值=实际售价x100,不支持传小数 |
reserveBarcode | text | 否 | EOS002,EOS003 | 多个备用条码以逗号分开,最多5个 |
isAsset | text | 否 | Y | Y:开启asset |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
修改商品 API
基本信息
HTTP
POST /open/edit_goods HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
barCode: "EOS001",
name: "goodsName",
goodsCode: "s12",
specification: "盒",
isShelfLife: "1",
shelfLifeDay: "20",
shelfLifeWarning: "2",
encodeType: "0",
introduction: "简介",
remark: "remrak",
prepackWeight: "100",
length: "2",
width: "3",
height: "2",
weight: "10",
image: "",
costPrice: "100",
price: "10",
reserveBarcode: "EOS002,EOS003",
}
返回数据体示例
{
msg: "成功",
code: 1,
data: ["EOS001"]
}
Path: /open/edit_goods
Method: POST
接口描述:
修改商品
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
barCode | text | 是 | barCode | 商品条码 |
name | text | 否 | goodsName | 商品名称 |
goodsCode | text | 否 | TW0002 | 商品货号 |
specification | text | 否 | 红色XXXL | 商品规格 |
introduction | text | 否 | 我是介绍 | 商品介绍 |
remark | text | 否 | 我是备注 | 商品备注 |
costPrice | text | 否 | 15000 | 成本价格 传值=实际价格x100,不支持传小数 |
price | text | 否 | 20000 | 售价 传值=实际售价x100,不支持传小数 |
prepackWeight | text | 否 | 50 | 预打包重量 单为 克/g |
length | text | 否 | 10 | 长度 单位 mm |
width | text | 否 | 10 | 宽度 单位 mm |
height | text | 否 | 10 | 高度 单位 mm |
weight | text | 否 | 50 | 重量 单位 克/g |
image | text | 否 | http://pic13.nipic.com/20110409/7119492_114440620000_2.jpg | 商品图片链接 |
reserveBarcode | text | 否 | EOS002,EOS003 | 多个备用条码以逗号分开,最多5个 |
isSn | text | 否 | Y | Y:开启sn管理,N:关闭sn管理 |
isAsset | text | 否 | Y | Y:开启asset管理,N:关闭asset管理 |
entCategoryCode | text | 否 | ABC0001 | 商品的二级分类 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
修改商品条形码 API
基本信息
HTTP
POST /open/updateBarcodeByCode HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
barCode: "FEX001",
goodsCode: "FEX0001",
specification: "red",
newBarcode: "barcode0001",
}
返回数据体示例
{
msg: "成功",
code: 1,
data: ["barcode0001"]
}
Path: /open/updateBarcodeByCode
Method: POST
接口描述:
修改商品条形码
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
barCode | text | 否 | FEX001 | 条形码 |
goodsCode | text | 否 | FEX0001 | 商品货号(条形码与商品货号至少传一个参数) |
specification | text | 否 | red | 商品规格 |
newBarcode | text | 是 | barcode0001 | 商品条码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
添加商品套装 API
基本信息
HTTP
POST /open/addComboGoods HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
barCode: "FEX0001",
name: "goodsName",
goodsCode: "s12",
specification: "",
costPrice: "1000",
price: "1500",
introduction: "简介",
remark: "remrak",
image: "",
children: '[{"barCode":"FEX0002","number":"5"},{"barCode":"FEX0003","number":"6"}]',
}
返回数据体示例
{
msg: "success",
code: 1,
data: 'FEX0001'
}
Path: /open/addComboGoods
Method: POST
接口描述:
创建套装商品
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
barCode | text | 是 | barCode | 商品套装条形码 | |||||||||||||||
name | text | 是 | goodsName | 商品名称 | |||||||||||||||
goodsCode | text | 否 | TW0001 | 商品货号 | |||||||||||||||
specification | text | 否 | 黑色XXL | 商品规格 | |||||||||||||||
costPrice | text | 否 | 15000 | 成本价格 单位为萨当,即1泰铢=100萨当 | |||||||||||||||
price | text | 否 | 20000 | 售价 单位为萨当,即1泰铢=100萨当 | |||||||||||||||
introduction | text | 否 | 我是商品的介绍 | 商品介绍 | |||||||||||||||
remark | text | 否 | 我是商品备注 | 备注信息 | |||||||||||||||
image | text | 否 | http://pic13.nipic.com/20110409/7119492_114440620000_2.jpg | 商品图片的真实链接 | |||||||||||||||
isEnable | text | 否 | 0 | 是否启用 [1]:是 [0]:否 | |||||||||||||||
children | text | 是 |
|
套装子商品信息 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 | 套装商品条码 |
商品档案查询 API(page)
基本信息
HTTP
POST /goods/list HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
"barCode": "barCode001,barCode002"
"page":1,
"pageSize":100
}
返回数据体示例
{
"code": 1,
"msg": "success",
"data": {
"limit": "1",
"page": "1",
"total": 583,
"list": [
{
"id": "24625",
"sellerId": "295",
"barCode": "1010",
"goodsCode": "123123",
"orderSourceType": "1",
"encodeType": "unique",
"snReg": "",
"name": "LP00528833848227",
"abbrName": "",
"brandId": "145",
"thirtySalesNum": "0",
"entCategoryId": "244",
"entCategoryPid": "241",
"oneUnit": "36",
"inUnit": "one",
"outUnit": "one",
"twoUnit": "13",
"twoConversion": "8",
"threeUnit": "28",
"threeConversion": "15",
"isCombo": "0",
"isImei": "0",
"hot": "A",
"length": "1",
"width": "2",
"height": "3",
"volume": "6",
"weight": "4",
"prepackWeight": "5",
"logisticRequire": [],
"storeType": "full",
"image": "https:\/\/wms-dev-fe.oss-ap-southeast-1.aliyuncs.com\/static\/image\/0bd8ab2f560fad40a69bcfc6305a3137.png",
"price": "200",
"costPrice": "100",
"specification": "zzzz",
"remark": "",
"isValuable": "0",
"isLocked": "1",
"isShelfLife": "0",
"shelfLifeDay": "20",
"shelfLifeType": "1",
"shelfLifeLockUp": "0",
"isUnpackedDelivery": "0",
"introduction": "",
"status": "3",
"isMix": "1",
"mixStatus": "3",
"mixCreater": "1780",
"mixCreated": "2022-08-02 18:23:49",
"createdName": "xiaodong",
"modifiedName": "",
"created": "2022-06-21 11:27:48",
"twoBarCode": "9",
"threeBarCode": "16",
"modified": "2024-07-18 22:07:00",
"isAsset": "0",
"replenishmentBatchNum": "24",
"rollbackMark": "0",
"reviewStatus": "1",
"isDefaultContainer": "1",
"channelSource": "",
"selfPackCode": "0",
"isBelongContainer": "n",
"chargingType": "1",
"reserveBarCode": "",
"declaredValue": "0",
"entCategoryName": null,
"reserveBarcode": "s1010,1,101010102101010102101010102,101010103101010103101010103,101010101110101010111010101011"
}
]
}
}
Path: /goods/list
Method: POST
接口描述:
查询商品信息,分页返回
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
barCode | text | 否 | 商品条形码 | |
page | text | 否 | 页码 | |
pageSize | text | 否 | 最大 200,超过 200 按照 200 计算 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
msg | string | 非必须 | |||
code | number | 非必须 | |||
data | object | 非必须 | |||
├─ SIHX | object | 非必须 | 条形码 | ||
├─ modifiedName | string | 非必须 | 最后修改商品档案的账号名称 | ||
├─ abbrName | string | 非必须 | |||
├─ remark | string | 非必须 | 备注 | ||
├─ isCombo | string | 非必须 | 【1】商品套装【0】普通商品 | ||
├─ hot | string | 非必须 | ABC分类 | ||
├─ sellerId | string | 非必须 | 货主ID | ||
├─ isAsset | string | 非必须 | 【1】Asset商品【0】普通商品 | ||
├─ encodeType | string | 非必须 | [unique]SN商品 [其他]非SN商品 | ||
├─ price | string | 非必须 | 售价 | ||
├─ isLocked | string | 非必须 | |||
├─ isUnpackedDelivery | string | 非必须 | |||
├─ modified | string | 非必须 | |||
├─ createdName | string | 非必须 | |||
├─ id | string | 非必须 | 商品ID | ||
├─ introduction | string | 非必须 | 商品简介 | ||
├─ image | string | 非必须 | 图片地址 | ||
├─ storeType | string | 非必须 | |||
├─ parentTwo | string | 非必须 | |||
├─ logisticRequire | string [] | 非必须 | 【dangerous】危险品【fragile】易碎品【not_flight】禁航品【damp_proof】防潮【fire_proof】防火【put_ice_bag】保鲜品【heteromorphism】异形【presale】预售【gift】赠品【high_price】高值品【isValuable】贵品【is_special】特货 | item 类型: string |
|
├─ created | string | 非必须 | |||
├─ costPrice | string | 非必须 | 成本价 单位为萨当 即1泰铢=100萨当 | ||
├─ specification | string | 非必须 | 商品规格 | ||
├─ isShelfLife | string | 非必须 | [0]非保质期商品 [1]是保质期商品 | ||
├─ barCode | string | 非必须 | 商品条码 | ||
├─ orderSourceType | string | 非必须 | |||
├─ name | string | 非必须 | 商品名称 | ||
├─ replenishmentBatchNum | string | 非必须 | |||
├─ parentOne | string | 非必须 | |||
├─ goodsCode | string | 非必须 | 商品货号 | ||
├─ categoryId | string | 非必须 | |||
├─ status | string | 非必须 | [1]停用 [2]存盘 [3]启用 | ||
├─ length | string | 非必须 | 商品长度,单位 mm | ||
├─ width | string | 非必须 | 商品宽度,单位 mm | ||
├─ height | string | 非必须 | 商品高度,单位 mm | ||
├─ volume | string | 非必须 | 体积,单位 mm³ | ||
├─ weight | string | 非必须 | 商品重量,单位 g | ||
├─ prepackWeight | string | 非必须 | 预打包重量,单位 g | ||
├─ entCategoryName | string | 非必须 | 企业类目 | ||
├─ reserveBarcode | string | 非必须 | 备用条码 |
入库 API
入库通知单新增 API
基本信息
HTTP
POST /arrival_notice/create HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
warehouseId: "1",
type: "1",
orderSn: "OS95354115",
qualityStatus: "normal",
channelSource: "",
deliveryWay: "logistics",
carrier: "",
deliveryMan: "zhangsan",
plateNumber: "DK22222",
deliveryNumber: "DN20191839",
deliveryContact: "18666668888",
remark: "test",
arrivalStart: "2019-06-10 14:45",
arrivalEnd: "2019-06-10 16:45",
goods: [
{
"i":1,
"barCode":"00000000001",
"num":4,
"price":123,
"asset":["aaaaaaa1","aaaaaaa2","aaaaaaa3","aaaaaaa4"]
},{
"i":2,
"barCode":"00000000002",
"num":2,
"price":456,
"asset":["bbbbbbb1","bbbbbbb2"]
}
],
ignorePrice: "0",
attachmentList: [
{
"filename":"test.pdf",
"ext":"pdf",
"contentBase64":""
}
]
}
返回数据体示例
{
msg: "成功",
code: 1,
data: 'AN2001018888'
}
Path: /arrival_notice/create
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
warehouseId | text | 是 | 1 | 仓库ID(可通过查询可用仓库的接口获取仓库ID) | |||||||||||||||||||||||||||||||||||
type | text | 否 | 1 | 入库类型(1:采购入库 ;3:退货入库 ;4:其他入库) | |||||||||||||||||||||||||||||||||||
qualityStatus | text | 否 | normal | 质量状态(normal:正品;bad:残品) | |||||||||||||||||||||||||||||||||||
orderSn | text | 否 | 外部单号(不能重复) | ||||||||||||||||||||||||||||||||||||
channelSource | text | 否 | 渠道来源 | ||||||||||||||||||||||||||||||||||||
deliveryWay | text | 否 | logistics | 配送方式:[logistics]物流(默认) [express]快递 [seller]自送 | |||||||||||||||||||||||||||||||||||
supplyCode | text | 否 | 供应商编码 | ||||||||||||||||||||||||||||||||||||
carrier | text | 否 | 承运商 | ||||||||||||||||||||||||||||||||||||
deliveryMan | text | 否 | 送货人 | ||||||||||||||||||||||||||||||||||||
plateNumber | text | 否 | 车牌号 | ||||||||||||||||||||||||||||||||||||
deliveryNumber | text | 否 | 运单号 | ||||||||||||||||||||||||||||||||||||
deliveryContact | text | 否 | 送货人联系方式 | ||||||||||||||||||||||||||||||||||||
remark | text | 否 | 备注 | ||||||||||||||||||||||||||||||||||||
arrivalStart | text | 否 | 2019-06-10 14:45 | 预计到货开始时间(无需到秒) | |||||||||||||||||||||||||||||||||||
arrivalEnd | text | 否 | 2019-06-10 16:45 | 预计到货结束时间(无需到秒) | |||||||||||||||||||||||||||||||||||
check | text | 否 | 0 | [0]代表需要在SCM审核 [1]代表无需SCM审核 | |||||||||||||||||||||||||||||||||||
ignorePrice | text | 否 | 0 | [0]No [1]Yes | |||||||||||||||||||||||||||||||||||
isBatchArrival | text | 否 | 0 | [0]No [1]Yes | |||||||||||||||||||||||||||||||||||
goods | text | 是 |
|
入库商品的json串 | |||||||||||||||||||||||||||||||||||
attachmentList | text | 否 |
|
入库附件, json string |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 | 入库单号 |
入库单列表 API
基本信息
HTTP
POST /arrival_notice/getOrderList HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
timeType: "created",
startTime: "2022-05-31 00:00:00",
endTime: "2023-08-29 23:59:59",
warehouseId: "295",
status: "10,20",
orderType: "1",
limit: "10",
page: "1"
}
返回数据体示例
{
"code": 1,
"msg": "success",
"data": {
"list": [
{
"noticeNumber": "AN2304141889",
"orderSn": "123123",
"warehouseId": "295",
"warehouseName": "warehouse",
"status": 50,
"orderType": "1"
}
],
"totalPages": 1,
"totalItems": 19,
"pageSize": 50
}
}
Path: /arrival_notice/getOrderList
Method: POST
接口描述:
入库单列表
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
startTime | string | 是 | 2022-05-31 00:00:00 | 开始时间 |
endTime | string | 是 | 2022-05-31 00:00:00 | 结束时间 |
warehouseId | string | 否 | 12 | 仓库id |
status | string | 否 | 10,20 | 状态:10待审核,20已审核,30已到货,40收货中,50收货完成(多个状态以逗号分隔) |
orderType | string | 否 | 1 | 入库类型:1采购入库,3退货入库,4其他入库 |
timeType | string | 否 | created | 按创建时间: created, 按完成时间: complete, 默认按创建时间 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
data>list[]
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
noticeNumber | string | AN2211115238 | 入库单号 |
orderSn | string | RKD01202211110006 | 外部单号 |
warehouseId | string | 295 | 仓库ID |
warehouseName | string | warehouse | 仓库名称 |
status | string | 50 | 状态:10待审核,20已审核,30已到货,40收货中,50收货完成 |
orderType | string | 1 | 入库类型:1采购入库,3退货入库,4其他入库 |
入库单审核 API
基本信息
HTTP
POST /Audit/inbound HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
orderSn: "AN2003198368"
}
返回数据体示例
{
msg: "success",
code: 1,
data: []
}
Path: /Audit/inbound
Method: POST
接口描述:
入库单审核
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
orderSn | string | 是 | AN2003198368 | 入库单号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
入库单详情 API
基本信息
HTTP
POST /Inbound/getInBoundDetail HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
inboundSn: "AN2003198368",
orderSn: ""
}
返回数据体示例
{
"code": 1,
"msg": "成功",
"data": [
{
"warehouseId": "78",
"warehouseName": "warehouse",
"fromOrderType": "1",
"inBoundSn": "AN2003125716",
"orderSource": "1",
"channelSource": "",
"fromOrderSn": "",
"orderSn": "",
"supplyCode": "",
"status": "50",
"distributionType": "logistics",
"remark": "",
"createdTime": "2020-03-12 09:52:17",
"auditTime": "2020-03-12 09:52:21",
"arrivalStartTime": "",
"arrivalEndTime": "",
"completeTime": "2020-03-12 09:53:43",
"carrier": "",
"deliveryNumber": "",
"deliveryMan": "",
"deliveryContact": "",
"plateNumber": "",
"unloadingParty": "warehouse",
"volume": "",
"unloadingTime": "2020-03-12 09:52:31 2020-03-12 10:52:31",
"regName": "ddd",
"regTime": "2020-03-12 09:52:32",
"regRemark": "",
"goodsList": [
{
"rowNumber": "1",
"barCode": "6662",
"goodsName": "aa",
"specification": "",
"number": "100",
"inNum": "100",
"price": "0",
"totalPrice": "0",
"normalNum": "5",
"badNum": "3",
"batchCode": ""
},
{
"rowNumber": "2",
"barCode": "6661",
"goodsName": "bb",
"specification": "",
"number": "100",
"inNum": "100",
"price": "0",
"totalPrice": "0",
"normalNum": "5",
"badNum": "3",
"batchCode": ""
},
{
"rowNumber": "3",
"barCode": "6663",
"goodsName": "cc",
"specification": "",
"number": "100",
"inNum": "100",
"price": "0",
"totalPrice": "0",
"normalNum": "5",
"badNum": "3",
"batchCode": ""
}
]
}
]
}
Path: /Inbound/getInBoundDetail
Method: POST
接口描述:
入库单详情
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
inboundSn | string | 否 | AN2003198368 | 入库单号 |
orderSn | string | 否 | 外部单号 (入库单号 与外部单号至少传一个) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | ||||
msg | string | ||||
data | object[list] | ||||
warehouseId | number | 仓库ID | |||
warehouseName | string | 仓库名称 | |||
fromOrderType | number | 入库类型 | [1]采购入库 [2]调拨入库 [3]退货入库 [4]其他入库 | ||
inBoundSn | string | 入库单号 | |||
orderSource | string | 订单来源 | [1]人工录入 [2]批量导入 [3]接口获取 [4]自动生成 | ||
channelSource | string | 来源渠道 | |||
fromOrderSn | string | 订单来源单号 | |||
orderSn | string | 外部单号 | |||
supplyCode | string | 供应商编码 | |||
status | enum | 状态 | [10]待审核 [20]已审核 [30]已到货 [40]收货中 [50]收货完成 | ||
distributionType | string | 配送方式 | [logistics]物流 [express]快递 [seller]自送 | ||
remark | string | 备注 | |||
createdTime | string | 创建时间 | |||
auditTime | string | 审核时间 | |||
arrivalStartTime | string | 预计到货开始时间 | |||
arrivalEndTime | string | 预计到货结束时间 | |||
completeTime | string | 收货完成时间 | |||
carrier | string | 承运商 | |||
deliveryNumber | string | 运单号 | |||
deliveryMan | string | 送货人 | |||
deliveryContact | string | 送货人联系方式 | |||
plateNumber | string | 车牌号 | |||
unloadingParty | string | 卸货方 | [warehouse]仓库 [seller]货主 [carrier]快递 | ||
volume | string | 体积 | m³ | ||
unloadingTime | string | 卸货时间 | |||
regName | string | 登记人 | |||
regTime | string | 登记时间 | |||
regRemark | string | 登记备注 | |||
goodsList | object[list] | 商品信息 | |||
rowNumber | number | 行号(顺序号) | |||
barCode | string | 商品条形码 | |||
goodsName | string | 商品名称 | |||
specification | string | 商品规格 | |||
number | number | 通知数量 | |||
inNum | number | 收货数量 | |||
price | number | 单价 | 单位 萨当 | ||
totalPrice | number | 金额 | 单位 萨当 | ||
normalNum | number | 正品数量 | |||
badNum | number | 残品数量 | |||
batchCode | number | 批次号 |
入库单撤回 API
基本信息
HTTP
POST /arrival_notice/rollback HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
inboundSn: "AN2003198368"
}
返回数据体示例
{
msg: "success",
code: 1,
data: "AN2003198368"
}
Path: /arrival_notice/rollback
Method: POST
接口描述:
入库单撤回
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
inboundSn | string | 是 | AN2003198368 | 入库单号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
入库单删除 API
基本信息
HTTP
POST /arrival_notice/delete HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
inboundSn: "AN2003198368"
}
返回数据体示例
{
msg: "success",
code: 1,
data: "AN2003198368"
}
Path: /arrival_notice/delete
Method: POST
接口描述:
入库单删除
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
inboundSn | string | 是 | AN2003198368 | 入库单号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
销售(B2C) API
发货单新增 API
基本信息
HTTP
POST /Order/addOrder HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
storeCode: "S0001",
orderSn: "OS4851326",
province: "bj",
city: "bj",
district: "",
postalCode: "100510",
consigneeName: "Jack",
consigneeAddress: "address",
phoneNumber: "18159426427",
buyerId: "10000",
buyerMessage: "danger goods",
logisticCharge: "21",
totalPrice: "18000",
orderDiscount:"0",
payMode: "1",
showPrice: 1,
goods: [
{
"barCode":"FEX00025",
"num":"1",
"price":"400",
"discountPrice":"0",
"externalName":"外部商品名称",
"externalSpe":"外部商品规格"
},{
"barCode":"FEX00026",
"num":"2",
"price":"500",
"discountPrice":"0",
"externalName":"外部商品名称",
"externalSpe":"外部商品规格"
}
],
type: "1",
deliverySn: "DS863154566",
expressSn:"TH0055555ED55",
expressCode:"",
expressName:"",
buyTime:"2020-05-01 00:00:01",
ignorePrice: "0",
channelSource: "",
extraDataJson: ""
}
返回数据体示例
{
msg: "成功",
code: 1,
data: "DO190856987"
}
Path: /Order/addOrder
Method: POST
接口描述:
1.商品传输格式 [{"barCode":"FEX00025","num":"1","price":"400","discountPrice":"0","externalName":"外部商品名称","externalSpe":"外部商品规格"},{"barCode":"FEX00026","num":"2","price":"500","discountPrice":"0","externalName":"外部商品名称","externalSpe":"外部商品规格"}]
2.提前录入快递单号的线上承运商,需要通过快递面单上传接口,上传面单
3.tiktok认证仓订单,channelSource字段传字符串 ID_WAREHOUSE_TIKTOK
,extraDataJson传业务参数格式为json字符串
{"order_id":"12313123","create_time":"","pay_time":"","shop_id":"","shop_name":"","package_id":"12313123","shipping_provider_id":"12313123","shipping_provider_name":"12313123","tracking_number":"12313123","sku_list":[{"sku_id":"3111231","quantity":"123"}]}
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
warehouseId | text | 否 | 1 | 仓库ID | |||||||||||||||||||||||||||||||||||
storeCode | text | 是 | SCM端添加的货主店铺编码 | ||||||||||||||||||||||||||||||||||||
orderSn | text | 是 | 订单号 | ||||||||||||||||||||||||||||||||||||
orderSourceCode | text | 是 | 外部来源单号,可入参平台单号 | ||||||||||||||||||||||||||||||||||||
orderSourcePlatform | text | 是 | 外部来源平台,枚举:TikTok、Shopee、Lazada、Line、Tokopedia、Shopify、Other | ||||||||||||||||||||||||||||||||||||
province | text | 是 | 省 | ||||||||||||||||||||||||||||||||||||
city | text | 是 | 市 | ||||||||||||||||||||||||||||||||||||
district | text | 否 | 区 | ||||||||||||||||||||||||||||||||||||
postalCode | text | 是 | 邮编 | ||||||||||||||||||||||||||||||||||||
consigneeName | text | 是 | 收件人名称 | ||||||||||||||||||||||||||||||||||||
consigneeAddress | text | 是 | 收件人详细地址 | ||||||||||||||||||||||||||||||||||||
phoneNumber | text | 是 | 联系电话 | ||||||||||||||||||||||||||||||||||||
buyerId | text | 否 | 买家ID | ||||||||||||||||||||||||||||||||||||
buyerMessage | text | 否 | 买家留言 | ||||||||||||||||||||||||||||||||||||
deliveryWay | text | 否 | 配送方式 快递:express 到仓自取:self,不传默认快递 | ||||||||||||||||||||||||||||||||||||
orderDiscount | text | 否 | 整单优惠金额 单位:萨当 | ||||||||||||||||||||||||||||||||||||
logisticCharge | text | 是 | 运费 单位:萨当 | ||||||||||||||||||||||||||||||||||||
totalPrice | text | 是 | 订单总金额 单位:萨当 | ||||||||||||||||||||||||||||||||||||
payMode | text | 是 | 支付方式 【1】货到付款 【2】银行转账【3】在线支付 | ||||||||||||||||||||||||||||||||||||
type | text | 否 | 1 | 订单类型 [1]销售订单 (默认) [2]补货订单 | |||||||||||||||||||||||||||||||||||
deliverySn | text | 否 | 原发货单号 | ||||||||||||||||||||||||||||||||||||
showPrice | text | 否 | 1 | 【0】发货单不打印价格【1】发货单打印价格 | |||||||||||||||||||||||||||||||||||
expressSn | text | 否 | TH5896666666 | 事先录入的快递单号 有运单号的就是线上快递;没有运单号的就会走线下快递(走系统设置的可用快递 )。 | |||||||||||||||||||||||||||||||||||
expressCode | text | 否 | 填写了会校验快递编码是否存在 | ||||||||||||||||||||||||||||||||||||
expressName | text | 否 | 当填写expressSn及不填expressCode时,为必填 | ||||||||||||||||||||||||||||||||||||
insured | integer | 是 | 0 | 是否保价 [1]: 保价 [0]:不保价 | |||||||||||||||||||||||||||||||||||
insureDeclareValue | integer | 否 | 物品金额 单位 :萨当 | ||||||||||||||||||||||||||||||||||||
buyTime | text | 否 | 2020-05-01 00:00:01 | 订购时间 | |||||||||||||||||||||||||||||||||||
outTime | text | 否 | 2020-05-01 00:00:01 | 期望出库时间 | |||||||||||||||||||||||||||||||||||
check | text | 否 | 0 | [0]代表需要在SCM审核 [1]代表无需SCM审核 | |||||||||||||||||||||||||||||||||||
ignorePrice | text | 否 | 0 | [0]No [1]Yes | |||||||||||||||||||||||||||||||||||
goods | text | 是 |
|
入库商品的json串 | |||||||||||||||||||||||||||||||||||
channelSource | text | 否 | 渠道来源 | ||||||||||||||||||||||||||||||||||||
extraDataJson | text | 否 | {"order_id":"12313123","create_time":"","pay_time":"","shop_id":"","shop_name":"","package_id":"12313123","shipping_provider_id":"12313123","shipping_provider_name":"12313123","tracking_number":"12313123","sku_list":[{"sku_id":"3111231","quantity":"123"}]} | 其他业务参数 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 | 发货单号 |
发货单审核 API
基本信息
HTTP
POST /Audit/delivery HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn: "DO20010124196"
}
返回数据体示例
{
msg: "success",
code: 1,
data: []
}
Path: /Audit/delivery
Method: POST
接口描述:
发货单审核
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 是 | DO20010124196 | 发货单号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
发货单取消 API
基本信息
HTTP
POST /order/cancelOrder HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn: "DO19051524196",
orderSn: "123094889129392382838",
}
返回数据体示例
{
msg: "success",
code: 1,
data: 10
}
Path: /order/cancelOrder
Method: POST
接口描述:
通过发货单号或者外部订单号查询发货单进行取消操作
接口返回值data说明
10 :取消成功
21 :发货单不存在
22 :订单不唯一
23 :订单已发货
24 :订单无法取消,请先申请撤回,撤回后可直接取消
25 :发货单已取消
26 :待激活状态下不能进行此操作
27 :合并拆分过的发货单不能取消
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO19051524196 | 发货单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (发货单号,外部订单号至少传一个参数) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
发货单撤回 API
基本信息
HTTP
POST /order/withdrawOrder HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn: "DO19051524196",
orderSn: "123094889129392382838",
}
返回数据体示例
{
msg: "success",
code: 1,
data: 10
}
Path: /order/withdrawOrder
Method: POST
接口描述:
通过发货单号或者外部订单号查询发货单进行撤回操作
接口返回值 code 说明
1 :撤回成功
1014 :发货单不存在
1041 :订单已经开始交接
1038 :订单已发货
1033 :订单不唯一,请细化请求条件
1040 :订单未审核,无需撤回
1039 :等待"撤回成功"
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO19051524196 | 发货单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (发货单号,外部订单号至少传一个参数) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
发货单撤回并取消 API(不拦截)
基本信息
HTTP
POST /order/withdrawCancel HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn: "DO19051524196",
orderSn: "123094889129392382838",
}
返回数据体示例
{
msg: "success",
code: 1,
data: 10
}
Path: /order/withdrawCancel
Method: POST
接口描述:
通过发货单号或者外部订单号查询发货单进行撤回操作,并取消(不拦截)
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO19051524196 | 发货单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (发货单号,外部订单号至少传一个参数) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
发货单列表 API
基本信息
HTTP
POST /order/getOrderList HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
startTime:'2019-05-01',
endTime:'2019-05-20',
warehouseNo:'W0001',
status:'allocated_warehouse,wait_approval',
deliverySn: "DO19051524196",
orderSn: "123094889129392382838",
expressSn:'TH55899666',
contact:'18598547523',
page:'1',
limit:'50'
}
返回数据体示例
{
msg: "success",
code: 1,
data: {list: [
'deliverySn'=>'DO1911308596',
'status' =>'已发货',
'statusId' =>'180',
'orderSn'=>'115885523556655',
'order_source'=>'接口获取',
'receiver' => '收货人姓名',
'contact' => '18596857455',
'receiveAddress' =>'北京市朝阳区三里屯',
'warehouseName' =>'京东一号仓',
'storeName' =>'小米自营旗舰店',
'pay_statua'=>'已支付',
'pay_model' =>'银行转账',
'total_price'=>'订单金额',
'carriage' => '运费',
'logistic' => '快递公司',
'expressSn'=>'TH1896655445',
'kinds_num' =>'5',
'goods_num' =>'20',
'creatorName' =>'Tom',
'created' => '2019-11-30 04:05:36',
'comment' =>'尽快发货‘
],
totalPages:1,
totalItems:10
}
}
Path: /order/getOrderList
Method: POST
接口描述:
查询发货单列表
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
startTime | string | 是 | 2019-05-01 | 订单创建开始时间 |
endTime | string | 是 | 2019-05-20 | 订单创建结束时间 |
warehouseNo | string | 否 | W00001 | 仓库编码 |
status | string | 否 | wait_activate,wait_allocate_warehouse | 订单状态 (多个状态以逗号分开) wait_activate:等待激活,pre_sale:预售订单,wait_allocate_warehouse:待分仓,cancelled:取消发货,sold_out:缺货,allocated_warehouse:已分仓,wait_approval:等待审核,failed_get_the_label:获取电子面单失败,in_outbound:出库中,packed:已打包,shipped:已发货,abnormal_delivery:配送异常,rejected:已拒收,partially_rejected:部分拒收,signed:已签收 |
deliverySn | string | 否 | DO19051524196 | 发货单号(多个单号以逗号分开) |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (多个单号以逗号分开) |
expressSn | string | 否 | TH198545666 | 运单号 (多个单号以逗号分开) |
contact | string | 否 | 18596857456 | 联系方式 |
page | string | 否 | 1 | 查询的页码,不传默认为为1,表示第一页 |
limit | string | 否 | 50 | 查询每页显示的数据量,不传默认为50,表示每页显示数据量为50,最大值不能超过100 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
返回数据list
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
list | |||
deliverySn | string | DO1911308596 | 发货单号 |
orderSn | string | 189665565656 | 外部订单号 |
order_source | string | 接口获取 | 订单来源 |
status | string | 已发货 | 订单状态 |
statusId | string | 180 | [110]:取消发货;[120]:等待激活;[121]:预售订单;[130]:待分仓;[140]:缺货;[150]:已分仓;[160]:等待审核;[170]:获取面单失败;[180]:出库中;[190]:已打包;[200]:已发货;[205]:配送异常;[210]:已拒收;[215]:部分拒收;[220]:已签收; |
receiver | string | Tom | 收货人 |
contact | string | 18596857485 | 联系方式 |
receiveAddress | string | 北京市朝阳区三里屯 | 详细地址 |
warehouseName | string | 京东一号仓 | 仓库名称 |
storeName | string | 小米自营店 | 店铺名称 |
pay_status | string | 已支付 | 支付状态 |
pay_mode | string | 银行转账 | 支付方式 |
total_price | string | 50000 | 订单金额 单位:萨当 |
carriage | string | 1000 | 运费金额 单位:萨当 |
logistic | string | Flashexpress | 快递公司 |
expressSn | string | TH98565475 | 运单号 |
kindsNum | string | 5 | 品种数 |
goodsNum | string | 10 | 商品数量 |
creatorName | string | Jerry | 创建人 |
created | string | 2019-11-30 05:05:36 | 创建时间 |
comment | string | 尽快发货 | 客服备注 |
totalPages | string | 10 | 总页数 |
totalItems | string | 50 | 数据总条数 |
发货单详情 API
基本信息
HTTP
POST /order/getOrderDetail HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn: "DO19051524196",
orderSn: "123094889129392382838",
}
返回数据体示例
{
msg: "success",
code: 1,
data: [
'warehouseName' =>'京东一号仓',
'sellerName' =>'帅帅货主',
'orderSn'=>'115885523556655',
'buyer_message' => '尽快发货',
'comment' =>'尽快发货',
'show_price' => '是',
'type' => '补发订单',
'deliverySn'=>'DO1911308596',
'status' =>'已发货',
'statusId' =>'180',
'pay_statua'=>'已支付',
'pay_model' =>'银行转账',
'total_price'=>'订单金额',
'carriage' => '运费',
'total_weight' => '100',
'order_discount_total_money' =>'500',
'goods_discount_total_money'=>'100',
'logistic' => '快递公司',
'expressSn'=>'TH1896655445',
'sendName' => 'Tom',
'sendPhoneNumber'=>'18596857485',
'sendAddress'=>'北京市朝阳区三里屯',
'sendPostalCode'=>'500545',
'warehouseAddress' =>'发货仓地址',
'receiver' => '收货人姓名',
'contact' => '18596857455',
'receiveAddress' =>'北京市朝阳区三里屯',
'postal_code' => '收件人邮编',
'created'=>'2019-12-01 05:30:30',
'auditTime'=>'2019-12-01 12:30:30',
'deliveryTime'=>'2019-12-03 12:30:30',
'insureDeclareValue' => '1200',
'goodsList' => [
'barCode'=>'FEX00586',
'goodsName'=>'商品名称',
'specification'=>'黑色XXXL',
'goodsNumber' => '5',
'goodsPrice' =>'50000',
'orderDiscountMoney' =>'0',
'goodsDiscountMoney' =>'0',
'goodsDealPrice'=>'10000',
'goodsDealTotalPrice'=>'50000',
'stockOut'=>'0',
'batchCode'=>'202301'
]
]
}
Path: /order/getOrderDetail
Method: POST
接口描述:
查询发货单详情
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO19051524196 | 发货单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (发货单号 与外部订单号至少传一个) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
返回数据
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
warehouseName | string | 京东仓库 | 仓库名称 |
sellerName | string | 帅帅货主 | 货主名称 |
orderSn | string | 15556565655665 | 外部单号 |
buyer_message | string | 尽快发货 | 买家留言 |
comment | string | 尽快发货 | 客服备注 |
show_price | string | 是 | 是否打印价格 |
type | string | 补发订单 | 订单类型 |
deliverySn | string | DO19153056896 | 发货单号 |
status | string | 已发货 | 订单状态 |
statusId | string | 180 | [110]:取消发货;[120]:等待激活;[121]:预售订单;[130]:待分仓;[140]:缺货;[150]:已分仓;[160]:等待审核;[170]:获取面单失败;[180]:出库中;[190]:已打包;[195]:待快递揽收;[200]:已发货;[205]:配送异常;[210]:已拒收;[215]:部分拒收;[220]:已签收; |
pay_status | string | 已支付 | 支付状态 |
pay_mode | string | 银行转账 | 支付方式 |
total_price | string | 50000 | 订单金额 单位:萨当 |
carriage | string | 1000 | 运费金额 单位:萨当 |
total_weight | string | 500 | 总重量 单位:克 |
order_discount_total_money | string | 0 | 整单优惠金额 单位:萨当 |
goods_discount_total_money | string | 0 | 商品优惠总金额 单位:萨当 |
logistic | string | Flashexpress | 承运商 |
expressSn | string | TH5588866546 | 运单号 |
sendName | string | Tom | 寄件人 |
sendPhoneNumber | string | 18596857458 | 寄件人联系方式 |
sendPostalCode | string | 566699 | 寄件人邮编 |
sendAddress | string | 北京市朝阳区三里屯 | 寄件人详细地址 |
warehouseAddress | string | 北京市朝阳区六里桥 | 发货仓地址 |
receiver | string | Jerry | 收件人 |
contact | string | 18596857456 | 收件人联系方式 |
receiveAddress | string | 北京市朝阳区三里屯 | 收件人详细地址 |
postal_code | string | 52226 | 收件人邮编 |
created | string | 2019-12-01 05:30:30 | 创建时间 |
auditTime | string | 2019-12-01 12:30:30 | 审核时间 |
deliveryTime | string | 2019-12-02 12:30:30 | 发货时间 |
insureDeclareValue | string | 1200 | 保价声明价值 |
goodsList | |||
- barCode | string | FEX55986 | 商品条码 |
- goodsName | string | 牛仔裤 | 商品名称 |
- specification | string | 黑色XXXL | 商品规格 |
- goodsNumber | string | 5 | 购买量 |
- goods_price | string | 10000 | 商品售价 单位:萨当 |
- totalPrice | string | 50000 | 售价金额 单位:萨当 |
- orderDiscountMoney | string | 0 | 整单优惠金额 单位:萨当 |
- goodsDiscountMoney | string | 0 | 商品优惠金额 单位:萨当 |
- goodsDealPrice | string | 10000 | 商品成交价 单位:萨当 |
- goodsDealTotalPrice | string | 50000 | 成交金额 单位:萨当 |
- stockOut | string | 0 | 是否缺货 0否 1是 |
- batchCode | string | 202301 | 批次号 |
发货单箱单列表查询 API
基本信息
HTTP
POST /box/deliveryOrderBox HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn: "DO19051524196",
orderSn: "123094889129392382838",
}
返回数据体示例
{
"code": 1,
"msg": "\u0e2a\u0e33\u0e40\u0e23\u0e47\u0e08",
"data": [
{
"deliverySn": "DO23082914783",
"orderSn": "434461295",
"isMasterSlaveItems": true,
"boxList": [
{
"boxSn": "BOX230829367408",
"boxIndex": "1\/2",
"expressSn": "TH0101B6TJ0A",
"weight": "0",
"length": "111",
"width": "111",
"height": "111",
"goodsList": [
{
"goodsName": "test1111111111111111111111111112",
"barCode": "1011",
"number": "4"
}
],
"containerList": [
{
"name": "ww",
"number": "1"
},
{
"name": "wws",
"number": "1"
}
]
},
{
"boxSn": "BOX230829741629",
"boxIndex": "1\/2",
"expressSn": "TH0101B6TJ0A",
"weight": "0",
"length": "111",
"width": "111",
"height": "111",
"goodsList": [
{
"goodsName": "test1111111111111111111111111112",
"barCode": "1011",
"number": "3"
}
],
"containerList": [
{
"name": "ww",
"number": "1"
}
]
}
]
}
]
}
Path: /box/deliveryOrderBox
Method: POST
接口描述:
发货单箱单列表查询
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO19051524196 | 发货单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (发货单号 与外部订单号至少传一个) |
返回数据
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
code | number | Y | 1:成功,其他失败 | ||
msg | string | Y | 成功或失败信息描述 | ||
data | []object | Y | 返回数据 | 详情见 data_structure |
data
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
deliverySn | string | DO23082914783 | 发货单号 |
orderSn | string | 434461295 | 外部单号 |
isMasterSlaveItems | bool | true | 是否子母件 |
boxList | []object | 箱单信息 |
boxList
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
boxSn | string | BOX230829367408 | 箱单号 |
boxIndex | string | 1/2 | 箱单序号 |
expressSn | string | TH0101B6TJ0A | 运单号 |
weight | string | 10 | 重量(g) |
length | string | 10 | 长度(mm) |
width | string | 10 | 宽度(mm) |
height | string | 10 | 高度(mm) |
goodsList | []object | 商品信息 | |
containerList | []object | 包材信息 |
goodsList
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
name | string | 商品名称 | |
barCode | string | 商品条码 | |
number | string | 10 | 商品数量 |
containerList
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
name | string | 商品名称 | |
number | string | 10 | 商品数量 |
上传电子面单 API
基本信息
HTTP
POST /order/importExpressLabel HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
orderCode: "DO19051524196",
filetype: "pdf",
file: ""
}
返回数据体示例
{
msg: "success",
code: 1,
data: [
]
}
Path: /order/importExpressLabel
Method: POST
接口描述:
上传电子面单
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
orderCode | string | 是 | DO19051524196 | 订单号 |
file | string | 是 | 文件 base64图片数据 | |
fileType | string | 是 | 文件类型 (支持:pdf2png2:PDF ;png2url:PNG,JPG,GIF ) | |
expressSn | string | 否 | SF123123 | 运单号 |
expressName | string | 否 | 顺丰 | 快递公司名称 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
获取面单文件 API
基本信息
HTTP
POST /order/getDocument HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn: "DO19051524196"
}
返回数据体示例
{
code: 1,
msg: "成功",
data: {
orderNo: "DO20080594741",
document: [{
mimeType: "text/html",
trackNo: "LEXDO0000171174",
file: "PGh0bWwgc3R5bGU=="
}]
}
}
Path: /order/getDocument
Method: POST
接口描述:
获取面单文件
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO19051524196 | 订单编号 deliverySn/orderSn 参数至少选择一个 |
orderSn | string | 否 | 202008061621324014 | 外部单号 deliverySn/orderSn 参数至少选择一个 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
发货单处理进程信息 API
基本信息
HTTP
POST /order/getOrderStatusByNo HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn: "DO19051524196",
orderSn: "123094889129392382838",
}
返回数据体示例
{
"code": 1,
"msg": "成功",
"data": {
"deliverySn": "DO21051137166",
"orderSn": "DO21051187295",
"expressCompany": "FlashExpress",
"intercept": "",
"expressSn": "TH010150XS6A",
"status": "Completed",
"statusDetail": [
{
"status": 00,
"statusDesc": "Canceled",//取消
"time": "2021-05-11 08:45:51"
},
{
"status": 10,
"statusDesc": "Pending",//待审核
"time": "2021-05-11 08:45:51"
},
{
"status": 20,
"statusDesc": "Ready to ship",//已审核
"time": "2021-05-11 16:45:52"
},
{
"status": 30,
"statusDesc": "Picked",//拣货完成
"time": "2021-05-11 20:37:51"
},
{
"status": 40,
"statusDesc": "Packed",//打包完成
"time": "2021-05-11 20:42:38"
},
{
"status": 50,
"statusDesc": "Shipped",//已发货
"time": "2021-05-11 20:46:42"
},
{
"status": 55,
"statusDesc": "Abnormal delivery",//配送异常
"time": "2021-05-11 20:46:42"
},
{
"status": 60,
"statusDesc": "Completed",//已签收
"time": "2021-06-11 05:07:01"
},
{
"status": 70,
"statusDesc": "Rejected",//已拒收
"time": "2021-06-11 05:07:01"
}
]
}
}
Path: /order/getOrderStatusByNo
Method: POST
接口描述:
通过发货单号或者外部订单号查询发货单处理进程信息
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO19051524196 | 发货单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (发货单号与外部订单号至少传一个参数) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
发货单物流信息查询 API
基本信息
HTTP
POST /order/getOrderTrackingInfoByNo HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn: "DO19051524196",
orderSn: "123094889129392382838",
expressSn:"TH7501HE636",
}
返回数据体示例
{
msg: "success",
code: 1,
data: [
'deliverySn' =>'DO19051524196',
'orderSn' => '123094889129392382838',
'expressCompany' =>'FlashExpress',
'expressSn' => 'TH0102345RF',
'status' => 'Completed',
'trackingInfo' => [
'expressSn'=>'TH0102345RF',
'routes'=>'[已揽件2019-08-22 22:31:26 已到网点-BKKSS 2019-08-23 19:50:59 发往分拨 2019-08-24 09:31:03总分拨已收件 2019-08-24 09:47:29 总分拨已发出2019-08-24 15:18:04 已到达派送网点 2019-08-26 10:00:02 正在派送中 2019-08-26 10:00:02 感谢使用flashexpress 2019-08-26 10:00:02]',
]
]
}
Path: /order/getOrderTrackingInfoByNo
Method: POST
接口描述:
通过发货单号或者外部订单号或者快递单号查询发货单物流跟踪信息
'deliverySn' =>'DO19051524196', //发货单号
'orderSn' => '123094889129392382838',//外部订单号
'expressCompany' =>'FlashExpress',//快递公司
'expressSn' => 'TH0102345RF',//快递单号
'status' => 'Completed',//当前状态
'trackingInfo' => [//运单跟踪明细
'expressSn'=>"TH0102345RF",
'routes'=>' 已到网点-BKKSS 2019-08-23 19:50:59
发往分拨 2019-08-24 09:31:03
总分拨已收件 2019-08-24 09:47:29
总分拨已发出2019-08-24 15:18:04
已到达派送网点 2019-08-26 10:00:02',
]
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO19051524196 | 发货单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 |
expressSn | string | 否 | TH0102345RF | 快递单号 (发货单号,外部订单号,快递单号至少传一个参数) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
发货单物流信息查询反馈路由节点信息(路由查询)API
基本信息
HTTP
POST /order/getTrackingBySn HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
expressSn:"TH01015HC30C",
}
返回数据体示例
{
"code": 1,
"msg": "สำเร็จ",
"data": {
"expressSn": "TH01015HC30C",
"returnedExpressSn": "",
"status": 1009,
"message": "Your parcel has been signed by 【abcdefg(Neighbour)】, thank you for using the Flash Express service!",
"statusChangeAt": "1631181166",
"routes": [
{
"routedAt": "1631181166",
"routeAction": "DELIVERY_CONFIRM",
"message": "Your parcel has been signed by 【abcdefg(Neighbour)】, thank you for using the Flash Express service!",
"status": 1009
},
{
"routedAt": "1631181165",
"routeAction": "DELIVERY_TICKET_CREATION_SCAN",
"message": "Delivering by Flash Express",
"status": 1007
},
{
"routedAt": "1631181155",
"routeAction": "RECEIVE_WAREHOUSE_SCAN",
"message": "Your shipment has been received at [Testing(北京团队测试用)].",
"status": null
},
{
"routedAt": "1631181154",
"routeAction": "RECEIVED",
"message": "Your parcel has been pickuped by the [Testing(北京团队测试用)] courier.",
"status": 1005
}
]
}
}
Path: /order/getTrackingBySn
Method: POST
接口描述:
发货单物流信息查询反馈路由节点信息
'expressSn' =>'TH01015HC30C', //快递单号
'returnedExpressSn' => 'TH01015HC302',//逆向单号
'status' => 1009,//当前订单状态(状态码1001-1013,1001=订单已审核, 1002=下发仓库,1003=拣货完成,1004=打包完成, 1005=已揽收,1006=运输中,1007=派送中,1008=已滞留, 1009=已签收,1010=疑难件处理中,1011=已退件, 1012=异常关闭,1013=已撤销)
'message' =>'Your parcel has been signed by 【abcdefg(Neighbour)】, thank you for using the Flash Express service!',//当前状态对应的文本描述
'statusChangeAt' => 1631181166,//包裹状态更新时间戳 UTC ,秒
'routes' => {[ //运单跟踪明细
'routedAt'=> 1631181166,
'routeAction'=> 'DELIVERY_CONFIRM',
'message'=> 'Your parcel has been signed by 【abcdefg(Neighbour)】, thank you for using the Flash Express service!',
'status'=> 1009,
]}
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
expressSn | string | 否 | TH0102345RF | 快递单号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
包裹重量尺寸查询 API
基本信息
HTTP
POST /open/getExpressDimensions HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
expressSn:"TH01027S3Q5D",
orderSn:"CH22010500013",
type:"CH",
}
返回数据体示例
{
"code": 1,
"msg": "สำเร็จ",
"data": {
"expressSn": "TH01027S3Q5D",
"orderSn": "CH22010500013",
"type": "CH",
"success": true,
"errorMessage": "success",
"length": "10",
"width": "20",
"height": "30",
"weight": "1000"
}
}
Path: /open/getExpressDimensions
Method: POST
接口描述:
查询打包时包裹重量和长宽高
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
expressSn | string | 是 | TH0102345RF | 快递单号 |
orderSn | string | 是 | CH22010500013 | 创建订单时传给ARU的订单单号 |
type | string | 否 | CH | 订单类型: CH,DO |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
返回数据data
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
data | |||
expressSn | string | TH0102345RF | 运单号 |
orderSn | string | CH22010500013 | 外部订单号 |
type | string | CH | 订单类型 |
success | bool | true | 是否成功 |
errorMessage | string | success | 错误信息 |
length | integer | 10 | ⻓度(单位:mm) |
width | integer | 20 | 宽度(单位:mm) |
height | integer | 30 | ⾼度(单位:mm) |
weight | integer | 40 | 重量(单位:g) |
上传发票文件 API
基本信息
HTTP
POST /order/uploadInvoice HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
orderCode: "DO19051524196",
filetype: "pdf",
file: ""
}
返回数据体示例
{
msg: "success",
code: 1,
data: [
]
}
Path: /order/uploadInvoice
Method: POST
接口描述:
上传发票文件
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO19051524196 | 发货单号,与orderSn必须有一个 |
orderSn | string | 是 | 19051524196 | 订单号,与deliverySn必须有一个 |
file | string | 是 | 文件 base64数据 | |
fileType | string | 是 | 文件类型 (支持:pdf; PDF) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
发货单冻结 API
基本信息
HTTP
POST /order/freeze HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn:"DO22050986392",
orderSn:"678901018YW98B",
reason:"更换地址",
}
返回数据体示例
{
"code": 1,
"msg": "สำเร็จ",
"data": []
}
Path: /order/freeze
Method: POST
接口描述:
发货单冻结
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO22050986392 | 发货单号 |
orderSn | string | 否 | 678901018YW98B | 外部单号(发货单与外部单号至少传一个) |
reason | string | 否 | 冻结原因 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
发货单解冻 API
基本信息
HTTP
POST /order/unfreeze HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
deliverySn:"DO22050986392",
orderSn:"678901018YW98B",
reason:"解冻原因",
}
返回数据体示例
{
"code": 1,
"msg": "สำเร็จ",
"data": []
}
Path: /order/unfreeze
Method: POST
接口描述:
发货单解冻
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
deliverySn | string | 否 | DO22050986392 | 发货单号 |
orderSn | string | 否 | 678901018YW98B | 外部单号(发货单与外部单号至少传一个) |
reason | string | 否 | 解冻原因 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
出库(B2B) API
出库单添加 API
基本信息
HTTP
POST /open/returnWarehouseAdd HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
status: "1",
warehouseId: "1",
type: "1",
channelSource: "",
nodeSn: "TH01090201",
consigneeName: "Jack",
consigneePhone: "18615431841",
province: "bj",
city: "bj",
district: "hd",
postalCode: "100510",
consigneeAddress: "jyy",
deliveryWay: "logistics",
outTime: "2000-01-01",
goodsStatus: "normal",
remark: "normal",
goods: [
{
"i":"0",
"barCode":"FEX00025",
"goodsName":"test1",
"specification":"14*20*6 cm",
"num":"1","price":"400",
"remark":"remark1"
},{
"i":"1",
"barCode":"FEX00026",
"goodsName":"test2",
"specification":"14*20*7 cm",
"num":"2",
"price":"500",
"remark":"remark2"
}
],
orderSn: "",
}
返回数据体示例
{
msg: "成功",
code: 1,
data: "RW202001015689"
}
Path: /open/returnWarehouseAdd
Method: POST
接口描述:
商品格式
[{"i":"0","barCode":"FEX00025","goodsName":"测试接口1","specification":"14*20*6 cm","num":"1","price":"400","remark":"商品备注一"},{"i":"1","barCode":"FEX00026","goodsName":"测试接口2","specification":"14*20*7 cm","num":"2","price":"500","remark":"商品备注二"}]
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | text | 否 | [1]待审核 | |||||||||||||||||||||||||||||||||||||||||
warehouseId | text | 是 | 1 | 仓库ID | ||||||||||||||||||||||||||||||||||||||||
type | text | 否 | 1 | 退供出库 | ||||||||||||||||||||||||||||||||||||||||
channelSource | text | 否 | 来源渠道 | |||||||||||||||||||||||||||||||||||||||||
nodeSn | text | 否 | TH01090201 | 网点(客户)编码 | ||||||||||||||||||||||||||||||||||||||||
consigneeName | text | 是 | 收货人 | |||||||||||||||||||||||||||||||||||||||||
consigneePhone | text | 是 | 联系方式 | |||||||||||||||||||||||||||||||||||||||||
province | text | 是 | 省 | |||||||||||||||||||||||||||||||||||||||||
city | text | 是 | 市 | |||||||||||||||||||||||||||||||||||||||||
district | text | 否 | 区 | |||||||||||||||||||||||||||||||||||||||||
postalCode | text | 是 | 邮编 | |||||||||||||||||||||||||||||||||||||||||
consigneeAddress | text | 是 | 详细地址 | |||||||||||||||||||||||||||||||||||||||||
deliveryWay | text | 否 | 配送方式【物流 logistics】 【快递express】 【 到仓自取self】 | |||||||||||||||||||||||||||||||||||||||||
outTime | text | 否 | 期望出库时间, eg:2000-01-01 | |||||||||||||||||||||||||||||||||||||||||
goodsStatus | text | 否 | 【normal】正品 【bad】残品 | |||||||||||||||||||||||||||||||||||||||||
remark | text | 否 | 备注 | |||||||||||||||||||||||||||||||||||||||||
markName | text | 否 | 出库单标记名称 | |||||||||||||||||||||||||||||||||||||||||
orderSn | text | 是 | 外部订单号 | |||||||||||||||||||||||||||||||||||||||||
goods | text | 是 |
|
出库商品的json串 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 | 出库单号 |
出库单审核 API
基本信息
HTTP
POST /Audit/outbound HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
orderSn: "RW2003198368"
}
返回数据体示例
{
msg: "success",
code: 1,
data: []
}
Path: /Audit/outbound
Method: POST
接口描述:
出库单审核
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
orderSn | string | 是 | RW2003198368 | 出库单号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
出库单取消 API
基本信息
HTTP
POST /open/cancelOutbound HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
outSn: "RW20051524196",
orderSn: "123094889129392382838",
}
返回数据体示例
{
msg: "success",
code: 1,
data: []
}
Path: /open/cancelOutbound
Method: POST
接口描述:
通过出库单号或者外部订单号取消出库单
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
outSn | string | 否 | RW20051524196 | 出库单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (出库单号与外部订单号至少传一个参数) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
客户商品出库明细
基本信息
HTTP
POST /open/outBoundGoods HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
startTime: "2018-07-15",
endTime: "2018-07-18",
nodeSn: "TH3052641",
barCode: "BC001"
}
返回数据体示例
{
msg: "成功",
code: 1,
data: [
'FEX001'=>[
'barcode'=>'FEX001',
'name' =>'goods name1',
'outNumber'=>5,
'outSn' =>'RW202001018956',
'outWarehouseTime' =>'2020-01-02 14:20:20'
],
'FEX002'=>[
'barcode'=>'FEX002',
'name' =>'goods name2',
'outNumber'=>5,
'outSn' =>'RW202001018956',
'outWarehouseTime' =>'2020-01-02 14:20:20'
],
]
}
Path: /open/outBoundGoods
Method: POST
接口描述:
返回数据字段解释 barCode 商品条码, outNumber 出库数量 outWarehouseTime 出库时间 outSn 出库单单号 (方便测试使用)
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
startTime | text | 是 | 2018-07-15 | 查询开始日期 |
endTime | text | 是 | 2019-07-15 | 查询结束日期 开始时间结束时间不要大于一年 |
nodeSn | text | 是 | TH3052641 | 客户编码(网点编号) |
barCode | text | 是 | FEX001,FEX002 | 商品barcode多个以 逗号隔开 barcode1,barcode2,barcode3 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
Data
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
barCode | string | FEX001 | 条形码 |
name | string | goods name | 商品名称 |
outNumber | int | 5 | 出库数量 |
outSn | string | RW202001018956 | 出库单号 |
outWarehouseTime | string | 2020-01-02 14:20:20 | 出库时间 |
出库单处理进程信息
基本信息
HTTP
POST /open/getOutboundOrderStatus HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
outSn: "RW20051524196",
orderSn: "123094889129392382838",
}
返回数据体示例
{
msg: "success",
code: 1,
data: [
'outSn' =>'RW20051524196',
'orderSn' => '123094889129392382838',
'status' => '100',
'desc' =>'Outbounded',
'statusDetail'=>[
['status' => 30, 'statusDesc' => 'Wait for approved', 'time' =>'2020-06-08 08:30:32'],
['status' => 50, 'statusDesc' => 'Approved', 'time' =>'2020-06-08 09:30:32'],
['status' => 70, 'statusDesc' => 'On the Outbound', 'time' =>'2020-06-08 16:30:32'],
['status' => 80, 'statusDesc' => 'Picking completed','time' =>'2020-06-08 17:30:32'],
['status' => 90, 'statusDesc' => 'packed', 'time' =>'2020-06-08 18:30:32'],
['status' => 100, 'statusDesc' => 'Outbounded', 'time' =>'2020-06-10 17:50:50'],
],
'operateTime' => '2020-06-10 17:50:50'
]
}
Path: /open/getOutboundOrderStatus
Method: POST
接口描述:
通过出库单号或者外部订单号查询出库单处理进程信息
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
outSn | string | 否 | RW20051524196 | 出库单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (出库单号与外部订单号至少传一个参数) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
返回数据
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
outSn | string | RW20051524196 | 出库单号 |
orderSn | string | 123094889129392382838 | 外部单号 |
status | string | 10 | [10]:已作废;[20]:草稿;[30]:待审核;[40]:审核不过;[50]:已审核;[60]:库存分配失败;[70]:出库中;[80]:拣货完成;[90]:已打包;[100]:已出库;[110]:已完成; |
desc | string | Abolished | 描述 |
operateTime | string | 2020-06-12 10:05:01 | 时间 |
statusDetail | string | ['status' => 30, 'statusDesc' => 'Wait for approved', 'time' =>'2020-05-06 08:30:00'] |
出库单物流信息
基本信息
HTTP
POST /open/getOutboundTrackingInfo HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
outSn: "RW20051524196",
orderSn: "123094889129392382838",
}
返回数据体示例
{
msg: "success",
code: 1,
data: [
'outSn' =>'RW19051524196',
'orderSn' => '123094889129392382838',
'expressCompany' =>'FlashExpress',
'expressSn' => 'TH0102345RF',
'status' => 'Outbounded',
'trackingInfo' => [
[
'boxSn' =>'BOX20200586984',
'expressSn'=>'TH0102345RF',
'routes'=>'[已揽件2019-08-22 22:31:26 已到网点-BKKSS 2019-08-23 19:50:59 发往分拨 2019-08-24 09:31:03总分拨已收件 2019-08-24 09:47:29 总分拨已发出2019-08-24 15:18:04 已到达派送网点 2019-08-26 10:00:02 正在派送中 2019-08-26 10:00:02 感谢使用flashexpress 2019-08-26 10:00:02]'
]
]
]
}
Path: /open/getOutboundTrackingInfo
Method: POST
接口描述:
通过出库单号或者外部订单号查询出库单物流信息
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
outSn | string | 否 | RW20051524196 | 出库单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (出库单号与外部订单号至少传一个参数) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
返回数据
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
outSn | string | RW20051524196 | 出库单号 |
orderSn | string | 123094889129392382838 | 外部单号 |
status | string | Outbounded | 状态 |
expressCompany | string | FlashExpress | 快递公司 |
expressSn | string | TH0102345RF | 快递单号 |
trackingInfo | 运单跟踪明细 | ||
boxSn | string | BOX20200586984 | 箱单号 |
expressSn | string | TH0102345RF | 运单号 |
routes | string | [已揽件2019-08-22 22:31:26 已到网点-BKKSS 2019-08-23 19:50:59 发往分拨 2019-08-24 09:31:03总分拨已收件 2019-08-24 09:47:29 总分拨已发出2019-08-24 15:18:04 已到达派送网点 2019-08-26 10:00:02 正在派送中 2019-08-26 10:00:02 感谢使用flashexpress 2019-08-26 10:00:02] |
出库单列表 API
基本信息
HTTP
POST /open/outBoundOrderList HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params:
{
"startTime":"2020-01-01",
"endTime":"2020-01-01",
"status":"PACKED",
"orderSn":"ORDER123456",
"outSn":"RW2011279913",
"outBoundMark":"1"
}
返回数据体示例
{
"code":1,
"msg":"成功",
"data":{
"total":"4",
"list":[
{
"status":"PACKED",
"outSn":"RW2011279913",
"orderSn":"RW2011279913_order_sn",
"orderSource":"1",
"customerCode":"TH19040301",
"customerName":"FH-ประจวบคีรีขันธ์05 เก่า",
"consigneeName":"เมธา ธนูทอง",
"consigneePhone":"0871707898",
"address":"ร่อนทอง-บางสะพาน-ประจวบคีรีขันธ์-77230-ร่อนทอง",
"warehouseName":"泰国北区",
"kindNum":"1",
"goodsNum":"1",
"createUser":"小猪佩奇",
"created":"2020-11-27 18:52:14",
"verifyUser":"小猪佩奇",
"verifyTime":"2020-11-27 18:56:13",
"outTime":"2020-12-16",
"outWarehouseTime":"2020-12-16 20:03:16",
"type":"1",
"remark":"FH-ประจวบคีรีขันธ์05",
"outBoundMark":"1,2,3"
}
]
}
}
Path: /open/outBoundOrderList
Method: POST
接口描述: 查询出库单列表
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
startTime | text | Y | 2020-10-10 | 订单创建开始时间 |
endTime | text | Y | 2020-11-11 | 订单创建结束时间 |
status | text | N | PACKED | 订单状态,枚举值参见status enum |
outSn | text | N | 1234567890 | 出库单号 |
orderSn | text | N | 1234567890 | 订单号 |
outBoundMark | int | N | 1 | 出库标记, 枚举值见outBoundMark enum |
status enum
枚举值 | 备注 |
---|---|
CANCEL | 已作废 |
DRAFT | 草稿 |
AUDITING | 待审核 |
NO_AUDIT | 审核不过 |
AUDITED | 审核通过 |
UNDISTRIBUTED | 分配库存失败 |
DELIVERING | 出库中 |
PACKED | 已打包 |
DELIVERED | 已出库 |
COMPLETED | 已完成 |
outBoundMark enum
枚举值 | 备注 |
---|---|
1 | 拆分 |
2 | 合并 |
3 | 紧急 |
返回数据
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
code | number | Y | 1:成功,其他失败 | ||
msg | string | Y | 成功或失败信息描述 | ||
data | object | Y | 见 data 结构 |
data
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
total | number | Y | 总条数 | ||
list | []object | Y | 订单列表,字段见 list structure |
list structure
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
outSN | text | Y | 出库单号 | ||
orderSn | text | Y | 订单号 | ||
orderSource | text | Y | 订单来源 | ||
status | text | Y | 订单状态 | ||
customerCode | text | Y | 客户ID | ||
customerName | text | Y | 客户名称 | ||
consigneeName | text | Y | 收货人 | ||
consigneePhone | text | Y | 收货人联系方式 | ||
address | text | Y | 收货地址 | ||
warehouseName | text | Y | 发货仓库名称 | ||
kindNum | text | Y | 品种数 | ||
goodsNum | text | Y | 商品数量 | ||
createUser | text | Y | 创建人 | ||
created | text | Y | 创建时间 | ||
verifyUser | text | Y | 审核人 | ||
verifyTime | text | Y | 审核时间 | ||
outTime | text | Y | 预计出库日期 | ||
outWarehouseTime | text | Y | 出库时间 | ||
type | number | Y | 出库类型,枚举值见 type enum | ||
remark | text | Y | 备注 | ||
outBoundMark | text | Y | 标记,逗号分隔,枚举值见 outBoundMark enum |
type num
枚举值 | 备注 |
---|---|
1 | 人工录入 |
2 | 批量导入 |
3 | 接口获取 |
4 | 自动生成 |
出库单详情 API
基本信息
HTTP
POST /open/outBoundOrderDetail HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params:
{
"orderSn":"1234567890",
"outSn":"1234567890"
}
返回数据体示例
{
"code":1,
"msg":"成功",
"data":{
"orderSn":"RW2011279913_order_sn",
"outSn":"RW2011279913",
"orderSource":"1",
"status":"PACKED",
"customerCode":"TH19040301",
"customerName":"FH-ประจวบคีรีขันธ์05 เก่า",
"warehouseName":"泰国北区",
"consigneeName":"เมธา ธนูทอง",
"createdTime": "2023-06-27 08:20:32",
"verifyTime": "2023-06-27 15:22:12",
"completeTime": "2023-07-28 05:41:00",
"goods":[
{
"barCode":"amy4",
"name":"商品4",
"specification":"",
"out_num":"1",
"isSn":true,
"isShelfLife":true,
"stockOut":"0",
"snList":[
{
"sn":"SN86004",
"asset":""
}
],
"shelfLifeList":[{
"batchCode":"20181127",
"productionDate":"2000-01-01",
"expiringDate":"2000-01-01",
"num":10
}]
}
],
"box": [
{
"boxSn": "BOX230627523975",
"expressSn": "TH0101B3KU2C",
"goods": [
{
"barCode": "FEX624007",
"name": "FEX624007",
"specification": "",
"num": "100",
"image": "https://abc.com?123.jpg"
}
]
}
]
}
}
Path: /open/outBoundOrderDetail
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
orderSn | text | N | 2020-10-10 | 外部订单号 |
outSn | text | N | 2020-11-11 | 出库单号(orderSn、outSn 必须传递至少一个) |
返回数据
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
code | number | Y | 1:成功,其他失败 | ||
msg | string | Y | 成功或失败信息描述 | ||
data | object | Y | 返回数据 | 详情见 data_structure |
data
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
outSN | text | Y | 出库单号 | ||
orderSn | text | Y | 外部订单号 | ||
orderSource | text | Y | 订单来源 | ||
status | text | Y | 订单状态, 枚举值见 status enum | ||
customerCode | text | Y | 客户ID | ||
customerName | text | Y | 客户名称 | ||
consigneeName | text | Y | 收货人 | ||
warehouseName | text | Y | 发货仓库名称 | ||
createdTime | text | Y | 创建时间 | ||
verifyTime | text | Y | 审核时间 | ||
completeTime | text | Y | 完成时间 | ||
goods | []object | Y | 商品信息 | 详细字段见 goods_structure |
status enum
枚举值 | 备注 |
---|---|
CANCEL | 已作废 |
DRAFT | 草稿 |
AUDITING | 待审核 |
NO_AUDIT | 审核不过 |
AUDITED | 审核通过 |
UNDISTRIBUTED | 分配库存失败 |
DELIVERING | 出库中 |
PACKED | 已打包 |
DELIVERED | 已出库 |
COMPLETED | 已完成 |
goods_structure
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
barCode | text | Y | 商品条码 | ||
name | text | Y | 商品名称 | ||
specification | Y | text | 商品规格 | ||
outNum | number | Y | 出库数量 | ||
isSn | bool | Y | 是否SN商品 | ||
stockOut | number | Y | 是否缺货 0否 1是 | ||
isShelfLife | bool | Y | 是否保质期商品 | ||
snList | []object | Y | sn 商品信息 | 详细字段见 snList structure | |
shelfLifeList | []object | Y | 保质期商品信息 | 详细字段见 shelfLifeList structure |
snList structure
名称 | 类型 | 备注 |
---|---|---|
sn | text | 商品 sn 码 |
asset | text | 商品 asset |
shelfLifeList structure
名称 | 类型 | 备注 |
---|---|---|
batchCode | text | 批次号 |
productionDate | text | 生产日期 |
expiringDate | text | 过期日期 |
num | number | 保质期商品数量 |
出库单详情(new) API
基本信息
HTTP
POST /return_warehouse/outBoundOrderDetail HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params:
{
"orderSn":"1234567890",
"outSn":"1234567890"
}
返回数据体示例
{
"code":1,
"msg":"\u0e2a\u0e33\u0e40\u0e23\u0e47\u0e08",
"data":[
{
"orderSn":"outRW2308303527",
"outSn":"RW2308303527",
"orderSource":"1",
"status":"PACKED",
"customerCode":"",
"customerName":"",
"warehouseName":"",
"consigneeName":"aaa",
"consigneePhone":"0987654321",
"consignee_address":"aa",
"consigneeProvince":"\u0e01\u0e23\u0e38\u0e07\u0e40\u0e17\u0e1e",
"consigneeCity":"\u0e04\u0e25\u0e2d\u0e07\u0e40\u0e15\u0e22",
"consigneeDistrict":"\u0e04\u0e25\u0e2d\u0e07\u0e40\u0e15\u0e22",
"warehouseProvince":"\u0e01\u0e23\u0e38\u0e07\u0e40\u0e17\u0e1e",
"warehouseCity":"\u0e04\u0e25\u0e2d\u0e07\u0e40\u0e15\u0e22",
"warehouseDistrict":"\u0e04\u0e25\u0e2d\u0e07\u0e40\u0e15\u0e22",
"warehouseAddress":"test",
"warehousePostCode":"10110",
"createdTime": "2023-06-27 08:20:32",
"verifyTime": "2023-06-27 15:22:12",
"completeTime": "2023-07-28 05:41:00",
"goods":[
{
"barCode":"1011",
"name":"test1111111111111111111111111112",
"specification":"\u578b\u53f7333333333333333333333",
"outNum":"10",
"isSn":false,
"isShelfLife":false,
"snList":[
],
"shelfLifeList":[
],
"stockOut":"0"
},
{
"barCode":"101101",
"name":"101101",
"specification":"",
"outNum":"1",
"isSn":false,
"isShelfLife":false,
"snList":[
],
"shelfLifeList":[
],
"stockOut":"0"
}
],
"box":[
{
"boxSn":"BOX230830334013",
"expressSn":["TH0101B72N0B0"],
"goods":[
{
"barCode":"1011",
"name":"test1111111111111111111111111112",
"specification":"\u578b\u53f7333333333333333333333",
"num":"10",
"image":"https:\/\/wms-dev-fe.oss-ap-southeast-1.aliyuncs.com\/static\/image\/e23b38df173a697f0a6d3684e4c74d61.png"
},
{
"barCode":"101101",
"name":"101101",
"specification":"",
"num":"1",
"image":"https:\/\/wms-dev-fe.oss-ap-southeast-1.aliyuncs.com\/static\/image\/d2decdef43ea9a52f385463d26290f27.jpeg"
}
]
}
]
},
{
"orderSn":"outRW2308303527",
"outSn":"RW2308307351",
"orderSource":"1",
"status":"AUDITING",
"customerCode":"",
"customerName":"",
"warehouseName":"",
"consigneeName":"aaa",
"consigneePhone":"0987654321",
"consignee_address":"aa",
"consigneeProvince":"\u0e01\u0e23\u0e38\u0e07\u0e40\u0e17\u0e1e",
"consigneeCity":"\u0e04\u0e25\u0e2d\u0e07\u0e40\u0e15\u0e22",
"consigneeDistrict":"\u0e04\u0e25\u0e2d\u0e07\u0e40\u0e15\u0e22",
"warehouseProvince":"\u0e01\u0e23\u0e38\u0e07\u0e40\u0e17\u0e1e",
"warehouseCity":"\u0e04\u0e25\u0e2d\u0e07\u0e40\u0e15\u0e22",
"warehouseDistrict":"\u0e04\u0e25\u0e2d\u0e07\u0e40\u0e15\u0e22",
"warehouseAddress":"test",
"warehousePostCode":"10110",
"goods":[
{
"barCode":"1010",
"name":"LP00528833848227",
"specification":"zzzz",
"outNum":"10",
"isSn":true,
"isShelfLife":false,
"snList":[
],
"shelfLifeList":[
],
"stockOut":"0"
}
],
"box":[
]
}
]
}
Path: /return_warehouse/outBoundOrderDetail
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
orderSn | text | N | 2020-10-10 | 外部订单号 |
outSn | text | N | 2020-11-11 | 出库单号(orderSn、outSn 必须传递至少一个) |
返回数据
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
code | number | Y | 1:成功,其他失败 | ||
msg | string | Y | 成功或失败信息描述 | ||
data | object | Y | 返回数据 | 详情见 data_structure |
data
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
outSN | text | Y | 出库单号 | ||
orderSn | text | Y | 外部订单号 | ||
orderSource | text | Y | 订单来源 | ||
status | text | Y | 订单状态, 枚举值见 status enum | ||
customerCode | text | Y | 客户ID | ||
customerName | text | Y | 客户名称 | ||
consigneeName | text | Y | 收货人 | ||
warehouseName | text | Y | 发货仓库名称 | ||
createdTime | text | Y | 创建时间 | ||
verifyTime | text | Y | 审核时间 | ||
completeTime | text | Y | 完成时间 | ||
goods | []object | Y | 商品信息 | 详细字段见 goods_structure | |
box | []object | Y | 箱单信息 | 详细字段见 box_structure |
status enum
枚举值 | 备注 |
---|---|
CANCEL | 已作废 |
DRAFT | 草稿 |
AUDITING | 待审核 |
NO_AUDIT | 审核不过 |
AUDITED | 审核通过 |
UNDISTRIBUTED | 分配库存失败 |
DELIVERING | 出库中 |
PACKED | 已打包 |
DELIVERED | 已出库 |
COMPLETED | 已完成 |
data.goods structure
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
barCode | text | Y | 商品条码 | ||
name | text | Y | 商品名称 | ||
specification | Y | text | 商品规格 | ||
outNum | number | Y | 出库数量 | ||
isSn | bool | Y | 是否SN商品 | ||
stockOut | number | Y | 是否缺货 0否 1是 | ||
isShelfLife | bool | Y | 是否保质期商品 | ||
snList | []object | Y | sn 商品信息 | 详细字段见 snList structure | |
shelfLifeList | []object | Y | 保质期商品信息 | 详细字段见 shelfLifeList structure |
goods.snList structure
名称 | 类型 | 备注 |
---|---|---|
sn | text | 商品 sn 码 |
asset | text | 商品 asset |
goods.shelfLifeList structure
名称 | 类型 | 备注 |
---|---|---|
batchCode | text | 批次号 |
productionDate | text | 生产日期 |
expiringDate | text | 过期日期 |
num | number | 保质期商品数量 |
data.box structure
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
boxSn | text | Y | 箱单号 | ||
expressSn | []string | Y | 运单号 | ||
goods | []object | Y | 箱单中商品信息 | 详细字段见 box.goods structure |
box.goods structure
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
barCode | text | Y | 商品条码 | ||
name | text | Y | 商品名称 | ||
specification | Y | text | 商品规格 | ||
num | number | Y | 箱中的商品数量 | ||
image | text | Y | 商品图片 |
出库单物流信息(new)
基本信息
HTTP
POST /return_warehouse/getOutboundTrackingInfo HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
outSn: "RW20051524196",
orderSn: "123094889129392382838",
}
返回数据体示例
{
"code": 1,
"msg": "\u0e2a\u0e33\u0e40\u0e23\u0e47\u0e08",
"data": [
{
"outSn": "RW2308089453",
"orderSn": "FE0169147641825535_1",
"status": "Outbounded",
"expressCompany": "Flash Express",
"expressSn": ["TH0101B5P82C"],
"trackingInfo": [
{
"boxSn": "BOX230808271824",
"expressSn": "TH0101B5P82C",
"routes": [
{
"id": "1183",
"type": "2",
"businessId": "848",
"expressSn": "TH0101B5P82C",
"lang": "th",
"routeAction": "DELIVERY_CONFIRM",
"message": "\u0e19\u0e33\u0e2a\u0e48\u0e07\u0e2a\u0e33\u0e40\u0e23\u0e47\u0e08 \u0e40\u0e0b\u0e47\u0e19\u0e23\u0e31\u0e1a\u0e42\u0e14\u0e22\u30101111111111111(\u0e40\u0e08\u0e49\u0e32\u0e02\u0e2d\u0e07\u0e2a\u0e34\u0e19\u0e04\u0e49\u0e32)\u3011 \u0e02\u0e2d\u0e1a\u0e04\u0e38\u0e13\u0e17\u0e35\u0e48\u0e43\u0e0a\u0e49\u0e1a\u0e23\u0e34\u0e01\u0e32\u0e23 Flash Express",
"routeTime": "1691498246"
}
]
}
]
}
]
}
Path: /return_warehouse/getOutboundTrackingInfo
Method: POST
接口描述:
通过出库单号或者外部订单号查询出库单物流信息
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
outSn | string | 否 | RW20051524196 | 出库单号 |
orderSn | string | 否 | 123094889129392382838 | 外部订单号 (出库单号与外部订单号至少传一个参数) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
返回数据
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
outSn | string | RW20051524196 | 出库单号 |
orderSn | string | 123094889129392382838 | 外部单号 |
status | string | Outbounded | 状态 |
expressCompany | string | FlashExpress | 快递公司 |
expressSn | []string | TH0102345RF | 快递单号 |
trackingInfo | []object | 运单跟踪明细 | |
boxSn | string | BOX20200586984 | 箱单号 |
expressSn | string | TH0102345RF | 运单号 |
routes | []object | ||
routeAction | string | 节点 | |
message | string | 描述 | |
routeTime | string | 时间戳 |
销退 API
销退单新增 API
基本信息
HTTP
POST /rollback_order/add HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
externalOrderSn: "EOS001",
backType: "allRejected",
backReason: "",
deliverySn: "",
externalUserInfo: "",
senderAddress: "senderAddress",
senderCountry: "",
province: "bj",
city: "bj",
district: "hd",
postalCode: "100100",
senderName: "Jack",
senderPhone: "18641586981",
carrier: "",
backExpressSn: "",
oriExpressSn: "",
weight: "",
size: "",
buyerRemark: "",
backPayMode: "cod",
backStatus: "",
bankId: "",
payee: "",
bankName: "",
warehouseId: "78",
goods: [
{
"barCode":"BC001",
"num":34,
"price":5565
},{
"barCode":"BC002",
"num":2,
"price":1200
}
],
ignorePrice: "0"
}
返回数据体示例
{
msg: "success",
code: 1,
data: 'SR2001018596'
}
Path: /rollback_order/add
Method: POST
接口描述:
{
"code":1,
"msg":"success",
"data":"SR2001018596"
}
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
externalOrderSn | text | 是 | dsfsfsf | 订单号(外部订单号) | ||||||||||||||||||||
backType | text | 是 | allRejected | 退货类型 [primary] 普通退货 | ||||||||||||||||||||
backReason | text | 否 | jijijijiji | 退回原因 | ||||||||||||||||||||
deliverySn | text | 否 | DO19081217361 | 销售订单号(SCM发货单号) | ||||||||||||||||||||
externalUserInfo | text | 否 | xingfukuaidi12 | 用户ID(用户在电商平台的用户) | ||||||||||||||||||||
senderAddress | text | 是 | ||||||||||||||||||||||
province | text | 是 | กรุงเทพ | 省 | ||||||||||||||||||||
city | text | 是 | คลองสามวา | 市 | ||||||||||||||||||||
district | text | 否 | ทรายกองดิน | 区 | ||||||||||||||||||||
postalCode | text | 是 | 10510 | 邮政编码 | ||||||||||||||||||||
senderName | text | 是 | binbin | 寄件人姓名 | ||||||||||||||||||||
senderPhone | text | 是 | 34534373457474 | 寄件人电话号码 9-20位数字 | ||||||||||||||||||||
carrier | text | 否 | 快递 | 承运商 | ||||||||||||||||||||
backExpressSn | text | 否 | 急急急试试 | 退回运单号 | ||||||||||||||||||||
oriExpressSn | text | 否 | 急急急 | 原运单号 | ||||||||||||||||||||
weight | text | 否 | 56 | 订单重量 g 传整形 | ||||||||||||||||||||
size | text | 否 | 4445 | 订单尺寸 mm 传整型 | ||||||||||||||||||||
buyerRemark | text | 否 | 备注 | 买家备注 | ||||||||||||||||||||
backPayMode | text | 是 | cod | 付款类型 枚举值 bank online cod | ||||||||||||||||||||
backStatus | text | 否 | 1 | 退款状态 枚举值 默认1 1:待退款 2:已退款 3:不退款 | ||||||||||||||||||||
bankId | text | 否 | 电饭锅 | 退款账号 | ||||||||||||||||||||
payee | text | 否 | lolo | 收款人 | ||||||||||||||||||||
bankName | text | 否 | 建行 | 银行 | ||||||||||||||||||||
warehouseId | text | 是 | 78 | 仓库ID | ||||||||||||||||||||
ignorePrice | text | 否 | 0 | [0]No [1]Yes | ||||||||||||||||||||
goods | text | 是 |
|
销退商品的json串 | ||||||||||||||||||||
check | text | 否 | 1 | [1]自动审核 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 | 销退单号 |
销退单审核 API
基本信息
HTTP
POST /Audit/returnBill HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
orderSn: "SR2003198368"
}
返回数据体示例
{
msg: "success",
code: 1,
data: []
}
Path: /Audit/returnBill
Method: POST
接口描述:
销退单审核
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
orderSn | string | 是 | SR2003198368 | 销退单号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
销退单取消 API
基本信息
HTTP
POST /rollback_order/cancel HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
orderSn: "SR2003198368",
externalOrderSn: "AA001",
cancelReason: "cancel reason",
}
返回数据体示例
{
msg: "success",
code: 1,
data: []
}
Path: /rollback_order/cancel
Method: POST
接口描述:
销退单取消
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
orderSn | string | 否 | SR2003198368 | 销退单号 |
externalOrderSn | string | 是 | SR2003198368 | 外部单号 |
cancelReason | string | 否 | cancel | 取消原因 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
销退单详情 API
基本信息
HTTP
POST /Inbound/getDeliveryRollbackOrderDetail HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
baskSn: "SR1908134403",
orderSn: ""
}
返回数据体示例
{
"code": 1,
"msg": "成功",
"data": [
{
"warehouseId": "78",
"warehouseName": "warehouse",
"backSn": "SR1908134403",
"orderSn": "erte77ru",
"status": "1060",
"backType": "allRejected",
"backReason": "5",
"deliverySn": "DO19081217361xgdgd",
"userId": "hhh",
"senderAddress": "dfdf",
"senderCountry": "th",
"senderProvince": "กรุงเทพ",
"senderCity": "คลองสามวา",
"senderDistrict": "ทรายกองดิน",
"senderPostalCode": "10510",
"senderMan": "zhanglibin",
"senderManPhone": "4588888888",
"oriExpressSn": "fffffffffffffff",
"backExpressSn": "dddddddddddddd",
"Carrier": "",
"totalWeight": "12",
"totalSize": "45",
"buyerRemark": "eee",
"backPayMode": "cod",
"backStatus": "2",
"bankId": "tytytyty",
"payee": "zhanglibin",
"bankName": "kaitaiBankfdgdfg",
"goodsList": [
{
"rowNumber": 1,
"barCode": "4",
"goodsName": "ssss",
"specification": "",
"backGoodsNumber": "343",
"backGoodsInNumber": "400",
"backGoodsTotalPrice": "5625200",
"qualityStatus":{
"normalNum": "2",
"badNum": 0
}
}
]
}
]
}
Path: /Inbound/getDeliveryRollbackOrderDetail
Method: POST
接口描述:
销退单详情
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
backSn | string | 否 | SR2003198368 | 销退单号 |
orderSn | string | 否 | 外部单号(销退单号 与外部单号至少传一个) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | ||||
msg | string | ||||
data | object[list] | ||||
warehouseId | number | 仓库ID | |||
warehouseName | string | 仓库名称 | |||
backSn | number | 销退单号 | |||
orderSn | string | 外部单号 | |||
status | string | 状态 | [1000] 取消退货 [1001] 已删除 [1010] 无需退回直接退款 [1020]待审核 [1030]等待买家寄回 [1040]买家已寄回 [1045] 已到货 [1050] 收货中[1060] 收货完成 | ||
backType | string | 退货类型 | [primary]普通退货 [backgoods]退货换货 [allRejected]全部拒收 | ||
backReason | string | 退回原因 | [1] 7天无理由 [2] 质量问题 [3] 过期 [4] 破损 [5] 其他 | ||
userId | string | 用户ID | 用户在电商平台的用户 | ||
senderAddress | string | 寄件人详细地址 | |||
senderCountry | enum | 寄件人国家 | 不填默认泰国 | ||
senderProvince | string | 寄件人省 | |||
senderCity | string | 寄件人市 | |||
senderDistrict | string | 寄件人区 | |||
senderPostalCode | string | 寄件人邮政编码 | |||
senderMan | string | 寄件人姓名 | |||
senderManPhone | string | 电话号码 | |||
oriExpressSn | string | 原运单号 | |||
backExpressSn | string | 退回运单号 | |||
carrier | string | 承运商 | |||
totalWeight | string | 订单重量 | g | ||
totalSize | string | 订单尺寸 | mm | ||
buyerRemark | string | 买家备注 | |||
backPayMode | string | 退款方式 | [bank] 银行转账 [online] 在线支付 [cod] 货到付款 | ||
backStatus | string | 退款状态 | [1] 待退款 [2] 已退款 [3] 不退款 | ||
bankId | string | 收款账号 | |||
payee | string | 收款人 | |||
bankName | string | 银行 | |||
goodsList | object[list] | 商品信息 | |||
- rowNumber | number | 行号(顺序号) | |||
- barCode | string | 商品条形码 | |||
- goodsName | string | 商品名称 | |||
- specification | string | 商品规格 | |||
- backGoodsNumber | number | 退货数量 | |||
- backGoodsInNumber | number | 收货数量 | 收货完成才有收货数量 | ||
- backGoodsTotalPrice | number | 退货价 | 单位 萨当 | ||
- qualityStatus | object | ||||
- - normalNum | string | 10 | |||
- - badNum | string | 2 |
销退单列表 API
基本信息
HTTP
POST /rollback_order/getOrderList HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
"storeCode":"s-001",
"warehouseNo":"w-001",
"status":"",
"sourceType":"",
"startTime":"2023-01-01 00:00:00",
"endTime":"2023-08-30 00:00:00",
"page":"1",
"limit":"1"
}
返回数据体示例
{
"code": 1,
"msg": "\u0e2a\u0e33\u0e40\u0e23\u0e47\u0e08",
"data": {
"list": [
{
"backSn": "SR2308087707",
"orderSn": "o-111",
"warehouseNo": "JQKA",
"warehouseName": null,
"status": "1060",
"storeCode": "s-001",
"storeName": "s-002",
"sourceType": 1,
"created": "2023-08-08 09:47:00"
}
],
"totalPages": 214,
"totalItems": "214"
}
}
Path: /rollback_order/getOrderList
Method: POST
接口描述:
销退单详情
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
storeCode | string | 否 | s-001 | 店铺编码 |
warehouseNo | string | 否 | w-001 | 仓库编码 |
status | string | 否 | 状态 | |
sourceType | string | 否 | 来源 | |
warehouseNo | string | 否 | w-001 | 仓库编码 |
startTime | string | 是 | 2023-01-01 00:00:00 | |
endTime | string | 是 | 2023-09-01 00:00:00 |
status enum
枚举值 | 备注 |
---|---|
1010 | 无需寄回,直接退款 |
1020 | 等待审核 |
1030 | 审核完成 |
1040 | 买家已寄回 |
1045 | 已到货 |
1050 | 收获中 |
1060 | 收货完成 |
sourceType enum
枚举值 | 备注 |
---|---|
1 | 货主录入 |
2 | 仓库录入 |
3 | 接口获取 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 |
---|---|---|---|---|
code | number | |||
msg | string | |||
data | object |
data['list']
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
backSn | string | b-001 | 销退单号 |
orderSn | string | o-001 | 外部单号 |
warehouseNo | string | w-001 | 仓库编码 |
warehouseName | string | w_name | 仓库名称 |
status | string | 1010 | 状态 |
storeCode | string | s-001 | 店铺编码 |
storeName | string | s-name | 店铺名称 |
sourceType | string | 1 | 来源 |
created | string | 2023-08-01 00:00:00 | 创建时间 |
库存 API
仓库库存查询 API
基本信息
HTTP
POST /open/goodsStock HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
barCode: "BC001",
warehouseId: "1",
goodsStatus: "normal",
startTime :'2020-01-01 00:00:00',
endTime :'2020-01-02 23:59:59'
}
返回数据体示例
{
msg: "成功",
code: 1,
data: {
BBBUI: {
availableInventory: "10",
totalInventory: "105",
inventory: "95"
},
NOINI: {
availableInventory: "2",
totalInventory: "2",
inventory: "0"
}
}
}
Path: /open/goodsStock
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
barCode | text | 否 | O3O2O1O,BBBUI,NNN | 条形码 多个用,隔开,验证正则 ^[\w-]+(,[\w-]+)* |
warehouseId | text | 否 | 1 | 仓库ID,不填默认全部仓库 |
goodsStatus | text | 否 | normal | 质量状态[normal]正品(默认),[bad]残品 |
goodsType | text | 否 | normal | 商品类型[normal]普通,[set]套装 |
startTime | text | 否 | 2020-01-01 00:00:00 | 开始时间 |
endTime | text | 否 | 2020-01-01 23:59:59 | 结束时间 ( 时间范围的跨度不能大于1天) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
msg | string | 非必须 | |||
code | number | 非必须 | |||
data | object | 非必须 | |||
├─ O3O2O1O | object | 非必须 | |||
├─ availableInventory | integer | 非必须 | 可售库存 | ||
├─ totalInventory | integer | 非必须 | 实物库存 | ||
├─ inventory | integer | 非必须 | 可用库存 | ||
├─ BBBUI | object | 非必须 | |||
├─ availableInventory | string | 非必须 | |||
├─ totalInventory | string | 非必须 | |||
├─ inventory | string | 非必须 | |||
├─ NNN | object | 非必须 | |||
├─ availableInventory | string | 非必须 | |||
├─ totalInventory | string | 非必须 | |||
├─ inventory | string | 非必须 |
仓库库存查询 API(返回错误的Barcode)
基本信息
HTTP
POST /open/goodsStockWithErrBarcode HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
barCode: "BC001",
warehouseId: "1",
goodsStatus: "normal",
startTime :'2020-01-01 00:00:00',
endTime :'2020-01-02 23:59:59'
}
返回数据体示例
{
"code": 1,
"msg": "成功",
"data": {
"stock": {
"goods001": {
"totalInventory": "100", //实物库存
"inventory": "88", //可用库存
"availableInventory": "88"//可售库存
},
"goods002": {
"totalInventory": "100", //实物库存
"inventory": "88", //可用库存
"availableInventory": "88"//可售库存
}
},
"errBarcode": [//错误的barcode
"goods001",
"zzz",
"kkkkk",
"kkkk"
]
}
}
{
"code": 1718,
"msg": "商品类型非法",
"data": []
}
Path: /open/goodsStockWithErrBarcode
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
barCode | text | 否 | O3O2O1O,BBBUI,NNN | 条形码 多个用,隔开,验证正则 ^[\w-]+(,[\w-]+)* |
warehouseId | text | 否 | 1 | 仓库ID,不填默认全部仓库 |
goodsStatus | text | 否 | normal | 质量状态[normal]正品(默认),[bad]残品 |
goodsType | text | 否 | normal | 商品类型[normal]普通,[set]套装 |
startTime | text | 否 | 2020-01-01 00:00:00 | 开始时间 |
endTime | text | 否 | 2020-01-01 23:59:59 | 结束时间 ( 时间范围的跨度不能大于1天) |
返回数据
详细结构见右侧
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
msg | string | 必须 | |||
code | number | 必须 | |||
data | object | 必须 |
SN库存查询 API
基本信息
HTTP
POST /open/getSnList HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
barCode: "BC001",
warehouseId: "1",
goodsStatus: "normal",
status: "1",
inWarehouseSn: "",
outWarehouseSn: "",
snCode: "",
assetCode: "",
limit: 50,
page: 50,
}
返回数据体示例
{
"code": 1,
"msg": "成功",
"data": {
"items": [
{
"warehouseId": "78",
"warehouseName": "warehouse",
"barCode": "999",
"goodsStatus": "normal",
"status": "1",
"snCode": "2222",
"assetCode": "",
"inWarehouseSn": "AN1910101280",
"inTime": "2019-10-14 16:27:28",
"outWarehouseSn": "",
"outTime": "",
"remark": ""
},
],
"first": 1,
"before": 1,
"previous": 1,
"current": 1,
"last": 1,
"next": 1,
"total_pages": 1,
"total_items": 1,
"limit": 50
}
}
Path: /open/getSnList
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
barCode | text | 是 | O3O2O1O,BBBUI,NNN | 条形码 多个用,隔开,验证正则 ^[\w-]+(,[\w-]+)* |
warehouseId | text | 否 | 1 | 仓库ID,不填默认全部仓库 |
goodsStatus | text | 否 | normal | 质量状态[normal]正品(默认),[bad]残品 |
status | text | 否 | 1 | 状态 [1]已入库(默认), [3] 已占用, [4]已出库 |
inWarehouseSn | text | 否 | 入库单号 | |
outWarehouseSn | text | 否 | 出库单号 | |
snCode | text | 否 | SN | |
assetCode | text | 否 | ASSET | |
limit | text | 否 | 50 | 查询每页显示的数据量,不传默认为50,表示每页显示的数据量为50,最大不能超过10000 |
page | text | 否 | 1 | 查询的页码,不传默认为1,表示第一页 |
返回数据
body
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
code | number | ||
msg | string | ||
data | object | ||
first | number | ||
before | number | ||
previous | number | ||
current | number | ||
last | number | ||
next | number | ||
total_pages | number | 总页数 | |
total_items | number | 总条数 | |
limit | number | ||
items | object | ||
warehouseId | number | 仓库ID | |
warehouseName | string | 仓库名称 | |
barCode | string | 条形码 | |
goodsStatus | string | 质量状态 | |
status | number | 状态 | |
snCode | string | sn码 | |
assetCode | string | asset码 | |
inWarehouseSn | string | 入库单号 | |
inTime | string | 入库时间 | |
outWarehouseSn | string | 出库单号 | |
outTime | string | 出库时间 | |
remark | string | 备注 |
保质期库存查询 API
基本信息
HTTP
POST /open/shelfLifeGoodsStock HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
barCode: "BC001,BC002",
warehouseId: "1",
goodsStatus: "normal"
}
返回数据体示例
{
"code": 1,
"msg": "成功",
"data": [
{
"warehouseId": "1",
"totalInventory": "498",
"qualityStatus": "normal",
"sellerGoodsBatchCode": "20190117",
"productionDate": "2019-01-17",
"expiringDate": "2019-03-03",
"nearDateType": "2",
"lockUpDate": "2019-03-03",
"barCode": "BC001"
},
{
"warehouseId": "1",
"totalInventory": "501",
"qualityStatus": "normal",
"sellerGoodsBatchCode": "20190118",
"productionDate": "2019-01-18",
"expiringDate": "2019-03-04",
"nearDateType": "2",
"lockUpDate": "2019-03-04",
"barCode": "BC002"
}
]
}
Path: /open/shelfLifeGoodsStock
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
barCode | text | 是 | O3O2O1O,BBBUI,NNN | 条形码 多个用,隔开,验证正则 ^[\w-]+(,[\w-]+)* |
warehouseId | text | 否 | 1 | 仓库ID,不填默认全部仓库 |
goodsStatus | text | 否 | normal | 质量状态[normal]正品(默认),[bad]残品 |
返回数据
body
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
code | number | ||
msg | string | ||
data | object | ||
warehouseId | string | 仓库ID | |
totalInventory | string | 实物库存 | |
goodsStatus | string | 质量状态 | |
sellerGoodsBatchCode | string | 批次号 | |
productionDate | string | 生产日期 | |
expiringDate | string | 失效日期 | |
lockUpDate | string | 禁售日期 | |
barCode | string | 条形码 | |
nearDateType | string | 临期类型 0正常 1临期预警 2已过期 |
出入库流水 API
基本信息
HTTP
POST /warehouse/inOutLog HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
"warehouseId":1,
"inOutType":1,
"startTime":"2023-01-01 00:00:00",
"endTime":"2023-01-02 00:00:00",
"limit":10,
"page":1
}
返回数据体示例
{
"code": 1,
"msg": "\u0e2a\u0e33\u0e40\u0e23\u0e47\u0e08",
"data": {
"list": [
{
"barCode": "1011",
"warehouseName": "\u81ea\u52a8\u4ed3",
"qualityStatus": "normal",
"number": "10000",
"businessSn": "AN2309026879",
"businessType": "InWarehouse",
"operateTime": "2023-09-02 03:37:08",
"externalOrderSn": "123123123"
},
{
"barCode": "1012",
"warehouseName": "\u81ea\u52a8\u4ed3",
"qualityStatus": "normal",
"number": "10000",
"businessSn": "AN2309026879",
"businessType": "InWarehouse",
"operateTime": "2023-09-02 03:37:08",
"externalOrderSn": ""
}
],
"totalItems": 35,
"totalPages": 18
}
}
Path: /warehouse/inOutLog
Method: POST
接口描述:
出入库流水
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
warehouseId | string | 否 | 1 | 仓库 ID |
inOutType | string | 否 | 1 | 1:入库 2:出库 |
startTime | string | 是 | 2023-01-01 00:00:00 | |
endTime | string | 是 | 2023-01-01 00:00:00,最大时间区间为一个月 | |
limit | string | 否 | 10,最大 500 | 默认值 10,最大 500 |
page | string | 否 | 1 | 默认值 1 |
返回数据
名称 | 类型 | 是否必须 | 备注 | 默认值 | 其他信息 |
---|---|---|---|---|---|
code | number | Y | 1:成功,其他失败 | ||
msg | string | Y | 成功或失败信息描述 | ||
data | []object | Y | 返回数据 | 详情见 data_structure |
data.list
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
barCode | string | 商品条码 | |
warehouseName | string | 仓库名称 | |
qualityStatus | string | 质量状态:normal, bad | |
number | string | goods num | |
businessSn | string | 单据 | |
businessType | string | 入库:InWarehouse, 出库OutWarehouse | |
operateTime | string | ||
externalOrderSn | string | 外部单号 |
仓库库存查询 API(page)
基本信息
HTTP
POST /goods/stock HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
barCode: "BC001",
warehouseId: "1",
goodsStatus: "normal",
page: "1",
pageSize: "100"
}
返回数据体示例
{
"code": 1,
"msg": "\u0e2a\u0e33\u0e40\u0e23\u0e47\u0e08",
"data": {
"page": "1",
"pageSize": "1",
"list": {
"1010": {
"normal": {
"totalInventory": "40485",
"inventory": "39857",
"availableInventory": "26327"
}
}
}
}
}
Path: /goods/stock
Method: POST
接口描述:
- 如果查询套装商品,只能通过 barCode 查询, 不支持指定 warehouseId, startTime, endTime, goodsStatus .
- 查询结果中,套装商品不区分正残品
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
barCode | text | 否 | O3O2O1O,BBBUI,NNN | 条形码 多个用,隔开,验证正则 ^[\w-]+(,[\w-]+)* |
warehouseId | text | 否 | 1 | 仓库ID,不填默认全部仓库 |
goodsStatus | text | 否 | normal | 质量状态[normal]正品(默认),[bad]残品 |
page | text | 否 | 1 | |
pageSize | text | 否 | 100 | |
startTime | text | 否 | 2023-01-01 00:00:00 | 时间范围最大为 1 天 |
endTime | text | 否 | 2023-01-02 00:00:00 | 时间范围最大为 1 天 |
返回数据
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
code | number | ||
msg | string | ||
data | object | ||
page | number | ||
pageSize | number | ||
list | []object | ||
barcode_as_key | []object | barcode as key | |
normal | object | goods status | |
totalInventory | string | 总库存 | |
inventory | string | 可用库存 | |
availableInventory | string | 可售库存 |
换单 API
换单订单新增 API
基本信息
HTTP
POST /seller_address/create HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
"mchId":"S0002",
"sign":"sign",
"storeCode":"S0001",
"warehouseCode":"xiaodong1",
"externalOrder":"E0000000333333",
"transferType":1,
"packageExpressSn":"P222",
"expressSn":"",
"payType":2,
"amount":111,
"isInsurance":1,
"insuranceAmount":22,
"remark":"remark",
"consignee":"Lily",
"province":"AAA",
"city":"BBB",
"district":"CCC",
"address":"address0000001",
"consigneePhone":"0123123123",
"senderProvince":"AAA",
"senderCity":"BBB",
"senderDistrict":"CCC",
"senderAddress":"1-2-3",
"senderPhone":"123123123123",
"customsInfo":[
{
"productType":"Lee",
"productName":"1111",
"productQuantity":10,
"productValue":"111",
"productBarcode":"111",
"productNameEn":"111",
"productBrand":"111",
"productOrigin":"11111",
"weight":111
}
]
}
返回数据体示例
{
"msg": "success",
"code": 1,
"data": []
}
Path: /transfer_order/add
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
storeCode | text | Y | S0001 | 店铺编码 |
warehouseCode | text | Y | W0001 | 仓库编码 |
externalOrder | text | Y | 1234567 | 平台订单号 |
transferType | text | Y | 1 | 1:一件一包裹 2:一件多包裹 |
packageExpressSn | text | Y | 0001,0002 | 国内运单号,多个逗号分隔 |
expressSn | text | N | 1234567 | 海外快递,尾程运单号 |
payType | text | Y | 1 | 支付方式:1:COD, 2:Online payment' |
amount | text | Y | 100.10 | 订单金额 |
isInsurance | text | N | 1 | 是否保价 |
insuranceAmount | text | N | 100.10 | 保价金额 |
remark | text | N | glass | 备注 |
consignee | text | Y | Lily | 收货人 |
province | text | Y | 北京 | 省份 |
city | text | Y | 北京 | 城市 |
district | text | Y | 朝阳 | 区域 |
address | text | Y | 15号 | 详细地址 |
consigneePhone | text | Y | 13200000000 | 收件人联系方式 |
senderProvince | text | N | 北京 | 发件人省份 |
senderCity | text | N | 北京 | 发件人城市 |
senderDistrict | text | N | 朝阳 | 发件人区域 |
senderAddress | text | N | 15号 | 发件人详细地址 |
senderPhone | text | N | 13200000000 | 发件人联系电话 |
postalCode | text | N | 100000 | 邮编 |
customsInfo | text | Y | 见customsInfo格式 | 清关信息,json字符串 |
customsInfo
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
productType | text | N | 商品类型 | |
productName | text | Y | 书籍 | 商品名称 |
productQuantity | text | Y | 商品数量 | |
productValue | text | Y | 100 | 商品价格 |
productBarcode | text | Y | 1234567 | 商品条码 |
productNameEn | text | Y | book | 商品名称(en) |
productBrand | text | N | 品牌 | |
productOrigin | text | N | 原产地 | |
weight | text | Y | 100 | 商品重量(kg) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | ||||
msg | string |
换单订单撤回 API
基本信息
HTTP
POST /seller_address/create HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
"mchId":"S0002",
"sign":"sign",
"transferSn":"S0001",
"externalOrder":"S0001",
"expressSn":"S0001"
}
返回数据体示例
{
"msg": "success",
"code": 1,
"data": []
}
Path: /transfer_order/recall
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
transferSn | text | Y | 1234567 | 换单订单 |
externalOrder | text | Y | 1234567 | 平台订单号 |
expressSn | text | Y | 1234567 | 尾程快递运单号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | ||||
msg | string |
获取订单轨迹/获取尾程运单号 API
基本信息
HTTP
POST /seller_address/create HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
"mchId":"S0002",
"sign":"sign",
"transferSn":"S0001",
"orderSn":"S0001",
}
返回数据体示例
{
"msg":"success",
"code":1,
"data":{
"transferSn":"",
"orderSn":"",
"expressSn":"",
"routes":[
{
"action":"T1001",
"description":"",
"time":"2022-01-01 00:00:00",
"timeZone":"Asia/Shanghai"
}
]
}
}
Path: /transfer_order/track_order
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
transferSn | text | N | 1234567 | 换单订单号 |
orderSn | text | N | 1234567 | 平台订单号 |
expressSn | text | N | 1234567 | 尾程运单号 |
Y | 1234567 | 换单订单号\平台订单号\尾程运单号至少传一个 |
返回数据
名称 | 类型 | 是否必须 | 备注 |
---|---|---|---|
code | number | ||
msg | string | ||
data | object | ||
transferSn | text | 换单订单号 | |
orderSn | text | 平台订单号 | |
expressSn | text | 尾程运单号 | |
routes | object | ||
action | text | 动作 | |
description | text | 动作描述 | |
time | text | 时间 | |
timeZone | text | 时区 |
客户 API
客户档案新增 API
基本信息
HTTP
POST /seller_address/create HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
nodeSn: "NS001",
name: "CustomName",
type: "",
contact: "",
telephone: "",
province: "",
city:"",
district:"",
postalCode: "",
address: "",
transferStation:"",
remark: "",
}
返回数据体示例
{
msg: "success",
code: 1,
data: []
}
Path: /seller_address/create
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
nodeSn | text | 是 | TH01050101 | 客户编号 |
name | text | 是 | 客户名称 | |
type | text | 否 | 客户类型 | |
contact | text | 否 | 联系人 | |
telephone | text | 否 | 电话号码 | |
province | text | 否 | 省 | |
city | text | 否 | 市 | |
district | text | 否 | 区 | |
postalCode | text | 否 | 地址邮编 (当省 市 邮编都填写的时候地址才有效) | |
address | text | 否 | 详细地址 | |
transferStation | text | 否 | 转运站 | |
remark | text | 否 | 备注 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
客户档案禁用 API
基本信息
HTTP
POST /seller_address/delete HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
nodeSn: "TH01050101"
}
返回数据体示例
{
msg: "success",
code: 1,
data: []
}
Path: /seller_address/delete
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
nodeSn | text | 是 | 客户编号 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
客户档案修改 API
基本信息
HTTP
POST /seller_address/update HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
nodeSn: "TH01050101",
name: "CustomName",
type: "",
contact: "Jack",
telephone: "18652125424",
province: "01050101",
city:"",
district:"",
postalCode: "TH01050101",
address: "address",
transferStation:"TH1055666666"
remark: "remark"
}
返回数据体示例
{
msg: "success",
code: 1,
data: []
}
Path: /seller_address/update
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
nodeSn | text | 是 | TH01050101 | 客户编号 |
name | text | 是 | 客户名称 | |
type | text | 否 | 客户类型 | |
contact | text | 否 | 联系人 | |
telephone | text | 否 | 电话号码 | |
province | text | 否 | 省 | |
city | text | 否 | 市 | |
district | text | 否 | 区 | |
postalCode | text | 否 | 地址邮编 (当省 市 邮编都填写的时候地址才有效) | |
address | text | 否 | 详细地址 | |
transferStation | text | 否 | 转运站 | |
remark | text | 否 | 备注 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 |
基础信息 API
可用仓库查询 API
基本信息
HTTP
POST /open/getWarehouseList HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {}
返回数据体示例
{
msg: "success",
code: 1,
data: [
'id' => 1,
'name' =>'warehouseName',
'warehouseNo'=>'warehouseCode',
'contact' =>'Tom',
'telephone' =>'8888888888',
'province' =>'province name',
'city' => 'city name',
'district' => 'district name',
'postalCode' => '100000',
'address' => 'address detail'
]
}
Path: /open/getWarehouseList
Method: POST
接口描述:
可用仓库查询接口
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
返回数据
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
id | int | 1 | 仓库ID |
name | string | warehouse name | 仓库名称 |
warehouseNo | string | W001 | 仓库编码 |
contact | string | Tom | 联系人 |
telephone | string | 8888888888 | 联系方式 |
province | string | province name | 省 |
city | string | city name | 市 |
district | string | district name | 区 |
postalCode | string | 10000 | 邮编 |
address | string | address detail | 详细地址 |
可用店铺查询 API
基本信息
HTTP
POST /order/getStoreList HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {}
返回数据体示例
{
msg: "success",
code: 1,
data: [
'storeName' =>'store name',
'storeCode' => 'S001',
'platformSourceName' =>'platform name',
'status' => 3
]
}
Path: /order/getStoreList
Method: POST
接口描述:
可用店铺查询接口
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 必须 |
返回数据
名称 | 类型 | 示例 | 备注 |
---|---|---|---|
storeName | string | store name | 店铺名称 |
storeCode | string | S0001 | 店铺编码 |
platformSourceName | string | platform source name | 店铺所属平台 |
status | string | 3 | 店铺状态 1:停用 2:存盘 3:启用 |
添加供应商档案 API
基本信息
HTTP
POST /supply/create HTTP/1.1
Host: https://open-training.flashfulfillment.co.th/
Content-Type: application/x-www-form-urlencoded
Accept: application/json
请求示例
params: {
code: "SP0001",
name: "SupplyName",
typeName: "",
contact: "",
phone: "",
country:"Thailand",
province: "",
city:"",
district:"",
postalCode: "",
address: "",
taxRate:"10",
remark: "",
}
返回数据体示例
{
msg: "success",
code: 1,
data: "SP0001"
}
Path: /supply/create
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/x-www-form-urlencoded | 是 |
Body
参数名称 | 参数类型 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
code | text | 是 | SP0001 | 供应商编码 |
name | text | 是 | SupplyName | 供应商名称 |
typeName | text | 否 | 供应商类别名称 | |
contact | text | 否 | 联系人 | |
phone | text | 否 | 联系电话 | |
country | text | 否 | 国家 [Thailand]:泰国 | |
province | text | 否 | 省 | |
city | text | 否 | 市 | |
district | text | 否 | 区 | |
postalCode | text | 否 | 地址邮编 (当国家 省 市 区 邮编都填写的时候才有效) | |
address | text | 否 | 详细地址 | |
taxRate | integer | 否 | 50 | 税率 0-100的整数 |
remark | text | 否 | 备注 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 非必须 | |||
msg | string | 非必须 | |||
data | string | 非必须 | 供应商编码 |
Webhook
接收方签名验证
签名规则
- 拼接字符串:首先,将应用程序的密钥(appKey)和一个 JSON 字符串(jsonStr)拼接在一起,形成一个新的字符串, str = appKey . jsonStr 。
- 生成 HMAC 哈希:使用一个密钥(appSecret)和 SHA-256 哈希算法,通过 HMAC 函数生成签名。
- 添加到响应 header, Authorization = sign;
- appKey/appSecret 联系产研同事, 不同于请求 api 时的 mchId/key, 请注意区分。
发货单状态通知
base info
push data json
{
"method":"deliveryOrder",
"orderId":"DO23071677705",
"outTradeNo":"23071665HHRT9B-631-SPXTH031871791907",
"pno":"SPXTH031871791907",
"recentPno":"",
"state":"1014",
"stateText":"SUCCESS_DELIVER",
"message":"Your order has been delivered",
"opTime":1689603825,
"updateAt":1689603827,
"mchId":"C0001"
}
request params
name | type | example | remark |
---|---|---|---|
method | string | deliveryOrder | |
orderId | string | DO23071677705 | ffm deliveryOrder sn |
outTradeNo | string | 23071665HHRT9B | order no |
pno | string | SPXTH031871791907 | tracking num |
recentPno | string | ||
state | string | 1014 | |
stateText | string | SUCCESS_DELIVER | |
message | string | Your order has been delivered | |
opTime | string | 1689603825 | |
updateAt | string | 1689603827 | |
mchId | string | C00001 |
state enum
state | stateText | remark |
---|---|---|
900 | STOCK_OUT | 缺货 |
910 | BACK | 撤回成功 |
1001 | SUCCESS_VERIFY | 审核成功 |
1002 | WAREHOUSE_RECEIVE | 仓库接收成功 |
1003 | SUCCESS_PICK | 拣货完成 |
1004 | SUCCESS_PACK | 打包完成 |
1005 | WAIT_EXPRESS_PICK_UP | 待快递揽收 |
1014 | SUCCESS_DELIVER | 发货完成 |
出库状态通知
base info
push data json
{
"method":"returnWarehouse",
"orderId":"RW23071677705",
"outTradeNo":"23071665HHRT9B",
"pno":"SPXTH031871791907",
"recentPno":"",
"state":"1014",
"stateText":"SUCCESS_DELIVER",
"message":"Your order has been delivered",
"opTime":1689603825,
"updateAt":1689603827,
"mchId":"C00001"
}
request params
name | type | example | remark |
---|---|---|---|
method | string | returnWarehouse | |
orderId | string | RW23071677705 | ffm outbound sn |
outTradeNo | string | 23071665HHRT9B | order no |
pno | string | SPXTH031871791907 | tracking num |
recentPno | string | ||
state | string | 1014 | |
stateText | string | SUCCESS_DELIVER | |
message | string | Your order has been delivered | |
opTime | string | 1689603825 | |
updateAt | string | 1689603827 | |
mchId | string | C00001 |
state enum
state | stateText | remark |
---|---|---|
1001 | SUCCESS_VERIFY | 审核成功 |
1002 | WAREHOUSE_RECEIVE | 仓库接收成功 |
1003 | SUCCESS_PICK | 拣货完成 |
1004 | SUCCESS_PACK | 打包完成 |
1005 | RECEIVED | 开始交接 |
1014 | SUCCESS_DELIVER | 发货完成 |
库存损益通知
base info
push data json
{
"method":"lossOverflow",
"orderId":"IS2308087707",
"orderSn":"MS2207117980",
"lossOverflowType":1,
"opTime":1689603825,
"goodsList":[
{
"barcode":"abc123",
"changeNum":1,
"snCode":"",
"batchCode":"",
"qualityStatus":""
}
],
"mchId":"C0001"
}
request params
name | type | example | remark |
---|---|---|---|
method | string | lossOverflow | |
orderId | string | SR2308087707 | ffm deliveryRollbackOrder no |
orderSn | string | 23071665HHRT9B | order no |
lossOverflowType | string | 1014 | |
opTime | string | 1689603825 | |
state | string | 1 | |
goodsList | []object | ||
mchId | string | C0001 |
lossOverflowType enum
state | stateText | remark |
---|---|---|
1 | Genuine Product Loss | 正品报损 |
2 | Defective Product Loss | 残品报损 |
3 | Genuine Product Profit | 正品报溢 |
4 | Defective Product Profit | 残品报溢 |
销退单状态通知
base info
push data json
{
"method":"deliveryRollbackOrder",
"orderId":"SR2308087707",
"orderSn":"MS2207117980",
"state":1,
"opTime":1689603825,
"mchId":"C0001"
}
request params
name | type | example | remark |
---|---|---|---|
method | string | deliveryRollbackOrder | |
orderId | string | SR2308087707 | ffm deliveryRollbackOrder no |
orderSn | string | 23071665HHRT9B | order no |
status | string | 1014 | |
opTime | string | 1689603825 | |
mchId | string | C0001 |
state enum
state | stateText | remark |
---|---|---|
1000 | Cancel | 取消 |
1020 | Awaiting Approval | 待审核 |
1030 | Awaiting Buyer to Send Back | 带买家寄回 |
1045 | Arrived | 已到货 |
1050 | Receiving Processing | 收获中 |
1060 | Receiving Completed | 收货完成 |
入库单状态通知
base info
push data json
{
"method":"arrivalNotice",
"orderId":"AN2308087707",
"orderSn":"MS2207117980",
"state":1,
"opTime":1689603825,
"mchId":"C0001"
}
request params
name | type | example | remark |
---|---|---|---|
method | string | arrivalNotice | |
orderId | string | AN2308087707 | ffm arrival notice no |
orderSn | string | 23071665HHRT9B | order no |
status | string | 1014 | |
opTime | string | 1689603825 | |
mchId | string | C0001 |
state enum
state | stateText | remark |
---|---|---|
20 | Verify | 审核通过 |
30 | Goods Down | 到货 |
50 | RECEIPT_DOWN | 收获完成 |
常量表
返回码 (code)
Code | Meaning |
---|---|
0 | 系统内部错误 |
1 | 成功 |
1000 | 数据校验错误 |
1001 | 货主账号不存在 |
100112 | 请先登录 |
100113 | 文件类型错误 |
100114 | 上传电子面单失败 |
100115 | 条形码必填 |
100116 | 数量必填 |
100117 | 货位必填 |
100118 | 条形码不存在 |
100119 | 条形码已禁用 |
100120 | 数量格式错误 |
100121 | 货位不存在 |
100122 | 货位不可用 |
100123 | 条形码不存在 |
100124 | 商品已经停用 |
100125 | 商品和货位重复 |
100126 | 该货位已停用 |
100127 | 货位类型不正确 |
100128 | 暂不支持保质期商品批量收货 |
100129 | SN数量与收货数量不一致 |
100130 | SN码格式不正确 |
100131 | SN码已添加 |
100132 | SN码重复 |
100133 | ASSET码商品暂不支持 |
100134 | 货主必填 |
100135 | 条形码不能重复 |
100136 | 该商品存放规则已存在 |
100137 | 货位未启用 |
100138 | 货位的用途属性必须是拣货或者备货 |
100139 | 商品编码必填 |
100140 | 参考值超过规定长度 |
100141 | 参数类型错误 |
100142 | 质量状态错误 |
100143 | 当前状态不支持审核 |
100144 | 来源货位不允许为空 |
100145 | 来源货位不存在 |
100146 | 来源货位未启用 |
100147 | 来源货位与来源库区不匹配 |
100148 | 条形码不允许为空 |
100149 | 数据重复 |
100150 | 商品信息不存在 |
100151 | 转移数量不允许为空 |
100152 | 转移数量格式错误 |
100153 | 转移数量必须大于0 |
100154 | 目标货位不允许为空 |
100155 | 目标货位不存在 |
100156 | 目标货位未启用 |
100157 | 目标货位与目标库区不匹配 |
100158 | 该货位上不允许再存放其他保质期商品,请更换货位 |
100159 | 供应商编码不存在 |
100160 | 供应商编码重复 |
100161 | 供应商名称重复 |
100162 | 供应商类别不存在 |
100163 | 供应商编码必填 |
100164 | 供应商名称必传 |
100165 | 参数值超过规定长度 |
100166 | 供应商编码未启用 |
100167 | 供应商编码规则错误 |
100168 | 暂不支持该国家 |
100169 | 税率不合法 |
100170 | 无快递单号的不需要上传面单文件 |
100171 | 有快递编码的不需要上传面单文件 |
100172 | 收货时只能收到暂存位 |
100173 | 没有商品信息 |
100174 | 商品条形码和数量必须填写 |
100175 | 表格内商品重复 |
100176 | 价格格式错误 |
100177 | 商品已存在 |
100178 | 同一套装内条形码重复 |
100179 | 子商品条形码不存在 |
100180 | 子商品档案未启用 |
100181 | 子商品条形码必填 |
100182 | 子商品无商品套装信息 |
100183 | 商品套装条形码在库内已存在 |
100184 | 商品套装条形码必填 |
100185 | 商品数量必填 |
100186 | 子商品数量错误 |
100187 | 子商品数量区间为[1-10000000] |
100188 | 商品套装条形码字符长度最大200 |
100189 | 商品套装货号字符长度最大50 |
100190 | 商品套装名称字符长度最大200 |
100191 | 规格型号字符长度最大100 |
100192 | 商品简介字符长度最大1000 |
100193 | 备注字符长度最大1000 |
100194 | 图片URL最大200 |
100195 | 成本价最大10000000.00泰铢 |
100196 | 统一售价最大10000000.00泰铢 |
100197 | 商品套装下没有子商品 |
100198 | 商品套装条形码重复 |
100199 | 商品套装名称必填 |
1002 | 签名不通过 |
100200 | 成本价格式错误 |
100201 | 售价格式错误 |
100202 | 商品条形码必填 |
100203 | 非此仓库签约货主 |
100204 | 商品条形码不属于此货主 |
100205 | 同货主下商品条形码重复 |
100206 | 商品条形码不存在 |
100207 | 商品长度 格式错误 |
100208 | 商品宽度 格式错误 |
100209 | 商品高度 格式错误 |
100210 | 重量 格式错误 |
100211 | 预打包重量 格式错误 |
100212 | 基础单位在系统内不存在 |
100213 | 二级单位在系统内不存在 |
100214 | 三级单位在系统内不存在 |
100215 | 基础单位为空 |
100216 | 二级单位为空 |
100217 | 三级单位为空 |
100218 | 二级单位不可与基础单位相同 |
100219 | 二级单位数量为空 |
100220 | 二级单位数量格式错误 |
100221 | 二级单位条形码 格式错误 |
100222 | 三级单位不可与二级单位/基础单位相同 |
100223 | 三级单位数量格式错误 |
100224 | 三级单位条形码格式错误 |
100225 | 指定入库/出库计费单位格式错误 |
100226 | 二级单位条形码表内重复 |
100227 | 三级单位条形码表内重复 |
100228 | 二级单位条形码系统内已存在 |
100229 | 三级单位条形码系统内已存在 |
100230 | 基础单位、二级单位不存在 |
100231 | 三级单位数量为空 |
100232 | 所指定入库/出库计费单位不存在 |
100233 | 业务单号必填 |
100234 | 业务发生日期必填 |
100235 | 计费项ID必填 |
100236 | 数量必填 |
100237 | 单位必填 |
100238 | 单价必填 |
100239 | 计费金额必填 |
100240 | 调整金额必填 |
100241 | 结算金额必填 |
100242 | 计费项不存在 |
100243 | 同一计费项下业务单号重复 |
100244 | 该业务单号已经存在此计费项流水 |
100245 | 业务发生日期格式错误 |
100246 | 业务单号格式错误 |
100247 | 数量格式错误 |
100248 | 单价格式错误 |
100249 | 计费金额格式错误 |
100250 | 调整金额格式错误 |
100251 | 结算金额格式错误 |
100252 | 金额异常 |
100253 | 存在重复结算账单 |
100254 | 运单号在导入表格内不能重复 |
100255 | 运单已存在 |
100256 | 运单在表格内重复 |
100257 | 重量格式错误 |
100258 | cod金额格式错误 |
100259 | Cod手续费格式错误 |
100260 | 运单号必填 |
100261 | 业务类型必填 |
100262 | 业务类型错误 |
100263 | 业务单号是科学计数法 |
100264 | 尺寸格式错误 |
100265 | 重量必填 |
100266 | 保价费格式错误 |
100267 | 优惠金额格式错误 |
100268 | 失效日期和批次号必填 |
100269 | 只有保质期商品允许填写失效日期和批次 |
100270 | 同一货位上的同一商品失效日期必须相同 |
100271 | 日期格式错误 |
100272 | 批次号格式错误 |
100273 | 该批次号与已存在批次号冲突 |
100274 | 外部单号必填 |
100275 | 外部单号格式错误 |
100276 | 发货单状态错误 |
100277 | 同一外部单号的原订单号需相同 |
100278 | 销退单类型必填 |
100279 | 销退单类型错误 |
100280 | 退款方式必填 |
100281 | 退款方式错误 |
100282 | 银行必填 |
100283 | 银行错误 |
100284 | 收款人、收款人账号、退货人必填 |
100285 | 退款人联系方式必填 |
100286 | 退货原因必填 |
100287 | 退货原因错误 |
100288 | 商品条形码必填 |
100289 | 发货单内无此商品条形码 |
100290 | 同一外部单号内商品条形码重复 |
100291 | 商品名称错误 |
100292 | 退货数量必填 |
100293 | 退货数量格式错误 |
100294 | 退货数量大于该商品可退货数量 |
100295 | 退货价格格式错误 |
100296 | 退货金额格式错误 |
100297 | 退货金额错误 |
100298 | 运费格式错误 |
100299 | 退款金额格式错误 |
1003 | 订单已存在 |
100300 | 退款金额错误 |
100301 | 客服备注最多700个字符 |
100302 | 退回仓库必填 |
100303 | 退回仓库错误 |
100304 | 收款人、收款人账号、退货人格式错误 |
100305 | 客服备注格式错误 |
100306 | 外部单号已存在 |
100307 | 订单状态错误 |
100308 | 外部订单号不存在 |
100309 | 出库标记值错误 |
100310 | 临期禁售天数必须小于等于保质期天数 |
100311 | 临期禁售天数不合法 |
100312 | 生产日期或者失效日期 和批次号必填 |
1004 | 发件地匹配不到 |
100401 | 启用库存更新填写错误,请填写Yes或No |
100402 | 库存更新百分比仅支持填写1-1000之间的整数 |
100403 | 虚拟库存仅支持填写大于0的整数值 |
100404 | 启用上下架填写错误,请填写Yes或No |
100405 | 该映射关系不存在 |
100406 | 所选店铺下,该映射关系不存在 |
100407 | 外部商品条码必填 |
100408 | 外部商品条码不存在 |
100409 | 所选店铺下,外部商品条码不存在 |
100410 | 已有入库单,请更换其他未使用暂存位! |
100411 | 该货位已经被他人使用,请更换 |
100412 | 最小下架数量仅支持填写大于0的整数值 |
1005 | 目的地匹配不到 |
1006 | 订单不存在 |
1007 | 仓库不存在 |
1008 | 暂未开通COD服务 |
1009 | COD不能小于0 |
1010 | 当前客户存在未完成的揽件通知,无需发送通知 |
1011 | 货主不存在 |
1012 | 销售平台不存在 |
1013 | 快递公司不存在 |
1014 | 发货单不存在 |
1015 | 已揽收的订单不可作废 |
1016 | 统一售价不能为0 |
1017 | 店铺不存在 |
1018 | 发件地和仓库不能都为空 |
1019 | 包裹号pno和客户mchId不匹配 |
1020 | 保价不能小于0 |
1021 | 发件地址邮政编码只能是5位的数字 |
1022 | 发件地址暂未开通服务 |
1023 | 原发货单必填 |
1024 | 没有找到此发货单的信息 |
1025 | 订单未发货,不能补货 |
1026 | 联系方式必填 |
1027 | 寄件人姓名必填 |
1028 | 提前录入快递单号时,快递公司CODE必填 |
1029 | 还不支持您使用的快递公司 |
1030 | 您无此快递的使用权限 |
1031 | 店铺未启用 |
1032 | 请至少传一个请求参数 |
1033 | 订单不唯一,请细化请求条件 |
1034 | 发货单已取消 |
1035 | 订单已发货,无法取消 |
1036 | 待激活状态下不能进行此操作 |
1037 | 订单无法取消,请先申请撤回,撤回后可直接取消 |
1038 | 订单已发货 |
1039 | 等待撤回成功 |
1040 | 订单未审核,无需撤回 |
1041 | 订单已经开始交接 |
1042 | 撤回成功 |
1043 | 该仓库禁用 |
1045 | 商品还未上架 |
1046 | 线上承运商名称必填 |
1086 | 套装内存在未启用的商品 |
1101 | 电话号码格式有误 |
1102 | 商品信息不合法 |
1103 | 条形码不能为空 |
1104 | 商品不存在 |
1105 | 商品数量必须 |
1106 | 商品重复 |
1107 | 订单号不允许为空 |
1108 | 时间格式不合法 |
1109 | 订单格式不合法 |
1110 | 商品名称不能为空 |
1112 | 启用保质期时,保质期天数及临期预警天数必填 |
1113 | 订单商品金额错误 |
1114 | 订单总金额错误 |
1201 | 下单日期不能为空 |
1202 | 订单金额不能为空 |
1203 | 详细地址及省市区邮编不能为空 |
1204 | 收货人姓名不能为空 |
1205 | 电话号码不能为空 |
1206 | 付款方式不能为空 |
1207 | 详细地址及邮编不能为空 |
1208 | 省市区不匹配 |
1209 | 省市必填 |
1210 | 详细地址不能为空 |
1300 | 下单日期不合法 |
1301 | 订单金额不合法 |
1302 | 省市区邮编不匹配 |
1303 | 付款方式不合法 |
1304 | 商品不存在 |
1305 | 商品未启用 |
1306 | 购买数量不合法 |
1307 | 售价不合法 |
1308 | 运费不合法 |
1309 | 商品条形码已存在 |
1310 | 导入文件存在相同的条形码 |
1311 | 条形码格式有误 |
1312 | 商品货号格式有误 |
1313 | 商品保质期参数有误 |
1314 | 是否SN参数有误 |
1315 | 成本价参数不合法 |
1316 | 长度参数不合法 |
1317 | 宽度参数不合法 |
1318 | 高度参数不合法 |
1319 | 重量参数不合法 |
1320 | 预打包重量不合法 |
1321 | 保质期商品的保质期天数必填 |
1322 | 保质期天数不合法 |
1323 | 保质期商品的临期预警天数必填 |
1324 | 临期预警天数不合法 |
1325 | 保质期商品不能同时是SN商品 |
1326 | 图片地址错误 |
1327 | 图片格式错误 |
1328 | 预警天数必须小于保质期天数 |
1329 | 付款时间不合法 |
1330 | 国家不能为空 |
1331 | 府不能为空 |
1332 | 市不能为空 |
1333 | 邮编不能为空 |
1334 | 退款状态不合法 |
1335 | 商品不能为空 |
1336 | 商品格式错误 |
1337 | 退货类型必填 |
1338 | 退货类型格式错误 |
1339 | 订单重量格式错误 |
1340 | 订单尺寸格式错误 |
1341 | 外部订单号最长64位 |
1342 | 是否需要发票不合法 |
1343 | 订单状态不合法 |
1344 | 订单已存在且待发货 |
1345 | 支付方式错误 |
1346 | 当前仓库没有此商品 |
1347 | 不支持套装商品入库 |
1348 | 商品已入库不可变更是否保质期 |
1349 | 商品已入库不可变更是否SN属性 |
1350 | 外部商品编码不能为空 |
1351 | 外部商品编码在导入表格内不能重复 |
1352 | 外部商品编码在系统内已存在 |
1353 | 系统编码不存在 |
1354 | 系统编码不是启用状态 |
1355 | 整单优惠金额不合法 |
1356 | 商品成交金额不能小于0 |
1357 | 商品优惠金额不能小于0 |
1358 | 发货单号不合法 |
1359 | 外部订单号不合法 |
1360 | 运单号不合法 |
1361 | 请输入6-15位的密码 |
1362 | 验证码已失效 |
1363 | 验证码错误 |
1364 | 用户名或者密码输入错误 |
1365 | 用户名已存在 |
1366 | 手机号已注册 |
1367 | 用户名不合法 |
1368 | 用户不存在 |
1369 | 验证码发送失败 |
1370 | 手机号不合法 |
1371 | 快递单号已存在 |
1372 | 快递单号重复 |
1373 | 快递单号必填 |
1374 | 企业类目不存在 |
1375 | 企业类目必须填写 |
1376 | 企业类目状态禁用 |
1377 | 商品品牌不存在 |
1378 | 访问过于频繁,请稍后再试 |
1379 | 运单号不存在 |
1380 | 状态不存在 |
1381 | 商品数量不合法 |
1400 | 相同订单存在售价相同的商品 |
1401 | 订单金额不一致 |
1402 | 货主没有签约此仓库,或仓库ID不存在 |
1403 | 质量状态参数有误 |
1501 | 商品未上架 |
1502 | 用户收货地址不存在 |
1503 | 参数必填 |
1504 | 参数错误 |
1505 | 地址不能为空 |
1506 | ID参数错误 |
1507 | 数量参数错误 |
1508 | 购买数量不能低于起订量 |
1509 | 购物车无此商品 |
1510 | 商品库存不足或缺货,无法提交订单 |
1511 | 商品已下架 |
1512 | 订单已审核无法取消 |
1513 | 商品已上架 |
1514 | 上架数量不能为0 |
1600 | 未授权登录 |
1601 | 网点信息匹配不到 |
1602 | 参数非JSON格式 |
1603 | 外部订单号必须 |
1604 | 发货单已经取消 |
1605 | 发货单已经开始交接 |
1606 | 发货单已经发货完成 |
1607 | 合并拆分过的发货单不能取消 |
1608 | 商品不存在或未启用 |
1609 | 网点编号不能为空 |
1610 | 网点编号格式有误 |
1611 | 网点名称不能为空 |
1612 | 联系人不能为空 |
1613 | Code和邮编不能为空 |
1614 | 网点信息已存在 |
1615 | 库区不能为空 |
1616 | 货位编码不能为空 |
1617 | 该库区不存在 |
1618 | 表格内货位编码重复 |
1619 | 系统中已存在 |
1620 | 货位编码格式错误 |
1621 | 货位顺序号格式错误 |
1622 | 货位排格式错误 |
1623 | 货位组格式错误 |
1624 | 货位层格式错误 |
1625 | 货位位格式错误 |
1626 | 货位最大体积格式错误 |
1627 | 货位最大承重格式错误 |
1628 | 货位长格式错误 |
1629 | 货位宽格式错误 |
1630 | 货位高格式错误 |
1631 | 货位质量状态格式错误 |
1632 | 库区不能修改 |
1633 | 货位ID不能为空 |
1634 | 表内货位ID重复 |
1635 | 货位ID不存在 |
1636 | 质量状态不可更改 |
1637 | 系统预置货位不能修改 |
1638 | ASSET格式错误 |
1639 | 开始时间应小于结束时间 |
1640 | 商品启用了ASSET,请提交ASSET编码 |
1641 | ASSET在库内已经存在 |
1642 | ASSET重复 |
1643 | ASSET数量与入库单商品数量不一致 |
1644 | 入库类型参数错误 |
1645 | 客户编码格式错误 |
1646 | 日期范围不正确 |
1647 | 编码不存在 |
1648 | 货位类型格式错误 |
1649 | 客户类别错误 |
1650 | 客户编码必填 |
1651 | 客户编码格式错误 |
1652 | 客户编码已存在 |
1653 | 客户名称不能为空 |
1654 | 客户匹配不到 |
1655 | 不能超过30天 |
1656 | 每页查询不能超过100条数据 |
1657 | 时间范围不合法 |
1658 | 时间范围的跨度不能大于1天 |
1659 | 外部商品编码在系统内不存在 |
1660 | 系统编码必填 |
1661 | 邮编格式错误 |
1662 | 导入文件存在相同的客户编码 |
1663 | 单号不存在 |
1664 | 不能审核缺货订单 |
1665 | 已启用ASSET码的商品数量与ASSET码不相等,请修改 |
1666 | 销退单不存在商品 |
1667 | 可用库存不足 |
1668 | 出库单不存在商品 |
1669 | 货主已被禁用 |
1670 | 价格参数错误 |
1671 | 申报价值不能为0 |
1672 | 申报价值不能大于50000泰铢 |
1673 | 需要保价时,物品保价金额不能为空 |
1674 | 匹配快递公司异常 |
1675 | 邮编省市不能为空 |
1676 | 面单号不能为空 |
1677 | 上传图片失败 |
1678 | 商品货号必传 |
1679 | 数据不唯一 |
1680 | 已入库商品不能修改 |
1681 | 条形码或货号至少填写一个 |
1682 | 套装内商品信息必须 |
1683 | 套装内商品条码必填 |
1684 | 套装内商品数量必须大于0 |
1685 | 套装内商品不存在 |
1687 | 套装内存在相同商品 |
1688 | 下单日期格式错误 |
1689 | 出库单号不合法 |
1690 | 外部单号不合法 |
1691 | 出库单不存在 |
1692 | 省市不匹配 |
1693 | 订单号重复 |
1694 | 订单号系统内已存在 |
1695 | 邮编为5个数值 |
1696 | COD金额不合法 |
1697 | COD金额为1-50000之间的整数 |
1698 | 是否保价格式错误 |
1699 | 申报价值为整型 |
1700 | 申报价值不能为0 |
1701 | 申报价值不能大于50000泰铢 |
1702 | 订单号字符长度最大64 |
1703 | 收件人姓名字符长度最大50 |
1704 | 买家留言字符长度最大600 |
1705 | 卖家留言字符长度最大600 |
1706 | 出库单已取消 |
1707 | 出库单已审核无法取消 |
1708 | 订单不唯一,请使用发货单号 |
1709 | 发货单号或外部单号必选其一 |
1710 | 未获取电子面单号 |
1711 | 文件不存在 |
1712 | 供应商不存在 |
1713 | 供应商未启用 |
1714 | 输入内容不合法 |
1715 | 配送方式错误 |
1716 | 字段长度不合法 |
1717 | 无此仓库权限 |
1718 | 商品类型非法 |
1719 | 启用锁定库存后,不支持此功能 |
1720 | 最多支持500个条码查询 |
1721 | COD金额为1-5000000之间的整数 |
1722 | 收件人不能为空 |
1723 | 供应商编码必填 |
1724 | 供应商报价不能为空 |
1725 | 税率不能为空 |
1726 | 供应商报价格式错误,仅支持填写大于0的数值 |
1727 | 税率格式错误,仅支持填写0至100之间的数值 |
1728 | 最小采购量格式错误,仅支持填写数值 |
1729 | 最小采购量需小于最大供货量 |
1730 | 最大供货量格式错误,仅支持填写数值 |
1731 | 不包含采购员权限,无法添加 |
1732 | 同一供应商下,商品不能重复 |
1733 | 同一供应商相同商品,系统内已有报价单 |
1734 | 出库单标记不存在,请先在SCM维护标记 |
1735 | 国家不存在 |
1736 | 省市镇错误,请重新填写 |
1737 | 省市错误,请重新填写 |
1738 | 网点编码不能为空 |
Demo 下载
C# Demo
PHP Demo
PHP Demo PHP Demo(second sign)(使用第二种签名算法)