开发者文档
智齿科技
2022-11-16
目录

商城中心

# 商城中心

# 接口声明

调用流程
智客接口调用流程
Token获取说明：
在调用接口时必须在https请求的header中携带"token"参数。
token是智齿客服接口开放平台全局唯一的接口调用凭据。
开发者在调用各业务接口时都需使用token，开发者需要进行妥善保存。token的存储至少要保留32个字符空间。token的有效期目前为24个小时，需定时刷新，或根据接口返回的token失效提示，进行重新获取。请求token接口，无论token是否存在，都会返回新的token，并重置token的过期时间(目前24小时)。

token使用方式说明：
1、开发者需要统一获取和管理token，在调用智齿客服各个业务开放接 口时都应该使用同一个的token，不应该每个业务都刷新获取新的 token，否则容易导致token失效，影响接口的正常调用；
2、目前token的有效期通过返回的expire_in来传达，目前是86400 秒之内的值。开发者需要根据这个有效时间提前去刷新新token。
3、开发者需要根据接口返回的token失效提示，进行重新获取token。

其他说明：
1、所有的接口需使用HTTPS协议、JSON数据格式、UTF8编码。
2、请求方式，标明接口调用的HTTP方法，区分HttpGet/HttpPost请求。
3、所有接口在调用失败时返回包里都有retCode、retMsg（部分接口在调用成功时没有返回retCode和retMsg）。开发者需根据retCode存在且不为000000判断为失败，否则为成功（retCode详见下方说明）。而retMsg仅作参考，后续可能会有变动，因此不可作为是否调用成功的判据。
4、为了接口安全, 所有接口都需要添加timestamp(请求时间戳)和nonce(随机值)两个参数。
5、所有接口单次推送的最大数据量为1000条。

# 接口调用

# 门店管理

# ● 新增门店

接口说明：

批量推送店铺全量信息。

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/stores/add
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
store_list list 是 店铺信息 store对象结构如下

门店store对象：

参数 类型 必填 名称 备注
storeid string 是 三方店铺id 不多于128个字节
store_name string 是 店铺名称 不超过30个字符
store_type int 否 店铺名称 详情见下方店铺映射关系表
country string 否 店铺的国家
province string 否 店铺的省
city string 否 店铺的市
district string 否 店铺的区
detail_address string 否 店铺的详细地址 不超过256个字符
parent_storeid string 否 父店铺的id 默认为0(最高父级店铺)
media_url string 否 门店图片url 门店图片url
source int 是 门店来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟
employee_list list 否 店铺员工列表 员工信息如下所示
store_code string 否 门店编码 门店的唯一编码
status int 是 门店状态 1-营业、2-闭店
create_time string 是 创建时间 时间戳(毫秒)
update_time string 是 更新时间 时间戳(毫秒)
creator string 否 创建人 企微userid
delete_flag int 是 是否删除 0-否, 1-是

店铺员工employee对象：

参数 类型 必填 名称 备注
employeeid string 否 员工id 员工智齿坐席id或智齿部门id，由employees_type确定
employees_type int 否 员工类型 employeeid存在时为必填:0-店长、1-普通员工、2-部门

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息

请求示例：

{
    "timestamp": "13500001234",
    "nonce": "123412323",
    "store_list": [
        {
            "storeid": "42870430",
            "store_name": "瑞幸咖啡汉威⼴场⼆分店",
            "store_type": 0,
            "country": "中国",
            "province": "北京",
            "city": "北京",
            "district": "北京",
            "detail_address": "汉威国际⼴场2区9号楼103号",
            "parent_storeid": "0",
            "media_url": "https://www.baidu.com.pic",
            "source": 2,
            "employee_list": [
                {
                    "employeeid": "zhangsan",
                    "employees_type": 1
                }
            ],
            "store_code": "S25472709390762003",
            "status": 1,
            "create_time": "1646233461",
            "update_time": "1646233461",
            "creator": "zhangsan",
            "delete_flag": 0
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

返回示例：

{
    "retCode": "000000",
    "retMsg": "操作成功",
    "data": []
}
1
2
3
4
5
# ● 查询门店

接口说明：

批量查询门店全量信息

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/stores/get
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
start_time string 否 查询开始时间 yyyy-MM-dd HH:mm:ss
end_time string 否 查询开始时间 yyyy-MM-dd HH:mm:ss
page_no int 是 页码 不多于128个字节
page_size int 是 分页数量 不多于128个字节

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息
data object 否 返回对象

data参数详情：

参数 类型 名称 备注
page_no int 页码
page_size int 每页返回数量
page_count int 总页数
total_count int 总条数
store_id string 三方门店id 三方门店id
sobot_store_id string 智齿门店id 智齿门店id
store_name string 门店名称
store_type int 门店类型 0-其他,1-线下店,2-网店
country string 国家 中国
province string 省份 四川省
city string 市
district string 区
detail_address string 店铺详细地址
parent_store_id string 父门店id
media_url string 门店图片url
source int 门店来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟
employee_list list 店铺员工列表
employeeid string 门店员工id 可能是员工id，也可能是部门id，以employees_type区分
employees_type int 门店员工类型 0-店长、1-普通员工、2-部门
employee_name string 门店员工名称 可能是员工名称，也可能是部门名称，以employees_type区分
store_code string 门店编码 门店的唯一编码
status int 门店状态 1-营业,2-闭店
create_time string 创建时间 时间戳(秒)
creator string 创建人
delete_flag int 是否删除 0-否, 1-是

请求示例：

{
    "timestamp": "1652361292",
    "nonce": "c31ef7d26f5f42aab753daff73375bbf",
    "start_time": "2022-04-20 10:59:16",
    "end_time": "2022-05-20 10:59:18",
    "page_no": 1,
    "page_size": 5
}
1
2
3
4
5
6
7
8

返回示例：

{
    "retCode": "000000",
    "retMsg": "成功",
    "data": {
        "page_no": 1,
        "page_size": 5,
        "data": [
            {
                "store_id": "00000000001",
                "sobot_store_id": "627d0724e4b05001a012544a",
                "store_name": "测试店铺wuytest",
                "store_type": 0,
                "country": "中国",
                "province": "河北",
                "city": "石家庄",
                "district": "藁城",
                "detail_address": "大学城",
                "parent_store_id": "0",
                "media_url": "https://img.yzcdn.cn/upload_files/2022/04/01/Fu0Sj2nD_UHNN71KLYhMpicjDgUD.jpg",
                "source": 2,
                "employee_list": [
                  {
                      "employeeid": "zhangsan",
                      "employees_type": 0,
                      "employee_name": "张三",
                  }
                ],
                "store_code": "S25472709390762003",
                "status": 1,
                "create_time": "1652357736",
                "creator": "zhangsan",
                "delete_flag": 0
                }
              ],
        "page_count": 1,
        "total_count": 1
    },
    "logMessageId": null,
    "success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

# 商品管理

# ● 新增商品类目

接口说明：

推送商品类目信息

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/item_category/add
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
item_category object 是 商品类目信息 商品类目结构如下所示

售后单item_category对象：

参数 类型 必填 名称 备注
category_id string 是 三方商品类目id 三方类目id，三方下唯一
source int 是 来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟
category_hierarchy string 是 类目层级
has_child_node int 是 是否还有子节点 0-否, 1-是
parent_node_id string 是 父级类目id
category_name string 是 类目名称
version string 否 版本
create_time string 否 创建时间 时间戳(毫秒)

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息

请求示例：

{
    "timestamp": "13500001234",
    "nonce": "123412323",
    "item_category": {
        "category_id": "202103045600000323434",
        "source": 2,
        "category_hierarchy": "102",
        "has_child_node": 1,
        "parent_node_id": "100",
        "category_name": "书籍",
        "version": "v2",
        "create_time": "13500001234"
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

返回示例：

{
    "retCode": "000000",
    "retMsg": "操作成功"
}
1
2
3
4
# ● 查询商品类目

接口说明：

查询商品类目详情

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/item_categories/get
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
category_id string 是 三方商品类目id 三方类目id，三方下唯一
source int 是 来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息
data object 否 返回对象

data参数详情：

参数 类型 名称 备注
sobot_category_id string 智齿商品类目id
category_id string 三方商品类目id
source string 商品来源 商品来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟
category_hierarchy string 类目层级
has_child_node string 是否还有子节点 0-是,1-否
parent_node_id string 父级类目id
category_name string 类目名称
version string 版本 第三方版本号
create_time string 创建时间 时间戳(秒)

请求示例：

{
  "timestamp": "1652361292",
  "nonce": "c31ef7d26f5f42aab753daff73375bbf",
  "category_id": "123456",
  "source": 2
}
1
2
3
4
5
6

返回示例：

{
    "retCode":"000000",
    "retMsg":"成功",
    "data":[
        {
            "sobot_category_id":"62427d6b60b228459521b5bb",
            "category_id":"202103045600000323434",
            "source":2,
            "category_hierarchy":"102",
            "has_child_node":1,
            "parent_node_id":"100",
            "category_name":"书籍",
            "version":"v2",
            "create_time":"13500001234"
        }
    ],
    "logMessageId":null,
    "success":true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# ● 新增商品信息

接口说明：

批量推送商品全量信息

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/items/add
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
item_list list 是 商品集合 item对象结构如下

商品item对象：

参数 类型 必填 名称 备注
storeid string 是 三方店铺id 不多于128个字节
itemid string 是 三方商品id
sku_code string 否 商品SKU编码
spu_code string 否 商品SPU编
name string 是 商品名称
title string 否 商品标题
cost_price string 否 划线价格 单位为分
retail_price string 是 零售价格 单位为分
source int 是 商品来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟
create_time string 是 创建时间 时间戳(毫秒)
update_time string 是 更新时间 时间戳(毫秒)
delete_flag int 是 是否删除 0-否, 1-是
media_url string 否 商品附件url
stock long 否 商品库存
sales_volume long 否 商品销售量
status int 是 商品状态 0-其他,1-在售、2-下架3-售罄
creator string 否 创建人 智齿坐席serviceId
category_id string 否 三方商品类目id

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息

请求示例：

{
    "timestamp": "13500001234",
    "nonce": "123412323",
    "item_list": [
        {
            "storeid": "42870430",
            "itemid": "865324",
            "sku_code": "00000323434 ",
            "spu_code": "BM50184126118",
            "name": "三年级语⽂精讲",
            "title": "三年级语⽂精讲测试标题",
            "cost_price": "300",
            "retail_price": "200",
            "source": 2,
            "create_time": "13500001234",
            "update_time": "13500001234",
            "delete_flag": 0,
            "media_url": "https://www.baidu.com.pic",
            "stock": 10,
            "sales_volume": 100,
            "status": 1,
            "creator": "zhangsan"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

返回示例：

{
    "retCode": "000000",
    "retMsg": "操作成功"
}
1
2
3
4
# ● 查询商品信息

接口说明：

批量查询商品全量信息

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/items/get
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
start_time string 否 查询开始时间 yyyy-MM-dd HH:mm:ss
end_time string 否 查询结束时间 yyyy-MM-dd HH:mm:ss
page_no int 是 页码
page_size int 是 分页数量

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息
data object 否 返回对象

data参数详情：

参数 类型 名称 备注
page_no int 页码
page_size int 每页返回数量
page_count int 总页数
total_count int 总条数
store_id string 三方门店id 三方门店id
item_id string 三方商品id 智齿门店id
sobot_item_id string 智齿商品id
sku_code string 商品SKU编码
spu_code string 商品SPU编码
name string 商品名称
title string 商品标题
cost_price string 划线价格 分
retail_price string 零售价格 分
delete_flag int 是否删除 0-否, 1-是
media_url string 商品附件url
stock int 商品库存
source int 门店来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟
status int 1-营业,2-闭店
create_time string 创建时间 时间戳(秒)
creator string 创建人
sales_volume int 商品销售量
status 商品状态 0-其他,1-在售,2- 下架,3-售罄
category_id string 三方商品类目id

请求示例：

{
  "timestamp": "1652361292",
  "nonce": "c31ef7d26f5f42aab753daff73375bbf",
  "start_time": "2022-04-20 10:59:16",
  "end_time": "2022-05-20 10:59:18",
  "page_no": 1,
  "page_size": 5
}
1
2
3
4
5
6
7
8
9

返回示例：

{
	"retCode": "000000",
	"retMsg": "成功",
	"data": {
		"page_no": 1,
		"page_size": 20,
		"data": [
			{
				"store_id": "324",
				"item_id": "32401",
				"sobot_item_id": "623c1d79e145ea97bcae7898",
				"sku_code": "sku324",
				"spu_code": "spu324",
				"name": "刘金萌测试商品",
				"title": "测试商品",
				"cost_price": "300",
				"retail_price": "200",
				"source": 2,
				"delete_flag": 0,
				"media_url": "https://store.mp.video.tencent-cloud.com/161/20304/snscosdownload/SZ/reserved/622c063f000b234400000000bc0c950b000000a000004f50",
				"stock": 10,
				"sales_volume": 100,
				"status": 1,
				"creator": "zhangsan",
				"create_time": "1648030497",
                "category_id": "1"

			}
		],
		"page_count": 1,
		"total_count": 1
	},
	"logMessageId": null,
	"success": true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

# 订单管理

# ● 新增订单信息

接口说明：

批量推送订单全量信息

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/orders/add
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
order_list list 是 订单集合 order对象结构如下所示

订单order对象：

参数 类型 必填 名称 备注
storeid string 是 三方店铺id 不多于128个字节
source int 是 来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟
orderid string 是 三方订单id
order_no string 是 订单号
create_time string 是 订单创建时间 时间戳(毫秒)
update_time string 是 订单更新时间 时间戳(毫秒)
payment_time string 否 订单支付时间 时间戳(毫秒)
status int 是 订单状态 0-其他、1-待付款、2-已付款、3-已发货、4-已签收、5-交易成功、6-交易关闭
actual_amount string 是 实际金额 单位为分
discount_amount string 否 优惠金额 单位为分
total_amount string 否 订单总金额 单位为分
buyerid string 是 买家id 如果为微信则传unionId
buyerid_type int 是 买家id类型 1-微信unionid、2-手机号、4-邮箱、5-智齿客户id
dispatch_type int 否 发货方式 0-其他,1-快递发货; 2-到店⾃提; 3-同城配送; 4-⽆需发货
item_list list 是 商品信息 订单商品信息结构如下
receiver object 是 收件人信息 结构如下所示
outer_order_no string 否 外部订单号
payment_serial_no string 否 支付流水号

订单商品item对象：

参数 类型 必填 名称 备注
itemid string 是 三方商品id
name string 是 商品名称
cost_price string 否 划线价格 分
actual_price string 是 实付金额 分
quantity long 是 购买数量
total_price string 是 商品总价 分
sku_id string 否 商品sku_id

收件人信息receiver对象：

参数 类型 必填 名称 备注
name string 是 收件人姓名
phone_number string 是 收件人手机号
country string 是 国家
province string 是 省
city string 是 市
district string 是 区
detail_address string 是 收件人详细地址

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息
data list 否 创建失败的订单信息

请求示例：

{
    "timestamp": "13500001234",
    "nonce": "123412323",
    "order_list": [
        {
          "storeid": "42870430",
          "source": 1,
          "orderid": "erwefwef324tfgrtrsdrgr",
          "order_no": "202103045600000323434",
          "create_time": "13500001234",
          "update_time": "13500001234",
          "payment_time": "13500001234",
          "status": 3,
          "actual_amount": "200",
          "discount_amount": "50",
          "total_amount": "200",
          "buyerid": "zhenyx@163.com",
          "buyerid_type": 4,
          "dispatch_type": 1,
          "item_list":	[
              {
                  "itemid": "1455664",
                  "name": "测试商品",
                  "cost_price": "199",
                  "actual_price": "100",
                  "quantity": 2,
                  "total_price": "200",
                  "sku_id": "2000000232323232"
              }
          ],
          "receiver": {
          "name": "李小胖",
          "phone_number": "13727372426",
          "country": "中国",
          "province": "北京",
          "city": "北京",
          "district": "北京",
          "detail_address": "汉威国际⼴场2区9号楼103号"
          },
          "outer_order_no": "O16581373580000001",
          "payment_serial_no": "P16581373880000001"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

返回示例：

{
    "retCode": "000000",
    "retMsg": "操作成功",
    "data":[
          {
            "orderid": "erwefwef324tfgrtrsdrgr",
            "retCode": 801001,
            "retMsg": "买家信息不存在"
          }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
# ● 查询订单信息

接口说明：

批量查询订单全量信息

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/orders/get
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
start_time string 否 查询开始时间 yyyy-MM-dd HH:mm:ss
end_time string 否 查询结束时间 yyyy-MM-dd HH:mm:ss
page_no int 是 页码
page_size int 是 分页数量

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息
data object 否 返回对象

data参数详情：

参数 类型 名称 备注
page_no int 页码
page_size int 每页返回数量
page_count int 总页数
total_count int 总条数
store_id string 三方门店id
source int 来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟
order_id string 三方订单id
sobot_order_id string 智齿订单id
order_no string 订单号
create_time string 创建时间 时间戳(秒)
payment_time string 订单支付时间 时间戳(秒)
status string 订单状态 0-其他,1-待付款,2-已付款,3-已发货,4-已签收,5-交易成功,6-交易闭
actual_amount string 实际支付金额 分
discount_amount string 优惠金额 分
total_amount string 订单总金额 分
buyer_id string 买家id
buyer_id_type string 买家id类型 1-微信unionid,2-手机号,4-邮箱,5-智齿客户id
dispatch_type string 发货方式 0-其他,1-快递发货,2-到店自提,3-同城配送,4-无需发货
order_item_list list 订单商品信息集合 结构如下
receiver object 收货人信息 结构如下
outer_order_no string 外部订单号
payment_serial_no string 支付流水号
sobot_customer_id string 智齿客户id

order_item_list参数详情：

参数 类型 名称 备注
item_id string 订单商品id
name string 订单商品名称
cost_price string 划线价格 分
actual_price string 实付价格 分
quantity int 购买数量
total_price string 商品总价 分
sku_id string 商品sku_id

receiver参数详情：

参数 类型 名称 备注
name string 收件人姓名
phone_number string 收件人手机号
country string 国家 中国
province string 省份 四川省
city string 市
district string 区
detail_address string 店铺详细地址

请求示例：

{
	"timestamp": "1652361292",
	"nonce": "c31ef7d26f5f42aab753daff73375bbf",
	"start_time": "2022-04-20 10:59:16",
	"end_time": "2022-05-20 10:59:18",
	"page_no": 1,
	"page_size": 5
}
1
2
3
4
5
6
7
8

返回示例：

{
    "retCode":"000000",
    "retMsg":"成功",
    "data":{
        "page_no":1,
        "page_size":1,
        "data":[
            {
                "store_id":"107185119",
                "source":2,
                "order_id":"E20220331160309008300061",
                "sobot_order_id":"6245604360b22da3c0bc2ab8",
                "order_no":"E20220331160309008300061",
                "create_time":"1648742590",
                "payment_time":"1648713795",
                "status":1,
                "actual_amount":"0",
                "discount_amount":"0",
                "total_amount":"1",
                "buyer_id":"or-MA5_cp3-RUnPUNkAcz-DkCKwE",
                "buyer_id_type":1,
                "dispatch_type":1,
                "order_item_list":[
                    {
                        "item_id":"1706494507",
                        "name":"有赞家大型时尚儿童玩具机器猫来喽",
                        "cost_price":"1",
                        "actual_price":"1",
                        "quantity":1,
                        "total_price":"1",
                        "sku_id":"2000000232323232"
                    }
                ],
                "receiver":{
                    "name":"武月",
                    "phone_number":"15711222310",
                    "country":"中国",
                    "province":"北京市",
                    "city":"北京市",
                    "district":"丰台区",
                    "detail_address":"新村街道中环西路汉威国际广场2区(南四环西路186号)"
                },
                "outer_order_no": "O16581373580000001",
                "payment_serial_no": "P16581373880000001",
                "sobot_customer_id": "f179a28a7e9d43dbb4b2b37efb47ad11"
            }
        ],
        "page_count":6,
        "total_count":6
    },
    "logMessageId":null,
    "success":true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

# 物流管理

# ● 新增物流信息

接口说明：

批量推送订单物流全量信息

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/logistics/add
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
logistics_list list 是 物流信息 结构如下所示

物流信息logistics对象：

参数 类型 必填 名称 备注
order_no string 是 第三方订单号
refund_no string 否 第三方售后单号 产生售后单并且有退商品时,此项需要填
logisticsid string 否 三方物流id
fee string 是 物流费用 物流总费用,单位分
status int 是 物流状态 0-其他,1-待发货; 2-已发货；3-待签收；4-已签收；5-拒收；6-配送中
company_name string 是 物流公司名
tracking_number string 是 物流单号
source int 是 来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟
create_time string 是 创建时间 时间戳(秒)
update_time string 是 更新时间 时间戳(秒)
delivery_time string 否 发货时间 时间戳(秒)
sign_time string 否 签收时间 时间戳(秒)
signer string 否 签收人 签收人名字

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息

请求示例：

{
  "timestamp": "13500001234",
  "nonce": "123412323",
  "logistics_list": [
    {
      "order_no": "202103045600000323434",
      "logisticsid": "1232324444",
      "fee": "180",
      "status": 1,
      "company_name": "顺丰",
      "tracking_number": "SF2334344334334",
      "source": 2,
      "create_time": "13500001234",
      "update_time": "13500001234"
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

返回示例：

{
    "retCode": "000000",
    "retMsg": "操作成功"
}
1
2
3
4

# 售后管理

# ● 新增售后信息

接口说明：

批量推送售后单全量信息

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/refunds/add
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
refund_list list 是 售后单信息 售后单信息结构如下所示

售后单refund对象：

参数 类型 必填 名称 备注
order_no string 是 订单号
refund_no string 是 退款流水号
fee string 是 退款金额 单位分
status int 是 退款状态 0-其他,1-未退款、2-部分退款成功、3-全部退款成功
create_time string 是 创建时间 时间戳(秒)
update_time string 是 更新时间 时间戳(秒)
success_time string 否 退款成功时间 时间戳(秒)
reason string 否 退款原因
return_goods int 否 是否有退货 1-是、2-否
item_list list 否 退款商品集合 退款商品信息结构如下所示
receiver object 否 退货收货人信息 结构如下所示
source int 是 来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟

退款商品item对象：

参数 类型 必填 名称 备注
itemid string 是 三方商品id
quantity long 是 退款商品数量
fee string 是 退款金额 分

退货收货人receiver对象：

参数 类型 必填 名称 备注
phone_number string 是 收货人电话
detail_address string 是 收货人详细地址
name string 是 收货人姓名

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息

请求示例：

{
  "timestamp": "13500001234",
  "nonce": "123412323",
  "refund_list": [
      {
        "order_no": "202103045600000323434",
        "refund_no": "201709282209550100010711",
        "fee": "100",
        "status": 1,
        "create_time": "13500001234",
        "update_time": "13500001234",
        "success_time": "",
        "reason": "不想要了",
        "return_goods": 1,
        "source": 2,
        "item_list": [
            {
              "itemid": "1455664",
              "quantity": 1,
              "fee": "50"
            }
        ],
        "item_list": {
            "name": "henry",
            "phone_number": "13527293423",
            "detail_address": "北京市汉威国际⼴场2区9号楼103号"
        }
      }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

返回示例：

{
    "retCode": "000000",
    "retMsg": "操作成功"
}
1
2
3
4
# ● 查询售后信息

接口说明：

批量查询商品售后全量信息

请求方式：

POST

请求地址：

https://wxm.soboten.com/gateway/zk-data-adapter/api/data/v1/refunds/get
1

请求参数：

参数 类型 必填 名称 备注
timestamp string 是 时间戳 请求发起时的时间戳(毫秒)
nonce string 是 随机值 请求随机值
start_time string 否 查询开始时间 yyyy-MM-dd HH:mm:ss
end_time string 否 查询结束时间 yyyy-MM-dd HH:mm:ss
page_no int 是 页码
page_size int 是 分页数量
sobot_order_id string 否 智齿订单号
sobot_refund_id string 否 智齿售后单号

返回参数：

参数 类型 必填 名称 备注
retCode string 是 返回编码
retMsg string 是 返回信息
data object 否 返回对象

data参数详情：

参数 类型 名称 备注
page_no int 页码
page_size int 每页返回数量
page_count int 总页数
total_count int 总条数
sobot_refund_id string 智齿售后单号
sobot_order_id string 智齿订单号
order_no string 三方订单号
refund_no string 三方售后单号
fee string 退款金额 分
status int 0-其他,1-未退款,2-部分退款成功,3-全部退款成功
success_time string 退款成功时间 时间戳(秒)
reason string 退款原因
return_goods int 是否有退货 1-否,2-是
source int 门店来源 1-⾃建、2-有赞、3-小鹅通、4-抖⾳、5-快⼿、6-京东、7-淘宝、8-唯品会、9-小红书、10-蘑菇街、11-微盟
create_time string 售后单创建时间 时间戳(秒)
item_list list 退款商品集合 退款商品信息结构如下所示
receiver object 退货收货人信息 结构如下所示

退款商品item对象：

参数 类型 名称 备注
item_id string 三方商品id
quantity long 退款商品数量
fee string 退款金额 分

退货收货人receiver对象：

参数 类型 名称 备注
phone_number string 收货人电话
detail_address string 收货人详细地址
name string 收货人姓名

请求示例：

{
  "timestamp": "1652361292",
  "nonce": "c31ef7d26f5f42aab753daff73375bbf",
  "start_time": "2022-04-20 10:59:16",
  "end_time": "2022-05-20 10:59:18",
  "page_no": 1,
  "page_size": 5,
  "sobot_order_id": "62441b3460b23dd86fa0fd87",
  "sobot_refund_id": "624151e860b2616881269844"
}
1
2
3
4
5
6
7
8
9
10

返回示例：

{
    "retCode":"000000",
    "retMsg":"成功",
    "data":{
        "page_no":1,
        "page_size":20,
        "data":[
            {
                "sobot_order_id":"62441b3460b23dd86fa0fd87",
                "sobot_refund_id":"624151e860b2616881269844",
                "order_no":"202103045600000323434",
                "refund_no":"201709282209550100010711",
                "fee":"100",
                "status":1,
                "create_time":"13500001234",
                "success_time":"",
                "reason":"不想要了",
                "return_goods":1,
                "source":2,
                "item_list":{
                    "name":"henry",
                    "phone_number":"13527293423",
                    "detail_address":"北京市汉威国际⼴场2区9号楼103号"
                }
            }
        ],
        "page_count":1,
        "total_count":1
    },
    "logMessageId":null,
    "success":true
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

# 智齿店铺/商品/订单相关状态说明

# ● 三方来源编码
来源 来源编码
企业自建 1
有赞 2
小鹅通 3
抖音 4
快手 5
京东 6
淘宝 7
唯品会 8
小红书 9
蘑菇街 10
微盟 11
# ● 门店状态对应关系
营业 闭店
智齿 1 2
有赞 - -
# ● 门店类型对应关系
营业 闭店 其他
智齿 1 2 0
有赞 0 单店， 1 总部， 2001 门店，3 独立仓，4 合伙人，6 分销供货店铺，7 前置仓 2002 网店 非以上状态都归到这里
# ● 商品状态对应关系
上架 下架 售罄 其他
智齿 1 2 3 0
有赞 is_listing为true且quantity大于 is_listing为false is_listing为true且quantity等于0 非以上状态都归到这里
# ● 订单状态对应关系（不含退款）
待付款 已付款 已发货 已签收
智齿 1 2 3 4
有赞 WAIT_BUYER_PAY TRADE_PAID
WAIT_CONFIRM
WAIT_SELLER_SEND_GOODS		 WAIT_BUYER_CONFIRM_GOODS TRADE_SUCCESS
TRADE_CLOSED
交易成功 交易关闭 其他
智齿 5 6 0
有赞 非以上状态都归到这里
# ● 订单退款状态对应关系
未退款 部分退款成功 全部退款成功 其他
智齿 1 2 3 0
有赞 0，11 2，1 12 非以上状态都归到这里
# ● 配送方式对应关系
快递发货 到店自提 同城配送
智齿 1 2 3
有赞 1 2 3
无需发货 其他
智齿 4 0
有赞 4 非以上状态都归到这里
# ● 物流状态对应关系
待发货 已发货 待签收 已签收
智齿 1 2 3 4
有赞 1 2 3 4
拒收 配送中 其他
智齿 5 6 0
有赞 5 6 非以上状态都归到这里
上次更新: 2024/4/15 11:19:20

←

最近更新
01
运营支持 API
03-03
02
CRM 对接方案
12-05
03
大模型机器人API
09-09
更多文章>
Theme by Vdoing