版权所有©，上海海鼎信息工程股份有限公司，2016-2022，保留所有权利。

接入指南

接口开发规范

  1. 协议规则

    传输方式:采用HTTPS传输
提交方式:
    参数以HTTP REQUEST PAYLOAD形式进行提交。
    设置Content-Type为“application/json”
    设置Accept为“application/json”
数据格式:传入以及返回数据以JSON格式表达
字符编码:采用UTF-8字符编码

  2. 安全规范

    认证:采用HTTP Basic Authentication 进行身份认证
HTTP header中需要携带Authorization请求头，Basic值的算法如下(+号表示字符串连接)：
base64_encode(user + ":" + password)
示例：
user=guest，password=guest，则Authorization: Basic Z3Vlc3Q6Z3Vlc3Q=

  3. 入参注意点

       没有值的字段，不要直接传空串(""),可以传null或者不传，注意字段值前后不要有空格。
   中台采用的是mysql数据库，数据库大小写不敏感，但是程序敏感，建议业务主见类的字段（如ID），不要大小写切换用。
operator传值，传实际的操作人的值，方便后续排查业务操作方，如果没有具体操作人，可以是具体的交互系统名称。
   参数类型：Path、Query和Body注意区分
   Query 是作为url的参数的，使用时类似” orderservice/submit?operator=***"
          而Path是用来替换你路径里的条目的，类似“orderservice/order/{order_id}”
   注意级联加载参数parts的使用，不传的情况下，不会加载关联数据，具体要求注意接口说明。
   如：查询指定订单接口，不传parts参数的情况下，不会返回订单商品明细。

通知回调

  1. 用途

    通知回调方式是由鼎立云主动通知的方式来回调接入系统，相比传统的由接入系统轮询鼎立云的方式，回调方式更及时高效，特别是在一些对时间要求比较高的场景中，回调性能更好，且能减少系统压力。

  2. 回调说明

    接入系统需要提供一个可被公网访问的URL地址，出于传输安全的需要，建议使用https方式但不进行证书校验）。
接入系统可以订阅不同的通知主题，不同的主题可以使用不同的回调地址，回调方式也可以和轮询方式同时使用。
请求时，请求头带有Authorization信息，接收方可以校验Authorization是否合法，Authorization跟海鼎分配的API鉴权一致。

  3. 格式内容说明

消息字段

字段名称

说明

id

消息ID

消息的唯一标识

group

消息分组

用于消息业务类型的分组

content

消息内容,json字符串

用于传递消息关键业务信息，如订单号

time

消息时间

消息产生时间

  1. 消息示例

     {
        "id": "1",
        "group": "order",
        "topic": "order.shipped",
        "content": "{ \"order_id\": \"44546546512132\" }",
        "time": "2019-04-30 10:00:00"
        "tag": "store:001"
     }
接入系统收到回调后请返回成功：
    {
        "success": true
    }
如果接收失败，可以返回错误，鼎力云将会延时重试推送10次，超过10次后此通知将被抛弃：
    {
        "success": false,
        "message": "错误信息"
    }
为了获得更好的性能，接入系统响应回调通知要求在200ms之内完成，对于处理时间比较长的任务，建议先收下通知再异步处理。

接入平台授权

  1. 授权信息说明

    平台(platform_id)
    开通新平台，需要约定平台ID，用于管理订单履约规则。
平台商家(shop_id)
    开通新平台，需要指定一个平台商家，用于管理订单履约规则。
租户申请(tenant_id)
    不同商户调用不同URL。
    如SAAS生产：提交订单：http://api.u.hd123.com/{tenant_id}/soms/orderservice/order
接口用户名(user)
    调用鼎力云接口API的用户名
接口密码(password)
    调用鼎力云接口API的密码

  2. 沙箱授权申请

    开发联调过程中，由项目工程负责人内部发起流程申请。

  3. 商户授权申请

    上线申请过程中，由项目工程负责人内部发起流程申请。

业务场景

平台订单对接

接入方作为【平台】的角色，接入中台，由中台完成订单履约

1. 订单结构

orderinfo

2. 门店订单商家配送流程

orderDelivery

说明:
提交订单后： 订单状态->已确认；配送状态->未配送
门店作业：门店接单->接单(accepted)；门店备货->拣货完成(shipping)；
拣货完成后，由中台根据配送调度规则，呼叫承运商的骑手进行配送
骑手揽收后：更新配送状态(shipped)： 订单状态->配送中(delivering)；配送状态->已发货(shipped)，发送发货消息给平台
骑手配送完成后：更新配送状态(signed)： 订单状态->配送完成(delivered)；配送状态->已妥投(signed)，发送签收消息给平台
Table 1. 相关接口消息
接口类型 接口说明 接口地址

API

提交订单中台

提交订单

API

更新订单发货,delivery_state=shipped

订单发货

API

更新订单签收,delivery_state=signed

订单签收

API

查询骑手轨迹

订单物流轨迹

消息

订单状态变更消息

order.state.changed

消息

订单门店作业状态消息

store.order.operation

3. 门店订单平台配送流程

orderThirdDelivery

说明:
提交订单后： 订单状态->已确认；配送状态->未配送
门店作业：门店接单->接单(accepted)；门店备货->拣货完成(shipping)；
拣货完成后，由平台根据配送调度规则，呼叫承运商的骑手进行配送
骑手揽收后：平台更新中台配送状态(shipped)： 订单状态->配送中(delivering)；配送状态->已发货(shipped)
骑手配送完成后：平台更新中台更新配送状态(signed)： 订单状态->配送完成(delivered)；配送状态->已妥投(signed)
Table 2. 相关接口消息
接口类型 接口说明 接口地址

API

提交订单中台

提交订单

API

更新订单发货,delivery_state=shipped

订单发货

API

更新订单签收,delivery_state=signed

订单签收

消息

订单状态变更消息

order.state.changed

消息

订单门店作业状态消息

store.order.operation

4. 门店自提订单流程

selftake

说明:
提交订单后： 订单状态->已确认；配送状态->未配送
门店作业：门店接单->接单(accepted)；门店备货->接单(shipping)；
自提检查： 顾客到店出示自提码，中台转发自提码给商城验证，验证通过，商城返回对应订单号，门店前端进入订单详情，操作确认自提
自提确认： 订单状态->配送完成(delivered)；配送状态->已妥投(signed)，中台端接收到状态变更消息：delivery_state=signed，核销订单
Table 3. 相关接口消息
接口类型 接口说明 接口地址

API

提交订单中台,delivery.type=selftake,自提码：selftake_code

提交订单

API

订单确认自提，同步自提结果给中台

确认自提

消息

订单状态变更消息

order.state.changed

消息

订单门店作业状态消息

store.order.operation

消息

自提检查消息，如果订单未提交自提码，需要通过自提码回调查询对应的订单

order.selftake.check

5. 仅退款流程

refund

说明:
提交退款单（type=refund）： 退单状态->已生成；退款状态->未退款
退款同意： 退单状态->已完成；退款状态->已退款
退款拒绝： 退款状态->已取消；退款状态->未退款
Table 4. 相关接口消息
接口类型 接口说明 接口地址

API

提交退单中台,type=refund

提交退单

API

审核退单接口，审核通过approve_state=financeApproved，审核不通过approve_state=serviceRefuse

审核退单

API

确认退款接口：默认审核通过后，自动确认退款完成

确认退款

API

取消仅退款接口：reason=取消原因

取消仅退款

消息

退单状态变更消息

rtn.state.changed

6. 退款退货流程

rtnRefund

说明:
提交退单（type=refundAndRtn）： 退单状态->已生成；退货状态->未退货
确认退状态： 退单状态->已完成；退货状态->已退货
Table 5. 相关接口消息
接口类型 接口说明 接口地址

API

提交退单中台,type=refundAndRtn

提交退单

API

审核退单接口，审核通过approve_state=financeApproved，审核不通过approve_state=serviceRefuse

审核退单

API

确认收货接口：return_state=received

确认收货接口

API

确认退款接口：默认确认收货后，自动确认退款完成

确认退款

API

取消退款退货接口：reason=收货失败

取消退款退货

消息

退单状态变更消息

rtn.state.changed

7. 订单预占货

stock

说明:
订单未支付之前，需要提前占货的场景，用户加购后，未支付，需要提前锁定库存。
如果超时未支付，平台取消订单，需要释放锁定库存
支付成功后，提交订单到中台，中台如果判断已经提前锁定库存，不会再次锁定。
Table 6. 相关接口消息
接口类型 接口说明 接口地址

API

提交订单占货

提交占货

API

取消订单接口

取消占货

平台资料对接

1. 资料层级结构

org

说明:
        平台商家：一个平台可以开通多个店铺（品牌、商家），一个店铺对应一个平台商家。
        如：友客客户有两个品牌入驻了美团：友客、益欣，对于美团来说这两个品牌是两个商家，那在中台，友客和益欣就是同一个平台下的两个平台商家。
        平台门店：一个平台商家可以关联多个门店，每个平台门店映射一个线下门店
        平台商品：一个平台可以售卖的商品范围
        平台门店商品：平台下的某个门店可以售卖的商品范围

2. 资料对齐方案

未启用资料中台的场景

说明: 接入的订单平台，如果是平台自闭环完成门店的运营和商品的发布，则拉取中台的门店和商品，进行基础资料对齐。

notmas

拉取中台门店

说明:
      平台可以通过获取中台的门店列表进行门店关系映射
      建议采用[最后修改时间]条件增量查询
  （相关接口地址：https://apidoc.hd123.com/public/soms/dly-doc/0.1/#_merchant_storeservice_query）

拉取中台商品

说明:
     平台可以通过获取中台的商品列表进行商品关系映射
     建议采用[最后修改时间]条件增量查询
 （相关接口地址：https://apidoc.hd123.com/public/soms/dly-doc/0.1/#_invc_itemservice_querysearch）

提交平台门店

invcStore

 说明:
         平台门店：表示【本平台】要上线的门店范围，不在范围内的门店，不会同步该平台的库存、价格
（相关接口地址：https://u.hd123.com/view/module/doc.html#es-api-2）

提交平台商品

invcProduct

         说明:
         平台商品：表示【本平台】要上线的商品范围，设置平台商品，可以缩小同步给该平台的库存、价格范围，提升同步效率
（相关接口地址：https://u.hd123.com/view/module/doc.html#es-api-1）

3. 资料中台发布方案

启用资料中台的场景

说明:
接入平台端的日常资料发布，上下架等操作，如果需要由中台统一管理，则需要按照资料中台接入方案

mas

资料中台开放平台文档： https://apidoc.hd123.com/public/mas/1.0.0/

平台门店

消息通知：platform_shop.changed.notify

查询API：/v2/{tenant}/service/platformshop/query

平台分类

消息通知：platform_category.changed.notify

查询API：/v2/{tenant}/service/platformcategory/query

平台商品

消息通知：platform_front_spu.changed.notify

查询API：/v2/{tenant}/service/platformfrontspu/{platformId}/{frontSpuId}

平台门店商品

消息通知：platform_shop_sku.changed.notify

查询API：/v2/{tenant}/service/platformShopSku/query

效果示例： case1

平台价格更新对接

价格变化通知

同步条件：1. 平台商家配置了回调地址 2. 平台门店开通了价格同步 3.价格有更新

priceNotify2

通知示例：

{
"id": "1",
"group": "sku",
"topic": "store.pricechanged",
"scope": "store:0001",
"content": {
    "skus": [
        {
            "store_id": "1001",
            "sku_id": "10001",
            "price": 100
        },
        {
            "store_id": "1001",
            "sku_id": "10002",
            "price": 150
        }
    ]
},
"time": "2019-04-30 10:00:00"
}
接入系统收到回调后请返回成功：
    {
        "success": true
    }
如果接收失败，可以返回错误，鼎力云将会延时重试推送3次，超过3次后此通知将不再重试：
    {
        "success": false,
        "message": "错误信息"
    }

平台库存更新对接

库存变化通知

同步条件：1. 平台商家配置了回调地址 2. 平台门店开通了库存同步 3.库存有更新

invcNotify2

通知示例：

{
    "id": "1",
    "group": "sku",
    "topic": "store.skuchanged",
    "scope": "store:0001",
    "content": {
        "skus": [
            {
                "store_id": "1001",
                "sku_id": "10001",
                "qty": 100
            },
            {
                "store_id": "1001",
                "sku_id": "10002",
                "qty": 150
            }
        ]
    },
    "time": "2019-04-30 10:00:00"
}
接入系统收到回调后请返回成功：
    {
        "success": true
    }
如果接收失败，可以返回错误，鼎力云将会延时重试推送3次，超过3次后此通知将不再重试：
    {
        "success": false,
        "message": "错误信息"
    }

门店履约端接入

接入方作为【门店履约方】的角色，接入中台，完成线上单据的履约操作

  1. 订单流程

orderDelivery

说明:
新订单通知
获取打印数据，打印小票
查询订单详情
拣货操作
送货操作
送达确认
自提确认

  1. 仅退款流程

refund

说明:
新退款通知
查询退款详情
同意退款
拒绝退款

  1. 退款退货流程

rtnRefund

说明:
新退货通知
查询退货详情
同意退款
拒绝退款
确认收货成功
确认收货失败

ERP接入

接入方作为【ERP】的角色，接入中台，完成资料同步、销售单据结算等流程

  1. 资料流程

erpmas

   说明:
通过门店同步接口，同步门店信息给鼎力云
通过品牌同步接口，同步品牌信息给鼎力云
通过类目同步解耦，同步商品类目信息给鼎力云
通过主档同步接口，同步商品主档信息给鼎力云
通过商品同步接口，同步商品信息给鼎力云
通过门店商品同步接口，同步门店商品信息给鼎力云
通过门店商品库存更新接口，同步库存信息给鼎力云
通过门店商品价格更新接口，同步价格信息给鼎力云
Table 7. 相关接口消息
接口类型 接口说明 接口地址

API

批量更新门店，不存在新建，存在修改

门店接口

API

批量更新品牌，不存在新建，存在修改

品牌接口

API

批量更新线下类目，不存在新建，存在修改

线下类目接口

API

批量更新商品主档，不存在新建，存在修改

商品主档接口

API

批量更新商品，不存在新建，存在修改

商品接口

API

批量更新门店商品，不存在新建，存在修改

门店商品接口

API

批量更新门店商品价格，不存在新建，存在修改

门店商品价格接口

API

批量更新门店商品库存，不存在新建，存在修改

门店商品库存接口

  1. 批发单流程

orderDelivery

  说明:
订单发货通知
查询订单详情
Table 8. 相关接口消息
接口类型 接口说明 接口地址

API

查询订单详情，注意parts参数的用法

指定订单查询接口

消息

订单发货消息

order.shipped

  1. 仅退款批发退流程

refund

说明:
退款确认通知
查询退单详情
Table 9. 相关接口消息
接口类型 接口说明 接口地址

API

查询退单详情，注意parts的用法

指定退单接口

消息

退单退款消息

refund.refunded

  1. 退款退货批发退流程

rtnRefund

  说明:
退货收货通知
查询退单详情
Table 10. 相关接口消息
接口类型 接口说明 接口地址

API

查询退单详情，注意parts的用法

指定退单接口

消息

退单退款消息

return.received

  1. 平台对账数据流程

      说明:
新订单对账消息通知
查询账单详情
Table 11. 相关接口消息
接口类型 接口说明 接口地址

API

查询账单详情

查询账单接口

消息

对账单新增消息

ordersettle.created

配送平台对接

通过中台能力，呼叫第三方配送平台（如：美团众包、达达、蜂鸟等）

delivery

促销场景

促销是线下商家典型采用的促销场景，包含多种促销模版。

概念：

促销活动：是指定时间段发生的一次促销行为。

促销模型：目前支持四种类型的促销模型：打折、满减、特价、赠送。

促销模版：在特定促销模型下变化出来的具体促销内容，比如特价分为单品特价、组合特价等。

  1. 单品特价

    模版名：single_price
说明：A从原先的价格X元直接降为Y元
示例：购买商品69010020045，原价20元，特价10元
        {
        "sku_id": "69010020045",
        "std_price": 20.00,
        "price": 10.00
    }

  2. 组合特价

    模版名：group_price
说明：商品A,B,C任选m件n元
示例：购买商品69010020045、69303401295任选2件10元
        {
        "sku_ids": ["69010020045", "69303401295"],
        "buy_qty": 2,
        "price": 10.00
    }

  3. 捆绑特价

    模版名：package_price
说明：购买A商品X件，并且购买B商品m个或者C商品n个特价Y元
示例：购买2件商品69120434096，再任选1件691111111或692222222，特价10.00
        {
      "fixed_sku_id": "69120434096",
      "fixed_qty": 2,
      "optional_skus": [
        { "sku_id": "691111111", "qty": 1 },
        { "sku_id": "692222222", "qty": 1 }
       ],
      "price": 10.00
    }

  4. 单品折扣

    模版名：single_discount
说明：购买A商品直接X折
示例：购买商品69010020045享受6折
        {
        "sku_id": "69010020045",
        "discount": 0.6
    }

  5. 单品满数量折扣

    模版名：qty_discount
说明：购买A商品满X个打Y折
示例：购买商品69010020045满5件享受6折
        {
        "sku_id": "69010020045",
        "min_qty": 5,
        "discount": 0.6
    }

  6. 单品满金额折扣

    模版名：amount_discount
说明：购买A商品满X元打Y折
示例：购买商品69010020045满100元享受6折
        {
        "sku_id": "69010020045",
        "min_amount": 100.00,
        "discount": 0.6
    }

  7. 单品满数量减

    模版名：qty_reduce
说明：购买A商品满X个减Y元
示例：购买商品69010020045满2件减5元
        {
        "sku_id": "69010020045",
        "min_qty": 2,
        "reduce_amount": 5.00
    }

  8. 单品满金额减

    模版名：amount_reduce
说明：购买A商品满X元减Y元
示例：购买商品69010020045满100元立减5元
        {
        "sku_id": "69010020045",
        "min_amount": 100.00,
        "reduce_amount": 5.00
    }

  9. 单品满赠

    模版名：single_gift
说明：买n个商品A送m个商品B（或A本身），赠品无售价，多买多送
示例：购买商品69111111每2件送1件赠品69222222
        {
        "buy_sku_id": "69111111",
        "buy_qty": 2,
        "gift_sku_id": "69222222",
        "gift_qty": 1
    }

  10. 单品满数量赠

    模版名：qty_gift
说明：购买A商品满X个送B赠品Y个，只送一次
示例：购买商品69111111满2件送1件赠品69222222
        {
        "buy_sku_id": "69111111",
        "min_qty": 2,
        "gift_sku_id": "69222222",
        "gift_qty": 1
    }

  11. 单品满金额赠

    模版名：amount_gift
说明：购买A商品满X元送B赠品Y个，只送一次
示例：购买商品69111111满100元送1件赠品69222222
        {
        "buy_sku_id": "69111111",
        "min_amount": 100.00,
        "gift_sku_id": "69222222",
        "gift_qty": 1
    }

可订阅的通知列表

  1. 订单类消息

    order.shipped（订单发货），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.shipped",
        "content": "{ \"order_id\": \"44546546512132\",\"front_order_id\": \"44546546512132\"}",
        "time": "2019-04-30 10:00:00"
    }

    消息内容说明

    字段 字段名称 说明

    order_id

    海鼎订单号

    唯一标识

    front_order_id

    平台订单号

    平台维度唯一标识

    		 
    order.canceled（订单取消），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.canceled",
        "content": "{ \"order_id\": \"44546546512132\", \"front_order_id\": \"44546546512132\" }",
        "time": "2019-04-30 10:00:00"
    }
    order.signed（订单签收），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.signed",
        "content": "{ \"order_id\": \"44546546512132\" ,\"front_order_id\": \"44546546512132\"}",
        "time": "2019-04-30 10:00:00"
    }
    order.refused（订单拒收），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.refused",
        "content": "{ \"order_id\": \"44546546512132\" ,\"front_order_id\": \"44546546512132\"}",
        "time": "2019-04-30 10:00:00"
    }
    return.received（退货单收货），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "return.received",
        "content": "{  \"order_id\": \"44546546512132\", \"front_order_id\": \"44546546512132\", \"rtn_id\": \"4565121321212125\" }",
        "time": "2019-04-30 10:00:00"
    }
    store.order.created（门店新订单），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "store.order.created",
        "tag": "store:001",
        "content": "{  \"order_id\": \"44546546512132\" }",
        "time": "2019-04-30 10:00:00"
    }
    store.return.created（门店新退货），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "store.return.created",
        "tag": "store:001",
        "content": "{ \"order_id\": \"44546546512132\",  \"rtn_id\": \"84544465646545645\"}",
        "time": "2019-04-30 10:00:00"
    }
    store.order.shipped（门店订单发货），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.shipped",
        "tag": "store:001",
        "content": "{ \"order_id\": \"44546546512132\" }",
        "time": "2019-04-30 10:00:00"
    }
    store.return.received（门店退货单收货），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "return.received",
        "tag": "store:001",
        "content": "{  \"order_id\": \"44546546512132\", \"front_order_id\": \"44546546512132\", \"rtn_id\": \"4565121321212125\" }",
        "time": "2019-04-30 10:00:00"
    }
    store.order.operation（门店配送作业），其中operation取值：shipping=门店集货，cancalShipping=门店取消集货，示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "store.order.operation",
        "tag": "store:001",
        "content": "{  \"order_id\": \"44546546512132\", \"operation\": \"shipping\" }",
        "time": "2019-04-30 10:00:00"
    }
    refund.refunded（退款完成）示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0002",
        "group": "order",
        "topic": "refund.refunded",
        "tag": "store:001",
        "content": "{  \"order_id\": \"44546546512132\", \"rtn_id\": \"1232142353\",\"front_order_id\": \"6578681232142353\" }",
        "time": "2019-04-30 10:00:00"
    }
    ordersettle.created（对账单生成消息），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "ordersettle.created",
         "content": "{ \"order_id\": \"44546546512132\"}",
        "time": "2019-04-30 10:00:00"
    }
    order.state.changed（订单状态变化消息），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.state.changed",
        "content": "{ \"order_id\": \"44546546512132\",\"front_order_id\": \"44546546512132\",\"state\": \"delivering\"}",
        "time": "2018-12-13 00:00:00"
    }
    order.deliverystate.changed（订单配送状态变化消息），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.deliverystate.changed",
        "content": "{ \"order_id\": \"44546546512132\",\"front_order_id\": \"44546546512132\",\"delivery_state\": \"shipped\"}",
        "time": "2018-12-13 00:00:00"
    }
    order.exception.changed（订单异常变化消息），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.exception.changed",
        "content": "{ \"order_id\": \"44546546512132\",\"front_order_id\": \"44546546512132\",\"has_exception\": \"true\",\"exception_reason\": \"异常原因\"}",
        "time": "2018-12-13 00:00:00"
    }
    order.carrierstate.changed（订单承运状态变化消息），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.carrierstate.changed",
        "content": "{ \"order_id\": \"44546546512132\",\"front_order_id\": \"44546546512132\",\"carrier_state\": \"pickup\"}",
        "time": "2018-12-13 00:00:00"
    }
    return.state.changed（退单状态变化消息），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "return.state.changed",
        "content": "{\"rtn_id\": \"44546546512132\", \"order_id\": \"44546546512132\",\"front_order_id\": \"44546546512132\",\"state\": \"finished\"}",
        "time": "2018-12-13 00:00:00"
    }
    order.selftake.check（自提检查接口），其中front_order_id和order_id非必传， 示例：
    //请求
    {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.selftake.check",
        "content": "{\"store_id\": \"0001\",\"selftake_code\": \"自提码\",\"platform_id\": \"youzan\",\"front_order_id\": \"平台订单号",\"order_id\": \"订单号"}",
        "time": "2018-12-13 00:00:00"
    }
//响应：
    {
        "success": true, //检查自提码是否可以核销
        "code": "success",
        "message": "检查通过",
        "order_id": "646464988813", //订单号
        "front_order_id": "646464988813" //平台订单号
    }
    order.operation.changed（订单门店作业状态变化消息），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.operation.changed",
        "content": "{ \"order_id\": \"44546546512132\",\"front_order_id\": \"44546546512132\",\"operation_state\": \"shipping\"}",
        "time": "2018-12-13 00:00:00"
    }
    order.item.changed（订单换货消息），示例：
        {

        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "order.item.changed",
        "content": "{\"platform_id\": \"youzan\",\"front_order_id\": \"平台订单号",\"order_id\": \"订单号"}",
        "time": "2018-12-13 00:00:00"
    }
    store.order.canceled（门店订单取消），示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "store.order.canceled",
        "tag": "store:001",
        "content": "{  \"order_id\": \"44546546512132\", \"front_order_id\": \"44546546512132\" }",
        "time": "2019-04-30 10:00:00"
    }

  2. 承运类消息

    store.order.carrierexception（承运异常），示例：
pickupFailed：揽件失败
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "order",
        "topic": "store.order.carrierexception",
        "tag": "store:001",
        "content": "{  \"order_id\": \"44546546512132\", \"carrier_state\": \"pickupFailed\" }",
        "time": "2019-04-30 10:00:00"
    }

  3. 支付类消息

    pay.order.success（订单支付成功），示例：
        {
        "id": "2c92819657c1a6860157c1a9f9220007",
        "group": "pay",
        "topic": "pay.order.success",
        "content":  "{\"payAmount\":0.01,\"storeNo\":\"0088\",\"billType\":\"pay\",\"orderUuid\":\"111110016acc4916834fad23354b5fb9\",\"payNo\":\"2016101421001004080274676406\",\"orderAmount\":0.01,\"orderNumber\":\"0088161014132716708\",\"uuid\":\"cf8705ee0e194f41b11b475b1d50816b\",\"payAccountId\":\"2088002495582085\",\"payChannelName\":\"支付宝\",\"payTime\":\"2016-10-14 13:27:16\",\"payChannel\":\"aliPay\",\"tenantId\":\"testbn01\",\"sourceOrderUuid\":\"testbn01\",\"remark\":\"支付成功\",\"payState\":\"paySuccess\"}",
        "time": "2019-04-30 10:00:00"
    }

  4. 营销类消息

    activity.audited（活动发布），示例：
        {
        "id": "2c92819657c1a6860157c1a9f9220007",
        "group": "mp",
        "topic": "activity.audited",
        "content": "{  \"activity_id\": \"201708050001\" }",
        "tag": "store:1001",
        "time": "2019-04-30 10:00:00"
    }
    activity.stopped（活动下架），示例：
        {
        "id": "2c92819657c1a6860157c1a9f9220007",
        "group": "mp",
        "topic": "activity.stopped",
        "content": "{  \"activity_id\": \"201708050001\" }",
        "tag": "store:1001",
        "time": "2019-04-30 10:00:00"
    }
    coupon.consumed（券核销），示例：
        {
        "id": "2c92819657c1a6860157c1a9f9220007",
        "group": "equity",
        "topic": "coupon.consumed",
        "content": "{  \"coupon_code\": \"201708050001\" }",
        "time": "2019-04-30 10:00:00"
    }
    tran.created(新交易)，示例：
        {
        "id": "4028fe8153b876e50153b8779b2a0001",
        "group": "member",
        "topic": "tran.created",
        "content": "{\"tran_time\":\"2017-07-26 17:17:00\",\"person_id\":\"00111\",\"pos_no\":\"0001\",\"face_id\":\"111100\",\"store_id\":\"0001\",\"tran_id\":\"qyh0000201707270007\",\"member_code\":\"8888170508000005\"}",
        "time": "2019-04-30 10:00:00"
    }

常见问题

授权相关

  1. 订单中心授权

    沙箱授权（由项目经理发起内部流程申请以下沙箱资源）
    租户ID(tenant_id)：租户ID，商户的唯一表示
    服务地址(url)：
    https://sandbox.api.u.hd123.com/{tenant_id}
    接口用户名(user)：***
    接口密码(password)：***
    平台(platform_id)：用于区分不同平台
    平台商家(shop_id)：用于区分平台商家的不同用户
    测试门店(station_id)：用于联调时使用的测试门店
    正式环境授权（由项目经理发起内部流程申请正式环境资源）
    租户ID(tenant_id)：租户ID，商户的唯一表示
    服务地址(url)：
    https://api.u.hd123.com/{tenant_id}
    接口用户名(user)：***
    接口密码(password)：***
    平台(platform_id)：用于区分不同平台
    平台商家(shop_id)：用于区分平台商家的不同用户

  2. 营销中心授权

    联系对接的项目经理处理

  3. 支付中心授权

    联系对接的项目经理处理

API相关

  1. 订单中心

    平台结算价settle_total
    平台结算价：平台和商家联合促销的情况，优惠金额由商家和平台共同承担的场景。平台结算价=客户实付商品金额+平台优惠分摊金额
    订单金额
    客户购买A、B、C上个商品，原价为A（120元），B（200元）、C（300元）。A商品促销价为100元。整单优惠60（其中平台优惠18，商家优惠42）。那么A商品优惠占比= （A的实付金额100）/(A+B+C)=1/6；B商品优惠占比=（B的实付金额200）/(A+B+C)=2/6；C商品优惠占比=（C的实付金额300）/(A+B+C)=3/6。
A的金额如下：
    整单分摊金额apt_dis_amount=60*1/6=10元。
    实付金额pay_amount=100-10=90元。
    单品促销金额discount_amount=120-100=20元。
    平台结算金额settle_total=90+（18*1/6）=93元。
B的金额如下：
    整单分摊金额apt_dis_amount=60*2/6=20元。
    实付金额pay_amount=200-20=180元。
    单品促销金额discount_amount=0元。
    平台结算金额settle_total=180+（18*2/6）=186元
C的金额如下：
    整单分摊金额apt_dis_amount=60-A的整单分摊-B的整单分摊=30（为了防止除不尽的情况，最后一个商品行的整单分摊金额用减法）。
    实付金额pay_amount=300-30=270元。
    单品促销金额discount_amount=0元。
    平台结算金额settle_total=270+（18*3/6）=279元
订单的金额如下：
    订单的实付金额real_total=90+180+270=540元。
    订单的平台结算金额settle_amount=93+186+279=558元。
    预占货订单
    商家是多平台共享库存，希望在下单的时候（未付款）就扣减其他平台的库存。
    回调地址
    鼎力云订单状态变化、库存变化、价格变化等都是通过推送消息给第三方的方式实现的。第三方平台对接需要提供接收消息的回调地址。
    消息内容参考：https://u.hd123.com/view/module/doc.html#nf-api-1=

接口

1. 接口定义

1.1. 商品服务

1.1.1. 分页查询品牌

POST /{tenant_id}/invc/itemservice/brands/query
1.1.1.1. 说明

分页查询品牌

1.1.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
必填

页码，必须>=0

integer (int32)

Query

page_size
必填

分页大小，范围是[1,1000]

integer (int32)

Query

sort_key
可选

排序字段：modified,id,name

string

Body

filter
必填

过滤器

BrandFilter
1.1.1.3. 响应
HTTP代码 说明 类型

200

successful operation

BrandPaging
1.1.1.4. HTTP请求示例
请求 path
/string/invc/itemservice/brands/query?desc=true&page=0&page_size=0
请求 body
{
  "name_like" : "aaa",
  "key_like" : "aaa",
  "parent_id" : "aaa",
  "ids" : [ "string" ],
  "parent_ids" : [ "string" ],
  "parent_id_is_null" : false,
  "modified_start" : "2020-06-17 10:00:00",
  "modified_end" : "2020-06-17 10:00:00"
}
1.1.1.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 0,
  "brands" : [ {
    "id" : "3434343434",
    "name" : "耐克",
    "remark" : "无",
    "parentId" : "324232"
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.1.2. 批量更新品牌

POST /{tenant_id}/invc/itemservice/brands/update
1.1.2.1. 说明

批量更新品牌，不存在则创建，存在则修改。

1.1.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

brands
必填

品牌列表，每次更新不超过100条

BrandList
1.1.2.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.2.4. HTTP请求示例
请求 path
/string/invc/itemservice/brands/update?operator=string
请求 body
{
  "brands" : [ {
    "id" : "3434343434",
    "name" : "耐克",
    "remark" : "无",
    "parentId" : "324232"
  } ]
}
1.1.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.3. 分页查询类别

POST /{tenant_id}/invc/itemservice/categories/query
1.1.3.1. 说明

分页查询类别

1.1.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

string

Query

desc
可选

boolean

Query

page
可选

integer (int32)

Query

page_size
可选

integer (int32)

Query

sort_key
可选

排序字段：modified,id,name

string

Body

body
可选

CategoryFilter
1.1.3.3. 响应
HTTP代码 说明 类型

200

successful operation

CategoryPaging
1.1.3.4. HTTP请求示例
请求 path
/string/invc/itemservice/categories/query
请求 body
{
  "parentId" : "string",
  "modifiedStart" : "2020-06-17 10:00:00",
  "modifiedEnd" : "2020-06-17 10:00:00",
  "name_like" : "string",
  "key_like" : "string",
  "ids" : [ "string" ],
  "parent_ids" : [ "string" ],
  "parent_id_is_null" : true
}
1.1.3.5. HTTP响应示例
响应 200
{
  "total" : 0,
  "page" : 0,
  "categories" : [ {
    "id" : "99",
    "name" : "百货类",
    "remark" : "string",
    "parentId" : "string"
  } ],
  "page_count" : 0,
  "page_size" : 0
}

1.1.4. 批量更新类别

POST /{tenant_id}/invc/itemservice/categories/update
1.1.4.1. 说明

批量更新类别，不存在则创建，存在则修改。

1.1.4.2. 参数
类型 名称 类型

Path

tenant_id
必填

string

Query

operator
可选

string

Body

body
可选

CategoryList
1.1.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.4.4. HTTP请求示例
请求 path
/string/invc/itemservice/categories/update
请求 body
{
  "categories" : [ {
    "id" : "99",
    "name" : "百货类",
    "remark" : "string",
    "parentId" : "string"
  } ]
}
1.1.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.5. 批量更新产品

POST /{tenant_id}/invc/itemservice/products/update
1.1.5.1. 说明

批量更新产品，如果不存在则新增，存在则修改

1.1.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

products
必填

产品列表

ProductList
1.1.5.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.5.4. HTTP请求示例
请求 path
/string/invc/itemservice/products/update?operator=string
请求 body
{
  "products" : [ {
    "id" : "484844554",
    "name" : "苹果",
    "state" : "新品、季节品、赠品、淘汰品、预淘汰品、缺品、买断",
    "gid" : "2323",
    "qpcs" : [ {
      "uuid" : "string",
      "id" : "string",
      "qpc" : 0.0,
      "qpc_str" : "string",
      "unit" : "string",
      "weight" : 0.0
    } ],
    "remark" : "23223",
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 1.0,
      "unit" : "包",
      "weight" : 0.0,
      "source" : "string",
      "qpc_str" : "1*1"
    } ],
    "is_unified" : false
  } ]
}
1.1.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.6. 批量上传商品图片

POST /{tenant_id}/invc/itemservice/sku/images/update
1.1.6.1. 说明

批量上传商品图片。

1.1.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

sku_images
必填

商品图片列表，每次更新不超过100条

SkuImageList
1.1.6.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.1.6.4. HTTP请求示例
请求 path
/string/invc/itemservice/sku/images/update?operator=string
请求 body
{
  "sku_images" : [ {
    "sku_id" : "string",
    "image" : {
      "name" : "a.jpg",
      "url" : "http://aa.png",
      "sort" : 1,
      "image_base64" : "xxxx"
    },
    "sub_images" : [ {
      "name" : "a.jpg",
      "url" : "http://aa.png",
      "sort" : 1,
      "image_base64" : "xxxx"
    } ],
    "detail_images" : [ {
      "name" : "a.jpg",
      "url" : "http://aa.png",
      "sort" : 1,
      "image_base64" : "xxxx"
    } ]
  } ],
  "upload_type" : "string"
}
1.1.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.7. 指定货号查询商品

GET /{tenant_id}/invc/itemservice/sku/{id}
1.1.7.1. 说明

指定货号查询商品

1.1.7.2. 参数
类型 名称 说明 类型

Path

id
必填

商品ID

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分:desc(商品详情)

string
1.1.7.3. 响应
HTTP代码 说明 类型

200

successful operation

Sku
1.1.7.4. HTTP请求示例
请求 path
/string/invc/itemservice/sku/string
1.1.7.5. HTTP响应示例
响应 200
{
  "id" : "484844554",
  "barcode" : "484844554",
  "upc" : "69...",
  "name" : "矿泉水",
  "remark" : "无",
  "disp" : false,
  "size" : {
    "unit" : "mm",
    "height" : 12.0,
    "width" : 15.0,
    "length" : 12.0
  },
  "weight" : {
    "unit" : "g",
    "value" : 12.0
  },
  "packing" : {
    "spec" : "1*1",
    "quantity" : 1.0,
    "spec2" : "200ml",
    "unit" : "瓶"
  },
  "title" : "矿泉水",
  "desc" : "好喝",
  "gid" : "145555",
  "capacity" : 0.001,
  "created" : "2018-11-11 21:12:55",
  "creator" : "123",
  "modifier" : "123",
  "product_id" : "1515151",
  "product_type" : "fresh",
  "brand_id" : "1515444444",
  "category_id" : "44848444484",
  "retail_price" : 15.15,
  "member_price" : 53.22,
  "image_url" : "http://aa.png",
  "sub_image_urls" : [ "string" ],
  "detail_image_urls" : [ "string" ],
  "tax_rate" : 0.13,
  "tax_sort_code" : "string",
  "invoice_name" : "string",
  "combined_items" : [ {
    "id" : "string",
    "title" : "string",
    "price" : 0.0,
    "quantity" : 0.0,
    "product_type" : "normal"
  } ],
  "customs_fields" : [ {
    "id" : "area_id",
    "name" : "地区代码",
    "value" : "ET09"
  } ],
  "input_codes" : [ {
    "type" : "EAN",
    "code" : "232323",
    "qpc" : 1.0,
    "unit" : "包",
    "weight" : 0.0,
    "source" : "string",
    "qpc_str" : "1*1"
  } ],
  "is_inv_unit" : true,
  "sku_combined_tag" : {
    "enabled" : false,
    "code" : "20-2-10",
    "qty" : 2.0,
    "price" : 19.9999
  },
  "kind_types" : [ "string" ],
  "capacity_unit" : "string",
  "invc_unit" : "string",
  "state" : "string",
  "modified" : "2018-11-11 21:12:55",
  "first_arriving_time" : "2018-11-11 21:12:55",
  "source" : "ERP",
  "label_printing" : false,
  "is_light_catering" : true,
  "trace_source_code_type" : "string",
  "online_type" : "string"
}

1.1.8. 批量取指定商品信息

POST /{tenant_id}/invc/itemservice/skus
1.1.8.1. 说明

批量取指定商品信息

1.1.8.2. 参数
类型 名称 类型

Path

tenant_id
必填

string

Body

body
可选

IdsWrapper
1.1.8.3. 响应
HTTP代码 说明 类型

200

successful operation

SkuList
1.1.8.4. HTTP请求示例
请求 path
/string/invc/itemservice/skus
请求 body
{
  "ids" : [ "string" ]
}
1.1.8.5. HTTP响应示例
响应 200
{
  "skus" : [ {
    "id" : "484844554",
    "barcode" : "484844554",
    "upc" : "69...",
    "name" : "矿泉水",
    "remark" : "无",
    "disp" : false,
    "size" : {
      "unit" : "mm",
      "height" : 12.0,
      "width" : 15.0,
      "length" : 12.0
    },
    "weight" : {
      "unit" : "g",
      "value" : 12.0
    },
    "packing" : {
      "spec" : "1*1",
      "quantity" : 1.0,
      "spec2" : "200ml",
      "unit" : "瓶"
    },
    "title" : "矿泉水",
    "desc" : "好喝",
    "gid" : "145555",
    "capacity" : 0.001,
    "created" : "2018-11-11 21:12:55",
    "creator" : "123",
    "modifier" : "123",
    "product_id" : "1515151",
    "product_type" : "fresh",
    "brand_id" : "1515444444",
    "category_id" : "44848444484",
    "retail_price" : 15.15,
    "member_price" : 53.22,
    "image_url" : "http://aa.png",
    "sub_image_urls" : [ "string" ],
    "detail_image_urls" : [ "string" ],
    "tax_rate" : 0.13,
    "tax_sort_code" : "string",
    "invoice_name" : "string",
    "combined_items" : [ {
      "id" : "string",
      "title" : "string",
      "price" : 0.0,
      "quantity" : 0.0,
      "product_type" : "normal"
    } ],
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 1.0,
      "unit" : "包",
      "weight" : 0.0,
      "source" : "string",
      "qpc_str" : "1*1"
    } ],
    "is_inv_unit" : true,
    "sku_combined_tag" : {
      "enabled" : false,
      "code" : "20-2-10",
      "qty" : 2.0,
      "price" : 19.9999
    },
    "kind_types" : [ "string" ],
    "capacity_unit" : "string",
    "invc_unit" : "string",
    "state" : "string",
    "modified" : "2018-11-11 21:12:55",
    "first_arriving_time" : "2018-11-11 21:12:55",
    "source" : "ERP",
    "label_printing" : false,
    "is_light_catering" : true,
    "trace_source_code_type" : "string",
    "online_type" : "string"
  } ]
}

1.1.9. 分页查询商品，使用es索引

POST /{tenant_id}/invc/itemservice/skus/es_query
1.1.9.1. 说明

分页查询商品，使用es索引，推荐使用

1.1.9.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码，从0开始，必须>=0

integer (int32)

Query

page_size
必填

分页大小，范围是[1,1000]

integer (int32)

Query

sort_key
可选

排序字段，取值范围:title(名称)、barcode(条码)、skuId(货号)、modified(最后修改时间)

string

Body

filter
必填

查询过滤器

SkuFilter
1.1.9.3. 响应
HTTP代码 说明 类型

200

successful operation

SkuPaging
1.1.9.4. HTTP请求示例
请求 path
/string/invc/itemservice/skus/es_query?desc=true&page=0&page_size=0
请求 body
{
  "barcode" : "43454",
  "codes" : [ "string" ],
  "barcodes" : [ "string" ],
  "name_like" : "aaa",
  "key_like" : "aaa",
  "brand_id" : "54564",
  "category_id" : "32434",
  "code_type" : "string",
  "product_ids" : [ "string" ],
  "exclude_sku_ids" : "aaa",
  "title_like" : "aaa",
  "barcode_like" : "123",
  "sku_id_from" : "12",
  "sku_id_like" : "233",
  "barcode_from" : "aaa",
  "sku_id_in" : [ "string" ],
  "product_types" : [ "normal" ],
  "modified_start" : "2018-11-11 21:12:55",
  "modified_end" : "2018-11-11 21:12:55",
  "created_start" : "2018-11-11 21:12:55",
  "created_end" : "2018-11-11 21:12:55",
  "fetch_parts" : "combinedItems",
  "kinds_in" : [ "string" ],
  "pre_page" : 1
}
1.1.9.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 0,
  "skus" : [ {
    "id" : "484844554",
    "barcode" : "484844554",
    "upc" : "69...",
    "name" : "矿泉水",
    "remark" : "无",
    "disp" : false,
    "size" : {
      "unit" : "mm",
      "height" : 12.0,
      "width" : 15.0,
      "length" : 12.0
    },
    "weight" : {
      "unit" : "g",
      "value" : 12.0
    },
    "packing" : {
      "spec" : "1*1",
      "quantity" : 1.0,
      "spec2" : "200ml",
      "unit" : "瓶"
    },
    "title" : "矿泉水",
    "desc" : "好喝",
    "gid" : "145555",
    "capacity" : 0.001,
    "created" : "2018-11-11 21:12:55",
    "creator" : "123",
    "modifier" : "123",
    "product_id" : "1515151",
    "product_type" : "fresh",
    "brand_id" : "1515444444",
    "category_id" : "44848444484",
    "retail_price" : 15.15,
    "member_price" : 53.22,
    "image_url" : "http://aa.png",
    "sub_image_urls" : [ "string" ],
    "detail_image_urls" : [ "string" ],
    "tax_rate" : 0.13,
    "tax_sort_code" : "string",
    "invoice_name" : "string",
    "combined_items" : [ {
      "id" : "string",
      "title" : "string",
      "price" : 0.0,
      "quantity" : 0.0,
      "product_type" : "normal"
    } ],
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 1.0,
      "unit" : "包",
      "weight" : 0.0,
      "source" : "string",
      "qpc_str" : "1*1"
    } ],
    "is_inv_unit" : true,
    "sku_combined_tag" : {
      "enabled" : false,
      "code" : "20-2-10",
      "qty" : 2.0,
      "price" : 19.9999
    },
    "kind_types" : [ "string" ],
    "capacity_unit" : "string",
    "invc_unit" : "string",
    "state" : "string",
    "modified" : "2018-11-11 21:12:55",
    "first_arriving_time" : "2018-11-11 21:12:55",
    "source" : "ERP",
    "label_printing" : false,
    "is_light_catering" : true,
    "trace_source_code_type" : "string",
    "online_type" : "string"
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.1.10. 批量更新商品

POST /{tenant_id}/invc/itemservice/skus/update
1.1.10.1. 说明

批量更新商品，不存在则创建，存在则修改。

1.1.10.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

group_by_product
必填

如果是true，表示上传的商品是所属产品的全部商品，如果为false，则只上传部分商品

boolean

Query

operator
必填

操作人

string

Body

skus
必填

商品列表，每次更新不超过100条

SkuList
1.1.10.3. 响应
HTTP代码 说明 类型

200

successful operation

ItemUpdateResponse
1.1.10.4. HTTP请求示例
请求 path
/string/invc/itemservice/skus/update?group_by_product=true&operator=string
请求 body
{
  "skus" : [ {
    "id" : "484844554",
    "barcode" : "484844554",
    "upc" : "69...",
    "name" : "矿泉水",
    "remark" : "无",
    "disp" : false,
    "size" : {
      "unit" : "mm",
      "height" : 12.0,
      "width" : 15.0,
      "length" : 12.0
    },
    "weight" : {
      "unit" : "g",
      "value" : 12.0
    },
    "packing" : {
      "spec" : "1*1",
      "quantity" : 1.0,
      "spec2" : "200ml",
      "unit" : "瓶"
    },
    "title" : "矿泉水",
    "desc" : "好喝",
    "gid" : "145555",
    "capacity" : 0.001,
    "created" : "2018-11-11 21:12:55",
    "creator" : "123",
    "modifier" : "123",
    "product_id" : "1515151",
    "product_type" : "fresh",
    "brand_id" : "1515444444",
    "category_id" : "44848444484",
    "retail_price" : 15.15,
    "member_price" : 53.22,
    "image_url" : "http://aa.png",
    "sub_image_urls" : [ "string" ],
    "detail_image_urls" : [ "string" ],
    "tax_rate" : 0.13,
    "tax_sort_code" : "string",
    "invoice_name" : "string",
    "combined_items" : [ {
      "id" : "string",
      "title" : "string",
      "price" : 0.0,
      "quantity" : 0.0,
      "product_type" : "normal"
    } ],
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 1.0,
      "unit" : "包",
      "weight" : 0.0,
      "source" : "string",
      "qpc_str" : "1*1"
    } ],
    "is_inv_unit" : true,
    "sku_combined_tag" : {
      "enabled" : false,
      "code" : "20-2-10",
      "qty" : 2.0,
      "price" : 19.9999
    },
    "kind_types" : [ "string" ],
    "capacity_unit" : "string",
    "invc_unit" : "string",
    "state" : "string",
    "modified" : "2018-11-11 21:12:55",
    "first_arriving_time" : "2018-11-11 21:12:55",
    "source" : "ERP",
    "label_printing" : false,
    "is_light_catering" : true,
    "trace_source_code_type" : "string",
    "online_type" : "string"
  } ]
}
1.1.10.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "errors" : [ {
    "id" : "string",
    "code" : "string",
    "message" : "string"
  } ]
}

1.2. 对账管理

1.2.1. 上传明细结算数据

POST /{tenant_id}/soms/ordersettleservice/item/upload
1.2.1.1. 说明

上传明细结算数据

1.2.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

bills
必填

明细结算数据列表对象

OrderSettleItemOrderList
1.2.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.2.1.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/item/upload?operator=string
请求 body
{
  "orders" : [ {
    "items" : [ {
      "created" : "2020-06-17 10:00:00",
      "modified" : "2020-06-17 10:00:00",
      "creator" : "string",
      "modifier" : "string",
      "total" : 20.0,
      "amount" : 33.0,
      "item_id" : "212121212",
      "platform_id" : "meituan",
      "shop_id" : "43435",
      "station_id" : "43435",
      "station_name" : "西店",
      "order_id" : "323232323",
      "sku_id" : "43434",
      "item_no" : "1",
      "order_created" : "2018-12-07 14:34:00",
      "front_sku_id" : "3230",
      "front_price" : 12.0,
      "front_discount_radio" : 0.0,
      "front_discount_amount" : 2.0,
      "front_score_amount" : 2.0,
      "quantity" : 12.0,
      "price" : 33.0,
      "unit_price" : 32.0,
      "discount_radio" : 0.0,
      "discount_amount" : 12.0,
      "pay_amount" : 12.0,
      "fav_amount" : 12.0,
      "discounts" : [ {
        "type" : "item",
        "act_id" : "343434",
        "act_name" : "string",
        "front_discount_type_id" : "3234",
        "front_discount_type_name" : "string",
        "front_discount_detail_type_id" : "2222",
        "front_discount_detail_type_name" : "string",
        "front_amount" : 333.0,
        "discount_amount" : 5.0,
        "radio" : 0.0,
        "amount" : 2.0
      } ]
    } ],
    "order_id" : "212121212"
  } ]
}
1.2.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.2.2. 取指定订单的对账单列表

GET /{tenant_id}/soms/ordersettleservice/ordersettle/byorders

operation.deprecated
1.2.2.1. 说明

取指定订单的对账单

1.2.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

order_ids
必填

订单号集合

< string > array(multi)
1.2.2.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSettleList
1.2.2.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/ordersettle/byorders?order_ids=string
1.2.2.5. HTTP响应示例
响应 200
{
  "items" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "total" : 22.0,
    "discount" : 2.0,
    "amount" : 22.0,
    "freight" : 0.0,
    "discounts" : [ {
      "type" : "item",
      "act_id" : "343434",
      "act_name" : "string",
      "front_discount_type_id" : "3234",
      "front_discount_type_name" : "string",
      "front_discount_detail_type_id" : "2222",
      "front_discount_detail_type_name" : "string",
      "front_amount" : 333.0,
      "discount_amount" : 5.0,
      "radio" : 0.0,
      "amount" : 2.0
    } ],
    "settle_id" : "68785680023933117_1",
    "front_settle_id" : "687856800239331",
    "platform_id" : "meituan",
    "shop_id" : "2123",
    "station_id" : "212123",
    "station_name" : "2323",
    "front_type_id" : "1",
    "front_type_name" : "外卖订单",
    "sub_front_type_id" : "1",
    "sub_front_type_name" : "外卖订单",
    "order_id" : "132344",
    "front_state" : "8",
    "settle_date" : "2019-08-07 00:00:00",
    "order_created" : "2019-08-07 00:00:00",
    "order_finish_time" : "2019-08-07 00:00:00",
    "refund_id" : "323434343",
    "refund_time" : "2019-08-07 00:00:00",
    "package_box" : 2.0,
    "package_fee" : 1.0,
    "other_fees" : [ {
      "type" : "delivery_tips",
      "fee" : 21.0
    } ],
    "discount_amount" : 2.0,
    "settle_discount" : 2.0,
    "shop_discount" : 2.0,
    "shop_freight_discount" : 0.0,
    "freight_discount" : 0.0,
    "settle_state" : "已入账",
    "settle_amount" : 2.0,
    "settle" : 22.0,
    "settle_commission" : 2.0,
    "selttle_commission" : 2.0,
    "settle_freight" : 120.01,
    "performance_service_fee" : 2.0,
    "platform_service_fee" : 2.0,
    "platform_service_rate" : 0.02,
    "bottom_service_fee" : 2.0,
    "platform_freight_discount" : 0.0,
    "pay_amount" : 22.0,
    "cod_amount" : 0.0,
    "freight_commission" : 0.0,
    "platform_promotion_settle" : 0.0,
    "invoice_fee" : 0.0
  } ]
}

1.2.3. 取指定单号的对账单明细

GET /{tenant_id}/soms/ordersettleservice/ordersettle/item/{item_id}
1.2.3.1. 说明

取指定单号的对账单明细

1.2.3.2. 参数
类型 名称 说明 类型

Path

item_id
必填

结算行id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分：items(明细详情)、item.discounts(优惠详情)

string
1.2.3.3. 响应
HTTP代码 说明 类型

200

successful operation

订单明细结算数据
1.2.3.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/ordersettle/item/string
1.2.3.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "total" : 20.0,
  "amount" : 33.0,
  "item_id" : "212121212",
  "platform_id" : "meituan",
  "shop_id" : "43435",
  "station_id" : "43435",
  "station_name" : "西店",
  "order_id" : "323232323",
  "sku_id" : "43434",
  "item_no" : "1",
  "order_created" : "2018-12-07 14:34:00",
  "front_sku_id" : "3230",
  "front_price" : 12.0,
  "front_discount_radio" : 0.0,
  "front_discount_amount" : 2.0,
  "front_score_amount" : 2.0,
  "quantity" : 12.0,
  "price" : 33.0,
  "unit_price" : 32.0,
  "discount_radio" : 0.0,
  "discount_amount" : 12.0,
  "pay_amount" : 12.0,
  "fav_amount" : 12.0,
  "discounts" : [ {
    "type" : "item",
    "act_id" : "343434",
    "act_name" : "string",
    "front_discount_type_id" : "3234",
    "front_discount_type_name" : "string",
    "front_discount_detail_type_id" : "2222",
    "front_discount_detail_type_name" : "string",
    "front_amount" : 333.0,
    "discount_amount" : 5.0,
    "radio" : 0.0,
    "amount" : 2.0
  } ]
}

1.2.4. 根据订单号获取对账单明细

GET /{tenant_id}/soms/ordersettleservice/ordersettle/item/{order_id}/order
1.2.4.1. 说明

根据订单号获取对账单明细

1.2.4.2. 参数
类型 名称 说明 类型

Path

order_id
必填

订单ID

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分：items(明细详情)、item.discounts(优惠详情)

string
1.2.4.3. 响应
HTTP代码 说明 类型

200

successful operation

明细结算数据列表
1.2.4.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/ordersettle/item/string/order
1.2.4.5. HTTP响应示例
响应 200
{
  "items" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "total" : 20.0,
    "amount" : 33.0,
    "item_id" : "212121212",
    "platform_id" : "meituan",
    "shop_id" : "43435",
    "station_id" : "43435",
    "station_name" : "西店",
    "order_id" : "323232323",
    "sku_id" : "43434",
    "item_no" : "1",
    "order_created" : "2018-12-07 14:34:00",
    "front_sku_id" : "3230",
    "front_price" : 12.0,
    "front_discount_radio" : 0.0,
    "front_discount_amount" : 2.0,
    "front_score_amount" : 2.0,
    "quantity" : 12.0,
    "price" : 33.0,
    "unit_price" : 32.0,
    "discount_radio" : 0.0,
    "discount_amount" : 12.0,
    "pay_amount" : 12.0,
    "fav_amount" : 12.0,
    "discounts" : [ {
      "type" : "item",
      "act_id" : "343434",
      "act_name" : "string",
      "front_discount_type_id" : "3234",
      "front_discount_type_name" : "string",
      "front_discount_detail_type_id" : "2222",
      "front_discount_detail_type_name" : "string",
      "front_amount" : 333.0,
      "discount_amount" : 5.0,
      "radio" : 0.0,
      "amount" : 2.0
    } ]
  } ],
  "order_id" : "212121212"
}

1.2.5. 取指定订单的对账单列表

POST /{tenant_id}/soms/ordersettleservice/ordersettle/v2/byorders
1.2.5.1. 说明

取指定订单的对账单

1.2.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Body

orderIds
必填

订单号集合

IdsWrapper
1.2.5.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSettleList
1.2.5.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/ordersettle/v2/byorders
请求 body
{
  "ids" : [ "string" ]
}
1.2.5.5. HTTP响应示例
响应 200
{
  "items" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "total" : 22.0,
    "discount" : 2.0,
    "amount" : 22.0,
    "freight" : 0.0,
    "discounts" : [ {
      "type" : "item",
      "act_id" : "343434",
      "act_name" : "string",
      "front_discount_type_id" : "3234",
      "front_discount_type_name" : "string",
      "front_discount_detail_type_id" : "2222",
      "front_discount_detail_type_name" : "string",
      "front_amount" : 333.0,
      "discount_amount" : 5.0,
      "radio" : 0.0,
      "amount" : 2.0
    } ],
    "settle_id" : "68785680023933117_1",
    "front_settle_id" : "687856800239331",
    "platform_id" : "meituan",
    "shop_id" : "2123",
    "station_id" : "212123",
    "station_name" : "2323",
    "front_type_id" : "1",
    "front_type_name" : "外卖订单",
    "sub_front_type_id" : "1",
    "sub_front_type_name" : "外卖订单",
    "order_id" : "132344",
    "front_state" : "8",
    "settle_date" : "2019-08-07 00:00:00",
    "order_created" : "2019-08-07 00:00:00",
    "order_finish_time" : "2019-08-07 00:00:00",
    "refund_id" : "323434343",
    "refund_time" : "2019-08-07 00:00:00",
    "package_box" : 2.0,
    "package_fee" : 1.0,
    "other_fees" : [ {
      "type" : "delivery_tips",
      "fee" : 21.0
    } ],
    "discount_amount" : 2.0,
    "settle_discount" : 2.0,
    "shop_discount" : 2.0,
    "shop_freight_discount" : 0.0,
    "freight_discount" : 0.0,
    "settle_state" : "已入账",
    "settle_amount" : 2.0,
    "settle" : 22.0,
    "settle_commission" : 2.0,
    "selttle_commission" : 2.0,
    "settle_freight" : 120.01,
    "performance_service_fee" : 2.0,
    "platform_service_fee" : 2.0,
    "platform_service_rate" : 0.02,
    "bottom_service_fee" : 2.0,
    "platform_freight_discount" : 0.0,
    "pay_amount" : 22.0,
    "cod_amount" : 0.0,
    "freight_commission" : 0.0,
    "platform_promotion_settle" : 0.0,
    "invoice_fee" : 0.0
  } ]
}

1.2.6. 取指定单号的对账单

GET /{tenant_id}/soms/ordersettleservice/ordersettle/{id}
1.2.6.1. 说明

取指定单号的对账单

1.2.6.2. 参数
类型 名称 说明 类型

Path

id
必填

对账ID

string

Path

tenant_id
必填

租户ID

string
1.2.6.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSettle
1.2.6.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/ordersettle/string
1.2.6.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "total" : 22.0,
  "discount" : 2.0,
  "amount" : 22.0,
  "freight" : 0.0,
  "discounts" : [ {
    "type" : "item",
    "act_id" : "343434",
    "act_name" : "string",
    "front_discount_type_id" : "3234",
    "front_discount_type_name" : "string",
    "front_discount_detail_type_id" : "2222",
    "front_discount_detail_type_name" : "string",
    "front_amount" : 333.0,
    "discount_amount" : 5.0,
    "radio" : 0.0,
    "amount" : 2.0
  } ],
  "settle_id" : "68785680023933117_1",
  "front_settle_id" : "687856800239331",
  "platform_id" : "meituan",
  "shop_id" : "2123",
  "station_id" : "212123",
  "station_name" : "2323",
  "front_type_id" : "1",
  "front_type_name" : "外卖订单",
  "sub_front_type_id" : "1",
  "sub_front_type_name" : "外卖订单",
  "order_id" : "132344",
  "front_state" : "8",
  "settle_date" : "2019-08-07 00:00:00",
  "order_created" : "2019-08-07 00:00:00",
  "order_finish_time" : "2019-08-07 00:00:00",
  "refund_id" : "323434343",
  "refund_time" : "2019-08-07 00:00:00",
  "package_box" : 2.0,
  "package_fee" : 1.0,
  "other_fees" : [ {
    "type" : "delivery_tips",
    "fee" : 21.0
  } ],
  "discount_amount" : 2.0,
  "settle_discount" : 2.0,
  "shop_discount" : 2.0,
  "shop_freight_discount" : 0.0,
  "freight_discount" : 0.0,
  "settle_state" : "已入账",
  "settle_amount" : 2.0,
  "settle" : 22.0,
  "settle_commission" : 2.0,
  "selttle_commission" : 2.0,
  "settle_freight" : 120.01,
  "performance_service_fee" : 2.0,
  "platform_service_fee" : 2.0,
  "platform_service_rate" : 0.02,
  "bottom_service_fee" : 2.0,
  "platform_freight_discount" : 0.0,
  "pay_amount" : 22.0,
  "cod_amount" : 0.0,
  "freight_commission" : 0.0,
  "platform_promotion_settle" : 0.0,
  "invoice_fee" : 0.0
}

1.2.7. 查询日账单

POST /{tenant_id}/soms/ordersettleservice/ordersettles/daily/query
1.2.7.1. 说明

查询日账单

1.2.7.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码,必须大于等于0

integer (int32)

Query

page_size
必填

查询分页大小必须在[0,1000]

integer (int32)

Query

sort_key
可选

排序字段 id 不传默认orderId

string

Body

filter
必填

查询过滤器

OrderDailySettleFilter
1.2.7.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderDailySettlePaging
1.2.7.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/ordersettles/daily/query?desc=true&page=0&page_size=0
请求 body
{
  "platform_id_eq" : "meituan",
  "shop_id_eq" : "323443",
  "station_id_eq" : "0001",
  "created_start" : "2019-08-07 19:49:36",
  "created_end" : "2019-08-07 19:49:36",
  "station_id_in" : [ "string" ],
  "platform_id_in" : [ "string" ],
  "settle_date_start" : "2019-08-07 19:49:36",
  "settle_date_end" : "2019-08-07 19:49:36"
}
1.2.7.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 0,
  "settles" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "settle_id" : "68785680023933117_1",
    "platform_id" : "meituan",
    "shop_id" : "2123",
    "station_id" : "212123",
    "station_name" : "2323",
    "settle_date" : "2019-08-07 00:00:00",
    "settle_amount" : 2.0
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.2.8. 查询指定订单明细结算数据

POST /{tenant_id}/soms/ordersettleservice/ordersettles/item/query
1.2.8.1. 说明

查询指定订单明细结算数据

1.2.8.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码，必须大于等于0

integer (int32)

Query

page_size
必填

分页大小，查询分页大小必须在[0,1000]

integer (int32)

Query

sort_key
可选

排序字段 目前没有可支持的值 不传默认orderId

string

Body

filter
必填

查询过滤器

OrderSettleItemFilter
1.2.8.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSettleItemPaging
1.2.8.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/ordersettles/item/query?desc=true&page=0&page_size=0
请求 body
{
  "platform_id_eq" : "meituan",
  "shop_id_eq" : "15154",
  "order_id_eq" : "323243434",
  "item_id_in" : [ "string" ]
}
1.2.8.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 0,
  "items" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "total" : 20.0,
    "amount" : 33.0,
    "item_id" : "212121212",
    "platform_id" : "meituan",
    "shop_id" : "43435",
    "station_id" : "43435",
    "station_name" : "西店",
    "order_id" : "323232323",
    "sku_id" : "43434",
    "item_no" : "1",
    "order_created" : "2018-12-07 14:34:00",
    "front_sku_id" : "3230",
    "front_price" : 12.0,
    "front_discount_radio" : 0.0,
    "front_discount_amount" : 2.0,
    "front_score_amount" : 2.0,
    "quantity" : 12.0,
    "price" : 33.0,
    "unit_price" : 32.0,
    "discount_radio" : 0.0,
    "discount_amount" : 12.0,
    "pay_amount" : 12.0,
    "fav_amount" : 12.0,
    "discounts" : [ {
      "type" : "item",
      "act_id" : "343434",
      "act_name" : "string",
      "front_discount_type_id" : "3234",
      "front_discount_type_name" : "string",
      "front_discount_detail_type_id" : "2222",
      "front_discount_detail_type_name" : "string",
      "front_amount" : 333.0,
      "discount_amount" : 5.0,
      "radio" : 0.0,
      "amount" : 2.0
    } ]
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.2.9. 查询指定对账数据

POST /{tenant_id}/soms/ordersettleservice/ordersettles/query
1.2.9.1. 说明

查询指定对账数据

1.2.9.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码,必须大于等于0

integer (int32)

Query

page_size
必填

查询分页大小必须在[0,1000]

integer (int32)

Query

sort_key
可选

排序字段 id 不传默认orderId

string

Body

filter
必填

查询过滤器

OrderSettleFilter
1.2.9.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSettlePaging
1.2.9.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/ordersettles/query?desc=true&page=0&page_size=0
请求 body
{
  "ids" : [ "string" ],
  "platform_id_eq" : "meituan",
  "shop_id_eq" : "323443",
  "order_id_eq" : "323345354",
  "station_id_eq" : "0001",
  "order_id_in" : [ "string" ],
  "created_start" : "2019-08-07 19:49:36",
  "created_end" : "2019-08-07 19:49:36",
  "order_ids" : [ "string" ],
  "platform_id_in" : [ "string" ],
  "station_id_in" : [ "string" ],
  "order_start_with" : "string",
  "front_type_name_start_with" : "string",
  "front_type_name_eq" : "string",
  "settle_date_start" : "2019-08-07 19:49:36",
  "settle_date_end" : "2019-08-07 19:49:36"
}
1.2.9.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 0,
  "items" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "total" : 22.0,
    "discount" : 2.0,
    "amount" : 22.0,
    "freight" : 0.0,
    "discounts" : [ {
      "type" : "item",
      "act_id" : "343434",
      "act_name" : "string",
      "front_discount_type_id" : "3234",
      "front_discount_type_name" : "string",
      "front_discount_detail_type_id" : "2222",
      "front_discount_detail_type_name" : "string",
      "front_amount" : 333.0,
      "discount_amount" : 5.0,
      "radio" : 0.0,
      "amount" : 2.0
    } ],
    "settle_id" : "68785680023933117_1",
    "front_settle_id" : "687856800239331",
    "platform_id" : "meituan",
    "shop_id" : "2123",
    "station_id" : "212123",
    "station_name" : "2323",
    "front_type_id" : "1",
    "front_type_name" : "外卖订单",
    "sub_front_type_id" : "1",
    "sub_front_type_name" : "外卖订单",
    "order_id" : "132344",
    "front_state" : "8",
    "settle_date" : "2019-08-07 00:00:00",
    "order_created" : "2019-08-07 00:00:00",
    "order_finish_time" : "2019-08-07 00:00:00",
    "refund_id" : "323434343",
    "refund_time" : "2019-08-07 00:00:00",
    "package_box" : 2.0,
    "package_fee" : 1.0,
    "other_fees" : [ {
      "type" : "delivery_tips",
      "fee" : 21.0
    } ],
    "discount_amount" : 2.0,
    "settle_discount" : 2.0,
    "shop_discount" : 2.0,
    "shop_freight_discount" : 0.0,
    "freight_discount" : 0.0,
    "settle_state" : "已入账",
    "settle_amount" : 2.0,
    "settle" : 22.0,
    "settle_commission" : 2.0,
    "selttle_commission" : 2.0,
    "settle_freight" : 120.01,
    "performance_service_fee" : 2.0,
    "platform_service_fee" : 2.0,
    "platform_service_rate" : 0.02,
    "bottom_service_fee" : 2.0,
    "platform_freight_discount" : 0.0,
    "pay_amount" : 22.0,
    "cod_amount" : 0.0,
    "freight_commission" : 0.0,
    "platform_promotion_settle" : 0.0,
    "invoice_fee" : 0.0
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.2.10. 上传对账数据

POST /{tenant_id}/soms/ordersettleservice/upload
1.2.10.1. 说明

上传对账数据

1.2.10.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

bills
必填

订单结算单列表对象

OrderSettleList
1.2.10.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.2.10.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/upload?operator=string
请求 body
{
  "items" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "total" : 22.0,
    "discount" : 2.0,
    "amount" : 22.0,
    "freight" : 0.0,
    "discounts" : [ {
      "type" : "item",
      "act_id" : "343434",
      "act_name" : "string",
      "front_discount_type_id" : "3234",
      "front_discount_type_name" : "string",
      "front_discount_detail_type_id" : "2222",
      "front_discount_detail_type_name" : "string",
      "front_amount" : 333.0,
      "discount_amount" : 5.0,
      "radio" : 0.0,
      "amount" : 2.0
    } ],
    "settle_id" : "68785680023933117_1",
    "front_settle_id" : "687856800239331",
    "platform_id" : "meituan",
    "shop_id" : "2123",
    "station_id" : "212123",
    "station_name" : "2323",
    "front_type_id" : "1",
    "front_type_name" : "外卖订单",
    "sub_front_type_id" : "1",
    "sub_front_type_name" : "外卖订单",
    "order_id" : "132344",
    "front_state" : "8",
    "settle_date" : "2019-08-07 00:00:00",
    "order_created" : "2019-08-07 00:00:00",
    "order_finish_time" : "2019-08-07 00:00:00",
    "refund_id" : "323434343",
    "refund_time" : "2019-08-07 00:00:00",
    "package_box" : 2.0,
    "package_fee" : 1.0,
    "other_fees" : [ {
      "type" : "delivery_tips",
      "fee" : 21.0
    } ],
    "discount_amount" : 2.0,
    "settle_discount" : 2.0,
    "shop_discount" : 2.0,
    "shop_freight_discount" : 0.0,
    "freight_discount" : 0.0,
    "settle_state" : "已入账",
    "settle_amount" : 2.0,
    "settle" : 22.0,
    "settle_commission" : 2.0,
    "selttle_commission" : 2.0,
    "settle_freight" : 120.01,
    "performance_service_fee" : 2.0,
    "platform_service_fee" : 2.0,
    "platform_service_rate" : 0.02,
    "bottom_service_fee" : 2.0,
    "platform_freight_discount" : 0.0,
    "pay_amount" : 22.0,
    "cod_amount" : 0.0,
    "freight_commission" : 0.0,
    "platform_promotion_settle" : 0.0,
    "invoice_fee" : 0.0
  } ]
}
1.2.10.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.2.11. 上传对账日数据

POST /{tenant_id}/soms/ordersettleservice/upload/daily
1.2.11.1. 说明

上传对账日数据

1.2.11.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

bills
必填

日结算单列表对象

OrderDailySettleList
1.2.11.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.2.11.4. HTTP请求示例
请求 path
/string/soms/ordersettleservice/upload/daily?operator=string
请求 body
{
  "settles" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "settle_id" : "68785680023933117_1",
    "platform_id" : "meituan",
    "shop_id" : "2123",
    "station_id" : "212123",
    "station_name" : "2323",
    "settle_date" : "2019-08-07 00:00:00",
    "settle_amount" : 2.0
  } ]
}
1.2.11.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.3. 门店库存服务

1.3.1. POS更新门店库存到鼎力云

POST /{tenant_id}/invc/storeinvservice/store/{store_id}/invs
1.3.1.1. 说明

POS更新门店库存到鼎力云

1.3.1.2. 参数
类型 名称 说明 类型

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Body

skus
必填

当前可用库存集合

SkuQuantityList
1.3.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.3.1.4. HTTP请求示例
请求 path
/string/invc/storeinvservice/store/string/invs
请求 body
{
  "operator" : "string",
  "skus" : [ {
    "available" : 155.0,
    "sku_id" : "54654",
    "fixed_qty" : 10.0,
    "stock_qty" : 12.0,
    "change_time" : "2019-07-30 00:00:00",
    "task_id" : "54654"
  } ]
}
1.3.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.4. 门店商品服务

1.4.1. 批量更新门店商品

POST /{tenant_id}/invc/storeskuservice/store/{store_id}/skus/updates
1.4.1.1. 说明

批量更新门店商品，不存在则创建，存在则修改。

1.4.1.2. 参数
类型 名称 说明 类型

Path

store_id
必填

门店id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

storeSkus
必填

门店商品列表，每次更新不超过100条

StoreSkuList
1.4.1.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreSkuUpdateResponse
1.4.1.4. HTTP请求示例
请求 path
/string/invc/storeskuservice/store/string/skus/updates?operator=string
请求 body
{
  "store_skus" : [ {
    "state" : "待售:forSale,可售:sale,禁售: notForSale",
    "modified" : "2016-03-02 12:00:02",
    "store_id" : "001",
    "store_name" : "测试店",
    "sku_id" : "12002",
    "business_type" : "string",
    "erp_state" : "string",
    "is_active_sales" : true
  } ]
}
1.4.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "errors" : [ {
    "code" : "string",
    "message" : "string",
    "store_id" : "string",
    "sku_id" : "string"
  } ]
}

1.5. 评论服务

1.5.1. 提交订单评价

POST /{tenant_id}/soms/commentservice/comment
1.5.1.1. 说明

提交订单评价

1.5.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order_comment
必填

订单评价

OrderComment
1.5.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.5.1.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "202012021621",
  "store" : {
    "id" : "string",
    "name" : "string"
  },
  "time" : "2020-12-02 00:00:00",
  "content" : "很好",
  "labels" : [ "string" ],
  "details" : [ {
    "type" : "string",
    "score" : 0,
    "labels" : [ "string" ]
  } ],
  "order_id" : "202012021621",
  "platform_id" : "jdo2o",
  "shop_id" : "213",
  "image_urls" : [ "string" ],
  "extra_info" : {
    "next_time" : "2020-12-02 00:00:00",
    "next_content" : "很好",
    "delivery_content" : "很好",
    "next_image_urls" : "url"
  },
  "like_skus" : [ "string" ],
  "dislike_skus" : [ "string" ],
  "expire_time" : "2020-06-17 10:00:00",
  "front_comment_id" : "string",
  "reply_state" : "string",
  "reply_time" : "2020-06-17 10:00:00",
  "reply_content" : "string",
  "process_state" : "string",
  "process_remark" : "string",
  "remark" : "string",
  "tags" : [ "string" ]
}
1.5.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.5.2. 查询评价

POST /{tenant_id}/soms/commentservice/comment/query
1.5.2.1. 说明

查询评价

1.5.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
可选

页码，从0开始，必须>=0

integer (int32)

Query

page_size
可选

分页大小，范围是[1,100]

integer (int32)

Query

sort_key
可选

排序字段，取值范围:created(创建时间)、commentTime(评价时间)

string

Body

filter
必填

查询条件

OrderCommentFilter
1.5.2.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderCommentPaging
1.5.2.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/query?desc=true
请求 body
{
  "platformIdEq" : "jdo2o",
  "stationIdEq" : "string",
  "idEq" : "string",
  "orderIdIn" : [ "string" ],
  "processStateEq" : "string",
  "processStateNotIn" : [ "string" ],
  "tagEq" : "string",
  "tagIn" : [ "string" ],
  "tagHas" : [ "string" ],
  "orderIdLike" : "32323232323323",
  "hasReply" : "invalid",
  "satisfieLevel" : "high",
  "hasContent" : false,
  "commentTimeStart" : "2016-03-02 12:00:01",
  "commentTimeEnd" : "2016-03-02 12:00:01",
  "id_in" : [ "string" ]
}
1.5.2.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "comments" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "202012021621",
    "store" : {
      "id" : "string",
      "name" : "string"
    },
    "time" : "2020-12-02 00:00:00",
    "content" : "很好",
    "labels" : [ "string" ],
    "details" : [ {
      "type" : "string",
      "score" : 0,
      "labels" : [ "string" ]
    } ],
    "order_id" : "202012021621",
    "platform_id" : "jdo2o",
    "shop_id" : "213",
    "image_urls" : [ "string" ],
    "extra_info" : {
      "next_time" : "2020-12-02 00:00:00",
      "next_content" : "很好",
      "delivery_content" : "很好",
      "next_image_urls" : "url"
    },
    "like_skus" : [ "string" ],
    "dislike_skus" : [ "string" ],
    "expire_time" : "2020-06-17 10:00:00",
    "front_comment_id" : "string",
    "reply_state" : "string",
    "reply_time" : "2020-06-17 10:00:00",
    "reply_content" : "string",
    "process_state" : "string",
    "process_remark" : "string",
    "remark" : "string",
    "tags" : [ "string" ]
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.5.3. 获取评价

GET /{tenant_id}/soms/commentservice/comment/{id}
1.5.3.1. 说明

获取评价

1.5.3.2. 参数
类型 名称 说明 类型

Path

id
必填

评论Id

string

Path

tenant_id
必填

租户ID

string
1.5.3.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderComment
1.5.3.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/string
1.5.3.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "202012021621",
  "store" : {
    "id" : "string",
    "name" : "string"
  },
  "time" : "2020-12-02 00:00:00",
  "content" : "很好",
  "labels" : [ "string" ],
  "details" : [ {
    "type" : "string",
    "score" : 0,
    "labels" : [ "string" ]
  } ],
  "order_id" : "202012021621",
  "platform_id" : "jdo2o",
  "shop_id" : "213",
  "image_urls" : [ "string" ],
  "extra_info" : {
    "next_time" : "2020-12-02 00:00:00",
    "next_content" : "很好",
    "delivery_content" : "很好",
    "next_image_urls" : "url"
  },
  "like_skus" : [ "string" ],
  "dislike_skus" : [ "string" ],
  "expire_time" : "2020-06-17 10:00:00",
  "front_comment_id" : "string",
  "reply_state" : "string",
  "reply_time" : "2020-06-17 10:00:00",
  "reply_content" : "string",
  "process_state" : "string",
  "process_remark" : "string",
  "remark" : "string",
  "tags" : [ "string" ]
}

1.5.4. 更新评价回复

POST /{tenant_id}/soms/commentservice/comment/{id}/reply
1.5.4.1. 说明

更新评价回复

1.5.4.2. 参数
类型 名称 说明 类型

Path

id
必填

评论Id

string

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

更新评价回复request

UpdateReplyContentRequest
1.5.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.5.4.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/string/reply?operator=string
请求 body
{
  "reply_content" : "string"
}
1.5.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.6. 门店价格服务

1.6.1. POS更新门店商品价格到鼎力云

POST /{tenant_id}/invc/storepriceservice/store/{store_id}/prices
1.6.1.1. 说明

POS更新门店商品价格到鼎力云

1.6.1.2. 参数
类型 名称 说明 类型

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Body

prices
必填

商品价格集合

SkuPriceList
1.6.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.6.1.4. HTTP请求示例
请求 path
/string/invc/storepriceservice/store/string/prices
请求 body
{
  "skus" : [ {
    "price" : 12.25,
    "modified" : "2019-07-30 00:00:00",
    "modifier" : "张三",
    "sku_id" : "54654",
    "min_price" : 12.25,
    "max_price" : 12.25,
    "unit_price" : 12.35,
    "mbr_price" : 15.25,
    "task_id" : "32323232",
    "price_mode" : "price",
    "change_time" : "2019-07-30 00:00:00"
  } ]
}
1.6.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.7. 自提规则服务

1.7.1. 获取自提规则

GET /{tenant_id}/soms/selftakeruleservice/selftakerule
1.7.1.1. 说明

获取自提规则

1.7.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

platform_id
必填

平台ID

string

Query

shop_id
必填

商家ID

string

Query

store_id
可选

门店ID

string
1.7.1.3. 响应
HTTP代码 说明 类型

200

successful operation

SelftakeRule
1.7.1.4. HTTP请求示例
请求 path
/string/soms/selftakeruleservice/selftakerule?platform_id=string&shop_id=string
1.7.1.5. HTTP响应示例
响应 200
{
  "state" : "applying",
  "def" : {
    "check_selftake_code" : true
  },
  "source" : "ptm_store",
  "platform_id" : "meituan",
  "shop_id" : "33454",
  "store_id" : "0001"
}

1.8. 订单占货服务

1.8.1. 订单占货

POST /{tenant_id}/invc/orderstockservice/lock
1.8.1.1. 说明

订单占货

1.8.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

param
必填

占货参数

OrderDataParam
1.8.1.3. 响应
HTTP代码 说明 类型

200

successful operation

LockStockResult
1.8.1.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/lock?operator=string
请求 body
{
  "items" : [ {
    "sku_id" : "12",
    "qty" : 32.0
  } ],
  "order_id" : "4545454545454542",
  "platform_id" : "jdo2o",
  "shop_id" : "12121212",
  "shop_name" : "百度外卖",
  "store_id" : "43435545",
  "store_name" : "aaa",
  "request_id" : "3232323",
  "lock_type" : "3232323"
}
1.8.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "message" : "占货失败",
  "stock_state" : "locked",
  "lock_result" : "none",
  "lock_id" : "string",
  "store_id" : "string"
}

1.8.2. 查询订单占货

GET /{tenant_id}/invc/orderstockservice/order/lockresult
1.8.2.1. 说明

查询订单占货

1.8.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

order_id
必填

订单号

string
1.8.2.3. 响应
HTTP代码 说明 类型

200

successful operation

LockStockResult
1.8.2.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/order/lockresult?order_id=string
1.8.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "message" : "占货失败",
  "stock_state" : "locked",
  "lock_result" : "none",
  "lock_id" : "string",
  "store_id" : "string"
}

1.8.3. 获取指定货号平台商家占用门店库存记录

GET /{tenant_id}/invc/orderstockservice/orderstocks
1.8.3.1. 说明

获取指定货号平台商家占用门店库存记录

1.8.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

platform_id
必填

平台id

string

Query

shop_id
必填

商家id

string

Query

shop_id
可选

门店id

string

Query

sku_ids
必填

货号集合

< string > array(multi)
1.8.3.3. 响应
HTTP代码 说明 类型

200

successful operation

SkuQuantityList
1.8.3.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/orderstocks?platform_id=string&shop_id=string&sku_ids=string
1.8.3.5. HTTP响应示例
响应 200
{
  "operator" : "string",
  "skus" : [ {
    "available" : 155.0,
    "sku_id" : "54654",
    "fixed_qty" : 10.0,
    "stock_qty" : 12.0,
    "change_time" : "2019-07-30 00:00:00",
    "task_id" : "54654"
  } ]
}

1.8.4. 订单占货发货|出库

PUT /{tenant_id}/invc/orderstockservice/ship/{order_id}
1.8.4.1. 说明

订单占货发货|出库

1.8.4.2. 参数
类型 名称 说明 类型

Path

order_id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string
1.8.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.8.4.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/ship/string?operator=string
1.8.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.5. 取消占货

POST /{tenant_id}/invc/orderstockservice/unlock
1.8.5.1. 说明

取消订单占货，释放占用库存

1.8.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Query

order_id
必填

订单号

string

Query

request_id
可选

标识一次占货请求，如果不为空表示释放某一次请求的占货结果，如果为空表示释放订单的占货结果

string
1.8.5.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.8.5.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/unlock?operator=string&order_id=string
1.8.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.9. 属性服务

1.9.1. 保存属性服务

POST /{tenant_id}/soms/optionservice/option
1.9.1.1. 说明

保存属性服务

1.9.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

option
必填

属性

Option
1.9.1.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.9.1.4. HTTP请求示例
请求 path
/string/soms/optionservice/option?operator=string
请求 body
{
  "type" : "comment",
  "caption" : "说明",
  "value" : "欢迎下次光临",
  "extra" : {
    "auto" : true,
    "conditions" : [ {
      "satisfie_level" : "欢迎下次光临"
    } ]
  }
}

1.9.2. 保存属性服务

POST /{tenant_id}/soms/optionservice/option/batchsave
1.9.2.1. 说明

保存属性服务

1.9.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

options
必填

属性

< Option > array
1.9.2.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.9.2.4. HTTP请求示例
请求 path
/string/soms/optionservice/option/batchsave?operator=string
请求 body
[ {
  "type" : "comment",
  "caption" : "说明",
  "value" : "欢迎下次光临",
  "extra" : {
    "auto" : true,
    "conditions" : [ {
      "satisfie_level" : "欢迎下次光临"
    } ]
  }
} ]

1.9.3. 删除属性服务

POST /{tenant_id}/soms/optionservice/option/{type}/delete
1.9.3.1. 说明

删除属性服务

1.9.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Path

type
必填

类型

string

Query

value
可选

值

string
1.9.3.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.9.3.4. HTTP请求示例
请求 path
/string/soms/optionservice/option/string/delete

1.9.4. 获取属性服务

GET /{tenant_id}/soms/optionservice/options/{type}/getall
1.9.4.1. 说明

获取属性服务

1.9.4.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Path

type
必填

类型：remind（催单）、comment(评论)

string
1.9.4.3. 响应
HTTP代码 说明 类型

200

successful operation

OptionList
1.9.4.4. HTTP请求示例
请求 path
/string/soms/optionservice/options/string/getall
1.9.4.5. HTTP响应示例
响应 200
{
  "options" : [ {
    "type" : "comment",
    "caption" : "说明",
    "value" : "欢迎下次光临",
    "extra" : {
      "auto" : true,
      "conditions" : [ {
        "satisfie_level" : "欢迎下次光临"
      } ]
    }
  } ]
}

1.9.5. 获取属性服务

GET /{tenant_id}/soms/optionservice/options/{type}/getoption
1.9.5.1. 说明

获取属性服务

1.9.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Path

type
必填

类型：remind（催单）、comment(评论)

string

Query

value
可选

值

string
1.9.5.3. 响应
HTTP代码 说明 类型

200

successful operation

Option
1.9.5.4. HTTP请求示例
请求 path
/string/soms/optionservice/options/string/getoption
1.9.5.5. HTTP响应示例
响应 200
{
  "type" : "comment",
  "caption" : "说明",
  "value" : "欢迎下次光临",
  "extra" : {
    "auto" : true,
    "conditions" : [ {
      "satisfie_level" : "欢迎下次光临"
    } ]
  }
}

1.10. 退货服务

1.10.1. 提交退单

POST /{tenant_id}/soms/returnservice/rtn
1.10.1.1. 说明

提交退单，只支持新增退单，不支持修改退单，新增状态：confirmed，仅退款：type=refund，退款退货：type=refundAndRtn，默认type=refundAndRtn

1.10.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

rtn
必填

退货单

Rtn
1.10.1.3. 响应
HTTP代码 说明 类型

200

successful operation

IdWrapper
1.10.1.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "脱敏名称**",
      "private_mobile" : "189389928893"
    }
  },
  "delivery" : {
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "state" : "none",
    "returner" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "厦门市",
        "district" : "思明区",
        "street" : "前埔",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      }
    },
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "station_type" : "string",
    "carrier_note" : "note",
    "wrh_rtn_id" : "XXXXXXXXX",
    "waybill_id" : "XXXXXXXXX",
    "return_mobile" : "18856556655"
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:02",
    "modified" : "2016-03-02 12:00:02",
    "state" : "已退货",
    "creator" : "254145",
    "source" : "平台生成：platform、商家发起:shop",
    "rtn_id" : "123456",
    "station_id" : "254145"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 2.0,
    "total" : 12.03,
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ]
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "item_no" : "1",
    "sku_id" : "123456",
    "product_id" : "2123",
    "item_title" : "冰红茶",
    "real_qty" : 0.0,
    "unit_price" : 12.03,
    "purchase_price" : 12.0,
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "image_url" : "http://1213323.png",
    "front_unit" : "string",
    "origin_sku_id" : "e235346ger545",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "item_id" : "22323232323",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "order_item_id" : "1",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "relation_sku_id" : "2123",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "is_gift" : true
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "name" : "满减",
      "type" : "string",
      "amount" : 10.5,
      "remark" : "测试优惠",
      "factor" : {
        "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
        "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
        "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
      },
      "sku_act_id" : "1111",
      "merchant_act_id" : "1111",
      "batch_act_id" : "1111",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（代理商）",
        "discount" : 1.0
      } ],
      "share_details" : "[]"
    } ]
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "member_info" : {
    "card_no" : "22323"
  },
  "apply_id" : "0002",
  "apply_system" : "shop",
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "exception_time" : "2020-11-11 12:11:21",
  "seller_info" : {
    "seller_note" : "收货失败原因",
    "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
  },
  "voucher_urls" : [ "string" ],
  "sku_quantity" : 1.0,
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0
    }
  },
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "settle_info" : {
    "settlable" : true,
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "rtn_req_id" : "string"
}
1.10.1.5. HTTP响应示例
响应 200
{
  "id" : "string"
}

1.10.2. 根据前端系统单号取单个退货单

GET /{tenant_id}/soms/returnservice/rtn/front/{rtn_id}
1.10.2.1. 说明

根据前端系统单号取单个退货单

1.10.2.2. 参数
类型 名称 说明 类型

Path

rtn_id
必填

前端退货单号

string

Path

tenant_id
必填

租户ID

string

Query

parts
必填

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

string

Query

platform_id
必填

平台ID

string
1.10.2.3. 响应
HTTP代码 说明 类型

200

successful operation

Rtn
1.10.2.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/front/string?parts=string&platform_id=string
1.10.2.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "脱敏名称**",
      "private_mobile" : "189389928893"
    }
  },
  "delivery" : {
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "state" : "none",
    "returner" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "厦门市",
        "district" : "思明区",
        "street" : "前埔",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      }
    },
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "station_type" : "string",
    "carrier_note" : "note",
    "wrh_rtn_id" : "XXXXXXXXX",
    "waybill_id" : "XXXXXXXXX",
    "return_mobile" : "18856556655"
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:02",
    "modified" : "2016-03-02 12:00:02",
    "state" : "已退货",
    "creator" : "254145",
    "source" : "平台生成：platform、商家发起:shop",
    "rtn_id" : "123456",
    "station_id" : "254145"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 2.0,
    "total" : 12.03,
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ]
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "item_no" : "1",
    "sku_id" : "123456",
    "product_id" : "2123",
    "item_title" : "冰红茶",
    "real_qty" : 0.0,
    "unit_price" : 12.03,
    "purchase_price" : 12.0,
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "image_url" : "http://1213323.png",
    "front_unit" : "string",
    "origin_sku_id" : "e235346ger545",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "item_id" : "22323232323",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "order_item_id" : "1",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "relation_sku_id" : "2123",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "is_gift" : true
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "name" : "满减",
      "type" : "string",
      "amount" : 10.5,
      "remark" : "测试优惠",
      "factor" : {
        "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
        "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
        "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
      },
      "sku_act_id" : "1111",
      "merchant_act_id" : "1111",
      "batch_act_id" : "1111",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（代理商）",
        "discount" : 1.0
      } ],
      "share_details" : "[]"
    } ]
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "member_info" : {
    "card_no" : "22323"
  },
  "apply_id" : "0002",
  "apply_system" : "shop",
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "exception_time" : "2020-11-11 12:11:21",
  "seller_info" : {
    "seller_note" : "收货失败原因",
    "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
  },
  "voucher_urls" : [ "string" ],
  "sku_quantity" : 1.0,
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0
    }
  },
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "settle_info" : {
    "settlable" : true,
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "rtn_req_id" : "string"
}

1.10.3. 提交退单(新版)

POST /{tenant_id}/soms/returnservice/rtn/submit
1.10.3.1. 说明

提交退单，只支持新增退单，不支持修改退单，新增状态：confirmed，仅退款：type=refund，退款退货：type=refundAndRtn，默认type=refundAndRtn

1.10.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

rtn
必填

退货单

Rtn
1.10.3.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnSubmitResponse
1.10.3.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/submit?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "脱敏名称**",
      "private_mobile" : "189389928893"
    }
  },
  "delivery" : {
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "state" : "none",
    "returner" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "厦门市",
        "district" : "思明区",
        "street" : "前埔",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      }
    },
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "station_type" : "string",
    "carrier_note" : "note",
    "wrh_rtn_id" : "XXXXXXXXX",
    "waybill_id" : "XXXXXXXXX",
    "return_mobile" : "18856556655"
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:02",
    "modified" : "2016-03-02 12:00:02",
    "state" : "已退货",
    "creator" : "254145",
    "source" : "平台生成：platform、商家发起:shop",
    "rtn_id" : "123456",
    "station_id" : "254145"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 2.0,
    "total" : 12.03,
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ]
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "item_no" : "1",
    "sku_id" : "123456",
    "product_id" : "2123",
    "item_title" : "冰红茶",
    "real_qty" : 0.0,
    "unit_price" : 12.03,
    "purchase_price" : 12.0,
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "image_url" : "http://1213323.png",
    "front_unit" : "string",
    "origin_sku_id" : "e235346ger545",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "item_id" : "22323232323",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "order_item_id" : "1",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "relation_sku_id" : "2123",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "is_gift" : true
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "name" : "满减",
      "type" : "string",
      "amount" : 10.5,
      "remark" : "测试优惠",
      "factor" : {
        "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
        "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
        "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
      },
      "sku_act_id" : "1111",
      "merchant_act_id" : "1111",
      "batch_act_id" : "1111",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（代理商）",
        "discount" : 1.0
      } ],
      "share_details" : "[]"
    } ]
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "member_info" : {
    "card_no" : "22323"
  },
  "apply_id" : "0002",
  "apply_system" : "shop",
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "exception_time" : "2020-11-11 12:11:21",
  "seller_info" : {
    "seller_note" : "收货失败原因",
    "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
  },
  "voucher_urls" : [ "string" ],
  "sku_quantity" : 1.0,
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0
    }
  },
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "settle_info" : {
    "settlable" : true,
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "rtn_req_id" : "string"
}
1.10.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "rtn_id" : "string"
}

1.10.4. 取指定退货单

GET /{tenant_id}/soms/returnservice/rtn/{id}
1.10.4.1. 说明

取指定退货单

1.10.4.2. 参数
类型 名称 说明 类型

Path

id
必填

退换货id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)、crm（营销信息）、prom（促销详情）、item.traceCodes（溯源码）

string
1.10.4.3. 响应
HTTP代码 说明 类型

200

successful operation

Rtn
1.10.4.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string
1.10.4.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "0002",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "type" : "refund",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "脱敏名称**",
      "private_mobile" : "189389928893"
    }
  },
  "delivery" : {
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "state" : "none",
    "returner" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "厦门市",
        "district" : "思明区",
        "street" : "前埔",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      }
    },
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "station_type" : "string",
    "carrier_note" : "note",
    "wrh_rtn_id" : "XXXXXXXXX",
    "waybill_id" : "XXXXXXXXX",
    "return_mobile" : "18856556655"
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_fieight" : 12.03,
    "settle_amount" : 12.03,
    "package_total" : 12.03,
    "settle_commission" : 2.0,
    "shop_amount" : 120.01
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:02",
    "modified" : "2016-03-02 12:00:02",
    "state" : "已退货",
    "creator" : "254145",
    "source" : "平台生成：platform、商家发起:shop",
    "rtn_id" : "123456",
    "station_id" : "254145"
  },
  "appeal" : false,
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 2.0,
    "total" : 12.03,
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ]
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "item_no" : "1",
    "sku_id" : "123456",
    "product_id" : "2123",
    "item_title" : "冰红茶",
    "real_qty" : 0.0,
    "unit_price" : 12.03,
    "purchase_price" : 12.0,
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "image_url" : "http://1213323.png",
    "front_unit" : "string",
    "origin_sku_id" : "e235346ger545",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "item_id" : "22323232323",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "order_item_id" : "1",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "relation_sku_id" : "2123",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "is_gift" : true
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "name" : "满减",
      "type" : "string",
      "amount" : 10.5,
      "remark" : "测试优惠",
      "factor" : {
        "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
        "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
        "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
      },
      "sku_act_id" : "1111",
      "merchant_act_id" : "1111",
      "batch_act_id" : "1111",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（代理商）",
        "discount" : 1.0
      } ],
      "share_details" : "[]"
    } ]
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "member_info" : {
    "card_no" : "22323"
  },
  "apply_id" : "0002",
  "apply_system" : "shop",
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "异常说明",
  "exception_time" : "2020-11-11 12:11:21",
  "seller_info" : {
    "seller_note" : "收货失败原因",
    "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
  },
  "voucher_urls" : [ "string" ],
  "sku_quantity" : 1.0,
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0
    }
  },
  "wrh_state" : "initial",
  "wrh_id" : "string",
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "settle_info" : {
    "settlable" : true,
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "rtn_req_id" : "string"
}

1.10.5. 审核退换货

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/approve
1.10.5.1. 说明

审核退换货

1.10.5.2. 参数
类型 名称 说明 类型

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退单审核请求

RtnApproveRequest
1.10.5.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.10.5.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/approve?operator=string
请求 body
{
  "reason" : "已发货，不能退",
  "approve_state" : "serviceApproved",
  "operator_role" : "platform"
}
1.10.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.10.6. 取消退货单

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/cancel
1.10.6.1. 说明

取消退货单

1.10.6.2. 参数
类型 名称 说明 类型

Path

id
必填

退货单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

CancelRtnRequest
1.10.6.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.10.6.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/cancel?operator=string
请求 body
{
  "sellerInfo" : {
    "seller_note" : "收货失败原因",
    "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
  },
  "reason" : "我不想要了",
  "operator_role" : "string",
  "approve_state" : "none"
}
1.10.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.10.7. 确认退货状态

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/deliver
1.10.7.1. 说明

确认退货状态

1.10.7.2. 参数
类型 名称 说明 类型

Path

id
必填

退货单ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退货请求对象

ReturnRequest
1.10.7.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.10.7.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/deliver?operator=string
请求 body
{
  "carrier" : {
    "state" : "initial",
    "type" : "self",
    "carrier" : {
      "id" : "string",
      "name" : "string"
    },
    "merchant" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman_mobile" : "18859658865",
    "exception_reason" : "异常原因",
    "delivery_id" : "8548418",
    "delivery_name" : "8548418"
  },
  "return_state" : "none",
  "waybill_id" : "1243566215",
  "carrier_note" : "note",
  "operator_role" : "platform"
}
1.10.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.10.8. 修改退货单

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/modify
1.10.8.1. 说明

修改退货单

1.10.8.2. 参数
类型 名称 说明 类型

Path

id
必填

退换货id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnModificationRequest
1.10.8.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.10.8.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/modify?operator=string
请求 body
{
  "rtnId" : "4356465768",
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 2.0,
    "total" : 12.03,
    "details" : [ {
      "id" : "01123",
      "title" : "01123",
      "quantity" : 0.01,
      "ratio" : 2.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ]
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "item_no" : "1",
    "sku_id" : "123456",
    "product_id" : "2123",
    "item_title" : "冰红茶",
    "real_qty" : 0.0,
    "unit_price" : 12.03,
    "purchase_price" : 12.0,
    "refund_amount" : 12.03,
    "settle_price" : 12.03,
    "settle_total" : 12.03,
    "front_sku_id" : "e235346ger545",
    "front_item_id" : "052700601",
    "image_url" : "http://1213323.png",
    "front_unit" : "string",
    "origin_sku_id" : "e235346ger545",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "shop_price" : 11.22,
    "shop_total" : 11.22,
    "item_id" : "22323232323",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "order_item_id" : "1",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "relation_sku_id" : "2123",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "is_gift" : true
  } ],
  "freight" : 12.03,
  "modify_item_detail" : false,
  "apply_reason" : "不想要了",
  "customer_note" : "haha",
  "voucher_urls" : [ "string" ],
  "settle_amount" : 12.03,
  "settle_commission" : 12.03,
  "refund_extra" : [ {
    "id" : "distance_freight",
    "name" : "远距离运费",
    "value" : "0.01"
  } ],
  "package_total" : 12.03
}
1.10.8.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.10.9. 通知仓库

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/notifywrh
1.10.9.1. 说明

通知仓库

1.10.9.2. 参数
类型 名称 说明 类型

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnNotifyWrhRequest
1.10.9.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.10.9.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/notifywrh?operator=string
请求 body
1.10.9.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.10.10. 确认退款

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/refund
1.10.10.1. 说明

确认退款

1.10.10.2. 参数
类型 名称 说明 类型

Path

id
必填

退货单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

ConfirmRefundRequest
1.10.10.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.10.10.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/refund?operator=string
请求 body
{
  "refundState" : "refunded",
  "payments" : [ {
    "code" : "支付方式代码",
    "name" : "支付宝",
    "amount" : 12.33,
    "score" : 100.0,
    "account_no" : "002002",
    "account_name" : "工行",
    "pay_id" : "3223232323",
    "out_pay_id" : "3223232323",
    "extra_info" : "{\"session\", \"123\"}"
  } ],
  "operator_role" : "platform"
}
1.10.10.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.10.11. 修改退单权益接口

POST /{tenant_id}/soms/returnservice/rtn/{id}/mod/crminfo
1.10.11.1. 说明

修改退单权益接口

1.10.11.2. 参数
类型 名称 说明 类型

Path

id
必填

退货单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

权益请求

CRMInfoModificationRequest
1.10.11.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.10.11.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/mod/crminfo?operator=string
请求 body
{
  "score" : 0.0
}
1.10.11.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.10.12. 修改退单的退款信息

POST /{tenant_id}/soms/returnservice/rtn/{id}/refund/update
1.10.12.1. 说明

修改退单的退款信息

1.10.12.2. 参数
类型 名称 说明 类型

Path

id
必填

退换货id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnRefundUpdateRequest
1.10.12.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.10.12.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/refund/update?operator=string
请求 body
{
  "payments" : [ {
    "code" : "支付方式代码",
    "name" : "支付宝",
    "amount" : 12.33,
    "score" : 100.0,
    "account_no" : "002002",
    "account_name" : "工行",
    "pay_id" : "3223232323",
    "out_pay_id" : "3223232323",
    "extra_info" : "{\"session\", \"123\"}"
  } ]
}
1.10.12.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.10.13. 修改退单的结算信息

POST /{tenant_id}/soms/returnservice/rtn/{id}/settleinfo/update
1.10.13.1. 说明

修改退单的结算信息

1.10.13.2. 参数
类型 名称 说明 类型

Path

id
必填

退换货id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnSettleInfoUpdateRequest
1.10.13.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.10.13.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/settleinfo/update?operator=string
请求 body
{
  "settlable" : true,
  "settle_date" : "2020-06-17 10:00:00"
}
1.10.13.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.10.14. 修改物流物流退回信息

POST /{tenant_id}/soms/returnservice/rtn/{id}/updatertndelivery
1.10.14.1. 说明

修改物流物流退回信息

1.10.14.2. 参数
类型 名称 说明 类型

Path

id
必填

退换货id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnUpdateDeliveryRequest
1.10.14.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.10.14.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/updatertndelivery?operator=string
请求 body
{
  "state" : "received",
  "carrier" : {
    "id" : "string",
    "name" : "string"
  },
  "mobile" : "18859540085",
  "waybill_id" : "43444444444232323"
}
1.10.14.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.10.15. 批量取退货单

GET /{tenant_id}/soms/returnservice/rtns
1.10.15.1. 说明

批量取退货单

1.10.15.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

string

Query

rtnIds
必填

退货单订单号集合，最多100个

< string > array(multi)
1.10.15.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnList
1.10.15.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns?rtnIds=string
1.10.15.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "厦门市",
          "district" : "思明区",
          "street" : "前埔",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "station_id" : "254145"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string"
  } ]
}

1.10.16. 根据前端系统单号取多个退货单

GET /{tenant_id}/soms/returnservice/rtns/front/{front_rtn_id}
1.10.16.1. 说明

根据前端系统单号取多个退货单

1.10.16.2. 参数
类型 名称 说明 类型

Path

front_rtn_id
必填

前端退货单号

string

Path

tenant_id
必填

租户ID

string

Query

parts
必填

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

string

Query

platform_id
必填

平台ID

string
1.10.16.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnList
1.10.16.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/front/string?parts=string&platform_id=string
1.10.16.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "厦门市",
          "district" : "思明区",
          "street" : "前埔",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "station_id" : "254145"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string"
  } ]
}

1.10.17. 查指定前端系统订单号的退货单

GET /{tenant_id}/soms/returnservice/rtns/frontorder
1.10.17.1. 说明

查指定前端系统订单号的退货单

1.10.17.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

order_id
必填

订单ID

string

Query

platform_id
必填

平台ID

string
1.10.17.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnList
1.10.17.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/frontorder?order_id=string&platform_id=string
1.10.17.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "厦门市",
          "district" : "思明区",
          "street" : "前埔",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "station_id" : "254145"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string"
  } ]
}

1.10.18. 查指定订单的退货单

GET /{tenant_id}/soms/returnservice/rtns/order
1.10.18.1. 说明

查指定订单的退货单

1.10.18.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

order_id
必填

订单ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

string
1.10.18.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnList
1.10.18.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/order?order_id=string
1.10.18.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "厦门市",
          "district" : "思明区",
          "street" : "前埔",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "station_id" : "254145"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string"
  } ]
}

1.10.19. 查指定订单的退货单

POST /{tenant_id}/soms/returnservice/rtns/orders
1.10.19.1. 说明

查指定订单的退货单

1.10.19.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分，多个“,”隔开,items(商品详情)、item.details（商品组合详情）、paymentDetails(退款支付明细)

string

Body

order_id
必填

订单ID

< string > array
1.10.19.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnList
1.10.19.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/orders
请求 body
[ "string" ]
1.10.19.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "厦门市",
          "district" : "思明区",
          "street" : "前埔",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "station_id" : "254145"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string"
  } ]
}

1.10.20. 批量获取退单打印(JPOS打印方)

GET /{tenant_id}/soms/returnservice/rtns/printbills

operation.deprecated
1.10.20.1. 说明

批量获取退单打印(JPOS打印方)

1.10.20.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

ids
必填

退单号集合

< string > array(multi)

Query

name
可选

打印联的名称，为空则打印全部联。取值有：外卖退单

string
1.10.20.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnPrintDataList
1.10.20.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/printbills?ids=string
1.10.20.5. HTTP响应示例
响应 200
{
  "rtns" : [ {
    "bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "time" : "2016-03-02 12:00:01",
    "rtn_id" : "20160122000006",
    "front_rtn_id" : "20160122000006"
  } ]
}

1.10.21. 查询退货单（ES查询）

POST /{tenant_id}/soms/returnservice/rtns/query
1.10.21.1. 说明

查询退货单（ES查询，推荐使用）

1.10.21.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

分页大小

integer (int32)

Query

sort_key
可选

排序字段 created、modified、front_created

string

Body

filter
必填

查询条件

RtnFilter
1.10.21.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnPaging
1.10.21.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/query?desc=true&page=0&page_size=0
请求 body
{
  "platform_id" : "jdo2o",
  "platform_ids" : "jdo2o",
  "order_id" : "123456",
  "order_id_in" : "123456",
  "rtn_Id" : "123456",
  "shop_id" : "12348522",
  "station_id" : "12345",
  "front_order_id" : "323434",
  "front_rtn_id" : "3232434",
  "customer_Name" : "张三",
  "customer_Mobile" : "18587887789",
  "customer_mobile_like" : "7789",
  "types" : [ "refund" ],
  "states" : [ "confirmed" ],
  "carrier_states" : [ "initial" ],
  "carrier_types" : [ "self" ],
  "approve_states" : [ "none" ],
  "return_states" : [ "none" ],
  "refund_states" : [ "none" ],
  "station_ids" : [ "string" ],
  "product_contains" : "sku2323",
  "front_created_start" : "2016-03-02 12:00:02",
  "front_created_end" : "2016-03-02 12:00:02",
  "created_start" : "2016-03-02 12:00:02",
  "created_end" : "2016-03-02 12:00:02",
  "deliver_rtn_start" : "2016-03-02 12:00:02",
  "deliver_rtn_end" : "2016-03-02 12:00:02",
  "waybill_id" : "32323434",
  "index_modified_start" : "2016-03-02 12:00:02",
  "index_modified_end" : "2016-03-02 12:00:02",
  "pre_page" : 1,
  "has_exception" : false,
  "front_sku_id" : "3234",
  "rtn_ids" : [ "string" ],
  "sku_id" : "232323",
  "has_billing" : false,
  "bill_id_like" : "3454545",
  "bill_id_eq" : "32323434",
  "app_id_eq" : "3232323",
  "vendor_code_eq" : "3232323",
  "vendor_code_start_with" : "3232323",
  "vendor_code_in" : "3232323",
  "wrh_id_start_with" : "3232323",
  "wrh_id_in" : "3232323",
  "station_type" : "wrh",
  "refund_phase" : "aftersale"
}
1.10.21.5. HTTP响应示例
响应 200
{
  "total" : 0,
  "page" : 0,
  "rtns" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "0002",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "type" : "refund",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      }
    },
    "delivery" : {
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "state" : "none",
      "returner" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "厦门市",
          "district" : "思明区",
          "street" : "前埔",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        }
      },
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "station_type" : "string",
      "carrier_note" : "note",
      "wrh_rtn_id" : "XXXXXXXXX",
      "waybill_id" : "XXXXXXXXX",
      "return_mobile" : "18856556655"
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_fieight" : 12.03,
      "settle_amount" : 12.03,
      "package_total" : 12.03,
      "settle_commission" : 2.0,
      "shop_amount" : 120.01
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:02",
      "modified" : "2016-03-02 12:00:02",
      "state" : "已退货",
      "creator" : "254145",
      "source" : "平台生成：platform、商家发起:shop",
      "rtn_id" : "123456",
      "station_id" : "254145"
    },
    "appeal" : false,
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 2.0,
      "total" : 12.03,
      "details" : [ {
        "id" : "01123",
        "title" : "01123",
        "quantity" : 0.01,
        "ratio" : 2.0,
        "real_quantity" : 0.0,
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "123456",
      "product_id" : "2123",
      "item_title" : "冰红茶",
      "real_qty" : 0.0,
      "unit_price" : 12.03,
      "purchase_price" : 12.0,
      "refund_amount" : 12.03,
      "settle_price" : 12.03,
      "settle_total" : 12.03,
      "front_sku_id" : "e235346ger545",
      "front_item_id" : "052700601",
      "image_url" : "http://1213323.png",
      "front_unit" : "string",
      "origin_sku_id" : "e235346ger545",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "shop_price" : 11.22,
      "shop_total" : 11.22,
      "item_id" : "22323232323",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "order_item_id" : "1",
      "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
      "relation_sku_id" : "2123",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "member_info" : {
      "card_no" : "22323"
    },
    "apply_id" : "0002",
    "apply_system" : "shop",
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "异常说明",
    "exception_time" : "2020-11-11 12:11:21",
    "seller_info" : {
      "seller_note" : "收货失败原因",
      "seller_voucher_urls" : "卖家收货失败凭证：图片地址"
    },
    "voucher_urls" : [ "string" ],
    "sku_quantity" : 1.0,
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0
      }
    },
    "wrh_state" : "initial",
    "wrh_id" : "string",
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "settle_info" : {
      "settlable" : true,
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "rtn_req_id" : "string"
  } ],
  "page_count" : 0,
  "page_size" : 0
}

1.11. 仓库库存服务

1.11.1. ERP更新仓库库存到鼎力云

POST /{tenant_id}/invc/wrhinvservice/wrh/{wrh_id}/invs
1.11.1.1. 说明

ERP更新仓库库存到鼎力云

1.11.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Path

wrh_id
必填

仓库代码

string

Query

operator
必填

操作人

string

Body

skus
必填

当前可用库存集合

SkuQuantityList
1.11.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.11.1.4. HTTP请求示例
请求 path
/string/invc/wrhinvservice/wrh/string/invs?operator=string
请求 body
{
  "operator" : "string",
  "skus" : [ {
    "available" : 155.0,
    "sku_id" : "54654",
    "fixed_qty" : 10.0,
    "stock_qty" : 12.0,
    "change_time" : "2019-07-30 00:00:00",
    "task_id" : "54654"
  } ]
}
1.11.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12. 仓库服务

1.12.1. 批量修改或保存仓库

POST /{tenant_id}/merchant/warehouseservice/warehouse/updates
1.12.1.1. 说明

批量修改或保存仓库

1.12.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

warehouses
必填

仓库列表

WarehouseList
1.12.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.12.1.4. HTTP请求示例
请求 path
/string/merchant/warehouseservice/warehouse/updates?operator=string
请求 body
{
  "warehouses" : [ {
    "code" : "00001",
    "name" : "广州仓",
    "gid" : "gid",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "phone" : "string"
    },
    "logistics_center_id" : "00001",
    "logistics_center_name" : "广州物流中行"
  } ]
}
1.12.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.13. 统计服务

1.13.1. 提交count

POST /{tenant_id}/soms/countservice/count
1.13.1.1. 说明

提交count

1.13.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

count
必填

统计

Count
1.13.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.13.1.4. HTTP请求示例
请求 path
/string/soms/countservice/count?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "type" : "order",
  "action" : "decrypt",
  "value" : "10",
  "business_key" : "123",
  "action_name" : "解密"
}
1.13.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.13.2. 查询统计

POST /{tenant_id}/soms/countservice/count/query
1.13.2.1. 说明

查询统计

1.13.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

分页大小 [1, 1000]

integer (int32)

Query

sort_key
可选

排序字段

string

Body

filter
必填

查询条件

统计服务过滤器
1.13.2.3. 响应
HTTP代码 说明 类型

200

successful operation

soms分页查询结果Count
1.13.2.4. HTTP请求示例
请求 path
/string/soms/countservice/count/query?desc=true&page=0&page_size=0
请求 body
{
  "typeEq" : "order",
  "typeIn" : "[\"order\"]",
  "businessKeyEq" : "123",
  "businessKeyIn" : "[\"123\",\"456\"]",
  "actionEq" : "decrypt",
  "actionIn" : "[\"decrypt\"]",
  "actionNameLike" : "string",
  "modifiedBegin" : "2021-08-23 12:16:20",
  "modifiedEnd" : "2021-08-23 12:16:20"
}
1.13.2.5. HTTP响应示例
响应 200
{
  "page" : 0,
  "pageSize" : 100,
  "pageCount" : 2,
  "total" : "1000L",
  "data" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "type" : "order",
    "action" : "decrypt",
    "value" : "10",
    "business_key" : "123",
    "action_name" : "解密"
  } ]
}

1.13.3. 获取count

GET /{tenant_id}/soms/countservice/count/{business_key}
1.13.3.1. 说明

获取count

1.13.3.2. 参数
类型 名称 说明 类型

Path

business_key
必填

业务key

string

Path

tenant_id
必填

租户ID

string

Query

action
必填

操作类型

string

Query

type
必填

类型

string
1.13.3.3. 响应
HTTP代码 说明 类型

200

successful operation

Count
1.13.3.4. HTTP请求示例
请求 path
/string/soms/countservice/count/string?action=string&type=string
1.13.3.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "type" : "order",
  "action" : "decrypt",
  "value" : "10",
  "business_key" : "123",
  "action_name" : "解密"
}

1.13.4. 计数加1

POST /{tenant_id}/soms/countservice/count/{business_key}/add
1.13.4.1. 说明

计数加1

1.13.4.2. 参数
类型 名称 说明 类型

Path

business_key
必填

业务key

string

Path

tenant_id
必填

租户Id

string

Query

action
必填

操作类型

string

Query

operator
可选

string

Query

type
必填

类型

string
1.13.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.13.4.4. HTTP请求示例
请求 path
/string/soms/countservice/count/string/add?action=string&type=string
1.13.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.14. 订单调整服务

1.14.1. 取指定调整单

GET /{tenant_id}/soms/orderadjustservice/orderadjust/{id}
1.14.1.1. 说明

取指定调整单

1.14.1.2. 参数
类型 名称 说明 类型

Path

adjustId
必填

单据ID

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分

string
1.14.1.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderAdjust
1.14.1.4. HTTP请求示例
请求 path
/string/soms/orderadjustservice/orderadjust/{id}
1.14.1.5. HTTP响应示例
响应 200
{
  "id" : "12121212",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "state" : "未提交=initial,已提交 =submitted,审批通过 =approved,审批不通过=rejected;",
  "reason" : "超重补差",
  "remark" : "超重补差",
  "amount" : 0.0,
  "details" : "{}",
  "items" : "{}",
  "payments" : "{}",
  "order_id" : "121212",
  "adjust_phase" : "onsale=售中，aftersale=售后",
  "adjust_version" : 1
}

1.15. 门店服务

1.15.1. 创建门店信息

POST /{tenant_id}/merchant/storeservice/store
1.15.1.1. 说明

创建门店信息

1.15.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

store
必填

门店对象

Store
1.15.1.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.15.1.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store?operator=string
请求 body
{
  "id" : "2345456",
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "gid" : "gid",
  "distance" : 100.0,
  "circles" : [ "string" ],
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "business_type" : "early_education",
  "business_hours" : "10:00-12:00;14:00-21:00",
  "main_image_url" : "string",
  "image_urls" : [ "string" ],
  "open_date" : "2018-06-01 00:00:00",
  "sap_code" : "sapCode",
  "source_sys" : "HDPOS4",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "customs_fields" : [ {
    "id" : "area_id",
    "name" : "地区代码",
    "value" : "ET09"
  } ],
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}

1.15.2. 查找指定租户的门店

GET /{tenant_id}/merchant/storeservice/store
1.15.2.1. 说明

查找指定租户的门店

1.15.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

id
必填

门店ID

string
1.15.2.3. 响应
HTTP代码 说明 类型

200

successful operation

Store
1.15.2.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store?id=string
1.15.2.5. HTTP响应示例
响应 200
{
  "id" : "2345456",
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "gid" : "gid",
  "distance" : 100.0,
  "circles" : [ "string" ],
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "business_type" : "early_education",
  "business_hours" : "10:00-12:00;14:00-21:00",
  "main_image_url" : "string",
  "image_urls" : [ "string" ],
  "open_date" : "2018-06-01 00:00:00",
  "sap_code" : "sapCode",
  "source_sys" : "HDPOS4",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "customs_fields" : [ {
    "id" : "area_id",
    "name" : "地区代码",
    "value" : "ET09"
  } ],
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}

1.15.3. 修改门店信息

POST /{tenant_id}/merchant/storeservice/store/{id}
1.15.3.1. 说明

修改门店信息

1.15.3.2. 参数
类型 名称 说明 类型

Path

id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

mod
必填

修改信息

StoreModification
1.15.3.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.15.3.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store/string?operator=string
请求 body
{
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "circles" : [ "string" ],
  "gid" : "string",
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "sap_code" : "string",
  "business_hours" : "string",
  "source_sys" : "HDPOS4",
  "business_type" : "early_education",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}
1.15.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.15.4. 查询单个门店详情

GET /{tenant_id}/merchant/storeservice/store/{id}
1.15.4.1. 说明

查询单个门店详情

1.15.4.2. 参数
类型 名称 说明 类型

Path

id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string
1.15.4.3. 响应
HTTP代码 说明 类型

200

successful operation

Store
1.15.4.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store/string
1.15.4.5. HTTP响应示例
响应 200
{
  "id" : "2345456",
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "gid" : "gid",
  "distance" : 100.0,
  "circles" : [ "string" ],
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "business_type" : "early_education",
  "business_hours" : "10:00-12:00;14:00-21:00",
  "main_image_url" : "string",
  "image_urls" : [ "string" ],
  "open_date" : "2018-06-01 00:00:00",
  "sap_code" : "sapCode",
  "source_sys" : "HDPOS4",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "customs_fields" : [ {
    "id" : "area_id",
    "name" : "地区代码",
    "value" : "ET09"
  } ],
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}

1.15.5. 批量获得门店信息

GET /{tenant_id}/merchant/storeservice/stores
1.15.5.1. 说明

批量获得门店信息

1.15.5.2. 参数
类型 名称 说明 类型

Query

id
必填

门店ID集合

< string > array(multi)

Query

org_id
必填

企业ID

string
1.15.5.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreList
1.15.5.4. HTTP请求示例
请求 path
/{tenant_id}/merchant/storeservice/stores?id=string&org_id=string
1.15.5.5. HTTP响应示例
响应 200
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}

1.15.6. 定位附近的门店

GET /{tenant_id}/merchant/storeservice/stores/location
1.15.6.1. 说明

定位附近的门店

1.15.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

count
可选

附近门店数量， null 为空默认查询30家

integer (int32)

Query

lat
必填

纬度

number

Query

lng
必填

经度

number
1.15.6.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreList
1.15.6.4. HTTP请求示例
请求 path
/string/merchant/storeservice/stores/location?lat=0.0&lng=0.0
1.15.6.5. HTTP响应示例
响应 200
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}

1.15.7. 分页查询门店

POST /{tenant_id}/merchant/storeservice/stores/query
1.15.7.1. 说明

分页查询门店

1.15.7.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

分页大小

integer (int32)

Query

sort_key
可选

排序字段

string

Body

filter
必填

查询过滤器

StoreFilter
1.15.7.3. 响应
HTTP代码 说明 类型

200

successful operation

StorePaging
1.15.7.4. HTTP请求示例
请求 path
/string/merchant/storeservice/stores/query?desc=true&page=0&page_size=0
请求 body
{
  "id" : "1323230",
  "states" : "opened",
  "types" : "self",
  "circles" : [ "string" ],
  "store_ids" : [ "string" ],
  "business_types" : [ "string" ],
  "key_like" : "2134",
  "latitude_start" : 65.0,
  "latitude_end" : 89.0,
  "longtitude_start" : 110.0,
  "longtitude_end" : 120.0,
  "modified_start" : "2018-09-07 00:00:00",
  "modified_end" : "2018-09-07 00:00:00"
}
1.15.7.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.15.8. 同步门店信息

POST /{tenant_id}/merchant/storeservice/updates
1.15.8.1. 说明

同步门店信息

1.15.8.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

stores
必填

门店列表

StoreList
1.15.8.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.15.8.4. HTTP请求示例
请求 path
/string/merchant/storeservice/updates?operator=string
请求 body
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}
1.15.8.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.15.9. 获取用户授权门店

GET /{tenant_id}/merchant/storeservice/user/{user_id}/managestores
1.15.9.1. 说明

获取用户授权门店

1.15.9.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Path

user_id
必填

用户ID

string
1.15.9.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreList
1.15.9.4. HTTP请求示例
请求 path
/string/merchant/storeservice/user/string/managestores
1.15.9.5. HTTP响应示例
响应 200
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}

1.15.10. 同步门店信息

POST /{tenant_id}/merchant/{tenant_id}/merchant/storeservice/syncStores
1.15.10.1. 说明

同步门店信息

1.15.10.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

stores
必填

门店列表

StoreList
1.15.10.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.15.10.4. HTTP请求示例
请求 path
/string/merchant/string/merchant/storeservice/syncStores?operator=string
请求 body
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}
1.15.10.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.16. 配送方案服务

1.16.1. 查询配送范围列表

POST /{tenant_id}/eshop/carrierschemeruleservice/carrier/scopes
1.16.1.1. 说明

查询配送范围列表

1.16.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

carrier_id
可选

承运商ID：fengniao、meituan

string

Body

storeIds
必填

门店列表，门店数量不能大于100

< string > array
1.16.1.3. 响应
HTTP代码 说明 类型

200

successful operation

< CarrierScope > array
1.16.1.4. HTTP请求示例
请求 path
/string/eshop/carrierschemeruleservice/carrier/scopes
请求 body
[ "string" ]
1.16.1.5. HTTP响应示例
响应 200
[ {
  "carrierId" : "meituan",
  "carrierMerchantId" : "02",
  "type" : "meituan",
  "shopId" : "10",
  "storeId" : "3243545",
  "coordinates" : [ {
    "type" : "GCJ02",
    "rangeId" : "0，1，2",
    "rangeName" : "快递配送",
    "rangeNo" : "1，2",
    "latitude" : 118.5,
    "longtitude" : 60.2
  } ]
} ]

1.16.2. 获取平台门店配送方案

GET /{tenant_id}/eshop/carrierschemeruleservice/schemerule
1.16.2.1. 说明

获平台门店配送方案

1.16.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

platform_id
必填

平台ID

string

Query

shop_id
必填

平台商家ID

string

Query

store_id
必填

门店ID

string
1.16.2.3. 响应
HTTP代码 说明 类型

200

successful operation

CarrierSchemeRule
1.16.2.4. HTTP请求示例
请求 path
/string/eshop/carrierschemeruleservice/schemerule?platform_id=string&shop_id=string&store_id=string
1.16.2.5. HTTP响应示例
响应 200
{
  "platformId" : "meituan",
  "shopId" : "3243",
  "storeId" : "32345355",
  "source" : "store",
  "state" : "applying",
  "schemes" : [ {
    "scopeSource" : "meituan",
    "carrierMerchantId" : "meituan",
    "selectCoordinate" : "1,2",
    "scope" : {
      "carrierId" : "meituan",
      "carrierMerchantId" : "02",
      "type" : "meituan",
      "shopId" : "10",
      "storeId" : "3243545",
      "coordinates" : [ {
        "type" : "GCJ02",
        "rangeId" : "0，1，2",
        "rangeName" : "快递配送",
        "rangeNo" : "1，2",
        "latitude" : 118.5,
        "longtitude" : 60.2
      } ]
    },
    "minAmount" : 5.25,
    "freight" : 2.0,
    "maxWeight" : 2.0,
    "packageAmount" : 0.0,
    "selfPackageAmount" : 0.0,
    "selfOrderNoFeight" : true,
    "freightDecs" : [ {
      "type" : "string",
      "conditions" : [ {
        "minValue" : "2",
        "maxValue" : "3",
        "decValue" : 3.0,
        "freeShipping" : true
      } ]
    } ],
    "freightIncs" : [ {
      "type" : "distance",
      "conditions" : [ {
        "minValue" : "2",
        "maxValue" : "3",
        "perValue" : 2.0,
        "incValue" : 3.0
      } ]
    } ]
  } ]
}

1.16.3. 获取配送方案列表

POST /{tenant_id}/eshop/carrierschemeruleservice/schemes
1.16.3.1. 说明

获取配送方案

1.16.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Body

filter
必填

方案过滤条件

CarrierSchemeFilter
1.16.3.3. 响应
HTTP代码 说明 类型

200

successful operation

< CarrierScheme > array
1.16.3.4. HTTP请求示例
请求 path
/string/eshop/carrierschemeruleservice/schemes
请求 body
{
  "storeId" : "0001",
  "scopeSource" : "fengniao"
}
1.16.3.5. HTTP响应示例
响应 200
[ {
  "scopeSource" : "meituan",
  "carrierMerchantId" : "meituan",
  "selectCoordinate" : "1,2",
  "scope" : {
    "carrierId" : "meituan",
    "carrierMerchantId" : "02",
    "type" : "meituan",
    "shopId" : "10",
    "storeId" : "3243545",
    "coordinates" : [ {
      "type" : "GCJ02",
      "rangeId" : "0，1，2",
      "rangeName" : "快递配送",
      "rangeNo" : "1，2",
      "latitude" : 118.5,
      "longtitude" : 60.2
    } ]
  },
  "minAmount" : 5.25,
  "freight" : 2.0,
  "maxWeight" : 2.0,
  "packageAmount" : 0.0,
  "selfPackageAmount" : 0.0,
  "selfOrderNoFeight" : true,
  "freightDecs" : [ {
    "type" : "string",
    "conditions" : [ {
      "minValue" : "2",
      "maxValue" : "3",
      "decValue" : 3.0,
      "freeShipping" : true
    } ]
  } ],
  "freightIncs" : [ {
    "type" : "distance",
    "conditions" : [ {
      "minValue" : "2",
      "maxValue" : "3",
      "perValue" : 2.0,
      "incValue" : 3.0
    } ]
  } ]
} ]

1.17. 订单服务

1.17.1. 获取催单

GET /{tenant_id}/soms/orderremindservice/orderremind/{id}
1.17.1.1. 说明

获取催单

1.17.1.2. 参数
类型 名称 说明 类型

Path

id
必填

催单ID

string

Path

tenant_id
必填

租户Id

string
1.17.1.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderRemind
1.17.1.4. HTTP请求示例
请求 path
/string/soms/orderremindservice/orderremind/string
1.17.1.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "store" : {
    "id" : "string",
    "name" : "string"
  },
  "time" : "2020-12-02 00:00:00",
  "count" : 1,
  "remind_id" : "很好",
  "order_id" : "202012021621",
  "platform_id" : "jdo2o",
  "shop_id" : "jdo2o",
  "front_remind_id" : "很好",
  "reply_state" : "string",
  "reply_time" : "2020-06-17 10:00:00",
  "reply_content" : "string",
  "reply_operator" : "string"
}

1.17.2. 催单回复

POST /{tenant_id}/soms/orderremindservice/remind/{id}/reply
1.17.2.1. 说明

催单回复

1.17.2.2. 参数
类型 名称 说明 类型

Path

id
必填

催单ID

string

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

催单

ReplyRemindRequest
1.17.2.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.17.2.4. HTTP请求示例
请求 path
/string/soms/orderremindservice/remind/string/reply?operator=string
请求 body
{
  "reply_time" : "2020-06-17 10:00:00",
  "reply_content" : "string",
  "reply_operator" : "string"
}
1.17.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.17.3. 查询催单

POST /{tenant_id}/soms/orderremindservice/reminds/query
1.17.3.1. 说明

查询催单

1.17.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
可选

页码，从0开始，必须>=0

integer (int32)

Query

page_size
可选

分页大小，范围是[1,100]

integer (int32)

Query

sort_key
可选

排序字段，取值范围:time(催单时间)、created(创建时间)、modified(最后修改时间)

string

Body

filter
必填

查询条件

OrderRemindFilter
1.17.3.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderRemindPaging
1.17.3.4. HTTP请求示例
请求 path
/string/soms/orderremindservice/reminds/query?desc=true
请求 body
{
  "id_eq" : "123",
  "id_in" : [ "string" ],
  "platform_id_eq" : "meituan",
  "order_id_eq" : "123465",
  "order_id_in" : [ "string" ],
  "store_id_eq" : "0001",
  "reply_state_eq" : "none（未回复）、replied（已回复）、invalid（失效）"
}
1.17.3.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "reminds" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "store" : {
      "id" : "string",
      "name" : "string"
    },
    "time" : "2020-12-02 00:00:00",
    "count" : 1,
    "remind_id" : "很好",
    "order_id" : "202012021621",
    "platform_id" : "jdo2o",
    "shop_id" : "jdo2o",
    "front_remind_id" : "很好",
    "reply_state" : "string",
    "reply_time" : "2020-06-17 10:00:00",
    "reply_content" : "string",
    "reply_operator" : "string"
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.17.4. 提交订单（旧版）

POST /{tenant_id}/soms/orderservice/order
1.17.4.1. 说明

提交订单，只支持新增订单，不支持修改订单，状态：confirmed

1.17.4.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order
必填

订单

Order
1.17.4.3. 响应
HTTP代码 说明 类型

200

successful operation

IdWrapper
1.17.4.4. HTTP请求示例
请求 path
/string/soms/orderservice/order?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "88822222222",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "source" : "小程序",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "脱敏名称**",
      "private_mobile" : "189389928893"
    }
  },
  "weight" : 500.0,
  "invoice" : {
    "required" : false,
    "result" : "开票成功",
    "details" : [ {
      "type" : "plain",
      "kind" : "paper",
      "title" : "XX公司",
      "content" : "上海股份有限公司",
      "amount" : 12.03,
      "tax" : 2.32,
      "account" : "0023415445",
      "telephone" : "12344545111",
      "bank" : "中国银行XXX",
      "address" : "福建厦门XX",
      "remark" : "plain",
      "email" : "chw@qq.com",
      "time" : "2019-07-15 16:56:23",
      "url" : "a.jpg",
      "title_type" : "person",
      "buyer_tax_code" : "1232000046600736XP",
      "taxer_id" : "1212345046600736XP",
      "print_number" : "123456",
      "securaty_code" : "2114445",
      "check_code" : "201622",
      "serial_no" : "454557884564545"
    } ],
    "error_reason" : "string",
    "apply_qrcode" : "string"
  },
  "payment" : {
    "type" : "online",
    "state" : "paid",
    "payee" : {
      "id" : "string",
      "name" : "string"
    },
    "amount" : 14.02,
    "freight" : 14.02,
    "details" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "cashier" : true,
      "score" : 100.0,
      "flowno" : "3223232323",
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "pay_time" : "2019-03-02 12:00:01",
    "pay_bill_id" : "0122333333",
    "cod_amount" : 0.0,
    "earnest_amount" : 0.0,
    "package_total" : 14.02,
    "other_fee" : 0.0
  },
  "delivery" : {
    "type" : "deliver",
    "state" : "none",
    "receiver" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "厦门市",
        "district" : "思明区",
        "street" : "前埔",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      }
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "waybills" : [ {
      "waybill_id" : "123"
    } ],
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "remark" : "定时达",
    "operation_state" : "none",
    "ship_mode" : "wrhShip",
    "ship_delivery_mode" : "wrhShipCarrierDeli",
    "wrh_order_id" : "32323",
    "ship_id" : "23232323",
    "waybill_id" : "123",
    "carrier_note" : "加快",
    "pre_type" : "normal：正常，dsd：定时达，half_day：半日达",
    "pre_start_delivery_time" : "2016-03-02 12:00:01",
    "pre_end_delivery_time" : "2016-03-02 14:00:01",
    "pickup_code" : "123456",
    "city_token" : "123456",
    "selftake_code" : "123456",
    "pre_selftake_time" : "03月05日 晚上",
    "selftake_confirmed" : true,
    "waybill_print_info" : {
      "datas" : [ {
        "type" : "string",
        "data" : "string"
      } ]
    }
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:01",
    "modified" : "2016-03-02 12:00:01",
    "state" : "已付款",
    "attribute" : "string",
    "order_id" : "1223654",
    "main_order_id" : "1223432",
    "inner_order_id" : "1223432",
    "dpt_station_time" : "2016-03-02 12:00:01",
    "station_id" : "254145",
    "station_order_no" : "1",
    "order_type" : {
      "id" : "string",
      "name" : "string"
    },
    "wrh_id" : "string"
  },
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "front" : {
      "spec" : "蓝色;微甜  少冰/多糖",
      "spec2" : "500g",
      "unit" : "string",
      "attributes" : [ {
        "group" : "口味",
        "values" : [ "string" ],
        "price" : 0.0,
        "qty" : 0.0
      } ],
      "sku_id" : "052700601",
      "spu_id" : "052700601",
      "item_id" : "052700601"
    },
    "details" : [ {
      "id" : "121212",
      "title" : "矿泉水",
      "quantity" : 4.0,
      "ratio" : 3.0,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "front_spec" : "辣",
      "real_quantity" : 0.0,
      "fault_tolerant_info" : "string",
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ]
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "item_no" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "weight" : 1.0,
    "pay_amount" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_qty" : 125.0,
    "package_total" : 205.44,
    "package_info" : {
      "thermosphere" : "string",
      "quantity" : 125.0,
      "total" : 205.44,
      "packageName" : "保温袋"
    },
    "price" : 122.34,
    "cost_price" : 122.34,
    "shop_price" : 122.22,
    "shop_total" : 122.22,
    "settle_price" : 122.2222,
    "settle_total" : 122.22,
    "settle_discountAmount" : 122.22,
    "consume_scores" : 12.2,
    "image_url" : "http://aaa/bbb.png",
    "item_id" : "1",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "relation_sku_id" : "2123",
    "orig_mas_sku_id" : "string",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_weight" : 1.0,
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "weight" : 0.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "orig_extra_info" : {
      "spec" : "1*1",
      "unit" : "个"
    },
    "fault_tolerant_info" : "string",
    "salesman" : {
      "id" : "string",
      "name" : "string"
    },
    "trace_codes" : [ "string" ],
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "extra_info" : "{\"inv_mgr\": false}",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "is_gift" : true
  } ],
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "exceptions" : [ {
    "code" : "sku",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "name" : "满减",
      "type" : "string",
      "amount" : 10.5,
      "remark" : "测试优惠",
      "factor" : {
        "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
        "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
        "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
      },
      "sku_act_id" : "1111",
      "merchant_act_id" : "1111",
      "batch_act_id" : "1111",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（代理商）",
        "discount" : 1.0
      } ],
      "share_details" : "[]"
    } ]
  },
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "approve_state" : "none",
  "wrh_state" : "initial",
  "customer_note" : "note",
  "seller_note" : "note",
  "salesman" : {
    "id" : "string",
    "name" : "string",
    "type" : "saleman",
    "org" : {
      "id" : "string",
      "name" : "string"
    },
    "org_type" : "门店",
    "inviter_mobile" : "18859226552",
    "inviter_name" : "王x",
    "inviter_wid" : "7567645",
    "personal_guider_name" : "王x",
    "personal_guider_no" : "3242323",
    "personal_guider_wid" : "3242323",
    "trade_guider_name" : "王x",
    "trade_guider_no" : "65756",
    "trade_guider_wid" : "45345",
    "weike_mobile" : "18859226552",
    "weike_name" : "张三",
    "weike_wid" : "765765756"
  },
  "cancel_type" : "customerCancel",
  "cancel_reason" : "我不想要了",
  "source_order_id" : "5346567534545645",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "商品不存在",
  "is_private" : true,
  "item_count" : 1,
  "sku_quantity" : 1.0,
  "real_total" : 120.01,
  "orig_total" : 120.01,
  "user_number" : 2,
  "settle_amount" : 120.01,
  "settle_commission" : 120.01,
  "selttle_commission" : 120.01,
  "settle_freight" : 120.01,
  "performance_service_fee" : 120.01,
  "shop_amount" : 120.01,
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "invoice_take_code" : "string",
  "item_change_records" : [ {
    "reason" : "string",
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "is_gift" : true
    } ],
    "change_items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "is_gift" : true
    } ]
  } ],
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "suspend_info" : {
    "suspended" : true,
    "code" : "string",
    "caption" : "string",
    "time" : "2017-12-26 16:40:19"
  },
  "member_info" : {
    "member_id" : "12253",
    "card_no" : "22323",
    "member_gid" : "12253",
    "outer_member_id" : "12253"
  },
  "fault_tolerant_info" : "string",
  "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0
    }
  },
  "settle_info" : {
    "settlable" : true,
    "discounts" : "[{}]",
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "item_logistics" : [ {
    "qty" : 0.0,
    "sku_id" : "string",
    "logistics_code" : "string"
  } ],
  "calc_data" : true,
  "wrh_id" : "4184",
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string"
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "quotas" : [ {
    "action" : "expect_shipping",
    "time" : "2021-09-26 16:40:19",
    "remark" : "无",
    "action_name" : "期望拣货完成时间"
  } ],
  "reissue_reason" : "string",
  "responsible_party" : "string",
  "mock_info" : {
    "persist" : true
  },
  "adjust_details" : [ {
    "field" : "amount,pay_amount,quantity",
    "before" : "10",
    "after" : "12"
  } ],
  "sale_order_id" : "string"
}
1.17.4.5. HTTP响应示例
响应 200
{
  "id" : "string"
}

1.17.5. 自提检查

POST /{tenant_id}/soms/orderservice/order/action/selftake/check
1.17.5.1. 说明

自提检查

1.17.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

OrderSelftakeCheckRequest
1.17.5.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSelftakeCheckResponse
1.17.5.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/action/selftake/check?operator=string
请求 body
{
  "store_id" : "232434",
  "platform_id" : "youzan",
  "selftake_code" : "123456",
  "selftake_qrcode" : "123456",
  "front_order_id" : "5745323545453"
}
1.17.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "5745323545453"
}

1.17.6. 确认自提(新接口)

POST /{tenant_id}/soms/orderservice/order/action/v2/selftake
1.17.6.1. 说明

确认自提(新接口)

1.17.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

OrderSelftakeV2Request
1.17.6.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSelftakeV2Response
1.17.6.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/action/v2/selftake?operator=string
请求 body
{
  "store_id" : "454534",
  "selftake_qrcode" : "222222",
  "order_id" : "12345",
  "platform_id" : "be.eleme"
}
1.17.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "5745323545453"
}

1.17.7. 订单检测

POST /{tenant_id}/soms/orderservice/order/check
1.17.7.1. 说明

地址检测：支持检测美团、蜂鸟、顺丰大网，用于检测地址是否在配送范围内；配送检测：用于检测配送平台是否可送；配送计算：用于计算使用哪个配送平台进行配送

1.17.7.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

订单检测

OrderCheckRequest
1.17.7.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderCheckResponse
1.17.7.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/check?operator=string
请求 body
{
  "type" : "deliverycheck",
  "station" : {
    "id" : "string",
    "name" : "string"
  },
  "weight" : 10.0,
  "amount" : 10.0,
  "items" : "[]",
  "platform_id" : "jdo2o",
  "order_id" : "121212",
  "receiver_address" : {
    "country" : "中国",
    "province" : "福建省",
    "city" : "厦门市",
    "district" : "思明区",
    "street" : "前埔",
    "postcode" : "363423",
    "latitude" : "45.3,范围0-90",
    "longtitude" : "121.2,范围0-180",
    "coordinate_type" : "GCJ02",
    "private_street" : "脱敏地址**"
  },
  "receiver_contact" : {
    "name" : "李飞",
    "telephone" : "189389928893",
    "mobile" : "189389928893",
    "email" : "55151@qq.com",
    "fax" : "123123",
    "private_name" : "脱敏名称**",
    "private_mobile" : "189389928893"
  },
  "pre_type" : "normal",
  "expect_delivery_time" : "2022-03-02 14:00:01",
  "sku_quantity" : 10.0,
  "carrier_id" : "meituan",
  "ship_mode" : "stationShip"
}
1.17.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "distance" : 1000.0,
  "freight" : 10.0,
  "suggest_carrier" : {
    "id" : "string",
    "name" : "string"
  },
  "pre_delivery_time" : "2022-06-30 12:00:00 或者 2022-06-30",
  "pre_delivery_slots" : [ {
    "pre_date" : "今天（周三）",
    "pre_ends" : "[\"立即送出\",\"12:00\",\"13:00\"]"
  } ],
  "delivery_mins" : 10.0
}

1.17.8. 批量修改订单下单门店

POST /{tenant_id}/soms/orderservice/order/mod/store
1.17.8.1. 说明

批量修改订单下单门店

1.17.8.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

修改内容

OrderStoreModRequest
1.17.8.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderStoreModResponse
1.17.8.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/mod/store?operator=string
请求 body
{
  "mods" : [ {
    "order_id" : "1212",
    "order_store" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}
1.17.8.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "errors" : [ {
    "id" : "1212",
    "message" : "订单不存在"
  } ]
}

1.17.9. 批量取指定订单

GET /{tenant_id}/soms/orderservice/order/orders
1.17.9.1. 说明

批量取订单，级联信息可以通过parts获取

1.17.9.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

id
必填

订单号集合，建议20，最多100个

< string > array(multi)

Query

parts
可选

需要返回的部分，取值范围:items(商品详情)、item.details（商品组合详情）,paymentDetails(支付详情)、invoiceDetails(发票详情)、printBills（打印信息）、prom（优惠信息）、exceptions（订单异常信息）、waybill.printinfo（运单打印信息）

string
1.17.9.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderList
1.17.9.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/orders?id=string
1.17.9.5. HTTP响应示例
响应 200
{
  "orders" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "88822222222",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "source" : "小程序",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      }
    },
    "weight" : 500.0,
    "invoice" : {
      "required" : false,
      "result" : "开票成功",
      "details" : [ {
        "type" : "plain",
        "kind" : "paper",
        "title" : "XX公司",
        "content" : "上海股份有限公司",
        "amount" : 12.03,
        "tax" : 2.32,
        "account" : "0023415445",
        "telephone" : "12344545111",
        "bank" : "中国银行XXX",
        "address" : "福建厦门XX",
        "remark" : "plain",
        "email" : "chw@qq.com",
        "time" : "2019-07-15 16:56:23",
        "url" : "a.jpg",
        "title_type" : "person",
        "buyer_tax_code" : "1232000046600736XP",
        "taxer_id" : "1212345046600736XP",
        "print_number" : "123456",
        "securaty_code" : "2114445",
        "check_code" : "201622",
        "serial_no" : "454557884564545"
      } ],
      "error_reason" : "string",
      "apply_qrcode" : "string"
    },
    "payment" : {
      "type" : "online",
      "state" : "paid",
      "payee" : {
        "id" : "string",
        "name" : "string"
      },
      "amount" : 14.02,
      "freight" : 14.02,
      "details" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "cashier" : true,
        "score" : 100.0,
        "flowno" : "3223232323",
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "pay_time" : "2019-03-02 12:00:01",
      "pay_bill_id" : "0122333333",
      "cod_amount" : 0.0,
      "earnest_amount" : 0.0,
      "package_total" : 14.02,
      "other_fee" : 0.0
    },
    "delivery" : {
      "type" : "deliver",
      "state" : "none",
      "receiver" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "厦门市",
          "district" : "思明区",
          "street" : "前埔",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        }
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "waybills" : [ {
        "waybill_id" : "123"
      } ],
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "remark" : "定时达",
      "operation_state" : "none",
      "ship_mode" : "wrhShip",
      "ship_delivery_mode" : "wrhShipCarrierDeli",
      "wrh_order_id" : "32323",
      "ship_id" : "23232323",
      "waybill_id" : "123",
      "carrier_note" : "加快",
      "pre_type" : "normal：正常，dsd：定时达，half_day：半日达",
      "pre_start_delivery_time" : "2016-03-02 12:00:01",
      "pre_end_delivery_time" : "2016-03-02 14:00:01",
      "pickup_code" : "123456",
      "city_token" : "123456",
      "selftake_code" : "123456",
      "pre_selftake_time" : "03月05日 晚上",
      "selftake_confirmed" : true,
      "waybill_print_info" : {
        "datas" : [ {
          "type" : "string",
          "data" : "string"
        } ]
      }
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:01",
      "modified" : "2016-03-02 12:00:01",
      "state" : "已付款",
      "attribute" : "string",
      "order_id" : "1223654",
      "main_order_id" : "1223432",
      "inner_order_id" : "1223432",
      "dpt_station_time" : "2016-03-02 12:00:01",
      "station_id" : "254145",
      "station_order_no" : "1",
      "order_type" : {
        "id" : "string",
        "name" : "string"
      },
      "wrh_id" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "is_gift" : true
    } ],
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "exceptions" : [ {
      "code" : "sku",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "wrh_state" : "initial",
    "customer_note" : "note",
    "seller_note" : "note",
    "salesman" : {
      "id" : "string",
      "name" : "string",
      "type" : "saleman",
      "org" : {
        "id" : "string",
        "name" : "string"
      },
      "org_type" : "门店",
      "inviter_mobile" : "18859226552",
      "inviter_name" : "王x",
      "inviter_wid" : "7567645",
      "personal_guider_name" : "王x",
      "personal_guider_no" : "3242323",
      "personal_guider_wid" : "3242323",
      "trade_guider_name" : "王x",
      "trade_guider_no" : "65756",
      "trade_guider_wid" : "45345",
      "weike_mobile" : "18859226552",
      "weike_name" : "张三",
      "weike_wid" : "765765756"
    },
    "cancel_type" : "customerCancel",
    "cancel_reason" : "我不想要了",
    "source_order_id" : "5346567534545645",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "商品不存在",
    "is_private" : true,
    "item_count" : 1,
    "sku_quantity" : 1.0,
    "real_total" : 120.01,
    "orig_total" : 120.01,
    "user_number" : 2,
    "settle_amount" : 120.01,
    "settle_commission" : 120.01,
    "selttle_commission" : 120.01,
    "settle_freight" : 120.01,
    "performance_service_fee" : 120.01,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "invoice_take_code" : "string",
    "item_change_records" : [ {
      "reason" : "string",
      "items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "string"
          } ]
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "name" : "满减",
            "type" : "string",
            "amount" : 10.5,
            "remark" : "测试优惠",
            "factor" : {
              "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
              "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
              "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
            },
            "sku_act_id" : "1111",
            "merchant_act_id" : "1111",
            "batch_act_id" : "1111",
            "prom_cls" : "string",
            "voucher_code" : "111111111",
            "settle_details" : [ {
              "role" : "shop（商家）、platform（平台）、agent（代理商）",
              "discount" : 1.0
            } ],
            "share_details" : "[]"
          } ],
          "discount_amount" : 0.1,
          "apported_discount_amount" : 0.1
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "is_gift" : true
      } ],
      "change_items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "string"
          } ]
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "name" : "满减",
            "type" : "string",
            "amount" : 10.5,
            "remark" : "测试优惠",
            "factor" : {
              "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
              "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
              "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
            },
            "sku_act_id" : "1111",
            "merchant_act_id" : "1111",
            "batch_act_id" : "1111",
            "prom_cls" : "string",
            "voucher_code" : "111111111",
            "settle_details" : [ {
              "role" : "shop（商家）、platform（平台）、agent（代理商）",
              "discount" : 1.0
            } ],
            "share_details" : "[]"
          } ],
          "discount_amount" : 0.1,
          "apported_discount_amount" : 0.1
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "is_gift" : true
      } ]
    } ],
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "suspend_info" : {
      "suspended" : true,
      "code" : "string",
      "caption" : "string",
      "time" : "2017-12-26 16:40:19"
    },
    "member_info" : {
      "member_id" : "12253",
      "card_no" : "22323",
      "member_gid" : "12253",
      "outer_member_id" : "12253"
    },
    "fault_tolerant_info" : "string",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0
      }
    },
    "settle_info" : {
      "settlable" : true,
      "discounts" : "[{}]",
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string"
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "quotas" : [ {
      "action" : "expect_shipping",
      "time" : "2021-09-26 16:40:19",
      "remark" : "无",
      "action_name" : "期望拣货完成时间"
    } ],
    "reissue_reason" : "string",
    "responsible_party" : "string",
    "mock_info" : {
      "persist" : true
    },
    "adjust_details" : [ {
      "field" : "amount,pay_amount,quantity",
      "before" : "10",
      "after" : "12"
    } ],
    "sale_order_id" : "string"
  } ],
  "empty" : true
}

1.17.10. 补发订单

POST /{tenant_id}/soms/orderservice/order/reissue
1.17.10.1. 说明

补发订单

1.17.10.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

订单补发请求

OrderReissueRequest
1.17.10.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderReissueResponse
1.17.10.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/reissue?operator=string
请求 body
{
  "receiver" : {
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "脱敏名称**",
      "private_mobile" : "189389928893"
    },
    "address" : {
      "country" : "中国",
      "province" : "福建省",
      "city" : "厦门市",
      "district" : "思明区",
      "street" : "前埔",
      "postcode" : "363423",
      "latitude" : "45.3,范围0-90",
      "longtitude" : "121.2,范围0-180",
      "coordinate_type" : "GCJ02",
      "private_street" : "脱敏地址**"
    }
  },
  "source_order_id" : "121212",
  "responsible_party" : "carrier",
  "reissue_reason" : "弄丢了",
  "reissue_order_items" : [ {
    "quantity" : 13.0,
    "item_no" : "1",
    "sku_id" : "132323"
  } ],
  "seller_note" : "商家备注"
}
1.17.10.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "string"
}

1.17.11. 提交订单（新版）

POST /{tenant_id}/soms/orderservice/order/submit
1.17.11.1. 说明

提交订单，只支持新增订单，不支持修改订单，订单状态：confirmed

1.17.11.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order
必填

订单

Order
1.17.11.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSubmitResponse
1.17.11.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/submit?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "88822222222",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "source" : "小程序",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "脱敏名称**",
      "private_mobile" : "189389928893"
    }
  },
  "weight" : 500.0,
  "invoice" : {
    "required" : false,
    "result" : "开票成功",
    "details" : [ {
      "type" : "plain",
      "kind" : "paper",
      "title" : "XX公司",
      "content" : "上海股份有限公司",
      "amount" : 12.03,
      "tax" : 2.32,
      "account" : "0023415445",
      "telephone" : "12344545111",
      "bank" : "中国银行XXX",
      "address" : "福建厦门XX",
      "remark" : "plain",
      "email" : "chw@qq.com",
      "time" : "2019-07-15 16:56:23",
      "url" : "a.jpg",
      "title_type" : "person",
      "buyer_tax_code" : "1232000046600736XP",
      "taxer_id" : "1212345046600736XP",
      "print_number" : "123456",
      "securaty_code" : "2114445",
      "check_code" : "201622",
      "serial_no" : "454557884564545"
    } ],
    "error_reason" : "string",
    "apply_qrcode" : "string"
  },
  "payment" : {
    "type" : "online",
    "state" : "paid",
    "payee" : {
      "id" : "string",
      "name" : "string"
    },
    "amount" : 14.02,
    "freight" : 14.02,
    "details" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "cashier" : true,
      "score" : 100.0,
      "flowno" : "3223232323",
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "pay_time" : "2019-03-02 12:00:01",
    "pay_bill_id" : "0122333333",
    "cod_amount" : 0.0,
    "earnest_amount" : 0.0,
    "package_total" : 14.02,
    "other_fee" : 0.0
  },
  "delivery" : {
    "type" : "deliver",
    "state" : "none",
    "receiver" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "厦门市",
        "district" : "思明区",
        "street" : "前埔",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      }
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "waybills" : [ {
      "waybill_id" : "123"
    } ],
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "remark" : "定时达",
    "operation_state" : "none",
    "ship_mode" : "wrhShip",
    "ship_delivery_mode" : "wrhShipCarrierDeli",
    "wrh_order_id" : "32323",
    "ship_id" : "23232323",
    "waybill_id" : "123",
    "carrier_note" : "加快",
    "pre_type" : "normal：正常，dsd：定时达，half_day：半日达",
    "pre_start_delivery_time" : "2016-03-02 12:00:01",
    "pre_end_delivery_time" : "2016-03-02 14:00:01",
    "pickup_code" : "123456",
    "city_token" : "123456",
    "selftake_code" : "123456",
    "pre_selftake_time" : "03月05日 晚上",
    "selftake_confirmed" : true,
    "waybill_print_info" : {
      "datas" : [ {
        "type" : "string",
        "data" : "string"
      } ]
    }
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:01",
    "modified" : "2016-03-02 12:00:01",
    "state" : "已付款",
    "attribute" : "string",
    "order_id" : "1223654",
    "main_order_id" : "1223432",
    "inner_order_id" : "1223432",
    "dpt_station_time" : "2016-03-02 12:00:01",
    "station_id" : "254145",
    "station_order_no" : "1",
    "order_type" : {
      "id" : "string",
      "name" : "string"
    },
    "wrh_id" : "string"
  },
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "front" : {
      "spec" : "蓝色;微甜  少冰/多糖",
      "spec2" : "500g",
      "unit" : "string",
      "attributes" : [ {
        "group" : "口味",
        "values" : [ "string" ],
        "price" : 0.0,
        "qty" : 0.0
      } ],
      "sku_id" : "052700601",
      "spu_id" : "052700601",
      "item_id" : "052700601"
    },
    "details" : [ {
      "id" : "121212",
      "title" : "矿泉水",
      "quantity" : 4.0,
      "ratio" : 3.0,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "front_spec" : "辣",
      "real_quantity" : 0.0,
      "fault_tolerant_info" : "string",
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ]
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "item_no" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "weight" : 1.0,
    "pay_amount" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_qty" : 125.0,
    "package_total" : 205.44,
    "package_info" : {
      "thermosphere" : "string",
      "quantity" : 125.0,
      "total" : 205.44,
      "packageName" : "保温袋"
    },
    "price" : 122.34,
    "cost_price" : 122.34,
    "shop_price" : 122.22,
    "shop_total" : 122.22,
    "settle_price" : 122.2222,
    "settle_total" : 122.22,
    "settle_discountAmount" : 122.22,
    "consume_scores" : 12.2,
    "image_url" : "http://aaa/bbb.png",
    "item_id" : "1",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "relation_sku_id" : "2123",
    "orig_mas_sku_id" : "string",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_weight" : 1.0,
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "weight" : 0.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "orig_extra_info" : {
      "spec" : "1*1",
      "unit" : "个"
    },
    "fault_tolerant_info" : "string",
    "salesman" : {
      "id" : "string",
      "name" : "string"
    },
    "trace_codes" : [ "string" ],
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "extra_info" : "{\"inv_mgr\": false}",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "is_gift" : true
  } ],
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "exceptions" : [ {
    "code" : "sku",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "name" : "满减",
      "type" : "string",
      "amount" : 10.5,
      "remark" : "测试优惠",
      "factor" : {
        "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
        "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
        "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
      },
      "sku_act_id" : "1111",
      "merchant_act_id" : "1111",
      "batch_act_id" : "1111",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（代理商）",
        "discount" : 1.0
      } ],
      "share_details" : "[]"
    } ]
  },
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "approve_state" : "none",
  "wrh_state" : "initial",
  "customer_note" : "note",
  "seller_note" : "note",
  "salesman" : {
    "id" : "string",
    "name" : "string",
    "type" : "saleman",
    "org" : {
      "id" : "string",
      "name" : "string"
    },
    "org_type" : "门店",
    "inviter_mobile" : "18859226552",
    "inviter_name" : "王x",
    "inviter_wid" : "7567645",
    "personal_guider_name" : "王x",
    "personal_guider_no" : "3242323",
    "personal_guider_wid" : "3242323",
    "trade_guider_name" : "王x",
    "trade_guider_no" : "65756",
    "trade_guider_wid" : "45345",
    "weike_mobile" : "18859226552",
    "weike_name" : "张三",
    "weike_wid" : "765765756"
  },
  "cancel_type" : "customerCancel",
  "cancel_reason" : "我不想要了",
  "source_order_id" : "5346567534545645",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "商品不存在",
  "is_private" : true,
  "item_count" : 1,
  "sku_quantity" : 1.0,
  "real_total" : 120.01,
  "orig_total" : 120.01,
  "user_number" : 2,
  "settle_amount" : 120.01,
  "settle_commission" : 120.01,
  "selttle_commission" : 120.01,
  "settle_freight" : 120.01,
  "performance_service_fee" : 120.01,
  "shop_amount" : 120.01,
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "invoice_take_code" : "string",
  "item_change_records" : [ {
    "reason" : "string",
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "is_gift" : true
    } ],
    "change_items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "is_gift" : true
    } ]
  } ],
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "suspend_info" : {
    "suspended" : true,
    "code" : "string",
    "caption" : "string",
    "time" : "2017-12-26 16:40:19"
  },
  "member_info" : {
    "member_id" : "12253",
    "card_no" : "22323",
    "member_gid" : "12253",
    "outer_member_id" : "12253"
  },
  "fault_tolerant_info" : "string",
  "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0
    }
  },
  "settle_info" : {
    "settlable" : true,
    "discounts" : "[{}]",
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "item_logistics" : [ {
    "qty" : 0.0,
    "sku_id" : "string",
    "logistics_code" : "string"
  } ],
  "calc_data" : true,
  "wrh_id" : "4184",
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string"
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "quotas" : [ {
    "action" : "expect_shipping",
    "time" : "2021-09-26 16:40:19",
    "remark" : "无",
    "action_name" : "期望拣货完成时间"
  } ],
  "reissue_reason" : "string",
  "responsible_party" : "string",
  "mock_info" : {
    "persist" : true
  },
  "adjust_details" : [ {
    "field" : "amount,pay_amount,quantity",
    "before" : "10",
    "after" : "12"
  } ],
  "sale_order_id" : "string"
}
1.17.11.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "string"
}

1.17.12. 取指定订单

GET /{tenant_id}/soms/orderservice/order/{id}
1.17.12.1. 说明

取指定订单，如果需要获取订单商品明细等其他信息，URL需要传parts参数

1.17.12.2. 参数
类型 名称 说明 类型

Path

orderId
必填

订单id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用英文,隔开。需要返回的部分,items(商品详情)、item.details（商品组合详情）,、item.details（商品组合详情）、item.change.records（换货记录）、paymentDetails（支付详情）、invoiceDetails（发票详情）、printBills（打印数据）、prom（促销详情）、crm（营销详情）、logs（日志详情）、waybill.printinfo（运单打印信息）

string
1.17.12.3. 响应
HTTP代码 说明 类型

200

successful operation

Order
1.17.12.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/{id}
1.17.12.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "88822222222",
  "shop" : {
    "id" : "string",
    "name" : "string"
  },
  "source" : "小程序",
  "state" : "confirmed",
  "customer" : {
    "id" : "10001",
    "contact" : {
      "name" : "李飞",
      "telephone" : "189389928893",
      "mobile" : "189389928893",
      "email" : "55151@qq.com",
      "fax" : "123123",
      "private_name" : "脱敏名称**",
      "private_mobile" : "189389928893"
    }
  },
  "weight" : 500.0,
  "invoice" : {
    "required" : false,
    "result" : "开票成功",
    "details" : [ {
      "type" : "plain",
      "kind" : "paper",
      "title" : "XX公司",
      "content" : "上海股份有限公司",
      "amount" : 12.03,
      "tax" : 2.32,
      "account" : "0023415445",
      "telephone" : "12344545111",
      "bank" : "中国银行XXX",
      "address" : "福建厦门XX",
      "remark" : "plain",
      "email" : "chw@qq.com",
      "time" : "2019-07-15 16:56:23",
      "url" : "a.jpg",
      "title_type" : "person",
      "buyer_tax_code" : "1232000046600736XP",
      "taxer_id" : "1212345046600736XP",
      "print_number" : "123456",
      "securaty_code" : "2114445",
      "check_code" : "201622",
      "serial_no" : "454557884564545"
    } ],
    "error_reason" : "string",
    "apply_qrcode" : "string"
  },
  "payment" : {
    "type" : "online",
    "state" : "paid",
    "payee" : {
      "id" : "string",
      "name" : "string"
    },
    "amount" : 14.02,
    "freight" : 14.02,
    "details" : [ {
      "code" : "支付方式代码",
      "name" : "支付宝",
      "amount" : 12.33,
      "cashier" : true,
      "score" : 100.0,
      "flowno" : "3223232323",
      "account_no" : "002002",
      "account_name" : "工行",
      "discount_amount" : 100.0,
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323",
      "extra_info" : "{\"session\", \"123\"}"
    } ],
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "pay_time" : "2019-03-02 12:00:01",
    "pay_bill_id" : "0122333333",
    "cod_amount" : 0.0,
    "earnest_amount" : 0.0,
    "package_total" : 14.02,
    "other_fee" : 0.0
  },
  "delivery" : {
    "type" : "deliver",
    "state" : "none",
    "receiver" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "厦门市",
        "district" : "思明区",
        "street" : "前埔",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      }
    },
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "waybills" : [ {
      "waybill_id" : "123"
    } ],
    "carrier" : {
      "state" : "initial",
      "type" : "self",
      "carrier" : {
        "id" : "string",
        "name" : "string"
      },
      "merchant" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman" : {
        "id" : "string",
        "name" : "string"
      },
      "deliveryman_mobile" : "18859658865",
      "exception_reason" : "异常原因",
      "delivery_id" : "8548418",
      "delivery_name" : "8548418"
    },
    "remark" : "定时达",
    "operation_state" : "none",
    "ship_mode" : "wrhShip",
    "ship_delivery_mode" : "wrhShipCarrierDeli",
    "wrh_order_id" : "32323",
    "ship_id" : "23232323",
    "waybill_id" : "123",
    "carrier_note" : "加快",
    "pre_type" : "normal：正常，dsd：定时达，half_day：半日达",
    "pre_start_delivery_time" : "2016-03-02 12:00:01",
    "pre_end_delivery_time" : "2016-03-02 14:00:01",
    "pickup_code" : "123456",
    "city_token" : "123456",
    "selftake_code" : "123456",
    "pre_selftake_time" : "03月05日 晚上",
    "selftake_confirmed" : true,
    "waybill_print_info" : {
      "datas" : [ {
        "type" : "string",
        "data" : "string"
      } ]
    }
  },
  "front" : {
    "platform" : {
      "id" : "string",
      "name" : "string"
    },
    "app" : {
      "id" : "string",
      "name" : "string"
    },
    "created" : "2016-03-02 12:00:01",
    "modified" : "2016-03-02 12:00:01",
    "state" : "已付款",
    "attribute" : "string",
    "order_id" : "1223654",
    "main_order_id" : "1223432",
    "inner_order_id" : "1223432",
    "dpt_station_time" : "2016-03-02 12:00:01",
    "station_id" : "254145",
    "station_order_no" : "1",
    "order_type" : {
      "id" : "string",
      "name" : "string"
    },
    "wrh_id" : "string"
  },
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "front" : {
      "spec" : "蓝色;微甜  少冰/多糖",
      "spec2" : "500g",
      "unit" : "string",
      "attributes" : [ {
        "group" : "口味",
        "values" : [ "string" ],
        "price" : 0.0,
        "qty" : 0.0
      } ],
      "sku_id" : "052700601",
      "spu_id" : "052700601",
      "item_id" : "052700601"
    },
    "details" : [ {
      "id" : "121212",
      "title" : "矿泉水",
      "quantity" : 4.0,
      "ratio" : 3.0,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "front_spec" : "辣",
      "real_quantity" : 0.0,
      "fault_tolerant_info" : "string",
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ]
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ],
      "discount_amount" : 0.1,
      "apported_discount_amount" : 0.1
    },
    "item_no" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.0,
    "weight" : 1.0,
    "pay_amount" : 2.0,
    "discount_amount" : 12.02,
    "apported_discount_amount" : 12.02,
    "package_qty" : 125.0,
    "package_total" : 205.44,
    "package_info" : {
      "thermosphere" : "string",
      "quantity" : 125.0,
      "total" : 205.44,
      "packageName" : "保温袋"
    },
    "price" : 122.34,
    "cost_price" : 122.34,
    "shop_price" : 122.22,
    "shop_total" : 122.22,
    "settle_price" : 122.2222,
    "settle_total" : 122.22,
    "settle_discountAmount" : 122.22,
    "consume_scores" : 12.2,
    "image_url" : "http://aaa/bbb.png",
    "item_id" : "1",
    "is_collocation" : false,
    "relation_item_id" : "2123",
    "relation_sku_id" : "2123",
    "orig_mas_sku_id" : "string",
    "orig_sku_id" : "121212",
    "orig_item_title" : "【组合】洗护套装",
    "orig_price" : 122.22,
    "orig_qty" : 2.0,
    "orig_barcode" : "1212",
    "orig_image_url" : "string",
    "orig_weight" : 1.0,
    "orig_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "weight" : 0.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "orig_extra_info" : {
      "spec" : "1*1",
      "unit" : "个"
    },
    "fault_tolerant_info" : "string",
    "salesman" : {
      "id" : "string",
      "name" : "string"
    },
    "trace_codes" : [ "string" ],
    "trace_code_details" : [ {
      "batch_no" : "string",
      "code" : "string",
      "valid_date" : "2020-06-17 10:00:00",
      "production_date" : "2020-06-17 10:00:00",
      "qty" : 0.0,
      "qpc_str" : "string"
    } ],
    "extra_info" : "{\"inv_mgr\": false}",
    "tags" : "标签",
    "real_weight" : 0.0,
    "real_quantity" : 0.0,
    "is_gift" : true
  } ],
  "logs" : [ {
    "action" : "modify",
    "message" : "修改订单商品明细",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "tenant_id" : "zuhu",
    "order_id" : "321212222",
    "rtn_id" : "212123333",
    "action_caption" : "修改订单"
  } ],
  "exceptions" : [ {
    "code" : "sku",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "name" : "满减",
      "type" : "string",
      "amount" : 10.5,
      "remark" : "测试优惠",
      "factor" : {
        "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
        "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
        "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
      },
      "sku_act_id" : "1111",
      "merchant_act_id" : "1111",
      "batch_act_id" : "1111",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（代理商）",
        "discount" : 1.0
      } ],
      "share_details" : "[]"
    } ]
  },
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "approve_state" : "none",
  "wrh_state" : "initial",
  "customer_note" : "note",
  "seller_note" : "note",
  "salesman" : {
    "id" : "string",
    "name" : "string",
    "type" : "saleman",
    "org" : {
      "id" : "string",
      "name" : "string"
    },
    "org_type" : "门店",
    "inviter_mobile" : "18859226552",
    "inviter_name" : "王x",
    "inviter_wid" : "7567645",
    "personal_guider_name" : "王x",
    "personal_guider_no" : "3242323",
    "personal_guider_wid" : "3242323",
    "trade_guider_name" : "王x",
    "trade_guider_no" : "65756",
    "trade_guider_wid" : "45345",
    "weike_mobile" : "18859226552",
    "weike_name" : "张三",
    "weike_wid" : "765765756"
  },
  "cancel_type" : "customerCancel",
  "cancel_reason" : "我不想要了",
  "source_order_id" : "5346567534545645",
  "has_exception" : true,
  "exception_codes" : "sku",
  "exception_remark" : "商品不存在",
  "is_private" : true,
  "item_count" : 1,
  "sku_quantity" : 1.0,
  "real_total" : 120.01,
  "orig_total" : 120.01,
  "user_number" : 2,
  "settle_amount" : 120.01,
  "settle_commission" : 120.01,
  "selttle_commission" : 120.01,
  "settle_freight" : 120.01,
  "performance_service_fee" : 120.01,
  "shop_amount" : 120.01,
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "invoice_take_code" : "string",
  "item_change_records" : [ {
    "reason" : "string",
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "is_gift" : true
    } ],
    "change_items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "is_gift" : true
    } ]
  } ],
  "print_bills" : [ {
    "name" : "外卖订单",
    "title" : "外卖订单",
    "content" : "内容",
    "created" : "2020-06-17 10:00:00",
    "printer" : "string",
    "outerId" : "string",
    "deleted" : true,
    "type" : "string",
    "ticket_type" : "小票",
    "deleted_time" : "2020-06-17 10:00:00",
    "sku_id" : "string"
  } ],
  "suspend_info" : {
    "suspended" : true,
    "code" : "string",
    "caption" : "string",
    "time" : "2017-12-26 16:40:19"
  },
  "member_info" : {
    "member_id" : "12253",
    "card_no" : "22323",
    "member_gid" : "12253",
    "outer_member_id" : "12253"
  },
  "fault_tolerant_info" : "string",
  "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
  "crm_info" : {
    "coupon_info" : {
      "details" : "[]",
      "use_total" : 1.0
    },
    "score_info" : {
      "total" : 1.0
    }
  },
  "settle_info" : {
    "settlable" : true,
    "discounts" : "[{}]",
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : "[]",
    "package_type" : "保温袋"
  },
  "item_logistics" : [ {
    "qty" : 0.0,
    "sku_id" : "string",
    "logistics_code" : "string"
  } ],
  "calc_data" : true,
  "wrh_id" : "4184",
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string"
  },
  "tags" : [ {
    "name" : "首单"
  } ],
  "quotas" : [ {
    "action" : "expect_shipping",
    "time" : "2021-09-26 16:40:19",
    "remark" : "无",
    "action_name" : "期望拣货完成时间"
  } ],
  "reissue_reason" : "string",
  "responsible_party" : "string",
  "mock_info" : {
    "persist" : true
  },
  "adjust_details" : [ {
    "field" : "amount,pay_amount,quantity",
    "before" : "10",
    "after" : "12"
  } ],
  "sale_order_id" : "string"
}

1.17.13. 取消订单

POST /{tenant_id}/soms/orderservice/order/{id}/action/cancel
1.17.13.1. 说明

发货前，用户申请取消订单会直接取消订单；发货后用户申请取消订单会自动生成退货订单，退货订单收货后，订单变成客户拒收。

1.17.13.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

取消订单请求对象

CancelOrderRequest
1.17.13.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.17.13.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/cancel?operator=string
请求 body
{
  "type" : "customerCancel",
  "reason" : "不想要了",
  "frontRtnId" : "599565656"
}
1.17.13.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.17.14. 更新订单承运信息

POST /{tenant_id}/soms/orderservice/order/{id}/action/carrier
1.17.14.1. 说明

更新订单承运信息

1.17.14.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

CarrierRequest
1.17.14.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.17.14.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/carrier?operator=string
请求 body
{
  "carrier" : {
    "state" : "initial",
    "type" : "self",
    "carrier" : {
      "id" : "string",
      "name" : "string"
    },
    "merchant" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman_mobile" : "18859658865",
    "exception_reason" : "异常原因",
    "delivery_id" : "8548418",
    "delivery_name" : "8548418"
  },
  "operator" : "user",
  "tags" : [ {
    "name" : "首单"
  } ],
  "waybill_id" : "123",
  "delivery_id" : "123",
  "carrier_note" : "加快",
  "exception_remark" : "第三方要求取消",
  "print_info" : {
    "datas" : [ {
      "type" : "string",
      "data" : "string"
    } ]
  }
}
1.17.14.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.17.15. 更新订单配送状态(发货、签收)

POST /{tenant_id}/soms/orderservice/order/{id}/action/deliver
1.17.15.1. 说明

更新订单配送状态，更新发货：delivery_state=shipped；更新签收：delivery_state=signed

1.17.15.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

DeliverRequest
1.17.15.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.17.15.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/deliver?operator=string
请求 body
{
  "operator" : "zhangsan",
  "operation" : "shipping",
  "carrier" : {
    "state" : "initial",
    "type" : "self",
    "carrier" : {
      "id" : "string",
      "name" : "string"
    },
    "merchant" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman_mobile" : "18859658865",
    "exception_reason" : "异常原因",
    "delivery_id" : "8548418",
    "delivery_name" : "8548418"
  },
  "print" : true,
  "delivery_state" : "none",
  "operation_state" : "none（空）、accepted（已接单）、shipping（ 已集货/已拣货）、rechecked（已复核）、handover（已交接）",
  "ship_id" : "122323232",
  "waybill_id" : "1243566215",
  "carrier_note" : "已经在发货的路上",
  "selftake_confirmed" : true,
  "front_modified" : "2016-03-02 12:00:01",
  "ship_time" : "2022-07-18 20:34:00"
}
1.17.15.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.17.16. 确认自提

POST /{tenant_id}/soms/orderservice/order/{id}/action/selftake
1.17.16.1. 说明

确认自提

1.17.16.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

OrderSelftakeRequest
1.17.16.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderSelftakeV2Response
1.17.16.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/selftake?operator=string
请求 body
{
  "store_id" : "454534",
  "selftake_qrcode" : "222222"
}
1.17.16.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "5745323545453"
}

1.17.17. 更新订单订单门店作业状态

POST /{tenant_id}/soms/orderservice/order/{id}/action/storeoperation
1.17.17.1. 说明

更新订单门店作业状态

1.17.17.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

门店作业请求

StoreOperationRequest
1.17.17.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.17.17.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/storeoperation?operator=string
请求 body
{
  "operation" : "accept",
  "store_id" : "21213323",
  "operation_state" : "none（空）、accepted（已接单）、shipping（ 已集货/已拣货）、rechecked（已复核）、handover（已交接）"
}
1.17.17.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.17.18. 商家主动发起退款

POST /{tenant_id}/soms/orderservice/order/{id}/applyrtn
1.17.18.1. 说明

商家主动发起退款

1.17.18.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

申请请求对象

OrderApplyRtnRequest
1.17.18.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderApplyRtnResponse
1.17.18.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/applyrtn?operator=string
请求 body
{
  "reason" : "不想要了",
  "type" : "refund",
  "policy" : "取值：orig_sku(原商品)、sku(现商品)",
  "items" : [ {
    "quantity" : 1.0,
    "weight" : 1.0,
    "weights" : "1",
    "item_no" : "1",
    "sku_id" : "2123",
    "refund_amount" : 12.03
  } ],
  "front_app" : {
    "id" : "string",
    "name" : "string"
  },
  "rtn_id" : "54132321623",
  "apply_type" : "weight_diff",
  "approve_state" : "none"
}
1.17.18.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "apply_id" : "申请幂等ID",
  "apply_ids" : "多个申请幂等ID"
}

1.17.19. 取消承运商配送申请

POST /{tenant_id}/soms/orderservice/order/{id}/cancel/carrier
1.17.19.1. 说明

取消承运商配送申请

1.17.19.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

取消承运商调度请求

CancelCarrierRequest
1.17.19.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.17.19.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/cancel/carrier?operator=string
请求 body
{
  "reason" : "客户不要了",
  "carrier_id" : "343434343",
  "auto_dispatch" : true
}
1.17.19.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.17.20. 更新开票结果

POST /{tenant_id}/soms/orderservice/order/{id}/invoice/result
1.17.20.1. 说明

更新开票结果

1.17.20.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

发票结果更新请求对象

OrderInvoiceResultRequest
1.17.20.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.17.20.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/invoice/result?operator=string
请求 body
{
  "time" : "2019-07-15 16:56:23",
  "url" : "a.jpg",
  "result" : "开票成功",
  "error_reason" : "系统异常",
  "serial_no" : "45546454454",
  "apply_qrcode" : "string"
}
1.17.20.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.17.21. 更新开票

POST /{tenant_id}/soms/orderservice/order/{id}/invoices
1.17.21.1. 说明

更新开票

1.17.21.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

发票更新请求对象

OrderInvoiceRequest
1.17.21.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.17.21.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/invoices?operator=string
请求 body
{
  "invoice" : {
    "required" : false,
    "result" : "开票成功",
    "details" : [ {
      "type" : "plain",
      "kind" : "paper",
      "title" : "XX公司",
      "content" : "上海股份有限公司",
      "amount" : 12.03,
      "tax" : 2.32,
      "account" : "0023415445",
      "telephone" : "12344545111",
      "bank" : "中国银行XXX",
      "address" : "福建厦门XX",
      "remark" : "plain",
      "email" : "chw@qq.com",
      "time" : "2019-07-15 16:56:23",
      "url" : "a.jpg",
      "title_type" : "person",
      "buyer_tax_code" : "1232000046600736XP",
      "taxer_id" : "1212345046600736XP",
      "print_number" : "123456",
      "securaty_code" : "2114445",
      "check_code" : "201622",
      "serial_no" : "454557884564545"
    } ],
    "error_reason" : "string",
    "apply_qrcode" : "string"
  }
}
1.17.21.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.17.22. 获取快递订单物流轨迹信息

GET /{tenant_id}/soms/orderservice/order/{id}/kd/trace
1.17.22.1. 说明

获取快递订单物流轨迹信息,支持快递100

1.17.22.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string
1.17.22.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderKdTrace
1.17.22.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/kd/trace?operator=string
1.17.22.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "state" : "canceled",
  "carrier" : {
    "id" : "string",
    "name" : "string"
  },
  "details" : [ {
    "time" : "2022-04-07 08:39:07",
    "address" : "福建,厦门市",
    "message" : "顺丰速运 已收取快件",
    "status" : "在途"
  } ],
  "waybill_id" : "213232"
}

1.17.23. 更换承运商

POST /{tenant_id}/soms/orderservice/order/{id}/mod/carrier
1.17.23.1. 说明

更换承运商

1.17.23.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

承运商修改请求

CarrierModificationRequest
1.17.23.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.17.23.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/mod/carrier?operator=string
请求 body
{
  "type" : "self",
  "carrier" : {
    "id" : "string",
    "name" : "string"
  },
  "merchant" : {
    "id" : "string",
    "name" : "string"
  },
  "deliveryman_id" : "32332",
  "deliveryman_name" : "李某",
  "deliveryman_mobile" : "1565586545"
}
1.17.23.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.17.24. 订单付款

POST /{tenant_id}/soms/orderservice/order/{id}/pay
1.17.24.1. 说明

订单付款

1.17.24.2. 参数
类型 名称 说明 类型

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

支付请求对象

PayRequest
1.17.24.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.17.24.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/pay?operator=string
请求 body
{
  "payee" : {
    "id" : "string",
    "name" : "string"
  },
  "details" : [ {
    "code" : "支付方式代码",
    "name" : "支付宝",
    "amount" : 12.33,
    "cashier" : true,
    "score" : 100.0,
    "flowno" : "3223232323",
    "account_no" : "002002",
    "account_name" : "工行",
    "discount_amount" : 100.0,
    "pay_id" : "3223232323",
    "out_pay_id" : "3223232323",
    "extra_info" : "{\"session\", \"123\"}"
  } ],
  "pay_state" : "paid",
  "pay_time" : "2019-12-12 12:12:00",
  "pay_bill_id" : "123434354"
}
1.17.24.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.17.25. 查询订单（ES查询）

POST /{tenant_id}/soms/orderservice/orders/query
1.17.25.1. 说明

查询订单（ES查询，推荐使用）

1.17.25.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page
必填

页码，从0开始，必须>=0

integer (int32)

Query

page_size
必填

分页大小，范围是[1,100]

integer (int32)

Query

sort_key
可选

排序字段，取值范围:front_created()、created(创建时间)、modified(最后修改时间)

string

Body

filter
必填

查询条件

OrderFilter
1.17.25.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderPaging
1.17.25.4. HTTP请求示例
请求 path
/string/soms/orderservice/orders/query?desc=true&page=0&page_size=0
请求 body
{
  "states" : [ "confirmed" ],
  "suspended" : true,
  "source" : "小程序",
  "prePage" : 0,
  "customerMobile" : "18896551546",
  "hasInvoice" : false,
  "invalid" : false,
  "platform_id" : "jdo2o",
  "platform_ids" : [ "string" ],
  "shop_id" : "0002",
  "pre_type" : "normal",
  "station_ids" : [ "string" ],
  "approve_states" : [ "none" ],
  "delivery_states" : [ "none" ],
  "delivery_types" : [ "selftake" ],
  "carrier_states" : [ "initial" ],
  "carrier_types" : [ "self" ],
  "payment_states" : [ "notPay" ],
  "payment_types" : [ "cod" ],
  "payment_out_pay_id" : "string",
  "receiver_mobile" : "18857485554",
  "receiver_mobile_like" : "5554",
  "receiver_name" : "张三",
  "carrier_id" : "0003",
  "waybill_id" : "0003",
  "front_order_id" : "32323232323323",
  "front_order_id_prefix" : "32323232323323",
  "front_order_ids" : "32323232323323",
  "front_created_start" : "2016-03-02 12:00:01",
  "front_created_end" : "2016-03-02 12:00:01",
  "created_start" : "2016-03-02 12:00:01",
  "created_end" : "2016-03-02 12:00:01",
  "modified_start" : "2016-03-02 12:00:01",
  "modified_end" : "2016-03-02 12:00:01",
  "cancel_type" : "customerCancel",
  "have_return" : true,
  "refund_state" : "none",
  "operation_state" : "none",
  "operation_states" : "[none,shipping]",
  "operation_shipping_time_start" : "2016-03-02 12:00:01",
  "operation_shipping_time_end" : "2016-03-02 12:00:01",
  "operation_handover_time_start" : "2016-03-02 12:00:01",
  "operation_handover_time_end" : "2016-03-02 12:00:01",
  "order_id" : "1000002111",
  "order_ids" : [ "string" ],
  "customer_name" : "张三",
  "customer_id" : "8568",
  "shipping_operator" : "张三",
  "handover_operator" : "张三",
  "address_contains" : "福建省",
  "delivered_time_start" : "2016-03-02 12:00:01",
  "delivered_time_end" : "2016-03-02 12:00:01",
  "delivering_time_start" : "2016-03-02 12:00:01",
  "delivering_time_end" : "2016-03-02 12:00:01",
  "deliveryman_name" : "张三",
  "delivery_id" : "111",
  "product_contains" : "sku1111",
  "sku_title" : "冰红茶",
  "has_exception" : false,
  "exception_code_contains" : "false",
  "selftake_code" : "123456",
  "index_modified_start" : "2016-03-02 12:00:01",
  "index_modified_end" : "2016-03-02 12:00:01",
  "has_billing" : true,
  "bill_id_like" : "32323",
  "bill_id_eq" : "3232323",
  "custom_order_state" : [ "string" ],
  "salesman_id_eq" : "3232323",
  "app_id_eq" : "3232323",
  "type_eq" : "拼团订单",
  "has_delivery_exception" : true,
  "front_main_order_id_eq" : "1223432",
  "front_main_order_id_start_with" : "1223432",
  "front_main_order_id_in" : "['123'，'456']",
  "front_sku_id" : "string",
  "sku_id" : "string",
  "sku_id_in" : "[\"sku1\", \"sku2\"]",
  "source_order_id_eq" : "213",
  "source_order_id_in" : [ "string" ],
  "wrh_id_start_with" : "3232323",
  "wrh_id_in" : "3232323",
  "vendor_code_eq" : "3232323",
  "vendor_code_start_with" : "3232323",
  "vendor_code_in" : "3232323",
  "ship_mode" : "string",
  "deliver_shipped_operator" : "rs",
  "prom_id" : "string",
  "prom_id_in" : [ "string" ],
  "prom_key" : "string",
  "prom_key_in" : [ "string" ],
  "prom_name_like" : "string"
}
1.17.25.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "orders" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "88822222222",
    "shop" : {
      "id" : "string",
      "name" : "string"
    },
    "source" : "小程序",
    "state" : "confirmed",
    "customer" : {
      "id" : "10001",
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      }
    },
    "weight" : 500.0,
    "invoice" : {
      "required" : false,
      "result" : "开票成功",
      "details" : [ {
        "type" : "plain",
        "kind" : "paper",
        "title" : "XX公司",
        "content" : "上海股份有限公司",
        "amount" : 12.03,
        "tax" : 2.32,
        "account" : "0023415445",
        "telephone" : "12344545111",
        "bank" : "中国银行XXX",
        "address" : "福建厦门XX",
        "remark" : "plain",
        "email" : "chw@qq.com",
        "time" : "2019-07-15 16:56:23",
        "url" : "a.jpg",
        "title_type" : "person",
        "buyer_tax_code" : "1232000046600736XP",
        "taxer_id" : "1212345046600736XP",
        "print_number" : "123456",
        "securaty_code" : "2114445",
        "check_code" : "201622",
        "serial_no" : "454557884564545"
      } ],
      "error_reason" : "string",
      "apply_qrcode" : "string"
    },
    "payment" : {
      "type" : "online",
      "state" : "paid",
      "payee" : {
        "id" : "string",
        "name" : "string"
      },
      "amount" : 14.02,
      "freight" : 14.02,
      "details" : [ {
        "code" : "支付方式代码",
        "name" : "支付宝",
        "amount" : 12.33,
        "cashier" : true,
        "score" : 100.0,
        "flowno" : "3223232323",
        "account_no" : "002002",
        "account_name" : "工行",
        "discount_amount" : 100.0,
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323",
        "extra_info" : "{\"session\", \"123\"}"
      } ],
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "pay_time" : "2019-03-02 12:00:01",
      "pay_bill_id" : "0122333333",
      "cod_amount" : 0.0,
      "earnest_amount" : 0.0,
      "package_total" : 14.02,
      "other_fee" : 0.0
    },
    "delivery" : {
      "type" : "deliver",
      "state" : "none",
      "receiver" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "厦门市",
          "district" : "思明区",
          "street" : "前埔",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        }
      },
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "vendor" : {
        "code" : "string",
        "name" : "string"
      },
      "wrh" : {
        "code" : "string",
        "name" : "string"
      },
      "waybills" : [ {
        "waybill_id" : "123"
      } ],
      "carrier" : {
        "state" : "initial",
        "type" : "self",
        "carrier" : {
          "id" : "string",
          "name" : "string"
        },
        "merchant" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman" : {
          "id" : "string",
          "name" : "string"
        },
        "deliveryman_mobile" : "18859658865",
        "exception_reason" : "异常原因",
        "delivery_id" : "8548418",
        "delivery_name" : "8548418"
      },
      "remark" : "定时达",
      "operation_state" : "none",
      "ship_mode" : "wrhShip",
      "ship_delivery_mode" : "wrhShipCarrierDeli",
      "wrh_order_id" : "32323",
      "ship_id" : "23232323",
      "waybill_id" : "123",
      "carrier_note" : "加快",
      "pre_type" : "normal：正常，dsd：定时达，half_day：半日达",
      "pre_start_delivery_time" : "2016-03-02 12:00:01",
      "pre_end_delivery_time" : "2016-03-02 14:00:01",
      "pickup_code" : "123456",
      "city_token" : "123456",
      "selftake_code" : "123456",
      "pre_selftake_time" : "03月05日 晚上",
      "selftake_confirmed" : true,
      "waybill_print_info" : {
        "datas" : [ {
          "type" : "string",
          "data" : "string"
        } ]
      }
    },
    "front" : {
      "platform" : {
        "id" : "string",
        "name" : "string"
      },
      "app" : {
        "id" : "string",
        "name" : "string"
      },
      "created" : "2016-03-02 12:00:01",
      "modified" : "2016-03-02 12:00:01",
      "state" : "已付款",
      "attribute" : "string",
      "order_id" : "1223654",
      "main_order_id" : "1223432",
      "inner_order_id" : "1223432",
      "dpt_station_time" : "2016-03-02 12:00:01",
      "station_id" : "254145",
      "station_order_no" : "1",
      "order_type" : {
        "id" : "string",
        "name" : "string"
      },
      "wrh_id" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "attributes" : [ {
          "group" : "口味",
          "values" : [ "string" ],
          "price" : 0.0,
          "qty" : 0.0
        } ],
        "sku_id" : "052700601",
        "spu_id" : "052700601",
        "item_id" : "052700601"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "front_spec" : "辣",
        "real_quantity" : 0.0,
        "fault_tolerant_info" : "string",
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ]
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "name" : "满减",
          "type" : "string",
          "amount" : 10.5,
          "remark" : "测试优惠",
          "factor" : {
            "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
            "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
            "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
          },
          "sku_act_id" : "1111",
          "merchant_act_id" : "1111",
          "batch_act_id" : "1111",
          "prom_cls" : "string",
          "voucher_code" : "111111111",
          "settle_details" : [ {
            "role" : "shop（商家）、platform（平台）、agent（代理商）",
            "discount" : 1.0
          } ],
          "share_details" : "[]"
        } ],
        "discount_amount" : 0.1,
        "apported_discount_amount" : 0.1
      },
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.0,
      "weight" : 1.0,
      "pay_amount" : 2.0,
      "discount_amount" : 12.02,
      "apported_discount_amount" : 12.02,
      "package_qty" : 125.0,
      "package_total" : 205.44,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋"
      },
      "price" : 122.34,
      "cost_price" : 122.34,
      "shop_price" : 122.22,
      "shop_total" : 122.22,
      "settle_price" : 122.2222,
      "settle_total" : 122.22,
      "settle_discountAmount" : 122.22,
      "consume_scores" : 12.2,
      "image_url" : "http://aaa/bbb.png",
      "item_id" : "1",
      "is_collocation" : false,
      "relation_item_id" : "2123",
      "relation_sku_id" : "2123",
      "orig_mas_sku_id" : "string",
      "orig_sku_id" : "121212",
      "orig_item_title" : "【组合】洗护套装",
      "orig_price" : 122.22,
      "orig_qty" : 2.0,
      "orig_barcode" : "1212",
      "orig_image_url" : "string",
      "orig_weight" : 1.0,
      "orig_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "weight" : 0.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "orig_extra_info" : {
        "spec" : "1*1",
        "unit" : "个"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "trace_codes" : [ "string" ],
      "trace_code_details" : [ {
        "batch_no" : "string",
        "code" : "string",
        "valid_date" : "2020-06-17 10:00:00",
        "production_date" : "2020-06-17 10:00:00",
        "qty" : 0.0,
        "qpc_str" : "string"
      } ],
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "real_weight" : 0.0,
      "real_quantity" : 0.0,
      "is_gift" : true
    } ],
    "logs" : [ {
      "action" : "modify",
      "message" : "修改订单商品明细",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "tenant_id" : "zuhu",
      "order_id" : "321212222",
      "rtn_id" : "212123333",
      "action_caption" : "修改订单"
    } ],
    "exceptions" : [ {
      "code" : "sku",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "name" : "满减",
        "type" : "string",
        "amount" : 10.5,
        "remark" : "测试优惠",
        "factor" : {
          "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
          "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
          "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
        },
        "sku_act_id" : "1111",
        "merchant_act_id" : "1111",
        "batch_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（代理商）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "wrh_state" : "initial",
    "customer_note" : "note",
    "seller_note" : "note",
    "salesman" : {
      "id" : "string",
      "name" : "string",
      "type" : "saleman",
      "org" : {
        "id" : "string",
        "name" : "string"
      },
      "org_type" : "门店",
      "inviter_mobile" : "18859226552",
      "inviter_name" : "王x",
      "inviter_wid" : "7567645",
      "personal_guider_name" : "王x",
      "personal_guider_no" : "3242323",
      "personal_guider_wid" : "3242323",
      "trade_guider_name" : "王x",
      "trade_guider_no" : "65756",
      "trade_guider_wid" : "45345",
      "weike_mobile" : "18859226552",
      "weike_name" : "张三",
      "weike_wid" : "765765756"
    },
    "cancel_type" : "customerCancel",
    "cancel_reason" : "我不想要了",
    "source_order_id" : "5346567534545645",
    "has_exception" : true,
    "exception_codes" : "sku",
    "exception_remark" : "商品不存在",
    "is_private" : true,
    "item_count" : 1,
    "sku_quantity" : 1.0,
    "real_total" : 120.01,
    "orig_total" : 120.01,
    "user_number" : 2,
    "settle_amount" : 120.01,
    "settle_commission" : 120.01,
    "selttle_commission" : 120.01,
    "settle_freight" : 120.01,
    "performance_service_fee" : 120.01,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "invoice_take_code" : "string",
    "item_change_records" : [ {
      "reason" : "string",
      "items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "string"
          } ]
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "name" : "满减",
            "type" : "string",
            "amount" : 10.5,
            "remark" : "测试优惠",
            "factor" : {
              "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
              "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
              "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
            },
            "sku_act_id" : "1111",
            "merchant_act_id" : "1111",
            "batch_act_id" : "1111",
            "prom_cls" : "string",
            "voucher_code" : "111111111",
            "settle_details" : [ {
              "role" : "shop（商家）、platform（平台）、agent（代理商）",
              "discount" : 1.0
            } ],
            "share_details" : "[]"
          } ],
          "discount_amount" : 0.1,
          "apported_discount_amount" : 0.1
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "is_gift" : true
      } ],
      "change_items" : [ {
        "uuid" : "string",
        "spec" : "1*1",
        "unit" : "瓶",
        "barcode" : "123456",
        "quantity" : 1.0,
        "total" : 2.0,
        "front" : {
          "spec" : "蓝色;微甜  少冰/多糖",
          "spec2" : "500g",
          "unit" : "string",
          "attributes" : [ {
            "group" : "口味",
            "values" : [ "string" ],
            "price" : 0.0,
            "qty" : 0.0
          } ],
          "sku_id" : "052700601",
          "spu_id" : "052700601",
          "item_id" : "052700601"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋"
          },
          "front_spec" : "辣",
          "real_quantity" : 0.0,
          "fault_tolerant_info" : "string",
          "trace_codes" : [ "string" ],
          "trace_code_details" : [ {
            "batch_no" : "string",
            "code" : "string",
            "valid_date" : "2020-06-17 10:00:00",
            "production_date" : "2020-06-17 10:00:00",
            "qty" : 0.0,
            "qpc_str" : "string"
          } ]
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "name" : "满减",
            "type" : "string",
            "amount" : 10.5,
            "remark" : "测试优惠",
            "factor" : {
              "total" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20",
              "qty" : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1",
              "sku_items" : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"
            },
            "sku_act_id" : "1111",
            "merchant_act_id" : "1111",
            "batch_act_id" : "1111",
            "prom_cls" : "string",
            "voucher_code" : "111111111",
            "settle_details" : [ {
              "role" : "shop（商家）、platform（平台）、agent（代理商）",
              "discount" : 1.0
            } ],
            "share_details" : "[]"
          } ],
          "discount_amount" : 0.1,
          "apported_discount_amount" : 0.1
        },
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.0,
        "weight" : 1.0,
        "pay_amount" : 2.0,
        "discount_amount" : 12.02,
        "apported_discount_amount" : 12.02,
        "package_qty" : 125.0,
        "package_total" : 205.44,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋"
        },
        "price" : 122.34,
        "cost_price" : 122.34,
        "shop_price" : 122.22,
        "shop_total" : 122.22,
        "settle_price" : 122.2222,
        "settle_total" : 122.22,
        "settle_discountAmount" : 122.22,
        "consume_scores" : 12.2,
        "image_url" : "http://aaa/bbb.png",
        "item_id" : "1",
        "is_collocation" : false,
        "relation_item_id" : "2123",
        "relation_sku_id" : "2123",
        "orig_mas_sku_id" : "string",
        "orig_sku_id" : "121212",
        "orig_item_title" : "【组合】洗护套装",
        "orig_price" : 122.22,
        "orig_qty" : 2.0,
        "orig_barcode" : "1212",
        "orig_image_url" : "string",
        "orig_weight" : 1.0,
        "orig_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "weight" : 0.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "orig_extra_info" : {
          "spec" : "1*1",
          "unit" : "个"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "trace_codes" : [ "string" ],
        "trace_code_details" : [ {
          "batch_no" : "string",
          "code" : "string",
          "valid_date" : "2020-06-17 10:00:00",
          "production_date" : "2020-06-17 10:00:00",
          "qty" : 0.0,
          "qpc_str" : "string"
        } ],
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "real_weight" : 0.0,
        "real_quantity" : 0.0,
        "is_gift" : true
      } ]
    } ],
    "print_bills" : [ {
      "name" : "外卖订单",
      "title" : "外卖订单",
      "content" : "内容",
      "created" : "2020-06-17 10:00:00",
      "printer" : "string",
      "outerId" : "string",
      "deleted" : true,
      "type" : "string",
      "ticket_type" : "小票",
      "deleted_time" : "2020-06-17 10:00:00",
      "sku_id" : "string"
    } ],
    "suspend_info" : {
      "suspended" : true,
      "code" : "string",
      "caption" : "string",
      "time" : "2017-12-26 16:40:19"
    },
    "member_info" : {
      "member_id" : "12253",
      "card_no" : "22323",
      "member_gid" : "12253",
      "outer_member_id" : "12253"
    },
    "fault_tolerant_info" : "string",
    "extra_info" : "{\"lcUserAccessToken\", \"123\"}",
    "crm_info" : {
      "coupon_info" : {
        "details" : "[]",
        "use_total" : 1.0
      },
      "score_info" : {
        "total" : 1.0
      }
    },
    "settle_info" : {
      "settlable" : true,
      "discounts" : "[{}]",
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : "[]",
      "package_type" : "保温袋"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string"
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "quotas" : [ {
      "action" : "expect_shipping",
      "time" : "2021-09-26 16:40:19",
      "remark" : "无",
      "action_name" : "期望拣货完成时间"
    } ],
    "reissue_reason" : "string",
    "responsible_party" : "string",
    "mock_info" : {
      "persist" : true
    },
    "adjust_details" : [ {
      "field" : "amount,pay_amount,quantity",
      "before" : "10",
      "after" : "12"
    } ],
    "sale_order_id" : "string"
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.18. 门店作业规则服务

1.18.1. 查询门店作业规则服务

POST /{tenant_id}/soms/storeoperationruleservice/rule
1.18.1.1. 说明

查询门店作业规则服务

1.18.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

desc
必填

升序、降序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

每页条数

integer (int32)

Query

sort_key
必填

排序字段

string

Body

store_operation_rule_filter
必填

过滤条件

StoreOperationRuleFilter
1.18.1.3. 响应
HTTP代码 说明 类型

200

successful operation

< StoreOperationRule > array
1.18.1.4. HTTP请求示例
请求 path
/string/soms/storeoperationruleservice/rule?desc=true&page=0&page_size=0&sort_key=string
请求 body
{
  "typeEq" : "string",
  "platformIdEq" : "string",
  "shopIdEq" : "string",
  "storeIdEq" : "string",
  "storeIdIn" : [ "string" ],
  "stateEq" : "string"
}
1.18.1.5. HTTP响应示例
响应 200
[ {
  "type" : "string",
  "platform_id" : "33454",
  "shop_id" : "33454",
  "store_id" : "33454",
  "state" : "applying",
  "def" : {
    "rtn_rule" : {
      "allow_part_refund" : true,
      "allow_float" : true,
      "manual_receive" : true
    }
  },
  "source" : "string"
} ]

1.18.2. 获取门店作业规则

GET /{tenant_id}/soms/storeoperationruleservice/rule
1.18.2.1. 说明

获取门店作业规则

1.18.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

platform_id
必填

平台ID

string

Query

shop_id
必填

商家代码

string

Query

store_id
必填

门店代码

string

Query

type
必填

规则：storeRtnRule（门店退单规则）

string
1.18.2.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreOperationRule
1.18.2.4. HTTP请求示例
请求 path
/string/soms/storeoperationruleservice/rule?platform_id=string&shop_id=string&store_id=string&type=string
1.18.2.5. HTTP响应示例
响应 200
{
  "type" : "string",
  "platform_id" : "33454",
  "shop_id" : "33454",
  "store_id" : "33454",
  "state" : "applying",
  "def" : {
    "rtn_rule" : {
      "allow_part_refund" : true,
      "allow_float" : true,
      "manual_receive" : true
    }
  },
  "source" : "string"
}

1.18.3. 删除门店作业规则

DELETE /{tenant_id}/soms/storeoperationruleservice/rule/delete
1.18.3.1. 说明

删除门店作业规则

1.18.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

platform_id
必填

平台ID

string

Query

shop_id
必填

商家代码

string

Query

store_id
必填

门店代码

string

Query

type
必填

规则：storeRtnRule（门店退单规则）

string
1.18.3.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.18.3.4. HTTP请求示例
请求 path
/string/soms/storeoperationruleservice/rule/delete?platform_id=string&shop_id=string&store_id=string&type=string

1.18.4. 保存门店作业规则

POST /{tenant_id}/soms/storeoperationruleservice/rule/save
1.18.4.1. 说明

保存门店作业规则

1.18.4.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

store_operation_rule_save
必填

自提规则

StoreOperationRuleSave
1.18.4.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.18.4.4. HTTP请求示例
请求 path
/string/soms/storeoperationruleservice/rule/save?operator=string
请求 body
{
  "platform_id" : "33454",
  "type" : "33454",
  "shop_id" : "storeRtnRule",
  "store_id" : "0001",
  "def" : {
    "rtn_rule" : {
      "allow_part_refund" : true,
      "allow_float" : true,
      "manual_receive" : true
    }
  }
}

2. 定义

2.1. ActionResult

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.2. Address

地址信息

名称 说明 类型

city
可选

市
样例 : "厦门市"

string

coordinate_type
可选

坐标类型，BD09：百度坐标， GCJ02：火星坐标，WGS84：WGS84坐标
样例 : "GCJ02"

string

country
可选

国家
样例 : "中国"

string

district
可选

区
样例 : "思明区"

string

latitude
可选

纬度
样例 : "45.3,范围0-90"

number

longtitude
可选

经度
样例 : "121.2,范围0-180"

number

postcode
可选

邮编
样例 : "363423"

string

private_street
可选

脱敏地址
样例 : "脱敏地址**"

string

province
可选

省份
样例 : "福建省"

string

street
可选

详细地址
样例 : "前埔"

string

2.3. AdjustDetail

名称 说明 类型

after
可选

调整后
样例 : "12"

string

before
可选

调整前
样例 : "10"

string

field
可选

调整字段
样例 : "amount,pay_amount,quantity"

string

2.4. Brand

品牌资料

名称 说明 类型

id
必填

品牌标识
样例 : "3434343434"

string

name
必填

名称
样例 : "耐克"

string

parentId
可选

父品牌ID
样例 : "324232"

string

remark
可选

备注
样例 : "无"

string

2.5. BrandFilter

品牌查询过滤器

名称 说明 类型

ids
可选

品牌ID集合
样例 : [ "string" ]

< string > array

key_like
可选

主键(id,name)类似于，常用于模糊搜索
样例 : "aaa"

string

modified_end
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modified_start
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

name_like
可选

名称类似于
样例 : "aaa"

string

parent_id
可选

父品牌ID等于
样例 : "aaa"

string

parent_id_is_null
可选

父节点是否空
默认值 : false
样例 : false

boolean

parent_ids
可选

父品牌ID集合
样例 : [ "string" ]

< string > array

2.6. BrandList

品牌列表

名称 说明 类型

brands
可选

品牌列表集合
样例 : [ "Brand" ]

< Brand > array

2.7. BrandPaging

品牌查询过滤器

名称 说明 类型

brands
可选

品牌列表
样例 : [ "Brand" ]

< Brand > array

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

2.8. CRMInfo

会员权益信息

名称 说明 类型

coupon_info
可选

券信息
样例 : CouponInfo

CouponInfo

score_info
可选

积分信息
样例 : ScoreInfo

ScoreInfo

2.9. CRMInfoModificationRequest

名称 说明 类型

score
可选

样例 : 0.0

number

2.10. CancelCarrierRequest

取消承运商配送请求对象

名称 说明 类型

auto_dispatch
可选

是否自动调度到下一个承运商，默认为false
默认值 : false
样例 : true

boolean

carrier_id
必填

承运商Id
样例 : "343434343"

string

reason
可选

原因
样例 : "客户不要了"

string

2.11. CancelOrderRequest

取消订单请求

名称 说明 类型

frontRtnId
可选

平台退单号
样例 : "599565656"

string

reason
可选

取消原因
样例 : "不想要了"

string

type
可选

取消类型,取值为stationRefuse（门店拒接）、customerCancel（客户取消）、refused（客户拒接）
样例 : "customerCancel"

string

2.12. CancelRtnRequest

取消退货请求对象

名称 说明 类型

approve_state
可选

样例 : "none"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

operator_role
可选

样例 : "string"

string

reason
可选

取消原因
样例 : "我不想要了"

string

sellerInfo
可选

收货失败：原因/凭证
样例 : SellerInfo

SellerInfo

2.13. Carrier

承运商

名称 说明 类型

carrier
可选

承运平台
样例 : IdName

IdName

delivery_id
可选

配送活动标识
样例 : "8548418"

string

delivery_name
可选

配送活动名称
样例 : "8548418"

string

deliveryman
可选

送货员
样例 : IdName

IdName

deliveryman_mobile
可选

送货员手机
样例 : "18859658865"

string

exception_reason
可选

承运异常原因
样例 : "异常原因"

string

merchant
可选

承运商家
样例 : IdName

IdName

state
可选

承运状态，取值范围:initial(初始状态)、created(已下发)、createdFailed（下发失败）、dispatched(已派单)、pickup(已揽件)、pickupFailed(揽件失败)、delivering（配送中）、delivered（配送完成）、canceled（已取消）
样例 : "initial"

enum (initial, created, dispatched, createdFailed, pickup, pickupFailed, delivering, delivered, canceled)

type
可选

承运商类型，取值范围:self(门店自送)、thirdparty(第三方配送)、express（快递配送）
样例 : "self"

enum (self, thirdparty, express)

2.14. CarrierModificationRequest

承运商修改请求对象

名称 说明 类型

carrier
可选

承运商
样例 : IdName

IdName

deliveryman_id
可选

配送员Id
样例 : "32332"

string

deliveryman_mobile
可选

配送员电话
样例 : "1565586545"

string

deliveryman_name
可选

配送员名称
样例 : "李某"

string

merchant
可选

承运商家
样例 : IdName

IdName

type
可选

承运类型： self（门店自送）、thirdparty（平台配送）、express（快递配送）
样例 : "self"

enum (self, thirdparty, express)

2.15. CarrierRequest

更新订单承运商物流状态

名称 说明 类型

carrier
必填

承运商
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "加快"

string

delivery_id
可选

配送ID
样例 : "123"

string

exception_remark
可选

承运异常备注
样例 : "第三方要求取消"

string

operator
可选

操作人
样例 : "user"

string

print_info
可选

运单打印信息
样例 : WaybillPrintInfo

WaybillPrintInfo

tags
可选

标签，会给订单加上标签，已有的标签不会重复添加
样例 : [ "OrderTag" ]

< OrderTag > array

waybill_id
可选

运单号
样例 : "123"

string

2.16. CarrierScheme

配送方案

名称 说明 类型

carrierMerchantId
可选

承运商家选择
样例 : "meituan"

string

freight
可选

基础运费
样例 : 2.0

number

freightDecs
可选

运费扣减
样例 : [ "FreightDeduction" ]

< FreightDeduction > array

freightIncs
可选

动态定价
样例 : [ "FreightIncrement" ]

< FreightIncrement > array

maxWeight
可选

重量限制,单位g
样例 : 2.0

number

minAmount
可选

起送金额
样例 : 5.25

number

packageAmount
可选

包装费
样例 : 0.0

number

scope
可选

配送范围,获取门店配送方案（门店维度）级联出配送范围
样例 : CarrierScope

CarrierScope

scopeSource
必填

配送范围来源：meituan（美团快递）…
样例 : "meituan"

string

selectCoordinate
可选

配送范围选择range_no
样例 : "1,2"

string

selfOrderNoFeight
可选

自提订单免起送价
默认值 : false
样例 : true

boolean

selfPackageAmount
可选

自提包装费
样例 : 0.0

number

2.17. CarrierSchemeFilter

配送方案过滤器

名称 说明 类型

scopeSource
必填

配送范围来源：fengniao、meituan
样例 : "fengniao"

string

storeId
必填

门店ID
样例 : "0001"

string

2.18. CarrierSchemeRule

门店配送方案规则

名称 说明 类型

platformId
必填

平台ID
样例 : "meituan"

string

schemes
可选

配送方案列表
样例 : [ "CarrierScheme" ]

< CarrierScheme > array

shopId
必填

平台商家ID
样例 : "3243"

string

source
可选

来源：store(门店)、shop（商家），可能为空,保存不需要传，获取时该字段区分方案的维度
样例 : "store"

string

state
必填

状态：applying（开通中）、opened（已开通）
样例 : "applying"

enum (applying, opened)

storeId
必填

门店ID
样例 : "32345355"

string

2.19. CarrierScope

承运范围

名称 说明 类型

carrierId
可选

承运商ID
样例 : "meituan"

string

carrierMerchantId
可选

承运平台商家
样例 : "02"

string

coordinates
可选

坐标范围
样例 : [ "Coordinate" ]

< Coordinate > array

shopId
可选

平台商家ID
样例 : "10"

string

storeId
可选

门店Id
样例 : "3243545"

string

type
可选

承运类型
样例 : "meituan"

string

2.20. Category

名称 说明 类型

id
必填

类目ID
样例 : "99"

string

name
必填

类目名称
样例 : "百货类"

string

parentId
可选

上一级类目ID
样例 : "string"

string

remark
可选

类目说明
样例 : "string"

string

2.21. CategoryFilter

名称 说明 类型

ids
可选

样例 : [ "string" ]

< string > array

key_like
可选

样例 : "string"

string

modifiedEnd
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifiedStart
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

name_like
可选

样例 : "string"

string

parentId
可选

样例 : "string"

string

parent_id_is_null
可选

默认值 : false
样例 : true

boolean

parent_ids
可选

样例 : [ "string" ]

< string > array

2.22. CategoryList

名称 说明 类型

categories
可选

样例 : [ "Category" ]

< Category > array

2.23. CategoryPaging

名称 说明 类型

categories
可选

样例 : [ "Category" ]

< Category > array

page
可选

样例 : 0

integer (int32)

page_count
可选

样例 : 0

integer (int32)

page_size
可选

样例 : 0

integer (int32)

total
可选

样例 : 0

integer (int64)

2.24. CodeName

名称 说明 类型

code
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.25. ConfirmRefundRequest

确认退款请求对象

名称 说明 类型

operator_role
可选

操作角色：platform（平台）
样例 : "platform"

string

payments
可选

退款支付明细
样例 : [ "RefundPayment" ]

< RefundPayment > array

refundState
必填

退款状态,none（未退款）,refunded（已退款）
样例 : "refunded"

enum (none, refunded)

2.26. Contact

联系方式

名称 说明 类型

name
可选

联系人名称
样例 : "李飞"

string

phone
可选

电话
样例 : "18676778787"

string

2.27. Coordinate

坐标范围

名称 说明 类型

latitude
可选

纬度
样例 : 118.5

number

longtitude
可选

经度
样例 : 60.2

number

rangeId
可选

标识id，可以认为是一个分组
样例 : "0，1，2"

string

rangeName
可选

名称
样例 : "快递配送"

string

rangeNo
可选

范围序号
样例 : "1，2"

string

type
可选

坐标类型：BD09（百度坐标）、GCJ02（火星坐标）、WGS84（WGS84坐標）
样例 : "GCJ02"

string

2.28. Count

名称 说明 类型

action
可选

action
样例 : "decrypt"

string

action_name
可选

actionName
样例 : "解密"

string

business_key
可选

业务key
样例 : "123"

string

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

type
可选

类型
样例 : "order"

string

value
可选

value
样例 : "10"

string

2.29. CouponDetail

券信息

名称 说明 类型

amount
可选

实际抵用金额
样例 : 10.0

number

code
可选

券号
样例 : "10245678"

string

name
可选

券名称
样例 : "现金券"

string

type
可选

cash（现金券）、discount（折扣券）
样例 : "cash"

string

type_id
可选

券类型代码
样例 : "0001"

string

use_mode
可选

用券形式：pay（支付）、discount(优惠)
样例 : "pay"

string

value
可选

折扣率或者现金面额
样例 : "100，0.1"

number

2.30. CouponInfo

券信息

名称 说明 类型

details
可选

券使用详情
样例 : "[]"

< CouponDetail > array

use_total
可选

券抵用总金额
样例 : 1.0

number

2.31. CustomField

自定义属性值

名称 说明 类型

id
可选

字段ID
样例 : "area_id"

string

name
可选

自定名称
样例 : "地区代码"

string

value
可选

字段值
样例 : "ET09"

string

2.32. Customer

客户

名称 说明 类型

contact
可选

联系方式
样例 : 联系方式(soms)

联系方式(soms)

id
可选

代码
样例 : "10001"

string

2.33. DeductionCondition

名称 说明 类型

decValue
可选

扣减量，（eg:加价3元，3即扣减量）
样例 : 3.0

number

freeShipping
可选

包邮
默认值 : false
样例 : true

boolean

maxValue
可选

条件最大值
样例 : "3"

string

minValue
可选

条件最小值
样例 : "2"

string

2.34. DeliverRequest

配送情况

名称 说明 类型

carrier
可选

承运商，非空时将更新
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "已经在发货的路上"

string

delivery_state
必填

配送状态，取值范围:none(未配送)、shipped(已发货)、signed(已妥投)、refused(已拒收)、redeliver(重投)
样例 : "none"

enum (none, shipped, signed, refused, redeliver)

front_modified
可选

平台订单最后修改时间，非空时将更新,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

operation
可选

门店作业：accept（接单）、shipping（集货）、recheck（复核）、handover（交接）、cancelShipping（取消集货）
样例 : "shipping"

string

operation_state
可选

作业状态
样例 : "none（空）、accepted（已接单）、shipping（ 已集货/已拣货）、rechecked（已复核）、handover（已交接）"

string

operator
可选

执行操作人
样例 : "zhangsan"

string

print
可选

是否打印
默认值 : false
样例 : true

boolean

selftake_confirmed
可选

自提确认
默认值 : false
样例 : true

boolean

ship_id
可选

发货码
样例 : "122323232"

string

ship_time
可选

发货时间，传入的话如果本次操作的是发货，则日志的time将记录该时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2022-07-18 20:34:00"

string (date-time)

waybill_id
可选

承运单号，非空时将更新
样例 : "1243566215"

string

2.35. Delivery

配送信息

名称 说明 类型

carrier
可选

承运商
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "加快"

string

city_token
可选

同城令牌
样例 : "123456"

string

operation_state
可选

门店作业状态，none（空），accepted（已接单），shipping（已集货（已拣货）），rechecked（已复核），handover（已交接）
样例 : "none"

string

pickup_code
可选

取件码
样例 : "123456"

string

pre_end_delivery_time
可选

预计送达结束时间
样例 : "2016-03-02 14:00:01"

string (date-time)

pre_selftake_time
可选

预计自提时间
样例 : "03月05日 晚上"

string

pre_start_delivery_time
可选

预计送达开始时间
样例 : "2016-03-02 12:00:01"

string (date-time)

pre_type
可选

订单预约类型
样例 : "normal：正常，dsd：定时达，half_day：半日达"

string

receiver
可选

收货人信息
样例 : Receiver

Receiver

remark
可选

配送说明
样例 : "定时达"

string

selftake_code
可选

自提码
样例 : "123456"

string

selftake_confirmed
可选

自提确认
默认值 : false
样例 : true

boolean

ship_delivery_mode
可选

发货及配送方式,可选值：wrhShipCarrierDeli（仓库发货，快递配送）、wrhShipStationDeli（仓库发货，门店配送）、stationShipStationDeli（门店发货，门店配送）、stationShipCarrierDeli（门店发货，快递配送）、vendorShipCarrierDeli（供应商发货，快递配送）
样例 : "wrhShipCarrierDeli"

enum (wrhShipCarrierDeli, wrhShipStationDeli, stationShipStationDeli, stationShipCarrierDeli, vendorShipCarrierDeli)

ship_id
可选

发货码
样例 : "23232323"

string

ship_mode
可选

发货方式，wrhShip（仓库发货），stationShip（门店发货），vendorShip（供应商发货）
样例 : "wrhShip"

enum (wrhShip, stationShip, vendorShip)

state
可选

配送状态，默认取值为:none。取值范围:none(未配送)、shipped(已发货)、signed(已妥投)、refused(已拒收)、redeliver(重投)
样例 : "none"

enum (none, shipped, signed, refused, redeliver)

station
可选

配送门店
样例 : IdName

IdName

type
可选

交付方式，默认取值:deliver。取值范围:selftake(到店自提)、deliver(送货上门)
样例 : "deliver"

enum (selftake, deliver)

vendor
可选

发货供应商
样例 : CodeName

CodeName

waybill_id
可选

运单号
样例 : "123"

string

waybill_print_info
可选

运单打印信息
样例 : WaybillPrintInfo

WaybillPrintInfo

waybills
可选

样例 : [ "Waybill" ]

< Waybill > array

wrh
可选

发货仓库
样例 : CodeName

CodeName

wrh_order_id
可选

仓库单号
样例 : "32323"

string

2.36. DiscountSettleDetail

优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

role
可选

优惠承担方
样例 : "shop（商家）、platform（平台）、agent（代理商）"

string

2.37. DiscountShareDetail

整合优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

type
可选

类型
样例 : "3：整合营销"

string

2.38. EncryptDetail

加密信息

名称 说明 类型

encrypt_mobile
可选

样例 : "string"

string

encrypt_name
可选

样例 : "string"

string

encrypt_street
可选

样例 : "string"

string

secretKey
可选

样例 : "string"

string

2.39. ExtraField

自定义字段

名称 说明 类型

id
可选

自定义id
样例 : "distance_freight"

string

name
可选

自定义名称
样例 : "远距离运费"

string

value
可选

自定义值
样例 : "0.01"

string

2.40. FavDetail

优惠详情

名称 说明 类型

amount
可选

优惠金额
样例 : 10.5

number

batch_act_id
可选

批次维度的活动ID
样例 : "1111"

string

factor
可选

优惠参与信息
样例 : FavFactor

FavFactor

id
可选

优惠ID
样例 : "1111"

string

merchant_act_id
可选

商家活动ID
样例 : "1111"

string

name
可选

活动名称
样例 : "满减"

string

prom_cls
可选

促销来源类型
样例 : "string"

string

remark
可选

优惠说明
样例 : "测试优惠"

string

settle_details
可选

优惠结算分摊详情
样例 : [ "DiscountSettleDetail" ]

< DiscountSettleDetail > array

share_details
可选

多方整合优惠分摊信息
样例 : "[]"

< DiscountShareDetail > array

sku_act_id
可选

商品维度的活动ID
样例 : "1111"

string

type
可选

优惠类型
样例 : "string"

string

voucher_code
可选

凭证代码
样例 : "111111111"

string

2.41. FavFactor

优惠参与信息

名称 说明 类型

qty
可选

本商品参与促销总数量
样例 : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与数量是：1"

number

sku_items
可选

来源商品参与优惠明细
样例 : "买2A+3B，赠送一个C，当前商品是C，则skuItems记录 2A和3B的参与详情"

< FavFactorItem > array

total
可选

本商品参与促销总金额
样例 : "A（40） B（160）-》100满减20。如果本商品是A，则最终A参与金额是：20"

number

2.42. FavFactorItem

参与优惠商品明细

名称 说明 类型

amount
可选

参与促销金额
样例 : 1.0

number

item_id
可选

行标识
样例 : "1"

string

item_no
必填

行号
样例 : 1

integer (int32)

qty
可选

参与促销数量
样例 : 1.0

number

2.43. FreightDeduction

运费满减

名称 说明 类型

conditions
可选

扣减条件（规则）
样例 : [ "DeductionCondition" ]

< DeductionCondition > array

type
可选

样例 : "string"

string

2.44. FreightIncrement

运费加价

名称 说明 类型

conditions
可选

加价条件（规则）
样例 : [ "IncrementCondition" ]

< IncrementCondition > array

type
必填

加价类型：distance（距离加价）、time_slot（时段加价）、weight（重量加价）
样例 : "distance"

string

2.45. FrontItem

平台商品行信息

名称 说明 类型

attributes
可选

属性
样例 : [ "FrontItemAttribute" ]

< FrontItemAttribute > array

item_id
必填

平台订单行ID
样例 : "052700601"

string

sku_id
可选

平台SKU ID
样例 : "052700601"

string

spec
可选

平台商品属性(口味), 多个属性以;或者/分隔显示
样例 : "蓝色;微甜 少冰/多糖"

string

spec2
可选

平台商品的规格,形如：500g、500ml
样例 : "500g"

string

spu_id
可选

平台SPU ID
样例 : "052700601"

string

unit
可选

单位
样例 : "string"

string

2.46. FrontItemAttribute

平台商品行属性信息

名称 说明 类型

group
可选

属性分组
样例 : "口味"

string

price
可选

属性售价
样例 : 0.0

number

qty
可选

属性数量
样例 : 0.0

number

values
可选

属性值
样例 : [ "string" ]

< string > array

2.47. FrontOrder

平台订单信息

名称 说明 类型

app
可选

平台应用
样例 : IdName

IdName

attribute
可选

属性信息
样例 : "string"

string

created
可选

下单时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

dpt_station_time
可选

平台调度门店时间，用于存储平台分配门店时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

inner_order_id
可选

平台内部单号
样例 : "1223432"

string

main_order_id
可选

平台主订单号,如果平台存在拆单，可以填入拆单的主单号
样例 : "1223432"

string

modified
可选

最后修改时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

order_id
必填

平台订单号,第三方单号
样例 : "1223654"

string

order_type
可选

订单类型,默认为ECOM（普通订单）:ECOM,普通订单;ShareGroup,拼团订单;POINTS_REDEEM,积分换购订单;ENLIST_REDEEM,预约兑换订单;PRESALE,预售订单;COMPENSATION,赔付订单
样例 : IdName

IdName

platform
必填

平台,其中：自接入平台需要提供约定平台id，申请在鼎力云开通。
样例 : IdName

IdName

state
可选

状态
样例 : "已付款"

string

station_id
可选

平台侧的门店编码
样例 : "254145"

string

station_order_no
可选

平台门店订单序号，该平台下单门店的第几单，用于骑手到店取件
样例 : "1"

string

wrh_id
可选

平台发货仓库编码
样例 : "string"

string

2.48. FrontRtn

平台退货信息

名称 说明 类型

app
可选

平台应用id
样例 : IdName

IdName

created
可选

退单申请时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

creator
可选

创建人
样例 : "254145"

string

modified
可选

退单最后修改时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

platform
必填

平台
样例 : IdName

IdName

rtn_id
可选

平台退货单号
样例 : "123456"

string

source
可选

来源
样例 : "平台生成：platform、商家发起:shop"

string

state
可选

平台退换货状态
样例 : "已退货"

string

station_id
可选

平台门店代码
样例 : "254145"

string

2.49. IdName

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.50. IdWrapper

名称 说明 类型

id
可选

样例 : "string"

string

2.51. IdsWrapper

名称 说明 类型

ids
可选

样例 : [ "string" ]

< string > array

2.52. ImageDetail

名称 说明 类型

image_base64
可选

上传的图片base64编码字符串数据
样例 : "xxxx"

string

name
必填

图片名称，长度不能超过64
样例 : "a.jpg"

string

sort
可选

图片的序号，序号越小排在越前面，默认值为1
样例 : 1

integer (int32)

url
可选

图片url
样例 : "http://aa.png"

string

2.53. IncrementCondition

加价条件

名称 说明 类型

incValue
可选

增加量，（eg:加价3元，3即增加量）
样例 : 3.0

number

maxValue
可选

条件最大值，距离加价和重量加价时为数字（最多1位小数），时段加价格式为HH:mm
样例 : "3"

string

minValue
可选

条件最小值，距离加价和重量加价时为数字（最多1位小数），时段加价格式为HH:mm
样例 : "2"

string

perValue
可选

每单位值，（目前重量加价有此值，eg:重量加价时，每2kg加价1元，2即每单位值）
样例 : 2.0

number

2.54. InputCode

输入码

名称 说明 类型

code
可选

条码
样例 : "232323"

string

qpc
可选

规格
样例 : 1.0

number

qpc_str
可选

规格说明
样例 : "1*1"

string

source
可选

来源
样例 : "string"

string

type
可选

输入码类型
样例 : "EAN"

string

unit
可选

单位
样例 : "包"

string

weight
可选

重量,默认单位是g
样例 : 0.0

number

2.55. Invoice

发票信息

名称 说明 类型

apply_qrcode
可选

开票二维码
样例 : "string"

string

details
可选

发票详情
样例 : [ "InvoiceDetail" ]

< InvoiceDetail > array

error_reason
可选

开票失败原因
样例 : "string"

string

required
必填

是否需要发票
默认值 : false
样例 : false

boolean

result
可选

开票结果：开票成功、开票失败，申请开票时不传
样例 : "开票成功"

string

2.56. InvoiceDetail

发票详情

名称 说明 类型

account
可选

银行编号/账号
样例 : "0023415445"

string

address
可选

地址
样例 : "福建厦门XX"

string

amount
必填

发票金额
样例 : 12.03

number

bank
可选

开户行
样例 : "中国银行XXX"

string

buyer_tax_code
可选

购买方税号，废弃，建议使用taxerId字段
样例 : "1232000046600736XP"

string

check_code
可选

校验码
样例 : "201622"

string

content
可选

发票内容
样例 : "上海股份有限公司"

string

email
可选

发票接收邮箱
样例 : "chw@qq.com"

string

kind
可选

发票种类，取值范围：e-invoice（电子）、paper（纸质）
样例 : "paper"

string

print_number
必填

打印单号
样例 : "123456"

string

remark
可选

发票备注
样例 : "plain"

string

securaty_code
可选

密码
样例 : "2114445"

string

serial_no
可选

流水号
样例 : "454557884564545"

string

tax
可选

税费
样例 : 2.32

number

taxer_id
可选

纳税人识别号（买家填写）
样例 : "1212345046600736XP"

string

telephone
可选

电话
样例 : "12344545111"

string

time
可选

开票日期
样例 : "2019-07-15 16:56:23"

string (date-time)

title
可选

发票抬头
样例 : "XX公司"

string

title_type
可选

抬头类型，取值范围：person（个人）、company（单位）
样例 : "person"

enum (person, company)

type
可选

发票类型，取值范围：plain（普通发票）、VAT（增值税专用发票）
样例 : "plain"

enum (plain, VAT)

url
可选

电子发票图片地址
样例 : "a.jpg"

string

2.57. ItemError

资料错误对象

名称 说明 类型

code
可选

样例 : "string"

string

id
可选

样例 : "string"

string

message
可选

样例 : "string"

string

2.58. ItemPromotion

商品行促销信息

名称 说明 类型

apported_discount_amount
可选

整单优惠分摊金额
样例 : 0.1

number

discount_amount
可选

商品优惠金额
样例 : 0.1

number

favs
可选

优惠详情
样例 : [ "FavDetail" ]

< FavDetail > array

2.59. ItemUpdateResponse

商品更新响应对象

名称 说明 类型

code
可选

样例 : "string"

string

errors
可选

样例 : [ "ItemError" ]

< ItemError > array

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.60. Location

位置信息

名称 说明 类型

area
可选

地区
样例 : "北区"

string

city
可选

市
样例 : "厦门"

string

city_code
可选

市代码
样例 : "01"

string

district
可选

区
样例 : "湖里"

string

district_code
可选

区代码
样例 : "13"

string

lat
可选

纬度
样例 : 123.0

number

lng
可选

经度
样例 : 64.0

number

province
可选

省
样例 : "福建"

string

province_code
可选

省代码
样例 : "365"

string

street
可选

详细地址
样例 : "金山街道226"

string

2.61. LockStockResult

占货结果

名称 说明 类型

lock_id
可选

占货ID
样例 : "string"

string

lock_result
可选

占货结果，取值：none（未占货）, lock_all（全部占货）, lock_part（部分占货）
样例 : "none"

string

message
可选

消息
样例 : "占货失败"

string

stock_state
可选

占货状态，取值：initial（未占货）, locked（已占货）, shipped（已发货）, aborted（已作废）
样例 : "locked"

enum (initial, locked, shipped, aborted)

store_id
可选

门店ID
样例 : "string"

string

success
可选

是否成功，取值：true（成功）, false（失败）
默认值 : false
样例 : true

boolean

2.62. Measure

重量对象

名称 说明 类型

unit
可选

单位：g（克）,kg（千克），为空默认是g
样例 : "g"

string

value
可选

值
样例 : 12.0

number

2.63. MemberInfo

积分信息

名称 说明 类型

card_no
可选

实体卡卡号,如果存在多个，以英文逗号隔开
样例 : "22323"

string

member_gid
可选

会员资料内码
样例 : "12253"

string

member_id
可选

会员ID
样例 : "12253"

string

outer_member_id
可选

外部会员id
样例 : "12253"

string

2.64. MockInfo

压测

名称 说明 类型

persist
可选

默认值 : false
样例 : true

boolean

2.65. Option

文案选项

名称 说明 类型

caption
可选

说明
样例 : "说明"

string

extra
可选

扩展信息
样例 : OptionExtra

OptionExtra

type
可选

类型：remind（催单）、comment(评论)、rtn.receivefailreason（退单收货失败原因）
样例 : "comment"

string

value
可选

回复文案
样例 : "欢迎下次光临"

string

2.66. OptionExtra

扩展条件

名称 说明 类型

auto
可选

是否开启自动回复
默认值 : false
样例 : true

boolean

conditions
可选

自动回复条件
样例 : [ "OptionExtraCondition" ]

< OptionExtraCondition > array

2.67. OptionExtraCondition

评价等级条件

名称 说明 类型

satisfie_level
可选

评价等级（好评：high；中评：medium；差评：low；）
样例 : "欢迎下次光临"

string

2.68. OptionList

文案选项列表

名称 说明 类型

options
可选

文案选项列表
样例 : [ "Option" ]

< Option > array

2.69. Order

订单

名称 说明 类型

adjust_details
可选

调整详情
样例 : [ "AdjustDetail" ]

< AdjustDetail > array

approve_state
可选

审核子状态,取值范围:none(未审核)、serviceApproved(客服已审核)、financeApproved(财务已审核)、warehouseApproved(物流已审核)、carrierApproved(承运商已审核)
样例 : "none"

enum (none, serviceApproved, financeApproved, warehouseApproved, carrierApproved)

calc_data
可选

是否需要反算金额，默认true
默认值 : false
样例 : true

boolean

cancel_reason
可选

取消原因
样例 : "我不想要了"

string

cancel_type
可选

取消类型,取值为stationRefuse（门店拒接）、customerCancel（客户取消）
样例 : "customerCancel"

string

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

crm_info
可选

营销信息
样例 : CRMInfo

CRMInfo

customer
可选

客户信息
样例 : Customer

Customer

customer_note
可选

客户备注
样例 : "note"

string

delivery
必填

配送信息
样例 : Delivery

Delivery

encrypt_detail
可选

加密详情
样例 : EncryptDetail

EncryptDetail

exception_codes
可选

异常代码，sku（商品异常）、amount（金额异常）、shopAmount（货款金额异常）、carrier（承运异常）
样例 : "sku"

string

exception_remark
可选

异常说明
样例 : "商品不存在"

string

exceptions
可选

异常信息
样例 : [ "OrderException" ]

< OrderException > array

extra_info
可选

扩展信息,json字符串
样例 : "{\"lcUserAccessToken\", \"123\"}"

string

fault_tolerant_info
可选

容错信息,json字符串
样例 : "string"

string

freight_discount
可选

运费优惠金额
样例 : 33.33

number

front
必填

平台订单信息
样例 : FrontOrder

FrontOrder

has_exception
可选

是否异常
默认值 : false
样例 : true

boolean

id
可选

订单Id，由系统自动生成，不需要填写
样例 : "88822222222"

string

invoice
可选

发票信息
样例 : Invoice

Invoice

invoice_take_code
可选

发票提取码，32位
样例 : "string"

string

is_private
可选

是否是隐私号,true:小票显示的顾客手机号格式为138*8888，false：原手机号显示
默认值 : false
样例* : true

boolean

item_change_records
可选

换货明细
样例 : [ "OrderItemChange" ]

< OrderItemChange > array

item_count
必填

商品明细数
样例 : 1

integer (int32)

item_logistics
可选

样例 : [ "OrderItemLogistics" ]

< OrderItemLogistics > array

items
必填

商品行
样例 : [ "OrderItem" ]

< OrderItem > array

logs
可选

订单日志
样例 : [ "OrderLog" ]

< OrderLog > array

member_info
可选

会员积分信息
样例 : MemberInfo

MemberInfo

mock_info
可选

样例 : MockInfo

MockInfo

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

order_store
可选

客户下单门店
样例 : IdName

IdName

orig_total
可选

订单原金额(优惠之前)
样例 : 120.01

number

package_discount
可选

包装优惠金额
样例 : 33.33

number

package_info
可选

订单打包信息
样例 : OrderPackageInfo

OrderPackageInfo

payment
必填

支付信息
样例 : Payment

Payment

performance_service_fee
可选

履约服务费
样例 : 120.01

number

print_bills
可选

打印单据
样例 : [ "PrintBill" ]

< PrintBill > array

promotion
可选

订单促销
样例 : OrderPromotion

OrderPromotion

quotas
可选

订单指标
样例 : [ "OrderQuota" ]

< OrderQuota > array

real_total
必填

实际销售商品金额(扣除所有优惠)，等于items中pay_amount之和，不包含运费等其他费用，系统会自动重算
样例 : 120.01

number

reissue_reason
可选

补发原因
样例 : "string"

string

responsible_party
可选

补发责任方
样例 : "string"

string

sale_order_id
可选

销售订单号，不存储，记录在关联信息
样例 : "string"

string

salesman
可选

推销员
样例 : SalesmanInfo

SalesmanInfo

seller_note
可选

商家备注
样例 : "note"

string

selttle_commission
可选

平台佣金 ，弃用，请使用settle_commission
样例 : 120.01

number

settle_amount
可选

平台的结算金额,平台结算金额=客户实付金额+平台优惠补贴， 为空等于amount
样例 : 120.01

number

settle_commission
可选

平台佣金
样例 : 120.01

number

settle_freight
可选

平台结算运费
样例 : 120.01

number

settle_info
可选

对账信息
样例 : OrderSettleInfo

OrderSettleInfo

shop
必填

平台商家，平台侧的商家，非门店
样例 : IdName

IdName

shop_amount
可选

商品货款金额=商品原金额-商家商品优惠金额
样例 : 120.01

number

sku_quantity
必填

商品总数
样例 : 1.0

number

source
可选

来源
样例 : "小程序"

string

source_order_id
可选

来源订单号
样例 : "5346567534545645"

string

state
可选

订单状态，新建可不填,默认取值为:confirmed。取值范围:confirmed(已确认)、prepared（已预处理）、approved(已审核)、delivering( 配送中)、delivered(配送完成)、canceled(已取消)
样例 : "confirmed"

enum (confirmed, prepared, approved, delivering, delivered, canceled)

suspend_info
可选

挂起信息
样例 : SuspendInfo

SuspendInfo

tags
可选

订单标签
样例 : [ "OrderTag" ]

< OrderTag > array

user_number
可选

使用人数,餐具数量
样例 : 2

integer (int32)

weight
可选

订单重量，单位：g
样例 : 500.0

number

wrh_id
可选

发货仓库编号
样例 : "4184"

string

wrh_state
可选

仓库状态
样例 : "initial"

enum (initial, notified, applyKickBack, shipped)

2.70. OrderAdjust

名称 说明 类型

adjust_phase
可选

调整时机
样例 : "onsale=售中，aftersale=售后"

enum (onsale, aftersale)

adjust_version
可选

调整版本
样例 : 1

integer (int64)

amount
可选

样例 : 0.0

number

details
可选

调整详情
样例 : "{}"

< AdjustDetail > array

id
可选

单据ID
样例 : "12121212"

string

items
可选

调整商品详情
样例 : "{}"

< OrderAdjustItem > array

order_id
可选

来源单号
样例 : "121212"

string

payments
可选

调整支付详情
样例 : "{}"

< PaymentDetail > array

reason
可选

调整原因
样例 : "超重补差"

string

remark
可选

调整说明
样例 : "超重补差"

string

shop
可选

商家
样例 : IdName

IdName

state
可选

状态
样例 : "未提交=initial,已提交 =submitted,审批通过 =approved,审批不通过=rejected;"

enum (initial, submitted, approved, rejected)

2.71. OrderAdjustItem

名称 说明 类型

details
可选

调整详情
样例 : "{}"

< AdjustDetail > array

item_no
可选

调整行号
样例 : 1

integer (int32)

item_title
可选

商品名称
样例 : "112121"

string

order_item_no
可选

订单商品行行号
样例 : "1"

string

payAmount
可选

调整后的商品实付金额
样例 : 112121.0

number

quantity
可选

调整后的数量
样例 : 112121.0

number

sku_id
可选

货号
样例 : "112121"

string

total
可选

商品金额
样例 : 112121.0

number

unit_price
可选

商品价格
样例 : 112121.0

number

2.72. OrderApplyRtnRequest

订单申请退款

名称 说明 类型

apply_type
可选

申请类型：weight_diff（缺重退差），stock_none(缺货退款)
样例 : "weight_diff"

string

approve_state
必填

审批状态，取值范围:none(未审核),serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝)
样例 : "none"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

front_app
可选

平台应用
样例 : IdName

IdName

items
必填

申请明细
样例 : [ "OrderItemRtnApply" ]

< OrderItemRtnApply > array

policy
必填

策略
样例 : "取值：orig_sku(原商品)、sku(现商品)"

string

reason
可选

原因
样例 : "不想要了"

string

rtn_id
可选

退单号
样例 : "54132321623"

string

type
必填

退货单类型,取值范围：refund(仅退款)、refundAndRtn(退款退货)
样例 : "refund"

enum (refund, refundAndRtn)

2.73. OrderApplyRtnResponse

名称 说明 类型

apply_id
可选

申请ID
样例 : "申请幂等ID"

string

apply_ids
可选

多个申请ID
样例 : "多个申请幂等ID"

< string > array

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.74. OrderCheckItem

订单检查商品行

名称 说明 类型

item_no
可选

订单行号
样例 : "1"

string

item_title
可选

商品标题
样例 : "葡萄"

string

pay_amount
必填

实付金额
样例 : 2.0

number

quantity
必填

数量
样例 : 1.0

number

sku_id
可选

商品标识（货号）
样例 : "00321"

string

total
必填

商品金额，等于unit_price * quantity
样例 : 2.0

number

unit_price
必填

商品销售价格（扣除优惠券前的价格）
样例 : 2.0

number

2.75. OrderCheckRequest

订单检测请求

名称 说明 类型

amount
可选

总金额
样例 : 10.0

number

carrier_id
可选

指定承运商ID
样例 : "meituan"

string

expect_delivery_time
可选

期望送达时间
样例 : "2022-03-02 14:00:01"

string (date-time)

items
可选

商品明细
样例 : "[]"

< OrderCheckItem > array

order_id
可选

订单号
样例 : "121212"

string

platform_id
可选

下单平台ID
样例 : "jdo2o"

string

pre_type
可选

订单预约类型:normal：正常，dsd：定时达，half_day：半日达
样例 : "normal"

string

receiver_address
可选

收货地址
样例 : Address

Address

receiver_contact
可选

收货联系方式
样例 : 联系方式(soms)

联系方式(soms)

ship_mode
可选

发货方式，wrhShip（仓库发货），stationShip（门店发货）
样例 : "stationShip"

string

sku_quantity
可选

总数量
样例 : 10.0

number

station
可选

配送站点：门店代码、门店名称
样例 : IdName

IdName

type
必填

检测类型：addresscheck(地址检测),deliverycheck(配送检测),deliverycalc(配送计算)
样例 : "deliverycheck"

string

weight
可选

订单商品总重量，单位：克
样例 : 10.0

number

2.76. OrderCheckResponse

名称 说明 类型

code
可选

样例 : "string"

string

delivery_mins
可选

配送时长，单位分钟
样例 : 10.0

number

distance
可选

送货距离，单位米
样例 : 1000.0

number

freight
可选

送货运费，单位元
样例 : 10.0

number

message
可选

样例 : "string"

string

pre_delivery_slots
可选

可选预计送达时间段
样例 : [ "OrderPreSlot" ]

< OrderPreSlot > array

pre_delivery_time
可选

预计送达时间
样例 : "2022-06-30 12:00:00 或者 2022-06-30"

string

success
可选

默认值 : false
样例 : true

boolean

suggest_carrier
可选

建议承运商
样例 : IdName

IdName

2.77. OrderComment

订单评价

名称 说明 类型

content
可选

评价内容
样例 : "很好"

string

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

details
可选

评价积分
样例 : [ "OrderCommentDetail" ]

< OrderCommentDetail > array

dislike_skus
可选

点踩的商品列表
样例 : [ "string" ]

< string > array

expire_time
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

extra_info
可选

评价自定义字段，不同平台不同内容
样例 : OrderExtraInfo

OrderExtraInfo

front_comment_id
可选

样例 : "string"

string

id
可选

评价ID
样例 : "202012021621"

string

image_urls
可选

评价图片
样例 : [ "string" ]

< string > array

labels
可选

评价标签
样例 : [ "string" ]

< string > array

like_skus
可选

点赞的商品列表
样例 : [ "string" ]

< string > array

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

order_id
可选

订单ID
样例 : "202012021621"

string

platform_id
可选

平台ID
样例 : "jdo2o"

string

process_remark
可选

处理说明
样例 : "string"

string

process_state
可选

处理状态
样例 : "string"

string

remark
可选

备注
样例 : "string"

string

reply_content
可选

回复内容
样例 : "string"

string

reply_state
可选

回复状态
样例 : "string"

string

reply_time
可选

回复时间
样例 : "2020-06-17 10:00:00"

string (date-time)

shop_id
可选

商家ID
样例 : "213"

string

store
可选

门店
样例 : IdName

IdName

tags
可选

标签
样例 : [ "string" ]

< string > array

time
可选

评价时间
样例 : "2020-12-02 00:00:00"

string (date-time)

2.78. OrderCommentDetail

名称 说明 类型

labels
可选

评价标签
样例 : [ "string" ]

< string > array

score
可选

评价得分
样例 : 0

integer (int32)

type
可选

评价类型
样例 : "string"

string

2.79. OrderCommentFilter

名称 说明 类型

commentTimeEnd
可选

评价时间结束,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

commentTimeStart
可选

评价时间开始,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

hasContent
可选

是否有评价内容
默认值 : false
样例 : false

boolean

hasReply
可选

回复状态：none、replied、invalid
样例 : "invalid"

string

idEq
可选

评价ID
样例 : "string"

string

id_in
可选

样例 : [ "string" ]

< string > array

orderIdIn
可选

订单ID集合
样例 : [ "string" ]

< string > array

orderIdLike
可选

订单号模糊搜索
样例 : "32323232323323"

string

platformIdEq
可选

平台ID
样例 : "jdo2o"

string

processStateEq
可选

处理状态：未处理、处理成功、处理失败
样例 : "string"

string

processStateNotIn
可选

状态不存在
样例 : [ "string" ]

< string > array

satisfieLevel
可选

满意程度（low、medium、high）
样例 : "high"

string

stationIdEq
可选

门店ID
样例 : "string"

string

tagEq
可选

标签
样例 : "string"

string

tagHas
可选

标签包含……必须完全包含
样例 : [ "string" ]

< string > array

tagIn
可选

标签在……中，包含一个就行
样例 : [ "string" ]

< string > array

2.80. OrderCommentPaging

订单评价分页对象

名称 说明 类型

comments
可选

订单评价列表
样例 : [ "OrderComment" ]

< OrderComment > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

total
可选

总条数
样例 : 100

integer (int64)

2.81. OrderDailySettle

订单日结算单

名称 说明 类型

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

platform_id
必填

平台ID
样例 : "meituan"

string

settle_amount
必填

平台结算金额（商家应收款）
样例 : 2.0

number

settle_date
可选

结账日期
样例 : "2019-08-07 00:00:00"

string (date-time)

settle_id
可选

账单ID
样例 : "68785680023933117_1"

string

shop_id
必填

平台商家ID
样例 : "2123"

string

station_id
必填

配送门店ID
样例 : "212123"

string

station_name
可选

配送门店名称
样例 : "2323"

string

2.82. OrderDailySettleFilter

查询指定对账数据过滤器

名称 说明 类型

created_end
可选

创建时间结束于
样例 : "2019-08-07 19:49:36"

string (date-time)

created_start
可选

创建时间起始于
样例 : "2019-08-07 19:49:36"

string (date-time)

platform_id_eq
可选

平台ID等于
样例 : "meituan"

string

platform_id_in
可选

平台ID数组
样例 : [ "string" ]

< string > array

settle_date_end
可选

账单日期结束于
样例 : "2019-08-07 19:49:36"

string (date-time)

settle_date_start
可选

账单日期起始于
样例 : "2019-08-07 19:49:36"

string (date-time)

shop_id_eq
可选

平台商家ID等于
样例 : "323443"

string

station_id_eq
可选

门店ID等于
样例 : "0001"

string

station_id_in
可选

门店ID数组
样例 : [ "string" ]

< string > array

2.83. OrderDailySettleList

日结算单列表对象

名称 说明 类型

settles
可选

日结算单列表
样例 : [ "OrderDailySettle" ]

< OrderDailySettle > array

2.84. OrderDailySettlePaging

日对账数据查询对象

名称 说明 类型

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

settles
可选

订单结算单列表
样例 : [ "OrderDailySettle" ]

< OrderDailySettle > array

total
可选

总记录数
样例 : 100

integer (int64)

2.85. OrderDataItem

明细

名称 说明 类型

qty
必填

库存
样例 : 32.0

number

sku_id
必填

商品ID
样例 : "12"

string

2.86. OrderDataParam

占货参数

名称 说明 类型

items
可选

明细
样例 : [ "OrderDataItem" ]

< OrderDataItem > array

lock_type
可选

占货类型：（pre_lock）预占、(lock)在单库存
样例 : "3232323"

string

order_id
必填

订单号
样例 : "4545454545454542"

string

platform_id
可选

平台id
样例 : "jdo2o"

string

request_id
可选

请求标识ID，识别一次占货请求
样例 : "3232323"

string

shop_id
必填

平台商家id
样例 : "12121212"

string

shop_name
必填

平台商家名称
样例 : "百度外卖"

string

store_id
必填

门店id
样例 : "43435545"

string

store_name
可选

门店名称
样例 : "aaa"

string

2.87. OrderException

名称 说明 类型

caption
可选

异常标题
样例 : "商品异常"

string

code
可选

异常代码
样例 : "sku"

string

operator
可选

操作人
样例 : "zuhu"

string

order_id
可选

订单号
样例 : "123456"

string

remark
可选

异常说明
样例 : "商品异常"

string

time
可选

异常时间
样例 : "2017-12-26 16:40:19"

string (date-time)

2.88. OrderExtraInfo

名称 说明 类型

delivery_content
可选

配送评价内容
样例 : "很好"

string

next_content
可选

追加评价内容
样例 : "很好"

string

next_image_urls
可选

配送评价图片
样例 : "url"

< string > array

next_time
可选

追加评价时间
样例 : "2020-12-02 00:00:00"

string (date-time)

2.89. OrderFee

订单费用

名称 说明 类型

fee
可选

费用
样例 : 21.0

number

type
可选

类型：platform_service_fee（平台服务费），performance_service_fee（履约服务费），delivery_extra_fee（配送费），delivery_tips（配送小费），tips（小费），cold_chain_processing_fee（冷链加工费），carrier_call_fee（众包呼单费），carrier_call_tips（呼单小费）
样例 : "delivery_tips"

string

2.90. OrderFilter

订单过滤器

名称 说明 类型

address_contains
可选

地址包含
样例 : "福建省"

string

app_id_eq
可选

平台应用代码等于
样例 : "3232323"

string

approve_states
可选

审核状态，取值:none(未审核)、serviceApproved(客服已审核)、financeApproved(财务已审核)、warehouseApproved(物流已审核)、carrierApproved(承运商已审核)
样例 : [ "none" ]

< enum (none, serviceApproved, financeApproved, warehouseApproved, carrierApproved) > array

bill_id_eq
可选

凭证单号等于
样例 : "3232323"

string

bill_id_like
可选

凭证单号类似
样例 : "32323"

string

cancel_type
可选

取消类型，取值为stationRefuse（门店拒接）、customerCancel（客户取消）
样例 : "customerCancel"

string

carrier_id
可选

承运商号
样例 : "0003"

string

carrier_states
可选

承运状态，取值范围:initial(初始状态)、created(已下发)、createdFailed（下发失败）、pickup(已揽件)、pickupFailed(揽件失败)、delivering（配送中）、delivered（配送完成）、canceled（已取消）
样例 : [ "initial" ]

< enum (initial, created, dispatched, createdFailed, pickup, pickupFailed, delivering, delivered, canceled) > array

carrier_types
可选

承运类型,取值范围:self(商家自送)、thirdparty(第三方配送)、express(快递配送)
样例 : [ "self" ]

< enum (self, thirdparty, express) > array

created_end
可选

创建结束时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

created_start
可选

创建起始时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

custom_order_state
可选

自定义订单状态
样例 : [ "string" ]

< string > array

customerMobile
可选

客户手机号
样例 : "18896551546"

string

customer_id
可选

客户代码
样例 : "8568"

string

customer_name
可选

客户姓名
样例 : "张三"

string

deliver_shipped_operator
可选

发货人
样例 : "rs"

string

delivered_time_end
可选

妥投结束时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

delivered_time_start
可选

妥投起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

delivering_time_end
可选

发货起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

delivering_time_start
可选

发货起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

delivery_id
可选

配送ID
样例 : "111"

string

delivery_states
可选

配送状态，取值:none(未配送)、shipped(已发货)、signed(已妥投)、refused(已拒收)、redeliver(重投)
样例 : [ "none" ]

< enum (none, shipped, signed, refused, redeliver) > array

delivery_types
可选

配送类型，取值:selftake(到店自提)、deliver(送货上门)
样例 : [ "selftake" ]

< enum (selftake, deliver) > array

deliveryman_name
可选

配送人姓名
样例 : "张三"

string

exception_code_contains
可选

异常代码
样例 : "false"

string

front_created_end
可选

下单时间终止时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

front_created_start
可选

下单时间起始时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

front_main_order_id_eq
可选

平台主订单号等于
样例 : "1223432"

string

front_main_order_id_in
可选

平台主订单号在……之中
样例 : "['123'，'456']"

< string > array

front_main_order_id_start_with
可选

平台主订单号起始于
样例 : "1223432"

string

front_order_id
可选

平台订单号
样例 : "32323232323323"

string

front_order_id_prefix
可选

平台订单号起始搜索
样例 : "32323232323323"

string

front_order_ids
可选

平台订单号
样例 : "32323232323323"

< string > array

front_sku_id
可选

平台商品编码，查询订单明细时才有用
样例 : "string"

string

handover_operator
可选

交接人
样例 : "张三"

string

hasInvoice
可选

是否拥有发票
默认值 : false
样例 : false

boolean

has_billing
可选

是否有凭证信息,false搜索没有、true搜索有
默认值 : false
样例 : true

boolean

has_delivery_exception
可选

是否配送异常
默认值 : false
样例 : true

boolean

has_exception
可选

是否异常
默认值 : false
样例 : false

boolean

have_return
可选

存在退货但未签收
默认值 : false
样例 : true

boolean

index_modified_end
可选

索引最后修改时间结束于,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

index_modified_start
可选

索引最后修改时间起始于,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

invalid
可选

是否无效订单
默认值 : false
样例 : false

boolean

modified_end
可选

修改结束时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

modified_start
可选

修改起始时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

operation_handover_time_end
可选

交接终止时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

operation_handover_time_start
可选

交接起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

operation_shipping_time_end
可选

集货终止时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

operation_shipping_time_start
可选

集货起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

operation_state
可选

门店作业状态,取值范围：none（空）、shipping（已集货）、handover（已交接）
样例 : "none"

string

operation_states
可选

门店作业状态,取值范围：none（空）、shipping（已集货）、handover（已交接）
样例 : "[none,shipping]"

< string > array

order_id
可选

订单号
样例 : "1000002111"

string

order_ids
可选

订单号
样例 : [ "string" ]

< string > array

payment_out_pay_id
可选

第三方支付流水号(商户订单号)
样例 : "string"

string

payment_states
可选

付款状态，取值范围：notPay(未付款)、earnest(已付定金)、paid(已付全款)
样例 : [ "notPay" ]

< enum (notPay, earnest, paid) > array

payment_types
可选

付款类型，取值范围：cod(货到付款)、online(在线支付)、earnest(预售)
样例 : [ "cod" ]

< enum (cod, online, earnest) > array

platform_id
可选

平台ID
样例 : "jdo2o"

string

platform_ids
可选

平台ID
样例 : [ "string" ]

< string > array

prePage
可选

上一页
样例 : 0

integer (int32)

pre_type
可选

预处理类型：normal：正常，dsd：定时达
样例 : "normal"

string

product_contains
可选

商品包括
样例 : "sku1111"

string

prom_id
可选

优惠ID等于
样例 : "string"

string

prom_id_in
可选

优惠ID在……之中
样例 : [ "string" ]

< string > array

prom_key
可选

优惠Key等于
样例 : "string"

string

prom_key_in
可选

优惠Key在……之中
样例 : [ "string" ]

< string > array

prom_name_like
可选

优惠名称类似于
样例 : "string"

string

receiver_mobile
可选

收货人手机号码
样例 : "18857485554"

string

receiver_mobile_like
可选

收货人手机号码模糊搜索
样例 : "5554"

string

receiver_name
可选

收货人
样例 : "张三"

string

refund_state
可选

退款状态，取值范围:none(未退款)、refunded(已退款)
样例 : "none"

string

salesman_id_eq
可选

分销员代码等于
样例 : "3232323"

string

selftake_code
可选

提货码
样例 : "123456"

string

ship_mode
可选

发货方式，wrhShip（仓库发货），stationShip（门店发货），vendorShip（供应商发货）
样例 : "string"

string

shipping_operator
可选

集货人
样例 : "张三"

string

shop_id
可选

商家ID
样例 : "0002"

string

sku_id
可选

商品编码
样例 : "string"

string

sku_id_in
可选

订单明细货号在……之中，最多指定100个货号
样例 : "[\"sku1\", \"sku2\"]"

< string > array

sku_title
可选

商品标题
样例 : "冰红茶"

string

source
可选

订单来源
样例 : "小程序"

string

source_order_id_eq
可选

源订单号等于
样例 : "213"

string

source_order_id_in
可选

源订单号集合
样例 : [ "string" ]

< string > array

states
可选

订单状态，取值:confirmed(已确认)、prepared(已预处理)、approved(已审核)、delivering(配送中)、delivered(配送完成)、canceled(已取消)
样例 : [ "confirmed" ]

< enum (confirmed, prepared, approved, delivering, delivered, canceled) > array

station_ids
可选

门店ID
样例 : [ "string" ]

< string > array

suspended
可选

是否挂起
默认值 : false
样例 : true

boolean

type_eq
可选

订单类型
样例 : "拼团订单"

string

vendor_code_eq
可选

供应商代码等于
样例 : "3232323"

string

vendor_code_in
可选

供应商代码集合
样例 : "3232323"

< string > array

vendor_code_start_with
可选

供应商代码起始于
样例 : "3232323"

string

waybill_id
可选

运单号
样例 : "0003"

string

wrh_id_in
可选

发货仓库ID集合
样例 : "3232323"

< string > array

wrh_id_start_with
可选

发货仓库ID起始于
样例 : "3232323"

string

2.91. OrderInvoiceRequest

发票更新请求对象

名称 说明 类型

invoice
可选

发票信息
样例 : Invoice

Invoice

2.92. OrderInvoiceResultRequest

发票结果更新请求对象

名称 说明 类型

apply_qrcode
可选

开票二维码
样例 : "string"

string

error_reason
可选

开票失败原因
样例 : "系统异常"

string

result
必填

开票结果：开票成功、开票失败
样例 : "开票成功"

string

serial_no
可选

流水号
样例 : "45546454454"

string

time
可选

开票日期
样例 : "2019-07-15 16:56:23"

string (date-time)

url
可选

电子发票图片地址
样例 : "a.jpg"

string

2.93. OrderItem

商品行

名称 说明 类型

apported_discount_amount
必填

整单优惠分摊金额，如：订单满减，整单分摊到明细
样例 : 12.02

number

barcode
可选

商品条码
样例 : "123456"

string

consume_scores
可选

消费积分
样例 : 12.2

number

cost_price
可选

成本价
样例 : 122.34

number

details
可选

原料商品明细
样例 : [ "OrderItemDetail" ]

< OrderItemDetail > array

discount_amount
必填

商品优惠金额，如：商品立减优惠
样例 : 12.02

number

extra_info
可选

扩展信息,json格式。如果存在 inv_mgr = false 的话，表示该商品为非库存管理商品
样例 : "{\"inv_mgr\": false}"

string

fault_tolerant_info
可选

容错信息,json字符串
样例 : "string"

string

front
可选

前端商品信息
样例 : FrontItem

FrontItem

image_url
可选

商品图片信息
样例 : "http://aaa/bbb.png"

string

is_collocation
可选

是否搭配商品(加料)，如奶茶+珍珠，珍珠是奶茶的加料商品
默认值 : false
样例 : false

boolean

is_gift
可选

默认值 : false
样例 : true

boolean

item_id
可选

订单商品行唯一标识
样例 : "1"

string

item_no
可选

订单行号
样例 : "1"

string

item_title
可选

商品标题
样例 : "葡萄"

string

orig_barcode
可选

转换前商品条码
样例 : "1212"

string

orig_extra_info
可选

原商品行扩展信息
样例 : OrigExtraInfo

OrigExtraInfo

orig_image_url
可选

转换前商品图片信息
样例 : "string"

string

orig_item
可选

定制：订单原商品信息，用于多规格、组合商品场景，记录用户下单时的商品信息
样例 : OrderOrigItem

OrderOrigItem

orig_item_title
可选

转换前的商品名称：用于多规格、组合商品转换标品场景
样例 : "【组合】洗护套装"

string

orig_mas_sku_id
可选

样例 : "string"

string

orig_price
可选

转换前的商品售价：用于多规格、组合商品转换标品场景
样例 : 122.22

number

orig_qty
可选

转换前的商品数量：用于多规格、组合商品转换标品场景
样例 : 2.0

number

orig_sku_id
可选

转换前的货号：用于多规格转换场景
样例 : "121212"

string

orig_weight
可选

转换前商品重量，单位g
样例 : 1.0

number

package_info
可选

商品打包信息
样例 : PackageInfo

PackageInfo

package_qty
可选

包装盒数量
样例 : 125.0

number

package_total
可选

包装费用
样例 : 205.44

number

pay_amount
必填

实付金额，等于total - apported_discount_amount - discount_amount
样例 : 2.0

number

price
可选

售价（促销价），为空等于pay_amount/quantity
样例 : 122.34

number

product_id
可选

商品代码
样例 : "2123"

string

promotion
可选

商品促销
样例 : ItemPromotion

ItemPromotion

purchase_price
可选

采购价
样例 : 2.0

number

quantity
必填

数量
样例 : 1.0

number

real_quantity
可选

实际拣货商品数量
样例 : 0.0

number

real_weight
可选

实际称重，明细总重量，单位g
样例 : 0.0

number

relation_item_id
可选

关联商品行号，如奶茶+珍珠，记录关联的奶茶的item_id
样例 : "2123"

string

relation_sku_id
可选

关联商品货号，如奶茶+珍珠，记录关联的奶茶的sku_id
样例 : "2123"

string

salesman
可选

推销员
样例 : IdName

IdName

settle_discountAmount
可选

平台优惠金额
样例 : 122.22

number

settle_price
可选

平台结算价格，为空等于售价
样例 : 122.2222

number

settle_total
可选

平台结算金额
样例 : 122.22

number

shop_price
可选

商家货款价格
样例 : 122.22

number

shop_total
可选

商家货款金额=商品原金额-商家商品优惠
样例 : 122.22

number

sku_id
必填

商品标识（货号）
样例 : "00321"

string

spec
可选

商品规格
样例 : "1*1"

string

tags
可选

标签
样例 : "标签"

< OrderItemTag > array

total
必填

商品金额，等于unit_price * quantity
样例 : 2.0

number

trace_code_details
可选

溯源码明细，与traceCodes（溯源码）字段相比，二者不能同时使用，优先使用traceCodeDetails，traceCodeDetails无值，在使用traceCodes
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

trace_codes
可选

溯源码
样例 : [ "string" ]

< string > array

unit
可选

单位：个、份等
样例 : "瓶"

string

unit_price
必填

商品销售价格（扣除优惠券前的价格）
样例 : 2.0

number

uuid
可选

样例 : "string"

string

weight
必填

单个商品重量，单位g
样例 : 1.0

number

2.94. OrderItemChange

换货明细

名称 说明 类型

change_items
可选

目标商品行
样例 : [ "OrderItem" ]

< OrderItem > array

items
可选

来源商品行
样例 : [ "OrderItem" ]

< OrderItem > array

reason
可选

原因
样例 : "string"

string

2.95. OrderItemDetail

原料商品信息

名称 说明 类型

fault_tolerant_info
可选

容错信息,json字符串
样例 : "string"

string

front_spec
可选

平台属性
样例 : "辣"

string

id
必填

原料商品货号
样例 : "121212"

string

package_info
可选

包装信息
样例 : PackageInfo

PackageInfo

quantity
必填

需要原料商品数量,C=2A+3B，原料商品数量=组合商品数量*基数，2C时，A：2*2，B：2*3
样例 : 4.0

number

ratio
必填

原料商品基数,C=2A+3B，A：2，B：3
样例 : 3.0

number

real_quantity
可选

实际拣货商品数量
样例 : 0.0

number

title
必填

名称
样例 : "矿泉水"

string

trace_code_details
可选

溯源码明细，与traceCodes（溯源码）字段相比，二者不能同时使用，优先使用traceCodeDetails，traceCodeDetails无值，在使用traceCodes
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

trace_codes
可选

溯源码
样例 : [ "string" ]

< string > array

2.96. OrderItemLogistics

订单明细物流信息

名称 说明 类型

logistics_code
可选

样例 : "string"

string

qty
可选

样例 : 0.0

number

sku_id
可选

样例 : "string"

string

2.97. OrderItemRtnApply

退款申请明细对象

名称 说明 类型

item_no
可选

订单行号
样例 : "1"

string

quantity
可选

数量
样例 : 1.0

number

refund_amount
可选

退款金额
样例 : 12.03

number

sku_id
必填

商品标识
样例 : "2123"

string

weight
可选

缺重重量,单位g
样例 : 1.0

number

weights
可选

缺重重量详情,多个数量不同缺重时使用,单位g
样例 : "1"

< number > array

2.98. OrderItemTag

订单明细标签

名称 说明 类型

name
可选

标签名称
样例 : "盲盒"

string

2.99. OrderItemTraceCodeDetail

溯源码

名称 说明 类型

batch_no
可选

批号
样例 : "string"

string

code
可选

溯源码
样例 : "string"

string

production_date
可选

生产日期
样例 : "2020-06-17 10:00:00"

string (date-time)

qpc_str
可选

规格
样例 : "string"

string

qty
可选

数量
样例 : 0.0

number

valid_date
可选

有效期
样例 : "2020-06-17 10:00:00"

string (date-time)

2.100. OrderKdTrace

订单快递跟踪

名称 说明 类型

carrier
可选

承运商
样例 : IdName

IdName

code
可选

样例 : "string"

string

details
可选

订单快递跟踪详情
样例 : [ "OrderKdTraceDetail" ]

< OrderKdTraceDetail > array

message
可选

样例 : "string"

string

state
可选

承运状态：initial（初始状态）、created（已下单）、 dispatched（已派单）、createdFailed（下单失败）、pickup（已揽件）、pickupFailed（揽件失败）、 delivering（配送中）、delivered（配送完成）、canceled（已取消）
样例 : "canceled"

enum (initial, created, dispatched, createdFailed, pickup, pickupFailed, delivering, delivered, canceled)

success
可选

默认值 : false
样例 : true

boolean

waybill_id
可选

快递单号
样例 : "213232"

string

2.101. OrderKdTraceDetail

订单快递跟踪详情

名称 说明 类型

address
可选

地点
样例 : "福建,厦门市"

string

message
可选

内容
样例 : "顺丰速运 已收取快件"

string

status
可选

状态
样例 : "在途"

string

time
可选

时间
样例 : "2022-04-07 08:39:07"

string (date-time)

2.102. OrderList

订单集合对象

名称 说明 类型

empty
可选

默认值 : false
样例 : true

boolean

orders
可选

订单列表
样例 : [ "Order" ]

< Order > array

2.103. OrderLog

订单日志

名称 说明 类型

action
可选

操作
样例 : "modify"

string

action_caption
可选

操作标题
样例 : "修改订单"

string

message
可选

操作说明
样例 : "修改订单商品明细"

string

operator
可选

操作人
样例 : "zuhu"

string

order_id
可选

订单号
样例 : "321212222"

string

rtn_id
可选

退换货单号
样例 : "212123333"

string

tenant_id
可选

租户ID
样例 : "zuhu"

string

time
可选

操作时间
样例 : "2017-12-26 16:40:19"

string (date-time)

2.104. OrderOrigItem

原商品行信息

名称 说明 类型

barcode
可选

转换前条码
样例 : "121221"

string

combined_id
可选

如果是组合商品，需要传组合标识ID，可以用组合商品ID作为标识
样例 : "121221"

string

image_url
可选

转换前图片地址
样例 : "string"

string

item_title
可选

转换前的商品名称：用于多规格、组合商品转换标品场景
样例 : "【组合】洗护套装"

string

price
可选

转换前的商品售价：用于多规格、组合商品转换标品场景
样例 : 33.22

number

quantity
可选

转换前的商品数量：用于多规格、组合商品转换标品场景
样例 : 3.0

number

sku_id
可选

转换前的货号：用于多规格、组合商品转换标品场景
样例 : "121221"

string

type
可选

类型，多规格multi、组合combined
样例 : "multi"

string

weight
可选

重量
样例 : 0.0

number

2.105. OrderPackageInfo

订单打包信息

名称 说明 类型

details
可选

包装明细
样例 : "[]"

< PackageDetail > array

package_type
可选

指定打包袋类型：保温袋、纸袋、PLA环保袋
样例 : "保温袋"

string

required
可选

是否需要打包袋
默认值 : false
样例 : false

boolean

type
可选

单据类型
样例 : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)"

string

2.106. OrderPaging

订单分页对象

名称 说明 类型

orders
可选

订单列表
样例 : [ "Order" ]

< Order > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

total
可选

总条数
样例 : 100

integer (int64)

2.107. OrderPreSlot

订单预计送达信息

名称 说明 类型

pre_date
可选

预计送达日期
样例 : "今天（周三）"

string

pre_ends
可选

预计送达时间
样例 : "[\"立即送出\",\"12:00\",\"13:00\"]"

< string > array

2.108. OrderPromotion

订单优惠

名称 说明 类型

favs
可选

优惠详情
样例 : [ "FavDetail" ]

< FavDetail > array

2.109. OrderQuota

订单指标

名称 说明 类型

action
可选

操作：expect_shipping
样例 : "expect_shipping"

string

action_name
可选

操作名称：期望拣货完成时间
样例 : "期望拣货完成时间"

string

remark
可选

备注
样例 : "无"

string

time
可选

日期
样例 : "2021-09-26 16:40:19"

string (date-time)

2.110. OrderReissueRequest

订单补发请求

名称 说明 类型

receiver
可选

收货信息
样例 : Receiver

Receiver

reissue_order_items
必填

补发商品明细
样例 : [ "ReissueOrderItem" ]

< ReissueOrderItem > array

reissue_reason
可选

补发原因
样例 : "弄丢了"

string

responsible_party
必填

责任方,carrier代表承运商责任
样例 : "carrier"

string

seller_note
可选

备注说明
样例 : "商家备注"

string

source_order_id
必填

来源订单号
样例 : "121212"

string

2.111. OrderReissueResponse

补发订单响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.112. OrderRemind

名称 说明 类型

count
可选

平台催单次数
样例 : 1

integer (int32)

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

front_remind_id
可选

平台催单Id
样例 : "很好"

string

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

order_id
可选

订单ID
样例 : "202012021621"

string

platform_id
可选

平台ID
样例 : "jdo2o"

string

remind_id
可选

催单Id
样例 : "很好"

string

reply_content
可选

回复内容
样例 : "string"

string

reply_operator
可选

回复人
样例 : "string"

string

reply_state
可选

回复状态，未回复、已回复、已失效
样例 : "string"

string

reply_time
可选

回复时间
样例 : "2020-06-17 10:00:00"

string (date-time)

shop_id
可选

店铺ID
样例 : "jdo2o"

string

store
可选

门店
样例 : IdName

IdName

time
可选

催单时间
样例 : "2020-12-02 00:00:00"

string (date-time)

2.113. OrderRemindFilter

名称 说明 类型

id_eq
可选

id等于
样例 : "123"

string

id_in
可选

idIn
样例 : [ "string" ]

< string > array

order_id_eq
可选

订单Id等于
样例 : "123465"

string

order_id_in
可选

订单IdIn
样例 : [ "string" ]

< string > array

platform_id_eq
可选

平台Id等于
样例 : "meituan"

string

reply_state_eq
可选

回复状态
样例 : "none（未回复）、replied（已回复）、invalid（失效）"

string

store_id_eq
可选

门店Id等于
样例 : "0001"

string

2.114. OrderRemindPaging

催单分页对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

reminds
可选

订单列表
样例 : [ "OrderRemind" ]

< OrderRemind > array

total
可选

总条数
样例 : 100

integer (int64)

2.115. OrderSelftakeCheckRequest

自提检查请求对象

名称 说明 类型

front_order_id
可选

平台订单号
样例 : "5745323545453"

string

platform_id
可选

平台ID
样例 : "youzan"

string

selftake_code
必填

自提码
样例 : "123456"

string

selftake_qrcode
必填

自提二维码
样例 : "123456"

string

store_id
必填

门店ID
样例 : "232434"

string

2.116. OrderSelftakeCheckResponse

自提检查返回结果对象

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

订单号
样例 : "5745323545453"

string

success
可选

默认值 : false
样例 : true

boolean

2.117. OrderSelftakeRequest

自提请求对象

名称 说明 类型

selftake_qrcode
可选

自提二维码（订单号和自提二维码不能同时为空）
样例 : "222222"

string

store_id
可选

门店ID
样例 : "454534"

string

2.118. OrderSelftakeV2Request

自提请求对象

名称 说明 类型

order_id
可选

订单号（订单号和自提二维码不能同时为空）
样例 : "12345"

string

platform_id
可选

平台ID（自提二维码不为空时必填）
样例 : "be.eleme"

string

selftake_qrcode
可选

自提二维码（订单号和自提二维码不能同时为空）
样例 : "222222"

string

store_id
可选

门店ID
样例 : "454534"

string

2.119. OrderSelftakeV2Response

自提请求响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

订单号
样例 : "5745323545453"

string

success
可选

默认值 : false
样例 : true

boolean

2.120. OrderSettle

订单结算单

名称 说明 类型

amount
必填

客户实付金额
样例 : 22.0

number

bottom_service_fee
可选

保底服务费
样例 : 2.0

number

cod_amount
必填

货到付款金额
样例 : 0.0

number

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

discount
必填

商家优惠金额
样例 : 2.0

number

discount_amount
必填

优惠总金额
样例 : 2.0

number

discounts
可选

订单级优惠详情
样例 : [ "OrderSettleItemDiscount" ]

< OrderSettleItemDiscount > array

freight
必填

原运费
样例 : 0.0

number

freight_commission
可选

运费佣金
样例 : 0.0

number

freight_discount
可选

运费优惠金额
样例 : 0.0

number

front_settle_id
可选

平台对账ID
样例 : "687856800239331"

string

front_state
可选

平台单据状态
样例 : "8"

string

front_type_id
可选

单据类型ID，不同平台ID不同
样例 : "1"

string

front_type_name
可选

单据类型名称，不同平台名称不同
样例 : "外卖订单"

string

invoice_fee
可选

开票金额
样例 : 0.0

number

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

order_created
可选

下单时间
样例 : "2019-08-07 00:00:00"

string (date-time)

order_finish_time
可选

完成时间
样例 : "2019-08-07 00:00:00"

string (date-time)

order_id
必填

订单ID
样例 : "132344"

string

other_fees
可选

其他费用
样例 : [ "OrderFee" ]

< OrderFee > array

package_box
必填

原餐盒费
样例 : 2.0

number

package_fee
必填

原打包费
样例 : 1.0

number

pay_amount
必填

付款金额
样例 : 22.0

number

performance_service_fee
可选

履约服务费
样例 : 2.0

number

platform_freight_discount
可选

平台运费优惠金额
样例 : 0.0

number

platform_id
必填

平台ID
样例 : "meituan"

string

platform_promotion_settle
可选

平台推广结算
样例 : 0.0

number

platform_service_fee
可选

平台服务费
样例 : 2.0

number

platform_service_rate
可选

平台服务费率，记小数，举例：0.02=20%
样例 : 0.02

number

refund_id
可选

平台退款ID
样例 : "323434343"

string

refund_time
可选

退款时间
样例 : "2019-08-07 00:00:00"

string (date-time)

selttle_commission
必填

平台结算佣金，拼写错误，建议使用：settle_commission
样例 : 2.0

number

settle
可选

结算金额
样例 : 22.0

number

settle_amount
必填

平台结算金额（商家应收款）
样例 : 2.0

number

settle_commission
必填

平台结算佣金
样例 : 2.0

number

settle_date
可选

结账日期
样例 : "2019-08-07 00:00:00"

string (date-time)

settle_discount
必填

平台结算优惠金额，平台优惠补贴
样例 : 2.0

number

settle_freight
可选

平台结算运费
样例 : 120.01

number

settle_id
可选

对账ID
样例 : "68785680023933117_1"

string

settle_state
必填

结算状态：已入账|未入账
样例 : "已入账"

string

shop_discount
可选

商家商品优惠金额贴
样例 : 2.0

number

shop_freight_discount
可选

商家运费优惠金额贴
样例 : 0.0

number

shop_id
必填

平台商家ID
样例 : "2123"

string

station_id
必填

配送门店ID
样例 : "212123"

string

station_name
可选

配送门店名称
样例 : "2323"

string

sub_front_type_id
可选

单据子类型ID，不同平台ID不同
样例 : "1"

string

sub_front_type_name
可选

单据子类型名称，不同平台名称不同
样例 : "外卖订单"

string

total
必填

原商品金额
样例 : 22.0

number

2.121. OrderSettleDiscount

对账优惠信息

名称 说明 类型

amount
可选

优惠金额
样例 : 1.0

number

details
可选

优惠结算详情
样例 : "[]"

< DiscountSettleDetail > array

scope
可选

优惠范围
样例 : "order（订单）、item（商品）、package（包装）、freight(运费)"

string

2.122. OrderSettleFilter

查询指定对账数据过滤器

名称 说明 类型

created_end
可选

创建时间结束于
样例 : "2019-08-07 19:49:36"

string (date-time)

created_start
可选

创建时间起始于
样例 : "2019-08-07 19:49:36"

string (date-time)

front_type_name_eq
可选

账单类型等于
样例 : "string"

string

front_type_name_start_with
可选

账单类型起始于
样例 : "string"

string

ids
可选

对账id数组
样例 : [ "string" ]

< string > array

order_id_eq
可选

订单ID等于
样例 : "323345354"

string

order_id_in
可选

订单ID数组
样例 : [ "string" ]

< string > array

order_ids
可选

订单ID数组
样例 : [ "string" ]

< string > array

order_start_with
可选

订单ID起始于
样例 : "string"

string

platform_id_eq
可选

平台ID等于
样例 : "meituan"

string

platform_id_in
可选

平台ID数组
样例 : [ "string" ]

< string > array

settle_date_end
可选

账单日期结束于
样例 : "2019-08-07 19:49:36"

string (date-time)

settle_date_start
可选

账单日期起始于
样例 : "2019-08-07 19:49:36"

string (date-time)

shop_id_eq
可选

平台商家ID等于
样例 : "323443"

string

station_id_eq
可选

门店ID等于
样例 : "0001"

string

station_id_in
可选

门店ID数组
样例 : [ "string" ]

< string > array

2.123. OrderSettleInfo

对账信息

名称 说明 类型

discounts
可选

优惠结算明细
样例 : "[{}]"

< OrderSettleDiscount > array

settlable
可选

是否可结算
默认值 : false
样例 : true

boolean

settle_date
可选

账单日期
样例 : "2022-08-25 00:00:00"

string (date-time)

station_settle_mode
可选

门店分账模式：online（线上分账模式）、offline（线下分账模式）
样例 : "online"

string

2.124. OrderSettleItemDiscount

订单级优惠详情

名称 说明 类型

act_id
可选

活动代码
样例 : "343434"

string

act_name
可选

活动名称
样例 : "string"

string

amount
必填

商家承担金额
样例 : 2.0

number

discount_amount
可选

优惠金额
样例 : 5.0

number

front_amount
必填

平台承担金额
样例 : 333.0

number

front_discount_detail_type_id
可选

平台优惠类型详情ID
样例 : "2222"

string

front_discount_detail_type_name
可选

平台优惠类型详情名称
样例 : "string"

string

front_discount_type_id
可选

平台优惠类型ID
样例 : "3234"

string

front_discount_type_name
可选

平台优惠类型名称
样例 : "string"

string

radio
可选

商家承担比例,[0,1]
样例 : 0.0

number

type
可选

类型：order，item
样例 : "item"

string

2.125. OrderSettleItemFilter

查询指定订单明细结算数据过滤器

名称 说明 类型

item_id_in
可选

明细行ID列表
样例 : [ "string" ]

< string > array

order_id_eq
可选

订单ID等于
样例 : "323243434"

string

platform_id_eq
可选

平台ID等于
样例 : "meituan"

string

shop_id_eq
可选

平台商家ID等于
样例 : "15154"

string

2.126. OrderSettleItemOrderList

明细结算数据列表对象

名称 说明 类型

orders
可选

明细结算数据列表
样例 : [ "明细结算数据列表" ]

< 明细结算数据列表 > array

2.127. OrderSettleItemPaging

订单明细结算数据查询对象

名称 说明 类型

items
可选

订单明细结算数据列表
样例 : [ "订单明细结算数据" ]

< 订单明细结算数据 > array

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

2.128. OrderSettleList

订单结算单列表对象

名称 说明 类型

items
可选

订单结算单列表
样例 : [ "OrderSettle" ]

< OrderSettle > array

2.129. OrderSettlePaging

对账数据查询对象

名称 说明 类型

items
可选

订单结算单列表
样例 : [ "OrderSettle" ]

< OrderSettle > array

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

2.130. OrderStoreMod

订单下单门店

名称 说明 类型

order_id
可选

订单号
样例 : "1212"

string

order_store
可选

下单门店
样例 : IdName

IdName

2.131. OrderStoreModError

修改订单下单门店失败明细

名称 说明 类型

id
可选

订单号
样例 : "1212"

string

message
可选

原因
样例 : "订单不存在"

string

2.132. OrderStoreModRequest

修改订单下单门店

名称 说明 类型

mods
可选

订单修改列表，一次修改记录不能超过100
样例 : [ "OrderStoreMod" ]

< OrderStoreMod > array

2.133. OrderStoreModResponse

修改订单下单门店响应

名称 说明 类型

code
可选

样例 : "string"

string

errors
可选

失败明细，如果sucess=false，errors为空表示整体失败，否则errors记录具体失败明细
样例 : [ "OrderStoreModError" ]

< OrderStoreModError > array

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.134. OrderSubmitResponse

订单新建响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.135. OrderTag

订单

名称 说明 类型

name
可选

标签名称
样例 : "首单"

string

2.136. OrigExtraInfo

原商品行扩展信息

名称 说明 类型

spec
可选

规格
样例 : "1*1"

string

unit
可选

规格单位
样例 : "个"

string

2.137. PackageDetail

打包商品明细

名称 说明 类型

amount
可选

打包袋金额
样例 : 1.0

number

qty
可选

打包袋数量
样例 : 1.0

number

sku_id
可选

打包袋ID
样例 : "213323232"

string

sku_name
可选

打包袋名称
样例 : "213323232"

string

2.138. PackageInfo

商品打包信息

名称 说明 类型

packageName
可选

打包袋名称
样例 : "保温袋"

string

quantity
可选

包装盒数量
样例 : 125.0

number

thermosphere
可选

温层
样例 : "string"

string

total
可选

包装费用
样例 : 205.44

number

2.139. Packing

包装规格

名称 说明 类型

quantity
必填

包装数量，默认1
样例 : 1.0

number

spec
可选

包装规格说明，比如1*8，默认1*1
样例 : "1*1"

string

spec2
可选

包装规格
样例 : "200ml"

string

unit
可选

单位
样例 : "瓶"

string

2.140. PayRequest

支付请求对象

名称 说明 类型

details
可选

支付方式详情
样例 : [ "PaymentDetail" ]

< PaymentDetail > array

pay_bill_id
可选

支付账单号
样例 : "123434354"

string

pay_state
可选

付款状态：notPay（未付款）、earnest（已付定金）、paid（已付全款）
样例 : "paid"

enum (notPay, earnest, paid)

pay_time
可选

付款时间
样例 : "2019-12-12 12:12:00"

string (date-time)

payee
可选

付款人
样例 : IdName

IdName

2.141. Payment

支付信息

名称 说明 类型

amount
必填

订单应付总金额（包含商品、运费、包装费等）
样例 : 14.02

number

cod_amount
必填

货到付款金额
样例 : 0.0

number

details
可选

支付详情
样例 : [ "PaymentDetail" ]

< PaymentDetail > array

earnest_amount
必填

预售订金金额
样例 : 0.0

number

extra
可选

支付费用扩展信息
样例 : [ "ExtraField" ]

< ExtraField > array

freight
必填

运费(优惠后)
样例 : 14.02

number

other_fee
可选

其他费用
样例 : 0.0

number

package_total
必填

商家包装费用
样例 : 14.02

number

pay_bill_id
可选

支付账单号
样例 : "0122333333"

string

pay_time
可选

付款时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2019-03-02 12:00:01"

string (date-time)

payee
可选

付款人
样例 : IdName

IdName

state
必填

付款状态，默认取值:notPay。取值范围：notPay(未付款)、earnest(已付定金)、paid(已付全款)
样例 : "paid"

enum (notPay, earnest, paid)

type
必填

付款类型，默认取值:online。取值范围：cod(货到付款)、online(在线支付)、earnest(预付)
样例 : "online"

enum (cod, online, earnest)

2.142. PaymentDetail

支付详情

名称 说明 类型

account_name
可选

账号名称
样例 : "工行"

string

account_no
可选

账号
样例 : "002002"

string

amount
必填

金额
样例 : 12.33

number

cashier
可选

是否缴款 ,此字段用于刻画收款人收的钱是否需要上缴，如收的是现金就需要上缴，刷卡则就不需要上缴
默认值 : false
样例 : true

boolean

code
可选

支付方式代码
样例 : "支付方式代码"

string

discount_amount
可选

支付优惠金额
样例 : 100.0

number

extra_info
可选

扩展信息,json字符串
样例 : "{\"session\", \"123\"}"

string

flowno
可选

业务流水号
样例 : "3223232323"

string

name
必填

支付方式名称
样例 : "支付宝"

string

out_pay_id
可选

第三方支付流水号
样例 : "3223232323"

string

pay_id
可选

支付id
样例 : "3223232323"

string

score
可选

积分数量
样例 : 100.0

number

2.143. PrintBill

打印单据

名称 说明 类型

content
可选

内容
样例 : "内容"

string

created
可选

单据创建时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2020-06-17 10:00:00"

string (date-time)

deleted
可选

默认值 : false
样例 : true

boolean

deleted_time
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

name
可选

模板小票名称
样例 : "外卖订单"

string

outerId
可选

外部Id，目前作为yilianyun打印的唯一标识
样例 : "string"

string

printer
可选

打印机类型：JPOS（JPOS打印机），yilianyun（易联云打印机），默认JPOS
样例 : "string"

string

sku_id
可选

样例 : "string"

string

ticket_type
可选

票据类型：小票、杯贴
样例 : "小票"

string

title
可选

显示名称
样例 : "外卖订单"

string

type
可选

样例 : "string"

string

2.144. Product

商品主档

名称 说明 类型

gid
可选

内码
样例 : "2323"

string

id
必填

商品主档id
样例 : "484844554"

string

input_codes
可选

输入码
样例 : [ "InputCode" ]

< InputCode > array

is_unified
可选

是否统一编码(大类编码):true为是,false为不是，修改时传null不修改
默认值 : false
样例 : false

boolean

name
必填

名称
样例 : "苹果"

string

qpcs
可选

输入码
样例 : [ "ProductQpc" ]

< ProductQpc > array

remark
可选

说明
样例 : "23223"

string

state
可选

状态
样例 : "新品、季节品、赠品、淘汰品、预淘汰品、缺品、买断"

string

2.145. ProductList

商品主档列表对象

名称 说明 类型

products
可选

商品主档列表
样例 : [ "Product" ]

< Product > array

2.146. ProductQpc

名称 说明 类型

id
可选

规格ID
样例 : "string"

string

qpc
可选

规格
样例 : 0.0

number

qpc_str
可选

规格文字
样例 : "string"

string

unit
可选

规格单位
样例 : "string"

string

uuid
可选

样例 : "string"

string

weight
可选

重量
样例 : 0.0

number

2.147. Receiver

收货人

名称 说明 类型

address
必填

地址
样例 : Address

Address

contact
必填

联系方式
样例 : 联系方式(soms)

联系方式(soms)

2.148. Refund

退款信息

名称 说明 类型

amount
必填

实际退货金额（包含运费）
样例 : 12.03

number

classification
可选

退款类别，取值范围:normal(正常)、balance(补差)，为空表示正常
样例 : "normal"

enum (normal, balance)

extra
可选

退款其他费用，退货取件费：rtn_pickup_freight
样例 : [ "ExtraField" ]

< ExtraField > array

freight
必填

退运费
样例 : 12.03

number

package_total
可选

包装费用
样例 : 12.03

number

part_refund
可选

是否部分退
默认值 : false
样例 : false

boolean

payments
可选

退款支付明細
样例 : [ "RefundPayment" ]

< RefundPayment > array

refund_phase
可选

退款阶段，取值范围:onsale(售中)、aftersale(售后)
样例 : "aftersale"

enum (onsale, aftersale)

settle_amount
可选

结算金额
样例 : 12.03

number

settle_commission
必填

平台结算佣金
样例 : 2.0

number

settle_fieight
可选

结算运费
样例 : 12.03

number

shop_amount
可选

商家货款金额
样例 : 120.01

number

state
必填

退款状态，取值范围:none(未退款)、refunded(已退款)
样例 : "none"

enum (none, refunded)

2.149. RefundPayment

退款支付明细

名称 说明 类型

account_name
可选

账号名称
样例 : "工行"

string

account_no
可选

账号
样例 : "002002"

string

amount
必填

退款金额
样例 : 12.33

number

code
可选

支付方式代码
样例 : "支付方式代码"

string

extra_info
可选

扩展信息,json字符串
样例 : "{\"session\", \"123\"}"

string

name
必填

支付方式名称
样例 : "支付宝"

string

out_pay_id
可选

第三方支付流水号
样例 : "3223232323"

string

pay_id
可选

支付id
样例 : "3223232323"

string

score
可选

积分数量
样例 : 100.0

number

2.150. ReissueOrderItem

补发商品明细

名称 说明 类型

item_no
必填

行号
样例 : "1"

string

quantity
必填

数量
样例 : 13.0

number

sku_id
必填

货号
样例 : "132323"

string

2.151. ReplyRemindRequest

名称 说明 类型

reply_content
可选

回复内容
样例 : "string"

string

reply_operator
可选

回复操作人
样例 : "string"

string

reply_time
可选

回复时间
样例 : "2020-06-17 10:00:00"

string (date-time)

2.152. ReturnDelivery

退货信息

名称 说明 类型

carrier
可选

承运商
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "note"

string

return_mobile
可选

退货联系人
样例 : "18856556655"

string

returner
可选

退货人
样例 : Receiver

Receiver

state
可选

退货状态，取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货)
样例 : "none"

enum (none, customerShipped, received)

station
可选

退回门店
样例 : IdName

IdName

station_type
可选

退回站点类型，取值范围:store(门店)、wrh(仓库)、vendor(供应商)
样例 : "string"

string

vendor
可选

退回供应商
样例 : CodeName

CodeName

waybill_id
可选

承运单号
样例 : "XXXXXXXXX"

string

wrh
可选

退回仓库
样例 : CodeName

CodeName

wrh_rtn_id
可选

仓库退货单号
样例 : "XXXXXXXXX"

string

2.153. ReturnRequest

退货请求对象

名称 说明 类型

carrier
可选

承运商
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "note"

string

operator_role
可选

操作角色
样例 : "platform"

string

return_state
必填

退货状态，取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货)
样例 : "none"

enum (none, customerShipped, received)

waybill_id
可选

承运单号，非空时将更新
样例 : "1243566215"

string

2.154. Rtn

退换货单

名称 说明 类型

appeal
可选

是否申诉
默认值 : false
样例 : false

boolean

apply_id
可选

申请ID
样例 : "0002"

string

apply_reason
可选

申请原因
样例 : "不想要了"

string

apply_system
可选

申请方
样例 : "shop"

string

approve_state
必填

审批状态，取值范围:none(未审核),serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝)
样例 : "none"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

cancel_reason
可选

取消申请原因
样例 : "又想要了"

string

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

crm_info
可选

营销信息
样例 : CRMInfo

CRMInfo

customer
可选

客户
样例 : Customer

Customer

customer_note
可选

客户留言
样例 : "haha"

string

delivery
必填

退货信息
样例 : ReturnDelivery

ReturnDelivery

exception_codes
可选

异常代码，sku（商品异常）
样例 : "sku"

string

exception_remark
可选

异常说明
样例 : "异常说明"

string

exception_time
可选

异常时间
样例 : "2020-11-11 12:11:21"

string (date-time)

front
必填

平台退货信息
样例 : FrontRtn

FrontRtn

has_exception
可选

是否异常
默认值 : false
样例 : true

boolean

id
可选

退货订单号，不能重复，为空自动生成
样例 : "0002"

string

items
可选

商品行
样例 : [ "RtnItem" ]

< RtnItem > array

member_info
可选

会员积分信息
样例 : RtnMemberInfo

RtnMemberInfo

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

order_id
必填

原订单号
样例 : "3232320003"

string

package_info
可选

打包信息
样例 : OrderPackageInfo

OrderPackageInfo

print_bills
可选

退单打印数据
样例 : [ "PrintBill" ]

< PrintBill > array

promotion
可选

退单促销
样例 : RtnPromotion

RtnPromotion

refund
必填

退款信息
样例 : Refund

Refund

rtn_req_id
可选

销售退单号，不存储，记录在关联信息
样例 : "string"

string

seller_info
可选

收货失败：原因/凭证
样例 : SellerInfo

SellerInfo

settle_info
可选

对账信息
样例 : RtnSettleInfo

RtnSettleInfo

shop
必填

平台商家
样例 : IdName

IdName

sku_quantity
必填

商品总数
样例 : 1.0

number

state
可选

退货单状态,新建可不填，取值范围：confirmed(已生成)、approved(已审核)、finished(已完成)、canceled(已取消),为空时取默认值confirmed
样例 : "confirmed"

enum (confirmed, approved, finished, canceled)

tags
可选

订单标签
样例 : [ "OrderTag" ]

< OrderTag > array

type
可选

退货单类型,取值范围：refund(仅退款)、refundAndRtn(退款退货)；为空默认为退款退货
样例 : "refund"

enum (refund, refundAndRtn)

voucher_urls
可选

凭证Url(图片)
样例 : [ "string" ]

< string > array

wrh_id
可选

发货仓库编号
样例 : "string"

string

wrh_state
可选

仓库状态,取值参考RtnWrhState
样例 : "initial"

string

2.155. RtnApproveRequest

退单审核请求对象

名称 说明 类型

approve_state
必填

审核状态:none（未审核）,serviceApproved（客服已审核）,serviceRefuse（客服已拒绝）,financeApproved（财务已审核）,financeRefuse（财务已拒绝）
样例 : "serviceApproved"

enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse)

operator_role
可选

操作角色：platform（平台）
样例 : "platform"

string

reason
可选

原因
样例 : "已发货，不能退"

string

2.156. RtnFilter

退单过滤器

名称 说明 类型

app_id_eq
可选

平台应用代码等于
样例 : "3232323"

string

approve_states
可选

审核状态，取值范围:none(未审核)、serviceApproved(客服已审核)、serviceRefuse(客服已拒绝)、financeApproved(财务已审核)、financeRefuse(财务已拒绝)
样例 : [ "none" ]

< enum (none, serviceApproved, serviceRefuse, financeApproved, financeRefuse) > array

bill_id_eq
可选

凭证单号等于
样例 : "32323434"

string

bill_id_like
可选

凭证单号类似
样例 : "3454545"

string

carrier_states
可选

承运状态，取值范围:initial(初始状态)、created(已下发)、createdFailed（下发失败）、pickup(已揽件)、pickupFailed(揽件失败)、delivering（配送中）、delivered（配送完成）、canceled（已取消）
样例 : [ "initial" ]

< enum (initial, created, dispatched, createdFailed, pickup, pickupFailed, delivering, delivered, canceled) > array

carrier_types
可选

承运类型,取值范围:self(商家自送)、thirdparty(第三方配送)、express(快递配送)
样例 : [ "self" ]

< enum (self, thirdparty, express) > array

created_end
可选

创建结束时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

created_start
可选

创建起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

customer_Mobile
可选

客户电话
样例 : "18587887789"

string

customer_Name
可选

客户姓名
样例 : "张三"

string

customer_mobile_like
可选

客户电话模糊搜索
样例 : "7789"

string

deliver_rtn_end
可选

退货终止时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

deliver_rtn_start
可选

退货起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

front_created_end
可选

下单时间终止时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

front_created_start
可选

下单时间起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

front_order_id
可选

平台订单ID
样例 : "323434"

string

front_rtn_id
可选

平台退换货ID
样例 : "3232434"

string

front_sku_id
可选

平台商品编码
样例 : "3234"

string

has_billing
可选

是否有凭证信息
默认值 : false
样例 : false

boolean

has_exception
可选

是否异常
默认值 : false
样例 : false

boolean

index_modified_end
可选

索引最后修改时间结束于,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

index_modified_start
可选

索引最后修改时间起始于,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

order_id
可选

订单号
样例 : "123456"

string

order_id_in
可选

订单号
样例 : "123456"

< string > array

platform_id
可选

平台ID
样例 : "jdo2o"

string

platform_ids
可选

平台ID集合
样例 : "jdo2o"

< string > array

pre_page
可选

上一次页数
样例 : 1

integer (int32)

product_contains
可选

商品包括
样例 : "sku2323"

string

refund_phase
可选

申请阶段
样例 : "aftersale"

string

refund_states
可选

退款状态，取值范围:none(未审核)、refunded(已退款)
样例 : [ "none" ]

< enum (none, refunded) > array

return_states
可选

退货状态，取值范围:none(未审核)、customerShipped(客户已发货)、received(已收货)
样例 : [ "none" ]

< enum (none, customerShipped, received) > array

rtn_Id
可选

退单号
样例 : "123456"

string

rtn_ids
可选

退单号
样例 : [ "string" ]

< string > array

shop_id
可选

店铺ID
样例 : "12348522"

string

sku_id
可选

商品编码
样例 : "232323"

string

states
可选

退货单状态,取值范围:confirmed(已生成)、approved(已审核)、finished(已完成)、canceled(已取消)
样例 : [ "confirmed" ]

< enum (confirmed, approved, finished, canceled) > array

station_id
可选

门店ID
样例 : "12345"

string

station_ids
可选

门店ID
样例 : [ "string" ]

< string > array

station_type
可选

退回站点
样例 : "wrh"

string

types
可选

退货类型
样例 : [ "refund" ]

< enum (refund, refundAndRtn) > array

vendor_code_eq
可选

供应商代码等于
样例 : "3232323"

string

vendor_code_in
可选

供应商代码集合
样例 : "3232323"

< string > array

vendor_code_start_with
可选

供应商代码起始于
样例 : "3232323"

string

waybill_id
可选

退回物流单号
样例 : "32323434"

string

wrh_id_in
可选

退回仓库code集合
样例 : "3232323"

< string > array

wrh_id_start_with
可选

退回仓库code起始于
样例 : "3232323"

string

2.157. RtnItem

退货商品行

名称 说明 类型

barcode
可选

商品条码
样例 : "123456"

string

details
可选

退款商品行明细
样例 : [ "RtnItemDetail" ]

< RtnItemDetail > array

extra_info
可选

扩展信息,json字符串
样例 : "{\"lcUserAccessToken\", \"123\"}"

string

front_item_id
可选

平台订单行ID
样例 : "052700601"

string

front_sku_id
可选

前台商品标识
样例 : "e235346ger545"

string

front_unit
可选

单位
样例 : "string"

string

image_url
可选

商品图片信息
样例 : "http://1213323.png"

string

is_collocation
可选

是否搭配商品(加料)
默认值 : false
样例 : false

boolean

is_gift
可选

默认值 : false
样例 : true

boolean

item_id
可选

行唯一标识
样例 : "22323232323"

string

item_no
可选

行号
样例 : "1"

string

item_title
可选

商品标题
样例 : "冰红茶"

string

order_item_id
可选

订单行标识id
样例 : "1"

string

orig_barcode
可选

转换前商品条码
样例 : "1212"

string

orig_image_url
可选

转换前商品图片信息
样例 : "string"

string

orig_item
可选

订单原商品信息，用于多规格、组合商品场景，记录用户下单时的商品信息
样例 : RtnOrigItem

RtnOrigItem

orig_item_title
可选

转换前的商品名称：用于多规格、组合商品转换标品场景
样例 : "【组合】洗护套装"

string

orig_price
可选

转换前的商品售价：用于多规格、组合商品转换标品场景
样例 : 122.22

number

orig_qty
可选

转换前的商品数量：用于多规格、组合商品转换标品场景
样例 : 2.0

number

orig_sku_id
可选

转换前的货号：用于多规格转换场景
样例 : "121212"

string

origin_sku_id
可选

替换前的商品标识,只有界面使用
样例 : "e235346ger545"

string

product_id
可选

商品代码
样例 : "2123"

string

promotion
可选

商品退促销
样例 : ItemPromotion

ItemPromotion

purchase_price
可选

采购价
样例 : 12.0

number

quantity
必填

退货数量
样例 : 2.0

number

real_qty
可选

实际数量
样例 : 0.0

number

real_quantity
可选

实际拣货商品数量
样例 : 0.0

number

real_weight
可选

实际称重，明细总重量，单位g
样例 : 0.0

number

refund_amount
必填

退款金额 （订单优惠后的金额）
样例 : 12.03

number

relation_item_id
可选

关联商品行号
样例 : "2123"

string

relation_sku_id
可选

关联的货号
样例 : "2123"

string

settle_price
可选

结算价格
样例 : 12.03

number

settle_total
可选

结算金额
样例 : 12.03

number

shop_price
可选

货款价格
样例 : 11.22

number

shop_total
可选

货款金额
样例 : 11.22

number

sku_id
必填

商品标识
样例 : "123456"

string

spec
可选

商品规格
样例 : "1*1"

string

tags
可选

标签
样例 : "标签"

< 退单明细标签 > array

total
必填

退款金额
样例 : 12.03

number

trace_code_details
可选

溯源码明细
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

unit
可选

单位：个、份等
样例 : "瓶"

string

unit_price
必填

价格
样例 : 12.03

number

uuid
可选

样例 : "string"

string

2.158. RtnItemDetail

退款商品行明细

名称 说明 类型

id
必填

商品货号
样例 : "01123"

string

quantity
必填

商品数量
样例 : 0.01

number

ratio
必填

原料比例，数值3表示，一个组合商品，包含3个原料商品
样例 : 2.0

number

real_quantity
可选

样例 : 0.0

number

title
必填

名称
样例 : "01123"

string

trace_code_details
可选

溯源码明细
样例 : [ "OrderItemTraceCodeDetail" ]

< OrderItemTraceCodeDetail > array

2.159. RtnList

退换货单集合

名称 说明 类型

rtns
可选

退换货单列表
样例 : [ "Rtn" ]

< Rtn > array

2.160. RtnMemberInfo

积分信息

名称 说明 类型

card_no
可选

实体卡卡号
样例 : "22323"

string

2.161. RtnModificationRequest

修改退货单请求对象

名称 说明 类型

apply_reason
可选

申请原因
样例 : "不想要了"

string

customer_note
可选

客户留言
样例 : "haha"

string

freight
可选

运费
样例 : 12.03

number

items
可选

退换货明细行
样例 : [ "RtnItem" ]

< RtnItem > array

modify_item_detail
可选

是否修改商品原料
默认值 : false
样例 : false

boolean

package_total
可选

包装费
样例 : 12.03

number

refund_extra
可选

退款其他费用，退货取件费：rtn_pickup_freight
样例 : [ "ExtraField" ]

< ExtraField > array

rtnId
可选

退换货单ID
样例 : "4356465768"

string

settle_amount
可选

结算金额
样例 : 12.03

number

settle_commission
可选

本退单退回佣金
样例 : 12.03

number

voucher_urls
可选

凭证Url(图片)
样例 : [ "string" ]

< string > array

2.162. RtnNotifyWrhRequest

通知仓库请求对象

类型 : object

2.163. RtnOrigItem

原商品行信息

名称 说明 类型

barcode
可选

转换前条码
样例 : "121221"

string

combined_id
可选

如果是组合商品，需要传组合标识ID，可以用组合商品ID作为标识
样例 : "121221"

string

image_url
可选

转换前图片地址
样例 : "string"

string

item_title
可选

转换前的商品名称：用于多规格、组合商品转换标品场景
样例 : "【组合】洗护套装"

string

price
可选

转换前的商品售价：用于多规格、组合商品转换标品场景
样例 : 33.22

number

quantity
可选

转换前的商品数量：用于多规格、组合商品转换标品场景
样例 : 3.0

number

sku_id
可选

转换前的货号：用于多规格、组合商品转换标品场景
样例 : "121221"

string

type
可选

类型，多规格multi、组合combined
样例 : "multi"

string

2.164. RtnPaging

退单分页对象

名称 说明 类型

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

总页数
样例 : 0

integer (int32)

page_size
可选

页大小
样例 : 0

integer (int32)

rtns
可选

退单列表
样例 : [ "Rtn" ]

< Rtn > array

total
可选

总条数
样例 : 0

integer (int64)

2.165. RtnPrintData

退单打印数据

名称 说明 类型

bills
可选

每联的打印数据
样例 : [ "PrintBill" ]

< PrintBill > array

front_rtn_id
可选

前端平台退单ID
样例 : "20160122000006"

string

rtn_id
可选

退单号
样例 : "20160122000006"

string

time
可选

打印数据的生成时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

2.166. RtnPrintDataList

退单打印数据列表对象

名称 说明 类型

rtns
可选

退单打印数据列表
样例 : [ "RtnPrintData" ]

< RtnPrintData > array

2.167. RtnPromotion

退单优惠

名称 说明 类型

favs
可选

优惠详情
样例 : [ "FavDetail" ]

< FavDetail > array

2.168. RtnRefundUpdateRequest

修改退款信息

名称 说明 类型

payments
可选

退款支付明細
样例 : [ "RefundPayment" ]

< RefundPayment > array

2.169. RtnSettleInfo

对账信息

名称 说明 类型

settlable
可选

是否可结算
默认值 : false
样例 : true

boolean

settle_date
可选

账单日期
样例 : "2022-08-25 00:00:00"

string (date-time)

station_settle_mode
可选

门店分账模式：online（线上分账模式）、offline（线下分账模式）
样例 : "online"

string

2.170. RtnSettleInfoUpdateRequest

修改结算信息

名称 说明 类型

settlable
可选

默认值 : false
样例 : true

boolean

settle_date
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

2.171. RtnSubmitResponse

退单新建响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

rtn_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.172. RtnUpdateDeliveryRequest

修改物流物流退回信息请求对象

名称 说明 类型

carrier
可选

承运商
样例 : IdName

IdName

mobile
可选

手机号
样例 : "18859540085"

string

state
可选

退货状态：none（未退货）、customerShipped（客户已发货）、received（已收货）
样例 : "received"

enum (none, customerShipped, received)

waybill_id
可选

承运单号
样例 : "43444444444232323"

string

2.173. SalesmanInfo

名称 说明 类型

id
可选

样例 : "string"

string

inviter_mobile
可选

邀请人手机号
样例 : "18859226552"

string

inviter_name
可选

邀请人名称
样例 : "王x"

string

inviter_wid
可选

邀请人wid
样例 : "7567645"

string

name
可选

样例 : "string"

string

org
可选

销售员所属组织
样例 : IdName

IdName

org_type
可选

所属组织类型：门店,总部
样例 : "门店"

string

personal_guider_name
可选

归属导购员名称
样例 : "王x"

string

personal_guider_no
可选

归属导购员编号
样例 : "3242323"

string

personal_guider_wid
可选

归属导购员wid
样例 : "3242323"

string

trade_guider_name
可选

交易导购员名称
样例 : "王x"

string

trade_guider_no
可选

交易导购员编号
样例 : "65756"

string

trade_guider_wid
可选

交易导购员wid
样例 : "45345"

string

type
可选

type：类型
样例 : "saleman"

string

weike_mobile
可选

微客手机号
样例 : "18859226552"

string

weike_name
可选

微客名称
样例 : "张三"

string

weike_wid
可选

微客名称wid
样例 : "765765756"

string

2.174. ScoreInfo

积分信息

名称 说明 类型

total
可选

获得积分
样例 : 1.0

number

2.175. SelftakeRule

自提规则

名称 说明 类型

def
可选

规则内容
样例 : SelftakeRuleDef

SelftakeRuleDef

platform_id
必填

平台ID
样例 : "meituan"

string

shop_id
必填

商家ID
样例 : "33454"

string

source
可选

规则来源，取值：ptm_shop（平台商家）、ptm_store（平台门店）
样例 : "ptm_store"

string

state
可选

是否开通：applying（未开通）、opened（已开通）
样例 : "applying"

enum (applying, opened)

store_id
必填

门店ID
样例 : "0001"

string

2.176. SelftakeRuleDef

自提规则定义

名称 说明 类型

check_selftake_code
可选

是否校验自提码
默认值 : false
样例 : true

boolean

2.177. SellerInfo

收货失败：原因/凭证

名称 说明 类型

seller_note
可选

收货失败原因
样例 : "收货失败原因"

string

seller_voucher_urls
可选

卖家收货失败凭证：图片地址
样例 : "卖家收货失败凭证：图片地址"

< string > array

2.178. Size

尺寸对象

名称 说明 类型

height
可选

高
样例 : 12.0

number

length
可选

长
样例 : 12.0

number

unit
可选

单位
样例 : "mm"

string

width
可选

宽
样例 : 15.0

number

2.179. Sku

商品对象

名称 说明 类型

barcode
可选

条码：已经弃用，传值跟id保持一致，国标码传upc字段
样例 : "484844554"

string

brand_id
可选

品牌ID
样例 : "1515444444"

string

capacity
可选

容量
样例 : 0.001

number

capacity_unit
可选

容量单位
样例 : "string"

string

category_id
可选

类别ID
样例 : "44848444484"

string

combined_items
可选

商品组合详情
样例 : [ "SkuCombinedItem" ]

< SkuCombinedItem > array

created
可选

创建时间
样例 : "2018-11-11 21:12:55"

string (date-time)

creator
可选

创建人
样例 : "123"

string

customs_fields
可选

样例 : [ "CustomField" ]

< CustomField > array

desc
可选

商品描述
样例 : "好喝"

string

detail_image_urls
可选

详情图片url列表
样例 : [ "string" ]

< string > array

disp
可选

商品是否散装,默认false
默认值 : false
样例 : false

boolean

first_arriving_time
可选

首次到店时间
样例 : "2018-11-11 21:12:55"

string (date-time)

gid
可选

商品GID属性
样例 : "145555"

string

id
必填

货号
样例 : "484844554"

string

image_url
可选

主图url
样例 : "http://aa.png"

string

input_codes
可选

输入码（识别码）
样例 : [ "InputCode" ]

< InputCode > array

invc_unit
可选

计重单位
样例 : "string"

string

invoice_name
可选

开票商品名称
样例 : "string"

string

is_inv_unit
可选

是否为最小库存管理单位
默认值 : false
样例 : true

boolean

is_light_catering
可选

是否轻餐饮
默认值 : false
样例 : true

boolean

kind_types
可选

商品种类
样例 : [ "string" ]

< string > array

label_printing
可选

是否打印标签
默认值 : false
样例 : false

boolean

member_price
可选

标准会员价
样例 : 53.22

number

modified
可选

最后修改时间
样例 : "2018-11-11 21:12:55"

string (date-time)

modifier
可选

最后修改人
样例 : "123"

string

name
必填

名称
样例 : "矿泉水"

string

online_type
可选

商品线上类型，取值（自营商品、供应商商品）
样例 : "string"

string

packing
可选

包装规格
样例 : Packing

Packing

product_id
必填

产品ID
样例 : "1515151"

string

product_type
可选

产品类型：取值范围：normal(普通商品),fresh(生鲜商品);combined(组合商品)
样例 : "fresh"

enum (normal, fresh, combined)

remark
可选

说明
样例 : "无"

string

retail_price
必填

标准零售价
样例 : 15.15

number

size
可选

尺寸
样例 : Size

Size

sku_combined_tag
可选

组合标签信息
样例 : SkuCombinedTag

SkuCombinedTag

source
可选

商品来源：DLY、ERP
样例 : "ERP"

string

state
可选

状态
样例 : "string"

string

sub_image_urls
可选

子图（幅图）url列表
样例 : [ "string" ]

< string > array

tax_rate
可选

税率,如果是13%，传0.13
样例 : 0.13

number

tax_sort_code
可选

税率分类码
样例 : "string"

string

title
可选

在前台展示的名称
样例 : "矿泉水"

string

trace_source_code_type
可选

溯源码类型，取值（一物一码、标准、酒类溯源码）
样例 : "string"

string

upc
可选

国标码
样例 : "69…​"

string

weight
可选

重量
样例 : Measure

Measure

2.180. SkuCombinedItem

名称 说明 类型

id
可选

样例 : "string"

string

price
可选

样例 : 0.0

number

product_type
可选

样例 : "normal"

enum (normal, fresh, combined)

quantity
可选

样例 : 0.0

number

title
可选

样例 : "string"

string

2.181. SkuCombinedTag

组合标签信息

名称 说明 类型

code
可选

标签，举例20-2-10，20所属商品大类代码，2商品数量，10价格
样例 : "20-2-10"

string

enabled
可选

是否启用组合标签，默认false（不启用）
默认值 : false
样例 : false

boolean

price
可选

价格
样例 : 19.9999

number

qty
可选

数量
样例 : 2.0

number

2.182. SkuFilter

查询条件对象

名称 说明 类型

barcode
可选

条码
样例 : "43454"

string

barcode_from
可选

条码起始于
样例 : "aaa"

string

barcode_like
可选

条码类似于
样例 : "123"

string

barcodes
可选

条码列表
样例 : [ "string" ]

< string > array

brand_id
可选

品牌ID
样例 : "54564"

string

category_id
可选

类别ID
样例 : "32434"

string

code_type
可选

样例 : "string"

string

codes
可选

样例 : [ "string" ]

< string > array

created_end
可选

创建结束时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2018-11-11 21:12:55"

string (date-time)

created_start
可选

创建起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2018-11-11 21:12:55"

string (date-time)

exclude_sku_ids
可选

样例 : "aaa"

< string > array

fetch_parts
可选

需要返回的部分
样例 : "combinedItems"

string

key_like
可选

(id,name)类似于，常用于模糊搜索
样例 : "aaa"

string

kinds_in
可选

样例 : [ "string" ]

< string > array

modified_end
可选

修改结束时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2018-11-11 21:12:55"

string (date-time)

modified_start
可选

修改起始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2018-11-11 21:12:55"

string (date-time)

name_like
可选

名称类似于
样例 : "aaa"

string

pre_page
可选

上一次页数
样例 : 1

integer (int32)

product_ids
可选

商品ID
样例 : [ "string" ]

< string > array

product_types
可选

取值范围：normal(普通商品),fresh(生鲜商品),combined(组合商品);
样例 : [ "normal" ]

< enum (normal, fresh, combined) > array

sku_id_from
可选

货号起始于
样例 : "12"

string

sku_id_in
可选

货号范围
样例 : [ "string" ]

< string > array

sku_id_like
可选

货号类似于
样例 : "233"

string

title_like
可选

展示名称类似于
样例 : "aaa"

string

2.183. SkuImage

商品图片对象

名称 说明 类型

detail_images
可选

详情图片
样例 : [ "ImageDetail" ]

< ImageDetail > array

image
可选

主图
样例 : ImageDetail

ImageDetail

sku_id
可选

样例 : "string"

string

sub_images
可选

子图
样例 : [ "ImageDetail" ]

< ImageDetail > array

2.184. SkuImageList

商品图片列表对象

名称 说明 类型

sku_images
可选

上传的商品图片列表
样例 : [ "SkuImage" ]

< SkuImage > array

upload_type
可选

上传方式 url 或 base64 ,默认url
样例 : "string"

string

2.185. SkuList

商品列表对象

名称 说明 类型

skus
可选

商品列表
样例 : [ "Sku" ]

< Sku > array

2.186. SkuPaging

商品分页结果

名称 说明 类型

page
可选

页号，从0开始，必须>=0
样例 : 0

integer (int32)

page_count
可选

总页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

skus
可选

商品集合
样例 : [ "Sku" ]

< Sku > array

total
可选

总记录
样例 : 100

integer (int64)

2.187. SkuPrice

库存

名称 说明 类型

change_time
可选

业务变化时间
样例 : "2019-07-30 00:00:00"

string (date-time)

max_price
可选

最大商品零售价
样例 : 12.25

number

mbr_price
可选

会员价
样例 : 15.25

number

min_price
可选

最小商品零售价
样例 : 12.25

number

modified
可选

最后修改时间
样例 : "2019-07-30 00:00:00"

string (date-time)

modifier
可选

修改人
样例 : "张三"

string

price
必填

商品零售价
样例 : 12.25

number

price_mode
可选

取价方式：unit_price（标准售价），price（固定价）
样例 : "price"

enum (unit_price, price)

sku_id
必填

商品ID
样例 : "54654"

string

task_id
可选

任务ID
样例 : "32323232"

string

unit_price
可选

标准售价
样例 : 12.35

number

2.188. SkuPriceList

商品价格集合

名称 说明 类型

skus
可选

商品价格集合
样例 : [ "SkuPrice" ]

< SkuPrice > array

2.189. SkuQuantity

库存

名称 说明 类型

available
必填

可用库存数
样例 : 155.0

number

change_time
可选

库存变化时间
样例 : "2019-07-30 00:00:00"

string (date-time)

fixed_qty
可选

期初库存数
样例 : 10.0

number

sku_id
必填

商品ID
样例 : "54654"

string

stock_qty
可选

占用库存
样例 : 12.0

number

task_id
可选

任务ID
样例 : "54654"

string

2.190. SkuQuantityList

当前可用库存集合

名称 说明 类型

operator
可选

操作人
样例 : "string"

string

skus
可选

当前可用库存集合
样例 : [ "SkuQuantity" ]

< SkuQuantity > array

2.191. Store

门店资料对象

名称 说明 类型

account_name
可选

开票银行名称
样例 : "1245"

string

account_no
可选

开票银行账号
样例 : "1245"

string

area_leader
可选

区域主管
样例 : IdName

IdName

business_hours
可选

经营时段
样例 : "10:00-12:00;14:00-21:00"

string

business_type
可选

业态：ip（ip），park（乐园），early_education（早教）
样例 : "early_education"

string

circles
可选

所属商圈
样例 : [ "string" ]

< string > array

contact
可选

联系方式
样例 : Contact

Contact

customs_fields
可选

自定义属性值
样例 : [ "CustomField" ]

< CustomField > array

distance
可选

距离
样例 : 100.0

number

gid
可选

门店Gid
样例 : "gid"

string

id
必填

门店代码
样例 : "2345456"

string

image_urls
可选

多张图片；分隔,最多5张图片
样例 : [ "string" ]

< string > array

location
可选

位置信息
样例 : Location

Location

main_image_url
可选

主图
样例 : "string"

string

name
必填

门店名称
样例 : "阳光店"

string

open_date
可选

开店时间
样例 : "2018-06-01 00:00:00"

string (date-time)

operation_manager
可选

运营经理
样例 : IdName

IdName

region
可选

所属区域
样例 : StoreRegion

StoreRegion

remark
可选

备注
样例 : "第二个路口左转"

string

sap_code
可选

门店SAP编码
样例 : "sapCode"

string

source_sys
可选

来源系统
样例 : "HDPOS4"

string

state
可选

门店状态：opened（正常），stopped（停业），closed（关闭）
样例 : "opened"

enum (opened, stopped, closed)

tags
可选

标签
样例 : [ "StoreTag" ]

< StoreTag > array

tax_no
可选

开票税号
样例 : "1245"

string

type
可选

门店类型:self（自营连锁），self_join（连锁加盟(自主)），managed_join（连锁加盟(托管)），interal_join（连锁加盟(内部)），single_store（单店），other（其它），direct（直营），join（加盟）
样例 : "self"

enum (self, self_join, managed_join, interal_join, single_store, other, direct, join)

2.192. StoreFilter

门店过滤器

名称 说明 类型

business_types
可选

业态
样例 : [ "string" ]

< string > array

circles
可选

所属商圈
样例 : [ "string" ]

< string > array

id
可选

门店代码
样例 : "1323230"

string

key_like
可选

查询关键字类似于
样例 : "2134"

string

latitude_end
可选

纬度结束于
样例 : 89.0

number

latitude_start
可选

纬度起始于
样例 : 65.0

number

longtitude_end
可选

经度终止于
样例 : 120.0

number

longtitude_start
可选

经度起始于
样例 : 110.0

number

modified_end
可选

修改时间结束于
样例 : "2018-09-07 00:00:00"

string (date-time)

modified_start
可选

修改时间起始于
样例 : "2018-09-07 00:00:00"

string (date-time)

states
可选

门店状态：opened（正常），opened（停业），opened（关闭）
样例 : "opened"

< enum (opened, stopped, closed) > array

store_ids
可选

多个门店代码
样例 : [ "string" ]

< string > array

types
可选

门店类型:self（自营连锁），self_join（连锁加盟(自主)），managed_join（连锁加盟(托管)），interal_join（连锁加盟(内部)），single_store（单店），other（其它），direct（直营），join（加盟）
样例 : "self"

< enum (self, self_join, managed_join, interal_join, single_store, other, direct, join) > array

2.193. StoreList

门店列表对象

名称 说明 类型

stores
可选

门店列表
样例 : [ "Store" ]

< Store > array

2.194. StoreModification

门店修改对象

名称 说明 类型

account_name
可选

开票银行名称
样例 : "1245"

string

account_no
可选

开票银行账号
样例 : "1245"

string

area_leader
可选

区域主管
样例 : IdName

IdName

business_hours
可选

样例 : "string"

string

business_type
可选

业态：ip（ip），park（乐园），early_education（早教）
样例 : "early_education"

string

circles
可选

所属商圈
样例 : [ "string" ]

< string > array

contact
可选

联系方式
样例 : Contact

Contact

gid
可选

内部GID
样例 : "string"

string

location
可选

位置信息
样例 : Location

Location

name
必填

门店名称
样例 : "阳光店"

string

operation_manager
可选

运营经理
样例 : IdName

IdName

region
可选

样例 : StoreRegion

StoreRegion

remark
可选

备注
样例 : "第二个路口左转"

string

sap_code
可选

样例 : "string"

string

source_sys
可选

来源系统
样例 : "HDPOS4"

string

state
可选

门店状态：opened（正常），stopped（停业），closed（关闭）
样例 : "opened"

enum (opened, stopped, closed)

tags
可选

样例 : [ "StoreTag" ]

< StoreTag > array

tax_no
可选

开票税号
样例 : "1245"

string

type
可选

门店类型:self（自营连锁），self_join（连锁加盟(自主)），managed_join（连锁加盟(托管)），interal_join（连锁加盟(内部)），single_store（单店），other（其它），direct（直营），join（加盟）
样例 : "self"

enum (self, self_join, managed_join, interal_join, single_store, other, direct, join)

2.195. StoreOperationRequest

门店作业请求

名称 说明 类型

operation
必填

作业动作：accept（接单）、shipping（集货）、recheck（复核）、handover（交接）、cancelShipping（取消集货）
样例 : "accept"

string

operation_state
必填

作业状态
样例 : "none（空）、accepted（已接单）、shipping（ 已集货/已拣货）、rechecked（已复核）、handover（已交接）"

string

store_id
必填

门店ID
样例 : "21213323"

string

2.196. StoreOperationRtnRule

名称 说明 类型

allow_float
可选

默认值 : false
样例 : true

boolean

allow_part_refund
可选

默认值 : false
样例 : true

boolean

manual_receive
可选

默认值 : false
样例 : true

boolean

2.197. StoreOperationRule

名称 说明 类型

def
可选

规则内容
样例 : StoreOperationRuleDef

StoreOperationRuleDef

platform_id
可选

平台ID
样例 : "33454"

string

shop_id
可选

商家ID
样例 : "33454"

string

source
可选

样例 : "string"

string

state
可选

是否开通：applying（未开通）、opened（已开通）
样例 : "applying"

enum (applying, opened)

store_id
可选

门店ID
样例 : "33454"

string

type
可选

样例 : "string"

string

2.198. StoreOperationRuleDef

名称 说明 类型

rtn_rule
可选

样例 : StoreOperationRtnRule

StoreOperationRtnRule

2.199. StoreOperationRuleFilter

名称 说明 类型

platformIdEq
可选

样例 : "string"

string

shopIdEq
可选

样例 : "string"

string

stateEq
可选

样例 : "string"

string

storeIdEq
可选

样例 : "string"

string

storeIdIn
可选

样例 : [ "string" ]

< string > array

typeEq
可选

样例 : "string"

string

2.200. StoreOperationRuleSave

名称 说明 类型

def
可选

def
样例 : StoreOperationRuleDef

StoreOperationRuleDef

platform_id
可选

平台ID
样例 : "33454"

string

shop_id
可选

商家代码
样例 : "storeRtnRule"

string

store_id
可选

门店代码
样例 : "0001"

string

type
可选

类型
样例 : "33454"

string

2.201. StorePaging

门店查询对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

stores
可选

门店列表
样例 : [ "Store" ]

< Store > array

total
可选

总记录数
样例 : 100

integer (int64)

2.202. StoreRegion

门店所属区域

名称 说明 类型

id
必填

区域代码
样例 : "2345456"

string

mgr_wechat_work_id
可选

区域经理企业微信id
样例 : "123456"

string

name
必填

区域名称
样例 : "阳光店"

string

2.203. StoreSku

门店商品对象

名称 说明 类型

business_type
可选

经营方式：经销、联营、代销
样例 : "string"

string

erp_state
可选

erp商品状态
样例 : "string"

string

is_active_sales
可选

是否动销
默认值 : false
样例 : true

boolean

modified
可选

修改时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:02"

string (date-time)

sku_id
必填

货号
样例 : "12002"

string

state
可选

门店商品售卖状态
样例 : "待售:forSale,可售:sale,禁售: notForSale"

string

store_id
必填

门店代码
样例 : "001"

string

store_name
可选

门店名称
样例 : "测试店"

string

2.204. StoreSkuError

门店商品对象

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

sku_id
可选

样例 : "string"

string

store_id
可选

样例 : "string"

string

2.205. StoreSkuList

门店商品列表

名称 说明 类型

store_skus
可选

门店商品列表
样例 : [ "StoreSku" ]

< StoreSku > array

2.206. StoreSkuUpdateResponse

门店商品对象

名称 说明 类型

code
可选

样例 : "string"

string

errors
可选

样例 : [ "StoreSkuError" ]

< StoreSkuError > array

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.207. StoreTag

名称 说明 类型

name
可选

样例 : "string"

string

2.208. SuspendInfo

挂起信息

名称 说明 类型

caption
必填

挂起原因标题，显示用
样例 : "string"

string

code
必填

挂起原因代码，每一种挂起原因用代码表示
样例 : "string"

string

suspended
可选

是否挂起
默认值 : false
样例 : true

boolean

time
可选

挂起时间
样例 : "2017-12-26 16:40:19"

string (date-time)

2.209. UpdateReplyContentRequest

名称 说明 类型

reply_content
可选

回复内容
样例 : "string"

string

2.210. Warehouse

仓库

名称 说明 类型

code
必填

代码
样例 : "00001"

string

contact
可选

仓库联系方式
样例 : WarehouseContact

WarehouseContact

gid
可选

仓库Gid
样例 : "gid"

string

location
可选

仓库位置信息
样例 : Location

Location

logistics_center_id
可选

物流中心代码
样例 : "00001"

string

logistics_center_name
可选

物流中心名称
样例 : "广州物流中行"

string

name
可选

名称
样例 : "广州仓"

string

2.211. WarehouseContact

名称 说明 类型

phone
可选

样例 : "string"

string

2.212. WarehouseList

仓库列表

名称 说明 类型

warehouses
必填

仓库列表
样例 : [ "Warehouse" ]

< Warehouse > array

2.213. Waybill

运单

名称 说明 类型

waybill_id
可选

运单号
样例 : "123"

string

2.214. WaybillPrintData

运单打印详情

名称 说明 类型

data
可选

数据
样例 : "string"

string

type
可选

request|response
样例 : "string"

string

2.215. WaybillPrintInfo

运单打印数据

名称 说明 类型

datas
可选

打印数据
样例 : [ "WaybillPrintData" ]

< WaybillPrintData > array

2.216. soms分页查询结果Count

名称 说明 类型

data
可选

数据
样例 : [ "Count" ]

< Count > array

page
可选

页码
样例 : 0

integer (int32)

pageCount
可选

页数
样例 : 2

integer (int32)

pageSize
可选

页面大小
样例 : 100

integer (int32)

total
可选

总数
样例 : "1000L"

integer (int64)

2.217. 明细结算数据列表

名称 说明 类型

items
可选

订单明细结算数据
样例 : [ "订单明细结算数据" ]

< 订单明细结算数据 > array

order_id
可选

订单ID
样例 : "212121212"

string

2.218. 统计服务过滤器

名称 说明 类型

actionEq
可选

action
样例 : "decrypt"

string

actionIn
可选

action在……之中
样例 : "[\"decrypt\"]"

< string > array

actionNameLike
可选

actionName
样例 : "string"

string

businessKeyEq
可选

业务key
样例 : "123"

string

businessKeyIn
可选

业务key在……之中
样例 : "[\"123\",\"456\"]"

< string > array

modifiedBegin
可选

最后修改时间起始于
样例 : "2021-08-23 12:16:20"

string (date-time)

modifiedEnd
可选

最后修改时间结束于
样例 : "2021-08-23 12:16:20"

string (date-time)

typeEq
可选

类型
样例 : "order"

string

typeIn
可选

类型在……之中
样例 : "[\"order\"]"

< string > array

2.219. 联系方式(soms)

联系方式

名称 说明 类型

email
可选

邮箱
样例 : "55151@qq.com"

string

fax
可选

传真
样例 : "123123"

string

mobile
可选

手机(mobile和telephone建议给值mobile)
样例 : "189389928893"

string

name
可选

姓名
样例 : "李飞"

string

private_mobile
可选

隐私号
样例 : "189389928893"

string

private_name
可选

脱敏名称
样例 : "脱敏名称**"

string

telephone
可选

电话
样例 : "189389928893"

string

2.220. 订单明细结算数据

名称 说明 类型

amount
可选

商品金额
样例 : 33.0

number

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

discount_amount
可选

商家承担金额
样例 : 12.0

number

discount_radio
可选

商家承担比例
样例 : 0.0

number

discounts
可选

订单级优惠列表
样例 : [ "OrderSettleItemDiscount" ]

< OrderSettleItemDiscount > array

fav_amount
可选

优惠总金额
样例 : 12.0

number

front_discount_amount
可选

平台承担金额
样例 : 2.0

number

front_discount_radio
可选

平台承担比例
样例 : 0.0

number

front_price
可选

平台商品价格
样例 : 12.0

number

front_score_amount
可选

平台积分金额
样例 : 2.0

number

front_sku_id
必填

平台商品编码
样例 : "3230"

string

item_id
可选

结算行id
样例 : "212121212"

string

item_no
可选

行号
样例 : "1"

string

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

order_created
可选

下单时间
样例 : "2018-12-07 14:34:00"

string (date-time)

order_id
必填

订单ID
样例 : "323232323"

string

pay_amount
必填

顾客实付金额
样例 : 12.0

number

platform_id
必填

平台ID
样例 : "meituan"

string

price
必填

价格
样例 : 33.0

number

quantity
必填

数量
样例 : 12.0

number

shop_id
必填

店铺ID
样例 : "43435"

string

sku_id
必填

商品平台编码
样例 : "43434"

string

station_id
必填

门店代码
样例 : "43435"

string

station_name
可选

门店名称
样例 : "西店"

string

total
可选

商品原价总金额
样例 : 20.0

number

unit_price
可选

原价
样例 : 32.0

number

2.221. 退单明细标签

名称 说明 类型

name
可选

名称
样例 : "盲盒"

string

商户接口

3. 接口定义

3.1. 权限服务

3.1.1. 保存权限定义

POST /{tenant_id}/merchant/permservice/perms
3.1.1.1. 说明

保存权限定义

3.1.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

group
必填

权限分组

string

Body

permissions
必填

权限列表

PermissionList
3.1.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.1.1.4. HTTP请求示例
请求 path
/string/merchant/permservice/perms?group=string
请求 body
{
  "permissions" : [ {
    "id" : "aaa.bbb",
    "name" : "权限a",
    "group" : "aaa",
    "group_name" : "分组aa"
  } ]
}
3.1.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.1.2. 根据分组获取权限定义

GET /{tenant_id}/merchant/permservice/perms
3.1.2.1. 说明

根据分组获取权限定义

3.1.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

group
可选

分组

string
3.1.2.3. 响应
HTTP代码 说明 类型

200

successful operation

PermissionList
3.1.2.4. HTTP请求示例
请求 path
/string/merchant/permservice/perms
3.1.2.5. HTTP响应示例
响应 200
{
  "permissions" : [ {
    "id" : "aaa.bbb",
    "name" : "权限a",
    "group" : "aaa",
    "group_name" : "分组aa"
  } ]
}

3.1.3. 赋予角色权限

POST /{tenant_id}/merchant/permservice/role/{role_id}/perms
3.1.3.1. 说明

赋予角色权限

3.1.3.2. 参数
类型 名称 说明 类型

Path

role_id
必填

角色ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

permissions
必填

权限列表

PermissionList
3.1.3.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.1.3.4. HTTP请求示例
请求 path
/string/merchant/permservice/role/string/perms?operator=string
请求 body
{
  "permissions" : [ {
    "id" : "aaa.bbb",
    "name" : "权限a",
    "group" : "aaa",
    "group_name" : "分组aa"
  } ]
}
3.1.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.1.4. 设置用户可管理的门店范围（覆盖）

POST /{tenant_id}/merchant/permservice/user/{user_id}/managestores
3.1.4.1. 说明

设置用户可管理的门店范围（覆盖）

3.1.4.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Path

user_id
必填

用户ID

string

Body

stores
必填

门店列表

IdNameList
3.1.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.1.4.4. HTTP请求示例
请求 path
/string/merchant/permservice/user/string/managestores
请求 body
{
  "items" : [ {
    "id" : "string",
    "name" : "string"
  } ]
}
3.1.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.1.5. 设置用户可管理的供应商范围（覆盖）

POST /{tenant_id}/merchant/permservice/user/{user_id}/managevendors
3.1.5.1. 说明

设置用户可管理的供应商范围（覆盖）

3.1.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Path

user_id
必填

用户ID

string

Body

vendorIds
必填

供应商ID集合

IdsWrapper
3.1.5.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.1.5.4. HTTP请求示例
请求 path
/string/merchant/permservice/user/string/managevendors
请求 body
{
  "ids" : [ "string" ]
}
3.1.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.1.6. 取用户已授权的权限

GET /{tenant_id}/merchant/permservice/user/{user_id}/perms
3.1.6.1. 说明

取用户已授权的权限

3.1.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Path

user_id
必填

用户ID

string

Query

group
必填

分组

string
3.1.6.3. 响应
HTTP代码 说明 类型

200

successful operation

PermissionList
3.1.6.4. HTTP请求示例
请求 path
/string/merchant/permservice/user/string/perms?group=string
3.1.6.5. HTTP响应示例
响应 200
{
  "permissions" : [ {
    "id" : "aaa.bbb",
    "name" : "权限a",
    "group" : "aaa",
    "group_name" : "分组aa"
  } ]
}

3.2. 用户资料服务

3.2.1. 获取用户资料

GET /{tenant_id}/merchant/userservice/user/{id}
3.2.1.1. 说明

获取用户资料

3.2.1.2. 参数
类型 名称 说明 类型

Path

id
必填

用户ID

string
3.2.1.3. 响应
HTTP代码 说明 类型

200

successful operation

User
3.2.1.4. HTTP请求示例
请求 path
/{tenant_id}/merchant/userservice/user/string
3.2.1.5. HTTP响应示例
响应 200
{
  "id" : "string",
  "name" : "string",
  "mobile" : "string",
  "state" : "using",
  "login_name" : "string",
  "tenant_id" : "string",
  "is_super_admin" : true,
  "is_super_store_manager" : true
}

3.2.2. POST /{tenant_id}/merchant/userservice/user/{id}/open

3.2.2.1. 参数
类型 名称 说明 类型

Path

id
必填

string

Path

tenant_id
必填

租户ID

string

Query

operator
可选

string

Body

body
可选

OpenRequest
3.2.2.2. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.2.2.3. HTTP请求示例
请求 path
/string/merchant/userservice/user/string/open
请求 body
{
  "state" : "using"
}
3.2.2.4. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.2.3. 批量同步用户

POST /{tenant_id}/merchant/userservice/users
3.2.3.1. 说明

批量同步用户

3.2.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

users
必填

用户列表

UserCreationList
3.2.3.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.2.3.4. HTTP请求示例
请求 path
/string/merchant/userservice/users?operator=string
请求 body
{
  "users" : [ {
    "name" : "string",
    "password" : "string",
    "mobile" : "string",
    "id" : "string",
    "login_name" : "string",
    "tenant_id" : "string",
    "is_super_admin" : true,
    "is_super_store_manager" : true,
    "need_encrypt" : true
  } ]
}
3.2.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.3. 产品功能服务

3.3.1. 同步功能

POST /functionservice/function/update
3.3.1.1. 说明

同步功能

3.3.1.2. 参数
类型 名称 说明 类型

Query

operator
必填

操作人

string

Body

function
必填

功能

FunctionPerm
3.3.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.3.1.4. HTTP请求示例
请求 path
/functionservice/function/update?operator=string
请求 body
{
  "function" : {
    "id" : "string",
    "name" : "string",
    "type" : "string",
    "seqNo" : 0,
    "path" : "string",
    "created" : "2020-06-17 10:00:00",
    "parent_id" : "string"
  },
  "permissions" : [ {
    "id" : "aaa.bbb",
    "name" : "权限a",
    "group" : "aaa",
    "group_name" : "分组aa"
  } ]
}
3.3.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.3.2. 批量更新功能

POST /functionservice/{tenant_id}/merchant/functions
3.3.2.1. 说明

批量同步功能

3.3.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

功能列表开通|关闭请求

FunctionOpenRequest
3.3.2.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.3.2.4. HTTP请求示例
请求 path
/functionservice/string/merchant/functions?operator=string
请求 body
{
  "functions" : [ {
    "id" : "string",
    "state" : "applying"
  } ]
}
3.3.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.4. 渠道接入服务

3.4.1. 取商家已开通的渠道ID

GET /{tenant_id}/merchant/accessservice/platforms
3.4.1.1. 说明

取商家已开通的渠道ID

3.4.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string
3.4.1.3. 响应
HTTP代码 说明 类型

200

successful operation

IdsWrapper
3.4.1.4. HTTP请求示例
请求 path
/string/merchant/accessservice/platforms
3.4.1.5. HTTP响应示例
响应 200
{
  "ids" : [ "string" ]
}

3.5. 供应商服务

3.5.1. 创建供应商

POST /{tenant_id}/merchant/vendorservice/vendor
3.5.1.1. 说明

创建供应商

3.5.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

vendor
必填

供应商对象

Vendor
3.5.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.5.1.4. HTTP请求示例
请求 path
/string/merchant/vendorservice/vendor?operator=string
请求 body
{
  "id" : "00001",
  "name" : "供应商",
  "state" : "closed"
}
3.5.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.5.2. 修改供应商

POST /{tenant_id}/merchant/vendorservice/vendor/{id}
3.5.2.1. 说明

修改供应商

3.5.2.2. 参数
类型 名称 说明 类型

Path

id
必填

供应商ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

mod
必填

修改请求对象

VendorModification
3.5.2.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.5.2.4. HTTP请求示例
请求 path
/string/merchant/vendorservice/vendor/string?operator=string
请求 body
{
  "name" : "华东供应商",
  "state" : "closed"
}
3.5.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.5.3. 获取供应商

GET /{tenant_id}/merchant/vendorservice/vendor/{id}
3.5.3.1. 说明

获取供应商

3.5.3.2. 参数
类型 名称 说明 类型

Path

id
必填

供应商ID

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分

string
3.5.3.3. 响应
HTTP代码 说明 类型

200

successful operation

Vendor
3.5.3.4. HTTP请求示例
请求 path
/string/merchant/vendorservice/vendor/string
3.5.3.5. HTTP响应示例
响应 200
{
  "id" : "00001",
  "name" : "供应商",
  "state" : "closed"
}

3.5.4. 供应商删除

DELETE /{tenant_id}/merchant/vendorservice/vendor/{id}
3.5.4.1. 说明

供应商删除

3.5.4.2. 参数
类型 名称 说明 类型

Path

id
必填

供应商ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string
3.5.4.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.5.4.4. HTTP请求示例
请求 path
/string/merchant/vendorservice/vendor/string?operator=string
3.5.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.5.5. 批量获取供应商

POST /{tenant_id}/merchant/vendorservice/vendors
3.5.5.1. 说明

批量获取供应商

3.5.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Body

ids
必填

供应商ID

IdsWrapper
3.5.5.3. 响应
HTTP代码 说明 类型

200

successful operation

VendorList
3.5.5.4. HTTP请求示例
请求 path
/string/merchant/vendorservice/vendors
请求 body
{
  "ids" : [ "string" ]
}
3.5.5.5. HTTP响应示例
响应 200
{
  "vendors" : [ {
    "id" : "00001",
    "name" : "供应商",
    "state" : "closed"
  } ]
}

3.5.6. 分页查询供应商

POST /{tenant_id}/merchant/vendorservice/vendors/query
3.5.6.1. 说明

分页查询供应商

3.5.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码必须大于等于0

integer (int32)

Query

page_size
必填

分页大小，查询分页大小必须在[1,1000]之间

integer (int32)

Query

sort_key
可选

排序字段：id，name，created，modified

string

Body

filter
必填

过滤器

VendorFilter
3.5.6.3. 响应
HTTP代码 说明 类型

200

successful operation

VendorPaging
3.5.6.4. HTTP请求示例
请求 path
/string/merchant/vendorservice/vendors/query?desc=true&page=0&page_size=0
请求 body
{
  "state" : "closed",
  "key_like" : "2123"
}
3.5.6.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "vendors" : [ {
    "id" : "00001",
    "name" : "供应商",
    "state" : "closed"
  } ],
  "page_count" : 10,
  "page_size" : 10
}

3.5.7. 批量修改或保存供应商

POST /{tenant_id}/merchant/vendorservice/vendors/updates
3.5.7.1. 说明

批量修改或保存供应商

3.5.7.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

vendors
必填

供应商列表

VendorList
3.5.7.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.5.7.4. HTTP请求示例
请求 path
/string/merchant/vendorservice/vendors/updates?operator=string
请求 body
{
  "vendors" : [ {
    "id" : "00001",
    "name" : "供应商",
    "state" : "closed"
  } ]
}
3.5.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.6. 员工服务

3.6.1. 新建或保存员工

POST /{tenant_id}/merchant/wd/staffservice/staff
3.6.1.1. 说明

新建或保存员工

3.6.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

staff
必填

员工对象

Staff
3.6.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.6.1.4. HTTP请求示例
请求 path
/string/merchant/wd/staffservice/staff?operator=string
请求 body
{
  "id" : "2345456",
  "name" : "百里追风",
  "gender" : "男",
  "mobile" : "18547859965",
  "state" : "on_job",
  "email" : "151551@qq.com",
  "password" : "123456",
  "created" : "2019-01-03 00:00:00",
  "modified" : "2019-01-03 00:00:00",
  "id_number" : "350426199912125520",
  "wx_id" : "9897547577594",
  "superior_id" : "11232",
  "superior_name" : "百里屠苏",
  "department_id" : "123",
  "department_name" : "事业部",
  "position_id" : "4345",
  "position_name" : "业务员",
  "org_postions" : [ {
    "org_id" : "2345456",
    "org_name" : "测试早教中心",
    "org_type" : "HQ",
    "org_business_type" : "ip",
    "postion_id" : "2345456",
    "postion_name" : "教师"
  } ],
  "job_number" : "2345456",
  "hire_date" : "2019-01-03 00:00:00",
  "departure_date" : "2019-06-03 00:00:00"
}
3.6.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.6.2. 获取员工信息

GET /{tenant_id}/merchant/wd/staffservice/staff/{id}
3.6.2.1. 说明

获取员工信息

3.6.2.2. 参数
类型 名称 说明 类型

Path

id
必填

员工代码

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回部分

string
3.6.2.3. 响应
HTTP代码 说明 类型

200

successful operation

Staff
3.6.2.4. HTTP请求示例
请求 path
/string/merchant/wd/staffservice/staff/string
3.6.2.5. HTTP响应示例
响应 200
{
  "id" : "2345456",
  "name" : "百里追风",
  "gender" : "男",
  "mobile" : "18547859965",
  "state" : "on_job",
  "email" : "151551@qq.com",
  "password" : "123456",
  "created" : "2019-01-03 00:00:00",
  "modified" : "2019-01-03 00:00:00",
  "id_number" : "350426199912125520",
  "wx_id" : "9897547577594",
  "superior_id" : "11232",
  "superior_name" : "百里屠苏",
  "department_id" : "123",
  "department_name" : "事业部",
  "position_id" : "4345",
  "position_name" : "业务员",
  "org_postions" : [ {
    "org_id" : "2345456",
    "org_name" : "测试早教中心",
    "org_type" : "HQ",
    "org_business_type" : "ip",
    "postion_id" : "2345456",
    "postion_name" : "教师"
  } ],
  "job_number" : "2345456",
  "hire_date" : "2019-01-03 00:00:00",
  "departure_date" : "2019-06-03 00:00:00"
}

3.6.3. 删除员工

POST /{tenant_id}/merchant/wd/staffservice/staff/{id}/delete
3.6.3.1. 说明

删除员工

3.6.3.2. 参数
类型 名称 说明 类型

Path

id
必填

员工代码

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string
3.6.3.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.6.3.4. HTTP请求示例
请求 path
/string/merchant/wd/staffservice/staff/string/delete?operator=string
3.6.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.6.4. 批量获取员工信息

POST /{tenant_id}/merchant/wd/staffservice/staffs
3.6.4.1. 说明

批量获取员工信息

3.6.4.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回部分

string

Body

ids
必填

员工代码

IdsWrapper
3.6.4.3. 响应
HTTP代码 说明 类型

200

successful operation

StaffList
3.6.4.4. HTTP请求示例
请求 path
/string/merchant/wd/staffservice/staffs
请求 body
{
  "ids" : [ "string" ]
}
3.6.4.5. HTTP响应示例
响应 200
{
  "staffs" : [ {
    "id" : "2345456",
    "name" : "百里追风",
    "gender" : "男",
    "mobile" : "18547859965",
    "state" : "on_job",
    "email" : "151551@qq.com",
    "password" : "123456",
    "created" : "2019-01-03 00:00:00",
    "modified" : "2019-01-03 00:00:00",
    "id_number" : "350426199912125520",
    "wx_id" : "9897547577594",
    "superior_id" : "11232",
    "superior_name" : "百里屠苏",
    "department_id" : "123",
    "department_name" : "事业部",
    "position_id" : "4345",
    "position_name" : "业务员",
    "org_postions" : [ {
      "org_id" : "2345456",
      "org_name" : "测试早教中心",
      "org_type" : "HQ",
      "org_business_type" : "ip",
      "postion_id" : "2345456",
      "postion_name" : "教师"
    } ],
    "job_number" : "2345456",
    "hire_date" : "2019-01-03 00:00:00",
    "departure_date" : "2019-06-03 00:00:00"
  } ]
}

3.6.5. 员工资料查询

POST /{tenant_id}/merchant/wd/staffservice/staffs/query
3.6.5.1. 说明

员工资料查询

3.6.5.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码，从0开始，必须>=0

integer (int32)

Query

page_size
必填

分页大小，范围是[1,100]

integer (int32)

Query

sort_key
可选

排序字段：created，modified

string

Body

filter
必填

员工查询过滤器

StaffFilter
3.6.5.3. 响应
HTTP代码 说明 类型

200

successful operation

StaffPaging
3.6.5.4. HTTP请求示例
请求 path
/string/merchant/wd/staffservice/staffs/query?desc=true&page=0&page_size=0
请求 body
{
  "id" : "12332",
  "keyword" : "12332",
  "modified_begin" : "2019-01-03 00:00:00",
  "modified_end" : "2019-01-03 00:00:00",
  "wx_id" : "12332"
}
3.6.5.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "staffs" : [ {
    "id" : "2345456",
    "name" : "百里追风",
    "gender" : "男",
    "mobile" : "18547859965",
    "state" : "on_job",
    "email" : "151551@qq.com",
    "password" : "123456",
    "created" : "2019-01-03 00:00:00",
    "modified" : "2019-01-03 00:00:00",
    "id_number" : "350426199912125520",
    "wx_id" : "9897547577594",
    "superior_id" : "11232",
    "superior_name" : "百里屠苏",
    "department_id" : "123",
    "department_name" : "事业部",
    "position_id" : "4345",
    "position_name" : "业务员",
    "org_postions" : [ {
      "org_id" : "2345456",
      "org_name" : "测试早教中心",
      "org_type" : "HQ",
      "org_business_type" : "ip",
      "postion_id" : "2345456",
      "postion_name" : "教师"
    } ],
    "job_number" : "2345456",
    "hire_date" : "2019-01-03 00:00:00",
    "departure_date" : "2019-06-03 00:00:00"
  } ],
  "page_count" : 10,
  "page_size" : 10
}

3.6.6. 批量更新员工

POST /{tenant_id}/merchant/wd/staffservice/staffs/update
3.6.6.1. 说明

批量更新员工，不存在则创建，存在则修改

3.6.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

staffs
必填

员工列表对象

StaffList
3.6.6.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.6.6.4. HTTP请求示例
请求 path
/string/merchant/wd/staffservice/staffs/update?operator=string
请求 body
{
  "staffs" : [ {
    "id" : "2345456",
    "name" : "百里追风",
    "gender" : "男",
    "mobile" : "18547859965",
    "state" : "on_job",
    "email" : "151551@qq.com",
    "password" : "123456",
    "created" : "2019-01-03 00:00:00",
    "modified" : "2019-01-03 00:00:00",
    "id_number" : "350426199912125520",
    "wx_id" : "9897547577594",
    "superior_id" : "11232",
    "superior_name" : "百里屠苏",
    "department_id" : "123",
    "department_name" : "事业部",
    "position_id" : "4345",
    "position_name" : "业务员",
    "org_postions" : [ {
      "org_id" : "2345456",
      "org_name" : "测试早教中心",
      "org_type" : "HQ",
      "org_business_type" : "ip",
      "postion_id" : "2345456",
      "postion_name" : "教师"
    } ],
    "job_number" : "2345456",
    "hire_date" : "2019-01-03 00:00:00",
    "departure_date" : "2019-06-03 00:00:00"
  } ]
}
3.6.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.7. 终端管理服务

3.7.1. 注册终端

POST /{tenant_id}/merchant/terminalservice/terminal/register
3.7.1.1. 说明

注册终端

3.7.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

TerminalRegisterRequest
3.7.1.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.7.1.4. HTTP请求示例
请求 path
/string/merchant/terminalservice/terminal/register?operator=string
请求 body
{
  "source" : "qianfan",
  "id" : "terminal008",
  "name" : "终端008"
}
3.7.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.7.2. 获取终端授权信息

GET /{tenant_id}/merchant/terminalservice/terminal/{id}/auth
3.7.2.1. 说明

获取终端授权信息

3.7.2.2. 参数
类型 名称 说明 类型

Path

id
必填

终端ID

string

Path

tenant_id
必填

租户ID

string

Query

source
必填

来源

string
3.7.2.3. 响应
HTTP代码 说明 类型

200

successful operation

TerminalAuth
3.7.2.4. HTTP请求示例
请求 path
/string/merchant/terminalservice/terminal/string/auth?source=string
3.7.2.5. HTTP响应示例
响应 200
{
  "terminal" : {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "source" : "qianfan",
    "id" : "terminal001",
    "name" : "终端一号",
    "state" : "applying"
  },
  "rest" : {
    "user" : "string",
    "password" : "string"
  }
}

3.8. 门店服务

3.8.1. 创建门店信息

POST /{tenant_id}/merchant/storeservice/store
3.8.1.1. 说明

创建门店信息

3.8.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

store
必填

门店对象

Store
3.8.1.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
3.8.1.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store?operator=string
请求 body
{
  "id" : "2345456",
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "gid" : "gid",
  "distance" : 100.0,
  "circles" : [ "string" ],
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "business_type" : "early_education",
  "business_hours" : "10:00-12:00;14:00-21:00",
  "main_image_url" : "string",
  "image_urls" : [ "string" ],
  "open_date" : "2018-06-01 00:00:00",
  "sap_code" : "sapCode",
  "source_sys" : "HDPOS4",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "customs_fields" : [ {
    "id" : "area_id",
    "name" : "地区代码",
    "value" : "ET09"
  } ],
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}

3.8.2. 查找指定租户的门店

GET /{tenant_id}/merchant/storeservice/store
3.8.2.1. 说明

查找指定租户的门店

3.8.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

id
必填

门店ID

string
3.8.2.3. 响应
HTTP代码 说明 类型

200

successful operation

Store
3.8.2.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store?id=string
3.8.2.5. HTTP响应示例
响应 200
{
  "id" : "2345456",
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "gid" : "gid",
  "distance" : 100.0,
  "circles" : [ "string" ],
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "business_type" : "early_education",
  "business_hours" : "10:00-12:00;14:00-21:00",
  "main_image_url" : "string",
  "image_urls" : [ "string" ],
  "open_date" : "2018-06-01 00:00:00",
  "sap_code" : "sapCode",
  "source_sys" : "HDPOS4",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "customs_fields" : [ {
    "id" : "area_id",
    "name" : "地区代码",
    "value" : "ET09"
  } ],
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}

3.8.3. 修改门店信息

POST /{tenant_id}/merchant/storeservice/store/{id}
3.8.3.1. 说明

修改门店信息

3.8.3.2. 参数
类型 名称 说明 类型

Path

id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

mod
必填

修改信息

StoreModification
3.8.3.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.8.3.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store/string?operator=string
请求 body
{
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "circles" : [ "string" ],
  "gid" : "string",
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "sap_code" : "string",
  "business_hours" : "string",
  "source_sys" : "HDPOS4",
  "business_type" : "early_education",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}
3.8.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.8.4. 查询单个门店详情

GET /{tenant_id}/merchant/storeservice/store/{id}
3.8.4.1. 说明

查询单个门店详情

3.8.4.2. 参数
类型 名称 说明 类型

Path

id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string
3.8.4.3. 响应
HTTP代码 说明 类型

200

successful operation

Store
3.8.4.4. HTTP请求示例
请求 path
/string/merchant/storeservice/store/string
3.8.4.5. HTTP响应示例
响应 200
{
  "id" : "2345456",
  "name" : "阳光店",
  "state" : "opened",
  "type" : "self",
  "location" : {
    "province" : "福建",
    "city" : "厦门",
    "district" : "湖里",
    "street" : "金山街道226",
    "area" : "北区",
    "lat" : 123.0,
    "lng" : 64.0,
    "province_code" : "365",
    "city_code" : "01",
    "district_code" : "13"
  },
  "contact" : {
    "name" : "李飞",
    "phone" : "18676778787"
  },
  "remark" : "第二个路口左转",
  "gid" : "gid",
  "distance" : 100.0,
  "circles" : [ "string" ],
  "region" : {
    "id" : "2345456",
    "name" : "阳光店",
    "mgr_wechat_work_id" : "123456"
  },
  "tags" : [ {
    "name" : "string"
  } ],
  "business_type" : "early_education",
  "business_hours" : "10:00-12:00;14:00-21:00",
  "main_image_url" : "string",
  "image_urls" : [ "string" ],
  "open_date" : "2018-06-01 00:00:00",
  "sap_code" : "sapCode",
  "source_sys" : "HDPOS4",
  "tax_no" : "1245",
  "account_no" : "1245",
  "account_name" : "1245",
  "customs_fields" : [ {
    "id" : "area_id",
    "name" : "地区代码",
    "value" : "ET09"
  } ],
  "operation_manager" : {
    "id" : "string",
    "name" : "string"
  },
  "area_leader" : {
    "id" : "string",
    "name" : "string"
  }
}

3.8.5. 批量获得门店信息

GET /{tenant_id}/merchant/storeservice/stores
3.8.5.1. 说明

批量获得门店信息

3.8.5.2. 参数
类型 名称 说明 类型

Query

id
必填

门店ID集合

< string > array(multi)

Query

org_id
必填

企业ID

string
3.8.5.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreList
3.8.5.4. HTTP请求示例
请求 path
/{tenant_id}/merchant/storeservice/stores?id=string&org_id=string
3.8.5.5. HTTP响应示例
响应 200
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}

3.8.6. 定位附近的门店

GET /{tenant_id}/merchant/storeservice/stores/location
3.8.6.1. 说明

定位附近的门店

3.8.6.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

count
可选

附近门店数量， null 为空默认查询30家

integer (int32)

Query

lat
必填

纬度

number

Query

lng
必填

经度

number
3.8.6.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreList
3.8.6.4. HTTP请求示例
请求 path
/string/merchant/storeservice/stores/location?lat=0.0&lng=0.0
3.8.6.5. HTTP响应示例
响应 200
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}

3.8.7. 分页查询门店

POST /{tenant_id}/merchant/storeservice/stores/query
3.8.7.1. 说明

分页查询门店

3.8.7.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码

integer (int32)

Query

page_size
必填

分页大小

integer (int32)

Query

sort_key
可选

排序字段

string

Body

filter
必填

查询过滤器

StoreFilter
3.8.7.3. 响应
HTTP代码 说明 类型

200

successful operation

StorePaging
3.8.7.4. HTTP请求示例
请求 path
/string/merchant/storeservice/stores/query?desc=true&page=0&page_size=0
请求 body
{
  "id" : "1323230",
  "states" : "opened",
  "types" : "self",
  "circles" : [ "string" ],
  "store_ids" : [ "string" ],
  "business_types" : [ "string" ],
  "key_like" : "2134",
  "latitude_start" : 65.0,
  "latitude_end" : 89.0,
  "longtitude_start" : 110.0,
  "longtitude_end" : 120.0,
  "modified_start" : "2018-09-07 00:00:00",
  "modified_end" : "2018-09-07 00:00:00"
}
3.8.7.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ],
  "page_count" : 10,
  "page_size" : 10
}

3.8.8. 同步门店信息

POST /{tenant_id}/merchant/storeservice/updates
3.8.8.1. 说明

同步门店信息

3.8.8.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

stores
必填

门店列表

StoreList
3.8.8.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.8.8.4. HTTP请求示例
请求 path
/string/merchant/storeservice/updates?operator=string
请求 body
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}
3.8.8.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.8.9. 获取用户授权门店

GET /{tenant_id}/merchant/storeservice/user/{user_id}/managestores
3.8.9.1. 说明

获取用户授权门店

3.8.9.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Path

user_id
必填

用户ID

string
3.8.9.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreList
3.8.9.4. HTTP请求示例
请求 path
/string/merchant/storeservice/user/string/managestores
3.8.9.5. HTTP响应示例
响应 200
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}

3.8.10. 同步门店信息

POST /{tenant_id}/merchant/{tenant_id}/merchant/storeservice/syncStores
3.8.10.1. 说明

同步门店信息

3.8.10.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

stores
必填

门店列表

StoreList
3.8.10.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
3.8.10.4. HTTP请求示例
请求 path
/string/merchant/string/merchant/storeservice/syncStores?operator=string
请求 body
{
  "stores" : [ {
    "id" : "2345456",
    "name" : "阳光店",
    "state" : "opened",
    "type" : "self",
    "location" : {
      "province" : "福建",
      "city" : "厦门",
      "district" : "湖里",
      "street" : "金山街道226",
      "area" : "北区",
      "lat" : 123.0,
      "lng" : 64.0,
      "province_code" : "365",
      "city_code" : "01",
      "district_code" : "13"
    },
    "contact" : {
      "name" : "李飞",
      "phone" : "18676778787"
    },
    "remark" : "第二个路口左转",
    "gid" : "gid",
    "distance" : 100.0,
    "circles" : [ "string" ],
    "region" : {
      "id" : "2345456",
      "name" : "阳光店",
      "mgr_wechat_work_id" : "123456"
    },
    "tags" : [ {
      "name" : "string"
    } ],
    "business_type" : "early_education",
    "business_hours" : "10:00-12:00;14:00-21:00",
    "main_image_url" : "string",
    "image_urls" : [ "string" ],
    "open_date" : "2018-06-01 00:00:00",
    "sap_code" : "sapCode",
    "source_sys" : "HDPOS4",
    "tax_no" : "1245",
    "account_no" : "1245",
    "account_name" : "1245",
    "customs_fields" : [ {
      "id" : "area_id",
      "name" : "地区代码",
      "value" : "ET09"
    } ],
    "operation_manager" : {
      "id" : "string",
      "name" : "string"
    },
    "area_leader" : {
      "id" : "string",
      "name" : "string"
    }
  } ]
}
3.8.10.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

3.9. 商家服务

3.9.1. 根据租户ID取商家信息

GET /{tenant_id}/merchant/orgservice/org
3.9.1.1. 说明

根据租户ID取商家信息

3.9.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分

string
3.9.1.3. 响应
HTTP代码 说明 类型

200

successful operation

Organization
3.9.1.4. HTTP请求示例
请求 path
/string/merchant/orgservice/org
3.9.1.5. HTTP响应示例
响应 200
{
  "id" : "yangleduo",
  "name" : "养乐多",
  "mobile" : "18723456654",
  "email" : "155454545@qq.com",
  "source" : "payman",
  "tenant_id" : "cscsc",
  "hd_user_id" : "aafs",
  "remark" : "string",
  "business_type" : "门店",
  "province" : "福建省",
  "city" : "厦门市",
  "image_url" : "string",
  "image_urls" : [ "string" ]
}

3.10. 设备服务

3.10.1. 查询设备分类

POST /{tenant_id}/merchant/devicecategoryservice/devicecategory/query
3.10.1.1. 说明

查询设备分类

3.10.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码,必须大于等于0

integer (int32)

Query

page_size
必填

页大小,查询分页大小必须在[1,100]之间

integer (int32)

Query

sort_key
可选

排序字段：created，modified

string

Body

filter
必填

过滤器

DeviceCategoryFilter
3.10.1.3. 响应
HTTP代码 说明 类型

200

successful operation

DeviceCategoryPaging
3.10.1.4. HTTP请求示例
请求 path
/string/merchant/devicecategoryservice/devicecategory/query?desc=true&page=0&page_size=0
请求 body
{
  "id" : "323",
  "code" : "comp",
  "modified_start" : "2017-12-26 16:30:08",
  "modified_end" : "2017-12-26 16:30:08"
}
3.10.1.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "page_count" : 10,
  "page_size" : 10,
  "device_categorys" : [ {
    "id" : "212122211",
    "name" : "电脑",
    "code" : "computer",
    "state" : "opened",
    "levelNo" : "1",
    "parent_id" : "1121515"
  } ]
}

3.11. 机台型号服务

3.11.1. 查询机台型号

POST /{tenant_id}/merchant/machinecategoryservice/machinecategory/query
3.11.1.1. 说明

查询机台型号

3.11.1.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码,必须大于等于0

integer (int32)

Query

page_size
必填

页大小,查询分页大小必须在[1,100]之间

integer (int32)

Query

sort_key
可选

排序字段：created，modified

string

Body

filter
必填

过滤器

MachineCategoryFilter
3.11.1.3. 响应
HTTP代码 说明 类型

200

successful operation

MachineCategoryPaging
3.11.1.4. HTTP请求示例
请求 path
/string/merchant/machinecategoryservice/machinecategory/query?desc=true&page=0&page_size=0
请求 body
{
  "id" : "323",
  "code" : "dell",
  "modified_start" : "2017-12-26 16:30:08",
  "modified_end" : "2017-12-26 16:30:08"
}
3.11.1.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "page_count" : 10,
  "page_size" : 10,
  "machine_categorys" : [ {
    "id" : "212122211",
    "name" : "戴尔2代",
    "code" : "dell2",
    "state" : "opened",
    "device_category_id" : "212122211"
  } ]
}

3.12. 组织服务

3.12.1. 根据组织获取岗位列表

GET /{tenant_id}/merchant/wd/orgservice/org/{org_id}/postions
3.12.1.1. 说明

根据组织获取岗位列表

3.12.1.2. 参数
类型 名称 说明 类型

Path

org_id
必填

组织ID

string

Path

tenant_id
必填

租户ID

string
3.12.1.3. 响应
HTTP代码 说明 类型

200

successful operation

PostionList
3.12.1.4. HTTP请求示例
请求 path
/string/merchant/wd/orgservice/org/string/postions
3.12.1.5. HTTP响应示例
响应 200
{
  "postions" : [ {
    "id" : "32345",
    "name" : "会计",
    "org_id" : "2345456"
  } ]
}

3.12.2. 查询组织岗位

POST /{tenant_id}/merchant/wd/orgservice/orgs/postions/query
3.12.2.1. 说明

查询组织岗位

3.12.2.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码,必须大于等于0

integer (int32)

Query

page_size
必填

页大小,查询分页大小必须在[1,100]之间

integer (int32)

Query

sort_key
可选

排序字段：created，modified

string

Body

filter
必填

过滤器

OrgPostionFilter
3.12.2.3. 响应
HTTP代码 说明 类型

200

successful operation

OrgPostionPaging
3.12.2.4. HTTP请求示例
请求 path
/string/merchant/wd/orgservice/orgs/postions/query?desc=true&page=0&page_size=0
请求 body
3.12.2.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "postions" : [ {
    "id" : "32345",
    "name" : "会计",
    "org_id" : "2345456"
  } ],
  "page_count" : 10,
  "page_size" : 10
}

3.12.3. 查询组织

POST /{tenant_id}/merchant/wd/orgservice/orgs/query
3.12.3.1. 说明

查询组织

3.12.3.2. 参数
类型 名称 说明 类型

Path

tenant_id
必填

租户ID

string

Query

desc
必填

是否倒序

boolean

Query

page
必填

页码,必须大于等于0

integer (int32)

Query

page_size
必填

页大小,查询分页大小必须在[1,100]之间

integer (int32)

Query

sort_key
可选

排序字段：created，modified

string

Body

filter
必填

过滤器

OrgFilter
3.12.3.3. 响应
HTTP代码 说明 类型

200

successful operation

OrgPaging
3.12.3.4. HTTP请求示例
请求 path
/string/merchant/wd/orgservice/orgs/query?desc=true&page=0&page_size=0
请求 body
{
  "id" : "3323223",
  "types" : "HQ",
  "modified_begin" : "2017-12-26 16:30:08",
  "modified_end" : "2017-12-26 16:30:08"
}
3.12.3.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "orgs" : [ {
    "id" : "2345456",
    "name" : "测试早教中心",
    "type" : "HQ",
    "remark" : "备注",
    "upgra_org" : "A14",
    "business_type" : "ip"
  } ],
  "page_count" : 10,
  "page_size" : 10
}

4. 定义

4.1. ActionResult

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

4.2. Contact

联系方式

名称 说明 类型

name
可选

联系人名称
样例 : "李飞"

string

phone
可选

电话
样例 : "18676778787"

string

4.3. CustomField

自定义属性值

名称 说明 类型

id
可选

字段ID
样例 : "area_id"

string

name
可选

自定名称
样例 : "地区代码"

string

value
可选

字段值
样例 : "ET09"

string

4.4. DeviceCategory

设备分类对象

名称 说明 类型

code
可选

编码
样例 : "computer"

string

id
可选

ID
样例 : "212122211"

string

levelNo
可选

等级
样例 : "1"

string

name
可选

名称
样例 : "电脑"

string

parent_id
可选

上级ID
样例 : "1121515"

string

state
可选

状态：opened（已开启），closed（已禁用），deleted（已删除）
样例 : "opened"

enum (opened, closed, deleted)

4.5. DeviceCategoryFilter

设备分类查询过滤器

名称 说明 类型

code
可选

编码
样例 : "comp"

string

id
可选

ID
样例 : "323"

string

modified_end
可选

修改时间结束于
样例 : "2017-12-26 16:30:08"

string (date-time)

modified_start
可选

修改时间起始于
样例 : "2017-12-26 16:30:08"

string (date-time)

4.6. DeviceCategoryPaging

设备分类查询对象

名称 说明 类型

device_categorys
可选

设备分类列表
样例 : [ "DeviceCategory" ]

< DeviceCategory > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

4.7. Function

名称 说明 类型

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

parent_id
可选

样例 : "string"

string

path
可选

样例 : "string"

string

seqNo
可选

样例 : 0

integer (int32)

type
可选

样例 : "string"

string

4.8. FunctionAccess

名称 说明 类型

id
可选

样例 : "string"

string

state
可选

样例 : "applying"

enum (applying, opened)

4.9. FunctionOpenRequest

名称 说明 类型

functions
可选

样例 : [ "FunctionAccess" ]

< FunctionAccess > array

4.10. FunctionPerm

名称 说明 类型

function
可选

样例 : Function

Function

permissions
可选

样例 : [ "Permission" ]

< Permission > array

4.11. IdName

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

4.12. IdNameList

名称 说明 类型

items
可选

样例 : [ "IdName" ]

< IdName > array

4.13. IdsWrapper

名称 说明 类型

ids
可选

样例 : [ "string" ]

< string > array

4.14. Location

位置信息

名称 说明 类型

area
可选

地区
样例 : "北区"

string

city
可选

市
样例 : "厦门"

string

city_code
可选

市代码
样例 : "01"

string

district
可选

区
样例 : "湖里"

string

district_code
可选

区代码
样例 : "13"

string

lat
可选

纬度
样例 : 123.0

number

lng
可选

经度
样例 : 64.0

number

province
可选

省
样例 : "福建"

string

province_code
可选

省代码
样例 : "365"

string

street
可选

详细地址
样例 : "金山街道226"

string

4.15. MachineCategory

机台型号对象

名称 说明 类型

code
可选

编码
样例 : "dell2"

string

device_category_id
可选

设备分类ID
样例 : "212122211"

string

id
可选

ID
样例 : "212122211"

string

name
可选

名称
样例 : "戴尔2代"

string

state
可选

状态：opened（已开启），closed（已禁用），deleted（已删除）
样例 : "opened"

enum (opened, closed, deleted)

4.16. MachineCategoryFilter

机台型号查询过滤器

名称 说明 类型

code
可选

编码
样例 : "dell"

string

id
可选

ID
样例 : "323"

string

modified_end
可选

修改结束时间
样例 : "2017-12-26 16:30:08"

string (date-time)

modified_start
可选

修改起始时间
样例 : "2017-12-26 16:30:08"

string (date-time)

4.17. MachineCategoryPaging

机台型号查询对象

名称 说明 类型

machine_categorys
可选

机台型号列表
样例 : [ "MachineCategory" ]

< MachineCategory > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

4.18. OpenRequest

名称 说明 类型

state
可选

样例 : "using"

enum (using, blocked)

4.19. Org

组织对象

名称 说明 类型

business_type
可选

组织业态：ip（ip），park（乐园），early_education（早教）
样例 : "ip"

enum (ip, park, early_education, superMarket, departmentStore)

id
可选

ID
样例 : "2345456"

string

name
可选

名称
样例 : "测试早教中心"

string

remark
可选

remark
样例 : "备注"

string

type
可选

组织类型：HQ（总部），biz_HQ（业态总部），area（区域），store（门店）
样例 : "HQ"

enum (HQ, biz_HQ, area, store)

upgra_org
可选

上级组织ID
样例 : "A14"

string

4.20. OrgFilter

组织查询过滤器

名称 说明 类型

id
可选

ID
样例 : "3323223"

string

modified_begin
可选

修改起始时间
样例 : "2017-12-26 16:30:08"

string (date-time)

modified_end
可选

修改结束时间
样例 : "2017-12-26 16:30:08"

string (date-time)

types
可选

组织类型：HQ（总部）、biz_HQ（业态总部）、area（区域）、store（门店）
样例 : "HQ"

< enum (HQ, biz_HQ, area, store) > array

4.21. OrgPaging

组织查询对象

名称 说明 类型

orgs
可选

组织列表
样例 : [ "Org" ]

< Org > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

4.22. OrgPostion

组织岗位对象

名称 说明 类型

org_business_type
可选

组织业态：ip（ip），park（乐园），early_education（早教），
样例 : "ip"

enum (ip, park, early_education, superMarket, departmentStore)

org_id
可选

组织ID
样例 : "2345456"

string

org_name
可选

组织名称
样例 : "测试早教中心"

string

org_type
可选

组织类型：HQ（总部），biz_HQ（业态总部），area（区域），store（门店）
样例 : "HQ"

enum (HQ, biz_HQ, area, store)

postion_id
可选

岗位代码
样例 : "2345456"

string

postion_name
可选

岗位名称
样例 : "教师"

string

4.23. OrgPostionFilter

组织岗位查询过滤器

类型 : object

4.24. OrgPostionPaging

组织岗位查询对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

postions
可选

岗位列表
样例 : [ "Postion" ]

< Postion > array

total
可选

总记录数
样例 : 100

integer (int64)

4.25. Organization

商家对象

名称 说明 类型

business_type
可选

业态
样例 : "门店"

string

city
可选

市
样例 : "厦门市"

string

email
可选

邮箱
样例 : "155454545@qq.com"

string

hd_user_id
可选

海鼎用户编码
样例 : "aafs"

string

id
可选

商户标识
样例 : "yangleduo"

string

image_url
可选

主图片
样例 : "string"

string

image_urls
可选

子图片
样例 : [ "string" ]

< string > array

mobile
可选

手机号
样例 : "18723456654"

string

name
可选

商户名称
样例 : "养乐多"

string

province
可选

省
样例 : "福建省"

string

remark
可选

备注
样例 : "string"

string

source
可选

来源
样例 : "payman"

string

tenant_id
可选

租户编号
样例 : "cscsc"

string

4.26. Permission

权限对象

名称 说明 类型

group
必填

权限分组
样例 : "aaa"

string

group_name
可选

权限分组名称
样例 : "分组aa"

string

id
必填

权限ID
样例 : "aaa.bbb"

string

name
必填

权限名称
样例 : "权限a"

string

4.27. PermissionList

权限列表对象

名称 说明 类型

permissions
可选

权限列表
样例 : [ "Permission" ]

< Permission > array

4.28. Postion

组织岗位

名称 说明 类型

id
可选

ID
样例 : "32345"

string

name
可选

名称
样例 : "会计"

string

org_id
可选

组织ID
样例 : "2345456"

string

4.29. PostionList

组织岗位列表对象

名称 说明 类型

postions
可选

岗位列表
样例 : [ "Postion" ]

< Postion > array

4.30. RestConfig

名称 说明 类型

password
可选

样例 : "string"

string

user
可选

样例 : "string"

string

4.31. Staff

员工对象

名称 说明 类型

created
可选

创建时间
样例 : "2019-01-03 00:00:00"

string (date-time)

department_id
可选

部门ID
样例 : "123"

string

department_name
可选

部门名称
样例 : "事业部"

string

departure_date
可选

离职时间
样例 : "2019-06-03 00:00:00"

string (date-time)

email
可选

邮箱
样例 : "151551@qq.com"

string

gender
必填

性别：男，女
样例 : "男"

string

hire_date
可选

入职时间
样例 : "2019-01-03 00:00:00"

string (date-time)

id
必填

代码
样例 : "2345456"

string

id_number
可选

身份证
样例 : "350426199912125520"

string

job_number
可选

工号
样例 : "2345456"

string

mobile
可选

手机号
样例 : "18547859965"

string

modified
可选

修改时间
样例 : "2019-01-03 00:00:00"

string (date-time)

name
必填

名称
样例 : "百里追风"

string

org_postions
可选

岗位列表
样例 : [ "OrgPostion" ]

< OrgPostion > array

password
可选

密码
样例 : "123456"

string

position_id
可选

岗位ID
样例 : "4345"

string

position_name
可选

岗位名称
样例 : "业务员"

string

state
必填

员工状态：on_job（在职），quit_job（离职），默认on_job
样例 : "on_job"

enum (on_job, quit_job)

superior_id
可选

上级主管ID
样例 : "11232"

string

superior_name
可选

上级主管名称
样例 : "百里屠苏"

string

wx_id
可选

万信号
样例 : "9897547577594"

string

4.32. StaffFilter

员工查询对象

名称 说明 类型

id
可选

员工代码
样例 : "12332"

string

keyword
可选

关键字（ID，name近似搜索）
样例 : "12332"

string

modified_begin
可选

修改起始时间
样例 : "2019-01-03 00:00:00"

string (date-time)

modified_end
可选

修改终止时间
样例 : "2019-01-03 00:00:00"

string (date-time)

wx_id
可选

万信号
样例 : "12332"

string

4.33. StaffList

员工列表对象

名称 说明 类型

staffs
可选

员工列表
样例 : [ "Staff" ]

< Staff > array

4.34. StaffPaging

员工查询对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

staffs
可选

员工列表
样例 : [ "Staff" ]

< Staff > array

total
可选

总记录数
样例 : 100

integer (int64)

4.35. Store

门店资料对象

名称 说明 类型

account_name
可选

开票银行名称
样例 : "1245"

string

account_no
可选

开票银行账号
样例 : "1245"

string

area_leader
可选

区域主管
样例 : IdName

IdName

business_hours
可选

经营时段
样例 : "10:00-12:00;14:00-21:00"

string

business_type
可选

业态：ip（ip），park（乐园），early_education（早教）
样例 : "early_education"

string

circles
可选

所属商圈
样例 : [ "string" ]

< string > array

contact
可选

联系方式
样例 : Contact

Contact

customs_fields
可选

自定义属性值
样例 : [ "CustomField" ]

< CustomField > array

distance
可选

距离
样例 : 100.0

number

gid
可选

门店Gid
样例 : "gid"

string

id
必填

门店代码
样例 : "2345456"

string

image_urls
可选

多张图片；分隔,最多5张图片
样例 : [ "string" ]

< string > array

location
可选

位置信息
样例 : Location

Location

main_image_url
可选

主图
样例 : "string"

string

name
必填

门店名称
样例 : "阳光店"

string

open_date
可选

开店时间
样例 : "2018-06-01 00:00:00"

string (date-time)

operation_manager
可选

运营经理
样例 : IdName

IdName

region
可选

所属区域
样例 : StoreRegion

StoreRegion

remark
可选

备注
样例 : "第二个路口左转"

string

sap_code
可选

门店SAP编码
样例 : "sapCode"

string

source_sys
可选

来源系统
样例 : "HDPOS4"

string

state
可选

门店状态：opened（正常），stopped（停业），closed（关闭）
样例 : "opened"

enum (opened, stopped, closed)

tags
可选

标签
样例 : [ "StoreTag" ]

< StoreTag > array

tax_no
可选

开票税号
样例 : "1245"

string

type
可选

门店类型:self（自营连锁），self_join（连锁加盟(自主)），managed_join（连锁加盟(托管)），interal_join（连锁加盟(内部)），single_store（单店），other（其它），direct（直营），join（加盟）
样例 : "self"

enum (self, self_join, managed_join, interal_join, single_store, other, direct, join)

4.36. StoreFilter

门店过滤器

名称 说明 类型

business_types
可选

业态
样例 : [ "string" ]

< string > array

circles
可选

所属商圈
样例 : [ "string" ]

< string > array

id
可选

门店代码
样例 : "1323230"

string

key_like
可选

查询关键字类似于
样例 : "2134"

string

latitude_end
可选

纬度结束于
样例 : 89.0

number

latitude_start
可选

纬度起始于
样例 : 65.0

number

longtitude_end
可选

经度终止于
样例 : 120.0

number

longtitude_start
可选

经度起始于
样例 : 110.0

number

modified_end
可选

修改时间结束于
样例 : "2018-09-07 00:00:00"

string (date-time)

modified_start
可选

修改时间起始于
样例 : "2018-09-07 00:00:00"

string (date-time)

states
可选

门店状态：opened（正常），opened（停业），opened（关闭）
样例 : "opened"

< enum (opened, stopped, closed) > array

store_ids
可选

多个门店代码
样例 : [ "string" ]

< string > array

types
可选

门店类型:self（自营连锁），self_join（连锁加盟(自主)），managed_join（连锁加盟(托管)），interal_join（连锁加盟(内部)），single_store（单店），other（其它），direct（直营），join（加盟）
样例 : "self"

< enum (self, self_join, managed_join, interal_join, single_store, other, direct, join) > array

4.37. StoreList

门店列表对象

名称 说明 类型

stores
可选

门店列表
样例 : [ "Store" ]

< Store > array

4.38. StoreModification

门店修改对象

名称 说明 类型

account_name
可选

开票银行名称
样例 : "1245"

string

account_no
可选

开票银行账号
样例 : "1245"

string

area_leader
可选

区域主管
样例 : IdName

IdName

business_hours
可选

样例 : "string"

string

business_type
可选

业态：ip（ip），park（乐园），early_education（早教）
样例 : "early_education"

string

circles
可选

所属商圈
样例 : [ "string" ]

< string > array

contact
可选

联系方式
样例 : Contact

Contact

gid
可选

内部GID
样例 : "string"

string

location
可选

位置信息
样例 : Location

Location

name
必填

门店名称
样例 : "阳光店"

string

operation_manager
可选

运营经理
样例 : IdName

IdName

region
可选

样例 : StoreRegion

StoreRegion

remark
可选

备注
样例 : "第二个路口左转"

string

sap_code
可选

样例 : "string"

string

source_sys
可选

来源系统
样例 : "HDPOS4"

string

state
可选

门店状态：opened（正常），stopped（停业），closed（关闭）
样例 : "opened"

enum (opened, stopped, closed)

tags
可选

样例 : [ "StoreTag" ]

< StoreTag > array

tax_no
可选

开票税号
样例 : "1245"

string

type
可选

门店类型:self（自营连锁），self_join（连锁加盟(自主)），managed_join（连锁加盟(托管)），interal_join（连锁加盟(内部)），single_store（单店），other（其它），direct（直营），join（加盟）
样例 : "self"

enum (self, self_join, managed_join, interal_join, single_store, other, direct, join)

4.39. StorePaging

门店查询对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

stores
可选

门店列表
样例 : [ "Store" ]

< Store > array

total
可选

总记录数
样例 : 100

integer (int64)

4.40. StoreRegion

门店所属区域

名称 说明 类型

id
必填

区域代码
样例 : "2345456"

string

mgr_wechat_work_id
可选

区域经理企业微信id
样例 : "123456"

string

name
必填

区域名称
样例 : "阳光店"

string

4.41. StoreTag

名称 说明 类型

name
可选

样例 : "string"

string

4.42. Terminal

终端信息

名称 说明 类型

created
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

creator
可选

样例 : "string"

string

id
必填

终端标识
样例 : "terminal001"

string

modified
可选

样例 : "2020-06-17 10:00:00"

string (date-time)

modifier
可选

样例 : "string"

string

name
可选

终端名称
样例 : "终端一号"

string

source
必填

来源
样例 : "qianfan"

string

state
可选

状态：opened（开通），applying（关闭），默认applying
样例 : "applying"

enum (applying, opened)

4.43. TerminalAuth

终端授权信息

名称 说明 类型

rest
可选

接口配置
样例 : RestConfig

RestConfig

terminal
可选

终端
样例 : Terminal

Terminal

4.44. TerminalRegisterRequest

注册终端请求对象

名称 说明 类型

id
必填

标识
样例 : "terminal008"

string

name
可选

名称
样例 : "终端008"

string

source
必填

来源
样例 : "qianfan"

string

4.45. User

名称 说明 类型

id
可选

样例 : "string"

string

is_super_admin
可选

默认值 : false
样例 : true

boolean

is_super_store_manager
可选

默认值 : false
样例 : true

boolean

login_name
可选

样例 : "string"

string

mobile
可选

样例 : "string"

string

name
可选

样例 : "string"

string

state
可选

样例 : "using"

enum (using, blocked)

tenant_id
可选

样例 : "string"

string

4.46. UserCreation

名称 说明 类型

id
可选

样例 : "string"

string

is_super_admin
可选

默认值 : false
样例 : true

boolean

is_super_store_manager
可选

默认值 : false
样例 : true

boolean

login_name
可选

样例 : "string"

string

mobile
可选

样例 : "string"

string

name
可选

样例 : "string"

string

need_encrypt
可选

默认值 : false
样例 : true

boolean

password
可选

样例 : "string"

string

tenant_id
可选

样例 : "string"

string

4.47. UserCreationList

名称 说明 类型

users
可选

样例 : [ "UserCreation" ]

< UserCreation > array

4.48. Vendor

供应商对象

名称 说明 类型

id
必填

代码
样例 : "00001"

string

name
可选

名称
样例 : "供应商"

string

state
可选

状态：opened（开启），closed（关闭），默认开启
样例 : "closed"

string

4.49. VendorFilter

供应商查询过滤器

名称 说明 类型

key_like
可选

关键字类似于（id,name）
样例 : "2123"

string

state
可选

状态：opened，closed
样例 : "closed"

string

4.50. VendorList

供应商列表

名称 说明 类型

vendors
必填

供应商列表
样例 : [ "Vendor" ]

< Vendor > array

4.51. VendorModification

供应商修改请求对象

名称 说明 类型

name
可选

名称
样例 : "华东供应商"

string

state
可选

状态：opened，closed
样例 : "closed"

string

4.52. VendorPaging

供应商查询对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

vendors
可选

供应商列表
样例 : [ "Vendor" ]

< Vendor > array