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

接入指南

接口开发规范

  1. 协议规则

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

  2. 安全规范

    认证:采用HTTP Basic Authentication 进行身份认证

通知回调

  1. 用途

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

  2. 回调说明

    接入系统需要提供一个可被公网访问的URL地址，出于传输安全的需要，建议使用https方式但不进行证书校验）。
接入系统可以订阅不同的通知主题，不同的主题可以使用不同的回调地址，回调方式也可以和轮询方式同时使用。

  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)
    调用鼎力云接口的用户名
接口密码(password)
    调用鼎力云接口的密码

  2. 沙箱授权申请

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

  3. 商户授权申请

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

业务场景

平台订单对接

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

  1. 门店配送订单流程

orderDelivery

说明:
提交订单后： 订单状态->已确认；配送状态->未配送
门店作业：门店接单->接单(accepted)；门店备货->接单(shipping)；
更新配送状态(shipped)： 订单状态->配送中(delivering)；配送状态->已发货(shipped)
更新配送状态(signed)： 订单状态->配送完成(delivered)；配送状态->已妥投(signed)
相关接口：
link:http://apidoc.hd123.com/public/soms/dly-doc/mcyp/#_soms_orderservice_newsubmit[提交订单]
相关消息：
link:http://apidoc.hd123.com/public/soms/dly-doc/mcyp/#%E5%8F%AF%E8%AE%A2%E9%98%85%E7%9A%84%E9%80%9A%E7%9F%A5%E5%88%97%E8%A1%A8[order.state.changed]

  1. 订单发货前整单取消

beforeCancel

说明:
提交订单： 订单状态->已确认；配送状态->未配送
取消订单： 订单状态->已取消；配送状态->未配送

  1. 订单发货后整单退

afterCancel

说明:
提交订单后： 订单状态->已确认；配送状态->未配送
更新配送状态(shipped)： 订单状态->配送中；配送状态->已发货
取消订单： 订单挂起，生成退货单
确认收到退货： 订单状态->配送完成；配送状态->已拒收

  1. 仅退款流程

refund

说明:
提交退款单（type=refund）： 退单状态->已生成；退款状态->未退款
退款同意： 退单状态->已完成；退款状态->已退款
退款拒绝： 退款状态->已取消；退款状态->未退款

  1. 退款退货流程

rtnRefund

说明:
提交退单（type=refundAndRtn）： 退单状态->已生成；退货状态->未退货
确认退状态： 退单状态->已完成；退货状态->已退货

  1. 订单预占货

image:images/stock.png

  1. 订单预占货取消

stockCancel

平台资料对接

资料层级结构

org

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

未启用资料中台的场景

提交平台门店

invcStore

说明:
        平台门店：表示【本平台】要上线的门店范围，不在范围内的门店，不会同步该平台的库存、价格

提交平台商品

invcProduct

说明:
        平台商品：表示【本平台】要上线的商品范围，设置平台商品，可以缩小同步给该平台的库存、价格范围，提升同步效率

启用资料中台的场景

mas

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

平台门店

消息通知：platform_shop.changed.notify

查询API：/v2/{tenant}/service/platformcategory/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

平台价格更新对接

价格变化通知

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": "错误信息"
    }

平台库存更新对接

库存变化通知

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

   说明:
通过门店同步接口，同步门店信息给鼎力云
通过品牌同步接口，同步品牌信息给鼎力云
通过类目同步解耦，同步商品类目信息给鼎力云
通过主档同步接口，同步商品主档信息给鼎力云
通过商品同步接口，同步商品信息给鼎力云
通过门店商品同步接口，同步门店商品信息给鼎力云
通过门店商品库存更新接口，同步库存信息给鼎力云
通过门店商品价格更新接口，同步价格信息给鼎力云

  1. 批发单流程

orderDelivery

  说明:
订单发货通知
查询订单详情

  1. 仅退款批发退流程

refund

说明:
退款确认通知
查询退单详情

  1. 退款退货批发退流程

rtnRefund

  说明:
退货收货通知
查询退单详情

  1. 平台对账数据流程

      说明:
新订单对账消息通知
查询账单详情

配送平台对接

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

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"
    }
    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/categories/query
1.1.2.1. 说明

分页查询类别

1.1.2.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.2.3. 响应
HTTP代码 说明 类型

200

successful operation

CategoryPaging
1.1.2.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.2.5. HTTP响应示例
响应 200
{
  "total" : 0,
  "page" : 0,
  "categories" : [ {
    "id" : "string",
    "name" : "string",
    "remark" : "string",
    "parentId" : "string",
    "sap_code" : "string"
  } ],
  "page_count" : 0,
  "page_size" : 0
}

1.1.3. 批量上传商品图片

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

批量上传商品图片。

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

sku_images
必填

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

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

200

successful operation

ActionResult
1.1.3.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.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.1.4. 指定货号查询商品

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

指定货号查询商品

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

Path

id
必填

商品ID

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

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

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

200

successful operation

Sku
1.1.4.4. HTTP请求示例
请求 path
/string/invc/itemservice/sku/string
1.1.4.5. HTTP响应示例
响应 200
{
  "id" : "484844554",
  "barcode" : "1152",
  "upc" : "69...",
  "name" : "矿泉水",
  "remark" : "无",
  "disp" : false,
  "size" : {
    "unit" : "mm",
    "height" : 12.0,
    "width" : 15.0,
    "length" : 12.0
  },
  "weight" : {
    "unit" : "kg",
    "value" : 12.0
  },
  "packing" : {
    "spec" : "1*1",
    "quantity" : 12.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,
  "suggest_price" : 53.22,
  "image_url" : "http://aa.png",
  "sub_image_urls" : [ "string" ],
  "detail_image_urls" : [ "string" ],
  "tax_rate" : 0.13,
  "tax_sort_code" : "string",
  "combined_items" : [ {
    "id" : "string",
    "title" : "string",
    "price" : 0.0,
    "quantity" : 0.0,
    "product_type" : "normal"
  } ],
  "customs_fields" : [ {
    "id" : "1212",
    "name" : "143434",
    "value" : "1212"
  } ],
  "input_codes" : [ {
    "type" : "EAN",
    "code" : "232323",
    "qpc" : 0.0,
    "unit" : "string",
    "weight" : 0.0,
    "qpc_str" : "string"
  } ],
  "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"
}

1.1.5. 批量取商品信息

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

批量取商品信息

1.1.5.2. 参数
类型 名称 类型

Path

tenant_id
必填

string

Body

body
可选

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

200

successful operation

SkuList
1.1.5.4. HTTP请求示例
请求 path
/string/invc/itemservice/skus
请求 body
{
  "ids" : [ "string" ]
}
1.1.5.5. HTTP响应示例
响应 200
{
  "skus" : [ {
    "id" : "484844554",
    "barcode" : "1152",
    "upc" : "69...",
    "name" : "矿泉水",
    "remark" : "无",
    "disp" : false,
    "size" : {
      "unit" : "mm",
      "height" : 12.0,
      "width" : 15.0,
      "length" : 12.0
    },
    "weight" : {
      "unit" : "kg",
      "value" : 12.0
    },
    "packing" : {
      "spec" : "1*1",
      "quantity" : 12.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,
    "suggest_price" : 53.22,
    "image_url" : "http://aa.png",
    "sub_image_urls" : [ "string" ],
    "detail_image_urls" : [ "string" ],
    "tax_rate" : 0.13,
    "tax_sort_code" : "string",
    "combined_items" : [ {
      "id" : "string",
      "title" : "string",
      "price" : 0.0,
      "quantity" : 0.0,
      "product_type" : "normal"
    } ],
    "customs_fields" : [ {
      "id" : "1212",
      "name" : "143434",
      "value" : "1212"
    } ],
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 0.0,
      "unit" : "string",
      "weight" : 0.0,
      "qpc_str" : "string"
    } ],
    "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"
  } ]
}

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

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

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

1.1.6.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.6.3. 响应
HTTP代码 说明 类型

200

successful operation

SkuPaging
1.1.6.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",
  "sku_ids" : [ "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",
  "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.6.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 0,
  "skus" : [ {
    "id" : "484844554",
    "barcode" : "1152",
    "upc" : "69...",
    "name" : "矿泉水",
    "remark" : "无",
    "disp" : false,
    "size" : {
      "unit" : "mm",
      "height" : 12.0,
      "width" : 15.0,
      "length" : 12.0
    },
    "weight" : {
      "unit" : "kg",
      "value" : 12.0
    },
    "packing" : {
      "spec" : "1*1",
      "quantity" : 12.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,
    "suggest_price" : 53.22,
    "image_url" : "http://aa.png",
    "sub_image_urls" : [ "string" ],
    "detail_image_urls" : [ "string" ],
    "tax_rate" : 0.13,
    "tax_sort_code" : "string",
    "combined_items" : [ {
      "id" : "string",
      "title" : "string",
      "price" : 0.0,
      "quantity" : 0.0,
      "product_type" : "normal"
    } ],
    "customs_fields" : [ {
      "id" : "1212",
      "name" : "143434",
      "value" : "1212"
    } ],
    "input_codes" : [ {
      "type" : "EAN",
      "code" : "232323",
      "qpc" : 0.0,
      "unit" : "string",
      "weight" : 0.0,
      "qpc_str" : "string"
    } ],
    "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"
  } ],
  "page_count" : 10,
  "page_size" : 10
}

1.2. 平台商家授权服务

1.2.1. 获取平台授权信息

GET /{tenant_id}/storedelivery/authservice/{platform_id}/{shop_id}/authinfo
1.2.1.1. 说明

获取平台授权信息

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

Path

platform_id
必填

平台ID

string

Path

shop_id
必填

商家ID

string

Path

tenant_id
必填

租户ID

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

200

successful operation

BaseResponseAuthInfo
1.2.1.4. HTTP请求示例
请求 path
/string/storedelivery/authservice/string/string/authinfo
1.2.1.5. HTTP响应示例
响应 200
{
  "message" : "string",
  "success" : true,
  "data" : {
    "platform_id" : "1001001",
    "shop_id" : "1001001",
    "app_key" : "1001001",
    "app_secret" : "1001001",
    "session_key" : "1001001"
  }
}

1.3. 采购建议单服务

1.3.1. 提交建议

POST /{tenant_id}/soms/purchasesuggestservice/suggest
1.3.1.1. 说明

提交建议

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

suggest
必填

单据

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

200

successful operation

PurchaseSuggestResponse
1.3.1.4. HTTP请求示例
请求 path
/string/soms/purchasesuggestservice/suggest?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "88822222222",
  "state" : "string",
  "vendor" : {
    "code" : "string",
    "name" : "string"
  },
  "purchaser" : {
    "code" : "string",
    "name" : "string"
  },
  "items" : [ {
    "qty" : 1.0,
    "sku_id" : "00321",
    "relation_qty" : 0.0
  } ],
  "remark" : "销售触发采购",
  "lock_state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
  "ship_state" : "shipped",
  "ship_wrh" : {
    "code" : "string",
    "name" : "string"
  },
  "expect_ship_time" : "2022-03-05 08:00:00",
  "ship_time" : "2022-03-05 08:00:00",
  "receive_wrh" : {
    "code" : "string",
    "name" : "string"
  },
  "relation_items" : [ {
    "qty" : 0.0,
    "order_type" : "order(订单),saleorder(销售订单)",
    "order_id" : "string",
    "suggest_id" : "string",
    "sku_id" : "string"
  } ]
}
1.3.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "id" : "88822222222"
}

1.3.2. 查询采购建议单

POST /{tenant_id}/soms/purchasesuggestservice/suggest/query
1.3.2.1. 说明

查询采购建议单

1.3.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
可选

排序字段，取值范围:expectShipTime(期望发货时间)、created(创建时间)

string

Body

filter
必填

查询条件

PurchaseSuggestFilter
1.3.2.3. 响应
HTTP代码 说明 类型

200

successful operation

PurchaseSuggestPaging
1.3.2.4. HTTP请求示例
请求 path
/string/soms/purchasesuggestservice/suggest/query?desc=true&page=0&page_size=0
请求 body
{
  "state" : "string",
  "id" : "32323232323323",
  "ids" : "32323232323323",
  "id_refix" : "32323232323323",
  "created_start" : "2016-03-02 12:00:01",
  "created_end" : "2016-03-02 12:00:01",
  "expect_ship_time_start" : "2016-03-02 12:00:01",
  "expect_ship_time_end" : "2016-03-02 12:00:01",
  "ship_time_start" : "2016-03-02 12:00:01",
  "ship_time_end" : "2016-03-02 12:00:01",
  "vendor_code" : "12",
  "ship_wrh_code" : "12",
  "purchaser_code" : "8568",
  "receive_wrh_code" : "8568",
  "lock_state" : "32323232323323",
  "ship_state" : "32323232323323",
  "order_id_in" : [ "string" ],
  "sku_id_in" : [ "string" ]
}
1.3.2.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "list" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "88822222222",
    "state" : "string",
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "purchaser" : {
      "code" : "string",
      "name" : "string"
    },
    "items" : [ {
      "qty" : 1.0,
      "sku_id" : "00321",
      "relation_qty" : 0.0
    } ],
    "remark" : "销售触发采购",
    "lock_state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
    "ship_state" : "shipped",
    "ship_wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "expect_ship_time" : "2022-03-05 08:00:00",
    "ship_time" : "2022-03-05 08:00:00",
    "receive_wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "relation_items" : [ {
      "qty" : 0.0,
      "order_type" : "order(订单),saleorder(销售订单)",
      "order_id" : "string",
      "suggest_id" : "string",
      "sku_id" : "string"
    } ]
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.3.3. 查询采购建议单关联明细

POST /{tenant_id}/soms/purchasesuggestservice/suggest/relationitem/query
1.3.3.1. 说明

查询采购建议单关联明细

1.3.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
可选

排序字段

string

Body

filter
必填

查询条件

PurchaseSuggestRelationFilter
1.3.3.3. 响应
HTTP代码 说明 类型

200

successful operation

SomsPageResponseRelationItem
1.3.3.4. HTTP请求示例
请求 path
/string/soms/purchasesuggestservice/suggest/relationitem/query?desc=true&page=0&page_size=0
请求 body
{
  "suggest_id" : "32323232323323",
  "order_id_eq" : "32323232323323",
  "sku_id_eq" : "32323232323323",
  "sku_id_in" : [ "string" ],
  "order_id_in" : [ "string" ]
}
1.3.3.5. HTTP响应示例
响应 200
{
  "echoCode" : 0,
  "echoMessage" : "string",
  "success" : true,
  "page" : 0,
  "pageSize" : 0,
  "pageCount" : 0,
  "total" : 0,
  "data" : [ {
    "qty" : 0.0,
    "order_type" : "order(订单),saleorder(销售订单)",
    "order_id" : "string",
    "suggest_id" : "string",
    "sku_id" : "string"
  } ]
}

1.3.4. 取指定采购建议单

GET /{tenant_id}/soms/purchasesuggestservice/suggest/{id}
1.3.4.1. 说明

取指定采购建议单

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

Path

id
必填

单据id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用,隔开。需要返回的部分,items(商品详情),relationitems(关联商品详情)

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

200

successful operation

PurchaseSuggest
1.3.4.4. HTTP请求示例
请求 path
/string/soms/purchasesuggestservice/suggest/string
1.3.4.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "88822222222",
  "state" : "string",
  "vendor" : {
    "code" : "string",
    "name" : "string"
  },
  "purchaser" : {
    "code" : "string",
    "name" : "string"
  },
  "items" : [ {
    "qty" : 1.0,
    "sku_id" : "00321",
    "relation_qty" : 0.0
  } ],
  "remark" : "销售触发采购",
  "lock_state" : "占货状态：none（缺货）、part（部分占货）、all（全部占货）",
  "ship_state" : "shipped",
  "ship_wrh" : {
    "code" : "string",
    "name" : "string"
  },
  "expect_ship_time" : "2022-03-05 08:00:00",
  "ship_time" : "2022-03-05 08:00:00",
  "receive_wrh" : {
    "code" : "string",
    "name" : "string"
  },
  "relation_items" : [ {
    "qty" : 0.0,
    "order_type" : "order(订单),saleorder(销售订单)",
    "order_id" : "string",
    "suggest_id" : "string",
    "sku_id" : "string"
  } ]
}

1.3.5. 审核采购建议单

POST /{tenant_id}/soms/purchasesuggestservice/suggest/{id}/action/approve
1.3.5.1. 说明

审核采购建议单

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

Path

id
必填

id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

SuggestApproveRequest
1.3.5.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.3.5.4. HTTP请求示例
请求 path
/string/soms/purchasesuggestservice/suggest/string/action/approve?operator=string
请求 body
1.3.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.3.6. 完成采购建议单

POST /{tenant_id}/soms/purchasesuggestservice/suggest/{id}/action/finish
1.3.6.1. 说明

完成采购建议单

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

Path

id
必填

id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

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

200

successful operation

ActionResult
1.3.6.4. HTTP请求示例
请求 path
/string/soms/purchasesuggestservice/suggest/string/action/finish?operator=string
1.3.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.3.7. 占货

POST /{tenant_id}/soms/purchasesuggestservice/suggest/{id}/lock
1.3.7.1. 说明

占货

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

Path

id
必填

id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

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

200

successful operation

SomsResponseVoid
1.3.7.4. HTTP请求示例
请求 path
/string/soms/purchasesuggestservice/suggest/string/lock?operator=string
1.3.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : { }
}

1.3.8. 添加关联明细

POST /{tenant_id}/soms/purchasesuggestservice/suggest/{id}/relationitem
1.3.8.1. 说明

添加关联明细

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

Path

id
必填

id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

关联明细列表

SomsRequestListRelationItem
1.3.8.3. 响应
HTTP代码 说明 类型

200

successful operation

SomsResponseVoid
1.3.8.4. HTTP请求示例
请求 path
/string/soms/purchasesuggestservice/suggest/string/relationitem?operator=string
请求 body
{
  "data" : [ {
    "qty" : 0.0,
    "order_type" : "order(订单),saleorder(销售订单)",
    "order_id" : "string",
    "suggest_id" : "string",
    "sku_id" : "string"
  } ]
}
1.3.8.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : { }
}

1.3.9. 发货

POST /{tenant_id}/soms/purchasesuggestservice/suggest/{id}/ship
1.3.9.1. 说明

发货

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

Path

id
必填

id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

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

200

successful operation

SomsResponseVoid
1.3.9.4. HTTP请求示例
请求 path
/string/soms/purchasesuggestservice/suggest/string/ship?operator=string
1.3.9.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : { }
}

1.4. 评论服务

1.4.1. 提交订单评价

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

提交订单评价

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order_comment
必填

订单评价

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

200

successful operation

ActionResult
1.4.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.4.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.4.2. 查询评价

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

查询评价

1.4.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.4.2.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderCommentPaging
1.4.2.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/query?desc=true&page=0&page_size=0
请求 body
{
  "platformIdEq" : "jdo2o",
  "stationIdEq" : "string",
  "idEq" : "string",
  "orderIdIn" : [ "string" ],
  "processStateEq" : "string",
  "processStateNotIn" : [ "string" ],
  "processStateIn" : [ "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" ],
  "created_start" : "2016-03-02 12:00:01",
  "created_end" : "2016-03-02 12:00:01"
}
1.4.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.4.3. 获取评价

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

获取评价

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

Path

id
必填

评论Id

string

Path

tenant_id
必填

租户ID

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

200

successful operation

OrderComment
1.4.3.4. HTTP请求示例
请求 path
/string/soms/commentservice/comment/string
1.4.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.4.4. 更新评价回复

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

更新评价回复

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

Path

id
必填

评论Id

string

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

更新评价回复request

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

200

successful operation

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

1.5. 自提规则服务

1.5.1. 获取自提规则

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

获取自提规则

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

Path

tenant_id
必填

租户Id

string

Query

platform_id
必填

平台ID

string

Query

shop_id
必填

商家ID

string

Query

store_id
可选

门店ID

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

200

successful operation

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

1.6. 订单占货服务

1.6.1. 订单批量占货

POST /{tenant_id}/invc/orderstockservice/batchlock
1.6.1.1. 说明

订单批量占货，同时成功，同时失败，支持返回缺货明细,pre_lock类型的占货，不支持部分占货

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

占货参数

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

200

successful operation

BatchLockStockResponse
1.6.1.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/batchlock?operator=string
请求 body
{
  "orders" : [ {
    "items" : [ {
      "shop_id" : "12121212",
      "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"
  } ],
  "allow_part" : false
}
1.6.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "details" : [ {
    "order_id" : "4545454545454542",
    "lock_id" : "string",
    "stock_state" : "locked",
    "lock_result" : "none",
    "outoflock_items" : [ {
      "sku_id" : "string"
    } ]
  } ],
  "lock_result" : "none"
}

1.6.2. 批量订单释放占货

POST /{tenant_id}/invc/orderstockservice/batchunlock
1.6.2.1. 说明

批量订单释放占货

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

占货参数

OrderBatchUnLockRequest
1.6.2.3. 响应
HTTP代码 说明 类型

200

successful operation

BatchUnLockStockResponse
1.6.2.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/batchunlock?operator=string
请求 body
{
  "unlocks" : [ {
    "reason" : "订单取消",
    "order_id" : "4545454545454542"
  } ]
}
1.6.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "errors" : [ {
    "id" : "string",
    "code" : "string",
    "message" : "string"
  } ]
}

1.6.3. 订单占货

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

订单占货

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

param
必填

占货参数

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

200

successful operation

LockStockResult
1.6.3.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/lock?operator=string
请求 body
{
  "items" : [ {
    "shop_id" : "12121212",
    "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.6.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "stock_state" : "locked",
  "lock_result" : "none",
  "lock_id" : "string"
}

1.6.4. 查询订单占货

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

查询订单占货

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

Path

tenant_id
必填

租户ID

string

Query

order_id
必填

订单号

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

200

successful operation

LockStockResult
1.6.4.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/order/lockresult?order_id=string
1.6.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "stock_state" : "locked",
  "lock_result" : "none",
  "lock_id" : "string"
}

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

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

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

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

Path

tenant_id
必填

租户ID

string

Query

platform_id
必填

平台id

string

Query

shop_id
必填

商家id

string

Query

shop_id
可选

门店id

string

Query

sku_ids
必填

货号集合，记录数大小[1,100]

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

200

successful operation

SkuQuantityList
1.6.5.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/orderstocks?platform_id=string&shop_id=string&sku_ids=string
1.6.5.5. HTTP响应示例
响应 200
{
  "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.6.6. 释放销售单预占

POST /{tenant_id}/invc/orderstockservice/removeSaleOrderPreLock
1.6.6.1. 说明

释放销售单预占

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

orderId
必填

销售单号

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

200

successful operation

ActionResult
1.6.6.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/removeSaleOrderPreLock?operator=string
请求 body
1.6.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.6.7. 销售单预占

POST /{tenant_id}/invc/orderstockservice/saleOrderPreLock
1.6.7.1. 说明

销售单预占

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

param
必填

占货参数

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

200

successful operation

LockStockResult
1.6.7.4. HTTP请求示例
请求 path
/string/invc/orderstockservice/saleOrderPreLock?operator=string
请求 body
{
  "items" : [ {
    "shop_id" : "12121212",
    "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.6.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "stock_state" : "locked",
  "lock_result" : "none",
  "lock_id" : "string"
}

1.6.8. 订单发货|出库

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

订单发货|出库

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

Path

order_id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

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

200

successful operation

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

1.6.9. 订单释放库存

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

订单释放库存

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Query

order_id
必填

订单号

string

Query

request_id
可选

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

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

200

successful operation

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

1.7. 属性服务

1.7.1. 保存属性服务

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

保存属性服务

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

option
必填

属性

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

default

successful operation

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

1.7.2. 保存属性服务

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

保存属性服务

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

options
必填

属性

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

default

successful operation

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

1.7.3. 删除属性服务

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

删除属性服务

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

Path

tenant_id
必填

租户Id

string

Path

type
必填

类型

string

Query

value
可选

值

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

default

successful operation

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

1.7.4. 根据多类型获取属性服务

POST /{tenant_id}/soms/optionservice/options/getByTypes
1.7.4.1. 说明

根据多类型获取属性服务

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

Path

tenant_id
必填

租户Id

string

Body

types
必填

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

SomsRequestListString
1.7.4.3. 响应
HTTP代码 说明 类型

200

successful operation

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

1.7.5. 获取属性服务

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

获取属性服务

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

Path

tenant_id
必填

租户Id

string

Path

type
必填

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

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

200

successful operation

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

1.7.6. 获取属性服务

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

获取属性服务

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

Path

tenant_id
必填

租户Id

string

Path

type
必填

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

string

Query

value
可选

值

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

200

successful operation

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

1.8. 退货服务

1.8.1. 提交退货单

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

提交退货单

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

rtn
必填

退货单

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

200

successful operation

IdWrapper
1.8.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"
    },
    "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" : "连江县/思明区",
        "town" : "string",
        "street" : "观日路46号603",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      },
      "oaid" : "string"
    },
    "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",
    "is_buyer_received" : false
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_amount" : 12.03,
    "settle_fieight" : 12.03,
    "package_total" : 12.03,
    "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" : "已退货",
    "type" : {
      "id" : "string",
      "name" : "string"
    },
    "creator" : "254145",
    "rtn_id" : "123456",
    "third_rtn_id" : "12212456112",
    "station_id" : "254145",
    "platform_group" : "string"
  },
  "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
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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",
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "tags" : "标签",
    "salesman_type" : "author",
    "salesman_id" : "123",
    "salesman_name" : "榕榕",
    "is_gift" : true
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "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的参与详情"
      },
      "merchant_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",
    "member_grade" : "12253"
  },
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : [ {
      "qty" : 1.0,
      "amount" : 1.0,
      "sku_id" : "213323232",
      "sku_name" : "213323232"
    } ],
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "type_change_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",
  "wrh_name" : "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"
  } ],
  "settle_info" : {
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "address_change_fee" : 120.01,
  "is_can_return_goods" : true
}
1.8.1.5. HTTP响应示例
响应 200
{
  "id" : "string"
}

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

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

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

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

Path

rtn_id
必填

前端退货单号

string

Path

tenant_id
必填

租户ID

string

Query

parts
必填

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

string

Query

platform_id
必填

平台ID

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

200

successful operation

Rtn
1.8.2.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/front/string?parts=string&platform_id=string
1.8.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"
    },
    "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" : "连江县/思明区",
        "town" : "string",
        "street" : "观日路46号603",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      },
      "oaid" : "string"
    },
    "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",
    "is_buyer_received" : false
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_amount" : 12.03,
    "settle_fieight" : 12.03,
    "package_total" : 12.03,
    "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" : "已退货",
    "type" : {
      "id" : "string",
      "name" : "string"
    },
    "creator" : "254145",
    "rtn_id" : "123456",
    "third_rtn_id" : "12212456112",
    "station_id" : "254145",
    "platform_group" : "string"
  },
  "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
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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",
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "tags" : "标签",
    "salesman_type" : "author",
    "salesman_id" : "123",
    "salesman_name" : "榕榕",
    "is_gift" : true
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "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的参与详情"
      },
      "merchant_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",
    "member_grade" : "12253"
  },
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : [ {
      "qty" : 1.0,
      "amount" : 1.0,
      "sku_id" : "213323232",
      "sku_name" : "213323232"
    } ],
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "type_change_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",
  "wrh_name" : "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"
  } ],
  "settle_info" : {
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "address_change_fee" : 120.01,
  "is_can_return_goods" : true
}

1.8.3. 提交退货单

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

新提交退货单接口

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

rtn
必填

退货单

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

200

successful operation

RtnSubmitResponse
1.8.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"
    },
    "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" : "连江县/思明区",
        "town" : "string",
        "street" : "观日路46号603",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      },
      "oaid" : "string"
    },
    "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",
    "is_buyer_received" : false
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_amount" : 12.03,
    "settle_fieight" : 12.03,
    "package_total" : 12.03,
    "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" : "已退货",
    "type" : {
      "id" : "string",
      "name" : "string"
    },
    "creator" : "254145",
    "rtn_id" : "123456",
    "third_rtn_id" : "12212456112",
    "station_id" : "254145",
    "platform_group" : "string"
  },
  "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
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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",
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "tags" : "标签",
    "salesman_type" : "author",
    "salesman_id" : "123",
    "salesman_name" : "榕榕",
    "is_gift" : true
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "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的参与详情"
      },
      "merchant_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",
    "member_grade" : "12253"
  },
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : [ {
      "qty" : 1.0,
      "amount" : 1.0,
      "sku_id" : "213323232",
      "sku_name" : "213323232"
    } ],
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "type_change_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",
  "wrh_name" : "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"
  } ],
  "settle_info" : {
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "address_change_fee" : 120.01,
  "is_can_return_goods" : true
}
1.8.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "rtn_id" : "string"
}

1.8.4. 取指定退货单

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

取指定退货单

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

Path

id
必填

退换货id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

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

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

200

successful operation

Rtn
1.8.4.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string
1.8.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"
    },
    "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" : "连江县/思明区",
        "town" : "string",
        "street" : "观日路46号603",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      },
      "oaid" : "string"
    },
    "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",
    "is_buyer_received" : false
  },
  "refund" : {
    "state" : "none",
    "freight" : 12.03,
    "amount" : 12.03,
    "extra" : [ {
      "id" : "distance_freight",
      "name" : "远距离运费",
      "value" : "0.01"
    } ],
    "payments" : [ {
      "name" : "支付宝",
      "amount" : 12.33,
      "score" : 100.0,
      "account_no" : "002002",
      "account_name" : "工行",
      "pay_id" : "3223232323",
      "out_pay_id" : "3223232323"
    } ],
    "classification" : "normal",
    "refund_phase" : "aftersale",
    "part_refund" : false,
    "settle_amount" : 12.03,
    "settle_fieight" : 12.03,
    "package_total" : 12.03,
    "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" : "已退货",
    "type" : {
      "id" : "string",
      "name" : "string"
    },
    "creator" : "254145",
    "rtn_id" : "123456",
    "third_rtn_id" : "12212456112",
    "station_id" : "254145",
    "platform_group" : "string"
  },
  "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
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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",
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "tags" : "标签",
    "salesman_type" : "author",
    "salesman_id" : "123",
    "salesman_name" : "榕榕",
    "is_gift" : true
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "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的参与详情"
      },
      "merchant_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",
    "member_grade" : "12253"
  },
  "customer_note" : "haha",
  "order_id" : "3232320003",
  "approve_state" : "none",
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : [ {
      "qty" : 1.0,
      "amount" : 1.0,
      "sku_id" : "213323232",
      "sku_name" : "213323232"
    } ],
    "package_type" : "保温袋"
  },
  "apply_reason" : "不想要了",
  "cancel_reason" : "又想要了",
  "type_change_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",
  "wrh_name" : "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"
  } ],
  "settle_info" : {
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "address_change_fee" : 120.01,
  "is_can_return_goods" : true
}

1.8.5. 审核退换货

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

审核退换货

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

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退单审核请求

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

200

successful operation

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

1.8.6. 取消退货单

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

取消退货单

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

Path

id
必填

退货单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

ActionResult
1.8.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.8.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.7. 确认退货状态

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

确认退货状态

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

Path

id
必填

退货单ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

退货请求对象

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

200

successful operation

ActionResult
1.8.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"
  },
  "stationType" : "string",
  "station" : {
    "id" : "string",
    "name" : "string"
  },
  "return_state" : "none",
  "carrier_note" : "note",
  "operator_role" : "string"
}
1.8.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.8. 回传仓库踢回结果

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/kickbackresult
1.8.8.1. 说明

回传仓库踢回结果

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

KickBackResultRequest
1.8.8.3. 响应
HTTP代码 说明 类型

200

successful operation

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

1.8.9. 修改退货单

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

修改退货单

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

Path

id
必填

退换货id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

ActionResult
1.8.9.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
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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",
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "tags" : "标签",
    "salesman_type" : "author",
    "salesman_id" : "123",
    "salesman_name" : "榕榕",
    "is_gift" : true
  } ],
  "freight" : 12.03,
  "modify_item_detail" : false,
  "apply_reason" : "不想要了",
  "customer_note" : "haha",
  "voucher_urls" : [ "string" ],
  "settle_amount" : 12.03,
  "package_total" : 12.03,
  "address_change_fee" : 10.01
}
1.8.9.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.10. 通知仓库

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

通知仓库

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

Path

id
必填

退单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

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

1.8.11. 确认退款

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

确认退款

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

Path

id
必填

退货单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

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

1.8.12. 转换退单类型

POST /{tenant_id}/soms/returnservice/rtn/{id}/action/transfer/type
1.8.12.1. 说明

转换退单类型

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

Path

id
必填

退换货id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

RtnChangeTypeRequest
1.8.12.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.8.12.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtn/string/action/transfer/type?operator=string
请求 body
{
  "change_reason" : "漏发",
  "change_type" : "refundAndRtn"
}
1.8.12.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.13. 修改退单权益接口

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

修改退单权益接口

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

Path

id
必填

退货单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

权益请求

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

200

successful operation

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

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

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

修改物流物流退回信息

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

Path

id
必填

退换货id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

ActionResult
1.8.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.8.14.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.8.15. 批量取退货单

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

批量取退货单

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

Path

tenant_id
必填

租户ID

string

Query

parts
可选

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

string

Query

rtnIds
必填

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

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

200

successful operation

RtnList
1.8.15.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns?rtnIds=string
1.8.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"
      },
      "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" : "连江县/思明区",
          "town" : "string",
          "street" : "观日路46号603",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        },
        "oaid" : "string"
      },
      "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",
      "is_buyer_received" : false
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_amount" : 12.03,
      "settle_fieight" : 12.03,
      "package_total" : 12.03,
      "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" : "已退货",
      "type" : {
        "id" : "string",
        "name" : "string"
      },
      "creator" : "254145",
      "rtn_id" : "123456",
      "third_rtn_id" : "12212456112",
      "station_id" : "254145",
      "platform_group" : "string"
    },
    "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
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "tags" : "标签",
      "salesman_type" : "author",
      "salesman_id" : "123",
      "salesman_name" : "榕榕",
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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",
      "member_grade" : "12253"
    },
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : [ {
        "qty" : 1.0,
        "amount" : 1.0,
        "sku_id" : "213323232",
        "sku_name" : "213323232"
      } ],
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "type_change_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",
    "wrh_name" : "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"
    } ],
    "settle_info" : {
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "address_change_fee" : 120.01,
    "is_can_return_goods" : true
  } ]
}

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

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

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

1.8.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.8.16.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnList
1.8.16.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/front/string?parts=string&platform_id=string
1.8.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"
      },
      "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" : "连江县/思明区",
          "town" : "string",
          "street" : "观日路46号603",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        },
        "oaid" : "string"
      },
      "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",
      "is_buyer_received" : false
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_amount" : 12.03,
      "settle_fieight" : 12.03,
      "package_total" : 12.03,
      "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" : "已退货",
      "type" : {
        "id" : "string",
        "name" : "string"
      },
      "creator" : "254145",
      "rtn_id" : "123456",
      "third_rtn_id" : "12212456112",
      "station_id" : "254145",
      "platform_group" : "string"
    },
    "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
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "tags" : "标签",
      "salesman_type" : "author",
      "salesman_id" : "123",
      "salesman_name" : "榕榕",
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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",
      "member_grade" : "12253"
    },
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : [ {
        "qty" : 1.0,
        "amount" : 1.0,
        "sku_id" : "213323232",
        "sku_name" : "213323232"
      } ],
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "type_change_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",
    "wrh_name" : "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"
    } ],
    "settle_info" : {
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "address_change_fee" : 120.01,
    "is_can_return_goods" : true
  } ]
}

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

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

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

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

Path

tenant_id
必填

租户ID

string

Query

order_id
必填

订单ID

string

Query

platform_id
必填

平台ID

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

200

successful operation

RtnList
1.8.17.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/frontorder?order_id=string&platform_id=string
1.8.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"
      },
      "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" : "连江县/思明区",
          "town" : "string",
          "street" : "观日路46号603",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        },
        "oaid" : "string"
      },
      "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",
      "is_buyer_received" : false
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_amount" : 12.03,
      "settle_fieight" : 12.03,
      "package_total" : 12.03,
      "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" : "已退货",
      "type" : {
        "id" : "string",
        "name" : "string"
      },
      "creator" : "254145",
      "rtn_id" : "123456",
      "third_rtn_id" : "12212456112",
      "station_id" : "254145",
      "platform_group" : "string"
    },
    "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
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "tags" : "标签",
      "salesman_type" : "author",
      "salesman_id" : "123",
      "salesman_name" : "榕榕",
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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",
      "member_grade" : "12253"
    },
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : [ {
        "qty" : 1.0,
        "amount" : 1.0,
        "sku_id" : "213323232",
        "sku_name" : "213323232"
      } ],
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "type_change_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",
    "wrh_name" : "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"
    } ],
    "settle_info" : {
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "address_change_fee" : 120.01,
    "is_can_return_goods" : true
  } ]
}

1.8.18. 查指定订单的退货单

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

查指定订单的退货单

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

Path

tenant_id
必填

租户ID

string

Query

order_id
必填

订单ID

string

Query

parts
可选

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

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

200

successful operation

RtnList
1.8.18.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/order?order_id=string
1.8.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"
      },
      "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" : "连江县/思明区",
          "town" : "string",
          "street" : "观日路46号603",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        },
        "oaid" : "string"
      },
      "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",
      "is_buyer_received" : false
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_amount" : 12.03,
      "settle_fieight" : 12.03,
      "package_total" : 12.03,
      "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" : "已退货",
      "type" : {
        "id" : "string",
        "name" : "string"
      },
      "creator" : "254145",
      "rtn_id" : "123456",
      "third_rtn_id" : "12212456112",
      "station_id" : "254145",
      "platform_group" : "string"
    },
    "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
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "tags" : "标签",
      "salesman_type" : "author",
      "salesman_id" : "123",
      "salesman_name" : "榕榕",
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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",
      "member_grade" : "12253"
    },
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : [ {
        "qty" : 1.0,
        "amount" : 1.0,
        "sku_id" : "213323232",
        "sku_name" : "213323232"
      } ],
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "type_change_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",
    "wrh_name" : "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"
    } ],
    "settle_info" : {
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "address_change_fee" : 120.01,
    "is_can_return_goods" : true
  } ]
}

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

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

operation.deprecated
1.8.19.1. 说明

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

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

Path

tenant_id
必填

租户ID

string

Query

ids
必填

退单号集合

< string > array(multi)

Query

name
可选

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

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

200

successful operation

RtnPrintDataList
1.8.19.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/printbills?ids=string
1.8.19.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"
    } ],
    "time" : "2016-03-02 12:00:01",
    "rtn_id" : "20160122000006",
    "front_rtn_id" : "20160122000006"
  } ]
}

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

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

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

1.8.20.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.8.20.3. 响应
HTTP代码 说明 类型

200

successful operation

RtnPaging
1.8.20.4. HTTP请求示例
请求 path
/string/soms/returnservice/rtns/query?desc=true&page=0&page_size=0
请求 body
{
  "platform_id" : "jdo2o",
  "order_id" : "123456",
  "order_id_match" : "123456",
  "order_id_in" : "123456",
  "rtn_Id" : "123456",
  "rtn_id_match" : "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" ],
  "refund_phases" : [ "onsale" ],
  "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",
  "front_third_rtn_id_eq" : "123213123",
  "front_third_rtn_id_in" : [ "string" ],
  "platform_group_eq" : "O2O",
  "member_grade_eq" : "12253",
  "has_billing_exception" : false
}
1.8.20.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"
      },
      "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" : "连江县/思明区",
          "town" : "string",
          "street" : "观日路46号603",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        },
        "oaid" : "string"
      },
      "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",
      "is_buyer_received" : false
    },
    "refund" : {
      "state" : "none",
      "freight" : 12.03,
      "amount" : 12.03,
      "extra" : [ {
        "id" : "distance_freight",
        "name" : "远距离运费",
        "value" : "0.01"
      } ],
      "payments" : [ {
        "name" : "支付宝",
        "amount" : 12.33,
        "score" : 100.0,
        "account_no" : "002002",
        "account_name" : "工行",
        "pay_id" : "3223232323",
        "out_pay_id" : "3223232323"
      } ],
      "classification" : "normal",
      "refund_phase" : "aftersale",
      "part_refund" : false,
      "settle_amount" : 12.03,
      "settle_fieight" : 12.03,
      "package_total" : 12.03,
      "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" : "已退货",
      "type" : {
        "id" : "string",
        "name" : "string"
      },
      "creator" : "254145",
      "rtn_id" : "123456",
      "third_rtn_id" : "12212456112",
      "station_id" : "254145",
      "platform_group" : "string"
    },
    "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
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "tags" : "标签",
      "salesman_type" : "author",
      "salesman_id" : "123",
      "salesman_name" : "榕榕",
      "is_gift" : true
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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",
      "member_grade" : "12253"
    },
    "customer_note" : "haha",
    "order_id" : "3232320003",
    "approve_state" : "none",
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : [ {
        "qty" : 1.0,
        "amount" : 1.0,
        "sku_id" : "213323232",
        "sku_name" : "213323232"
      } ],
      "package_type" : "保温袋"
    },
    "apply_reason" : "不想要了",
    "cancel_reason" : "又想要了",
    "type_change_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",
    "wrh_name" : "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"
    } ],
    "settle_info" : {
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "address_change_fee" : 120.01,
    "is_can_return_goods" : true
  } ],
  "page_count" : 0,
  "page_size" : 0
}

1.9. 统计服务

1.9.1. 提交count

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

提交count

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

count
必填

统计

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

200

successful operation

ActionResult
1.9.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.9.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.9.2. 查询统计

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

查询统计

1.9.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.9.2.3. 响应
HTTP代码 说明 类型

200

successful operation

soms分页查询结果Count
1.9.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.9.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.9.3. 获取count

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

获取count

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

Path

business_key
必填

业务key

string

Path

tenant_id
必填

租户ID

string

Query

action
必填

操作类型

string

Query

type
必填

类型

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

200

successful operation

Count
1.9.3.4. HTTP请求示例
请求 path
/string/soms/countservice/count/string?action=string&type=string
1.9.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.9.4. 计数加1

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

计数加1

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

Path

business_key
必填

业务key

string

Path

tenant_id
必填

租户Id

string

Query

action
必填

操作类型

string

Query

operator
可选

string

Query

type
必填

类型

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

200

successful operation

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

1.10. 订单调整服务

1.10.1. 取指定调整单

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

取指定调整单

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

Path

adjustId
必填

单据ID

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

需要返回的部分

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

200

successful operation

OrderAdjust
1.10.1.4. HTTP请求示例
请求 path
/string/soms/orderadjustservice/orderadjust/{id}
1.10.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.11. 客户提货服务

1.11.1. 获取门店订单可用承运商

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/availablecarriers
1.11.1.1. 说明

获取门店订单可用承运商

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

id
可选

订单号

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

200

successful operation

CarrierList
1.11.1.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/availablecarriers
1.11.1.5. HTTP响应示例
响应 200
{
  "carriers" : [ {
    "id" : "string",
    "name" : "string"
  } ]
}

1.11.2. 取得订单投递失败的可选原因

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/deliverfailreasons
1.11.2.1. 说明

取得订单投递失败的可选原因

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

type
可选

投递失败原因类型，取值范围:refused(客户拒收)、redeliver(未妥投)

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

200

successful operation

DeliverFailReasonList
1.11.2.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/deliverfailreasons
1.11.2.5. HTTP响应示例
响应 200
{
  "reasons" : [ {
    "type" : "redeliver",
    "reason" : "原因说明"
  } ]
}

1.11.3. 取得订单上架异常的可选原因

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/listingexceptionreasons
1.11.3.1. 说明

取得订单上架异常的可选原因

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

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

200

successful operation

ReasonList
1.11.3.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/listingexceptionreasons
1.11.3.5. HTTP响应示例
响应 200
{
  "values" : [ "string" ],
  "empty" : true
}

1.11.4. 取单个客户订单

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}
1.11.4.1. 说明

取单个客户订单

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

Path

id
必填

订单号

string

Path

store_id
必填

门店

string

Path

tenant_id
必填

租户ID

string

Query

fetch_parts
可选

需要返回的订单部分，取值范围:items(商品详情)、item.details(组合商品详情)、paymentDetails(支付详情)、invoiceDetails(发票详情)、quota(订单指标)

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

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

200

successful operation

DeliverOrder
1.11.4.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string?operator_id=string
1.11.4.5. HTTP响应示例
响应 200
{
  "id" : "1001001",
  "status" : "confirming",
  "total" : 12.03,
  "items" : [ {
    "quantity" : 12.0,
    "total" : 12.25,
    "itemCustomField" : {
      "sfield1" : "aaa",
      "sfield2" : "bbb",
      "sfield3" : "ccc",
      "sfield4" : "ddd",
      "sfield5" : "eee",
      "sfield6" : "ggg",
      "sfield7" : "eee",
      "sfield8" : "fff",
      "nfield1" : 23.0,
      "nfield2" : 34.0,
      "item_code" : "323231"
    },
    "tags" : [ {
      "name" : "首单"
    } ],
    "item_no" : "1",
    "item_code" : "32323",
    "item_name" : "可乐",
    "spec" : "1*1",
    "barcode" : "32323",
    "unit_price" : 32.05,
    "fav_price" : 12.54,
    "fav_total" : 12.25,
    "image_url" : "http://aaa/bbb.png",
    "details" : [ {
      "id" : "323231",
      "title" : "aaa",
      "quantity" : 12.0,
      "ratio" : 0.25
    } ],
    "orig_item" : {
      "quantity" : 12.0,
      "item_code" : "32323",
      "item_name" : "可乐",
      "qpc" : "1*1",
      "unit" : "份"
    },
    "fault_tolerant_info" : "string"
  } ],
  "mobile" : "15855885589",
  "salechannel" : "mdj",
  "deliveryman" : "李三",
  "quotas" : [ {
    "action" : "expect_shipping",
    "time" : "2021-09-26 16:40:19",
    "remark" : "无",
    "action_name" : "期望拣货完成时间"
  } ],
  "tags" : [ {
    "name" : "首单"
  } ],
  "store_id" : "0002",
  "type_caption" : "一小时达",
  "ship_location" : "store",
  "ship_location_caption" : "上海",
  "customer_info" : "string",
  "private_customer_info" : "string",
  "payment_type" : "货到付款",
  "delivery_type" : "送货上门",
  "status_caption" : "已取消",
  "create_time" : "2017-11-27 18:38:42",
  "ship_time" : "2017-11-27 18:38:42",
  "sign_time" : "2017-11-27 18:38:42",
  "exception_type" : "stopped",
  "exception_info" : "string",
  "invoice" : {
    "required" : false,
    "details" : [ {
      "amount" : 12.02,
      "content" : "某某公司",
      "title" : "plain"
    } ]
  },
  "freight" : 12.03,
  "expected_delivered_date" : "2014-02-03",
  "expected_delivered_time_slot" : "11:00-12:00",
  "payable_amount" : 12.02,
  "customer_note" : "无",
  "private_mobile" : "189389928893",
  "private_street" : "脱敏地址**",
  "salechannel_name" : "美到家",
  "cancel_type" : "customerCancel",
  "carrier_type" : "express",
  "carrier_state" : "pickupFailed",
  "deliveryman_mobile" : "15655895658",
  "carrier_id" : "self",
  "carrier_name" : "顺丰",
  "waybill_id" : "123456",
  "carrier_exception_remark" : "门店不存在",
  "multi_store" : false,
  "fault_tolerant_info" : "string",
  "shop_id" : "string",
  "packages" : [ {
    "sku_id" : "2015456648",
    "barcode" : "6931798836288",
    "sku_name" : "可降解打包袋（大号）",
    "qty" : 1.0,
    "amount" : 0.5
  } ]
}

1.11.5. 调整承运商

PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/carrier
1.11.5.1. 说明

调整承运商

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

Path

id
必填

订单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

detail
可选

承运商详情

CarrierDetail
1.11.5.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.5.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/carrier?operator_id=string
请求 body
{
  "action" : "recall",
  "carrier_type" : "express",
  "carrier_id" : "sf",
  "carrier_name" : "顺丰速运",
  "deliveryman_id" : "32332",
  "deliveryman" : "李某",
  "deliveryman_mobile" : "1565586545"
}

1.11.6. 更新承运商配送信息

PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/carrier/update
1.11.6.1. 说明

更新承运商配送信息

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

Path

id
必填

订单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

detail
可选

承运商详情

CarrierDetailInfo
1.11.6.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.6.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/carrier/update?operator_id=string
请求 body
{
  "carrier_id" : "sf",
  "carrier_name" : "顺丰速运",
  "waybill_id" : "32332"
}

1.11.7. 订单取消接单（冲账）检查

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/delistingcheck
1.11.7.1. 说明

订单取消接单（冲账）检查

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

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

200

successful operation

CheckResult
1.11.7.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/delistingcheck
1.11.7.5. HTTP响应示例
响应 200
{
  "accepted" : true,
  "message" : "恭喜您，验证通过"
}

1.11.8. 提货检查

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/delivercheck
1.11.8.1. 说明

提货检查

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

check_code
可选

验证码

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

200

successful operation

CheckResult
1.11.8.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/delivercheck
1.11.8.5. HTTP响应示例
响应 200
{
  "accepted" : true,
  "message" : "恭喜您，验证通过"
}

1.11.9. 订单接单（上架）检查

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/listingcheck
1.11.9.1. 说明

订单接单（上架）检查

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

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

200

successful operation

CheckResult
1.11.9.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/listingcheck
1.11.9.5. HTTP响应示例
响应 200
{
  "accepted" : true,
  "message" : "恭喜您，验证通过"
}

1.11.10. 报告上架异常

PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/listingexception
1.11.10.1. 说明

报告上架异常

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

detail
必填

上架异常详情

ListingExceptionDetail
1.11.10.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.10.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/listingexception?operator_id=string
请求 body
{
  "reason" : "商品不存在，上架异常"
}

1.11.11. 修改商品明细

POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/mod/items
1.11.11.1. 说明

修改商品明细

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

Path

id
必填

订单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

mod
必填

修改商品明细请求

DeliverOrderItemMod
1.11.11.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.11.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/mod/items?operator_id=string
请求 body
{
  "type" : "weight_diff",
  "reason" : "补差",
  "items" : [ {
    "quantity" : 12.0,
    "details" : [ {
      "field" : "total,fav_total,quantity",
      "before" : "10",
      "after" : "12"
    } ],
    "item_no" : "1",
    "item_code" : "32323"
  } ],
  "payments" : [ {
    "name" : "支付宝",
    "amount" : 12.03,
    "card_number" : "22121",
    "store_pay" : false,
    "need_cash" : false
  } ]
}

1.11.12. 付款检查

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/paycheck
1.11.12.1. 说明

付款检查

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

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

200

successful operation

CheckResult
1.11.12.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/paycheck
1.11.12.5. HTTP响应示例
响应 200
{
  "accepted" : true,
  "message" : "恭喜您，验证通过"
}

1.11.13. 取订单的打印数据

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/printdata
1.11.13.1. 说明

取订单的打印数据

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

names
可选

打印模版名称name：拣货单、外卖订单、运单，长度不超过40，打印多个用英文逗号隔开如：拣货单,外卖订单。不传表示打印全部

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

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

200

successful operation

DeliverOrderPrintData
1.11.13.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/printdata?operator_id=string
1.11.13.5. HTTP响应示例
响应 200
{
  "parts" : [ "string" ],
  "order_id" : "21212",
  "time" : "2019-07-03 13:06:46"
}

1.11.14. 指定订单号查询退款申请列表

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/refunds
1.11.14.1. 说明

指定订单号查询退款申请列表

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

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

200

successful operation

OrderRefundList
1.11.14.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/refunds
1.11.14.5. HTTP响应示例
响应 200
{
  "values" : [ {
    "order_id" : "32323",
    "refundReq_id" : "32323",
    "refund_total" : 12.02,
    "products" : [ {
      "skuId" : "00212",
      "qty" : 12.0,
      "total" : 12.25
    } ],
    "payment_details" : [ {
      "name" : "支付宝",
      "amount" : 12.03,
      "card_number" : "22121",
      "store_pay" : false,
      "need_cash" : false
    } ]
  } ]
}

1.11.15. 确认自提

POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/selftake
1.11.15.1. 说明

确认自提，仅支持非货到付款自提

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

Path

id
必填

订单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

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

default

successful operation

无内容
1.11.15.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/selftake?operator_id=string

1.11.16. 确认自提

POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/selftake/confirm
1.11.16.1. 说明

确认自提，支持货到付款和非货到付款自提

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

Path

id
必填

订单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

detail
可选

自提详情

SelftakeConfirmDetail
1.11.16.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.16.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/selftake/confirm?operator_id=string
请求 body
{
  "payments" : [ {
    "name" : "支付宝",
    "amount" : 12.03,
    "card_number" : "22121",
    "store_pay" : false,
    "need_cash" : false
  } ]
}

1.11.17. 门店拒绝配送指定的订单

PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/station_refuse
1.11.17.1. 说明

门店拒绝配送指定的订单

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Query

reason
可选

拒绝原因

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

default

successful operation

无内容
1.11.17.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/station_refuse?operator_id=string

1.11.18. 订单取消接单（冲账）

PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/delisting
1.11.18.1. 说明

订单取消接单（冲账）

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

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

default

successful operation

无内容
1.11.18.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/delisting?operator_id=string

1.11.19. 订单客户签收

PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/delivered
1.11.19.1. 说明

订单客户签收

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

detail
必填

签收详情

DeliverDetail
1.11.19.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.19.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/delivered?operator_id=string
请求 body
{
  "payments" : [ {
    "name" : "支付宝",
    "amount" : 12.03,
    "card_number" : "22121",
    "store_pay" : false,
    "need_cash" : false
  } ],
  "deliver_id" : "22121",
  "deliver_name" : "李某",
  "on_duty_emps" : [ {
    "id" : "string",
    "name" : "string"
  } ]
}

1.11.20. 订单投递失败

PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/deliverfailed
1.11.20.1. 说明

订单投递失败

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

detail
必填

投递失败的原因

DeliverFailDetail
1.11.20.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.20.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/deliverfailed?operator_id=string
请求 body
{
  "type" : "refused",
  "reason" : "商品破损"
}

1.11.21. 订单送货登记

PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/delivering
1.11.21.1. 说明

订单送货登记

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

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

default

successful operation

无内容
1.11.21.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/delivering?operator_id=string

1.11.22. 订单备货（上架）

PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/status/listing
1.11.22.1. 说明

订单备货（上架）

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

Path

id
必填

订单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

carrier_id
可选

承运商ID

string

Query

carrier_name
可选

承运商名称

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Query

picking_operator_id
可选

备货人ID，长度不超过20

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

default

successful operation

无内容
1.11.22.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/status/listing?operator_id=string

1.11.23. 订单申请

POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{id}/{action}/apply
1.11.23.1. 说明

订单申请

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

Path

action
必填

动作：cancel，refund

string

Path

id
必填

订单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

request
必填

订单申请请求

OrderActionApplyRequest
1.11.23.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.23.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/string/apply?operator_id=string
请求 body
{
  "reason" : "不要了",
  "items" : [ {
    "quantity" : 2.0,
    "order_item_no" : "1",
    "item_code" : "0001"
  } ]
}

1.11.24. 获取盲盒活动商品范围

POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/blindbox/skurange
1.11.24.1. 说明

获取盲盒活动商品范围

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

Path

order_id
必填

订单Id

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户Id

string

Query

operator_name
可选

string

Body

body
可选

盲盒
1.11.24.3. 响应
HTTP代码 说明 类型

200

successful operation

IdNameRange
1.11.24.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/blindbox/skurange
请求 body
{
  "sku_id" : "202214816_7"
}
1.11.24.5. HTTP响应示例
响应 200
{
  "limit" : true,
  "id_names" : [ {
    "id" : "string",
    "name" : "string"
  } ]
}

1.11.25. 获取订单的运单列表

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/carrierorders
1.11.25.1. 说明

获取订单的运单列表

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

Path

order_id
必填

订单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

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

200

successful operation

CarrierOrderResponse
1.11.25.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/carrierorders
1.11.25.5. HTTP响应示例
响应 200
{
  "success" : true,
  "message" : "string",
  "order_id" : "123434354",
  "waybill_id" : "123434354",
  "carrier_orders" : [ {
    "deliveryman" : "123434354",
    "created" : "2022-08-30 00:00:00",
    "modified" : "2022-08-30 00:00:00",
    "details" : [ {
      "time" : "2022-04-07 08:39:07",
      "address" : "福建,厦门市",
      "message" : "顺丰速运 已收取快件",
      "status" : "在途"
    } ],
    "carrier_id" : "sf",
    "carrier_name" : "顺丰速运",
    "waybill_id" : "32332",
    "deliveryman_phone" : "123434354",
    "carrier_state" : "created",
    "exception_remark" : "运力不足"
  } ]
}

1.11.26. 订单解密

POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/decrypt
1.11.26.1. 说明

订单解密

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

Path

order_id
必填

订单Id

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户Id

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

request
必填

解密请求

DeliverOrderDecryptRequest
1.11.26.3. 响应
HTTP代码 说明 类型

200

successful operation

DeliverOrderDecryptResponse
1.11.26.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/decrypt?operator_id=string
请求 body
1.11.26.5. HTTP响应示例
响应 200
{
  "receiver_mobile" : "string",
  "receiver_street" : "string",
  "customer_info" : "string"
}

1.11.27. 修改订单盲盒明细

POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/mod/blindboxs
1.11.27.1. 说明

修改订单盲盒明细

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

Path

order_id
必填

订单Id

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户Id

string

Query

operator_name
可选

string

Body

body
可选

订单盲盒列表
1.11.27.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.11.27.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/mod/blindboxs
请求 body
{
  "data" : [ {
    "sku_id" : "202214816_7"
  } ]
}
1.11.27.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.11.28. 打包袋检查

POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/packagebag/check
1.11.28.1. 说明

打包袋检查

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

Path

order_id
必填

订单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Body

request
必填

打包袋检查请求

CheckPackageRequest
1.11.28.3. 响应
HTTP代码 说明 类型

200

successful operation

CheckPackageResult
1.11.28.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/packagebag/check
请求 body
{
  "skus" : [ {
    "sku_id" : "string",
    "qty" : 0.0
  } ]
}
1.11.28.5. HTTP响应示例
响应 200
{
  "result" : "string",
  "message" : "string",
  "skus" : [ {
    "success" : true,
    "message" : "string",
    "sku_id" : "string"
  } ]
}

1.11.29. 打包袋修改

POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/packagebag/modfiy
1.11.29.1. 说明

打包袋修改（全量覆盖）

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

Path

order_id
必填

订单号

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

request
必填

打包袋修改请求

ModifyPackageRequest
1.11.29.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.11.29.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/packagebag/modfiy?operator_id=string
请求 body
{
  "skus" : [ {
    "sku_id" : "string",
    "qty" : 0.0
  } ]
}
1.11.29.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.11.30. 获取抖音电子面单打印数据

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/order/{order_id}/waybill/printinfo
1.11.30.1. 说明

获取抖音电子面单打印数据

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

Path

order_id
必填

订单号

string

Path

store_id
必填

门店

string

Path

tenant_id
必填

租户ID

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

200

successful operation

BaseResponsePrintInfo
1.11.30.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/order/string/waybill/printinfo
1.11.30.5. HTTP响应示例
响应 200
{
  "message" : "string",
  "success" : true,
  "data" : {
    "waybill_infos" : {
      "sign" : "string",
      "order_id" : "string",
      "track_no" : "string",
      "print_data" : "string"
    },
    "template_info" : {
      "version" : "string",
      "template_type" : "string",
      "template_code" : "string",
      "template_name" : "string",
      "template_url" : "string",
      "preview_url" : "string",
      "template_id" : "string"
    }
  }
}

1.11.31. 分页查询异常订单

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/orders/exceptions
1.11.31.1. 说明

分页查询异常订单

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Query

page
必填

页码，大于等于0

integer (int32)

Query

page_size
必填

分页大小，范围[0,100]

integer (int32)

Query

type
可选

异常类型，取值是：redeliver-未妥投，refused-客户拒收，timeout-超期未提，stopped=发货后取消， listingexception=上架异常 不传则取全部异常类型的订单。

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

200

successful operation

DeliverOrderPaging
1.11.31.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/orders/exceptions?operator_id=string&page=0&page_size=0
1.11.31.5. HTTP响应示例
响应 200
{
  "paging" : {
    "page" : 0,
    "page_size" : 20,
    "page_count" : 20,
    "record_count" : 20,
    "has_more" : false
  },
  "records" : [ {
    "id" : "1001001",
    "status" : "confirming",
    "total" : 12.03,
    "items" : [ {
      "quantity" : 12.0,
      "total" : 12.25,
      "itemCustomField" : {
        "sfield1" : "aaa",
        "sfield2" : "bbb",
        "sfield3" : "ccc",
        "sfield4" : "ddd",
        "sfield5" : "eee",
        "sfield6" : "ggg",
        "sfield7" : "eee",
        "sfield8" : "fff",
        "nfield1" : 23.0,
        "nfield2" : 34.0,
        "item_code" : "323231"
      },
      "tags" : [ {
        "name" : "首单"
      } ],
      "item_no" : "1",
      "item_code" : "32323",
      "item_name" : "可乐",
      "spec" : "1*1",
      "barcode" : "32323",
      "unit_price" : 32.05,
      "fav_price" : 12.54,
      "fav_total" : 12.25,
      "image_url" : "http://aaa/bbb.png",
      "details" : [ {
        "id" : "323231",
        "title" : "aaa",
        "quantity" : 12.0,
        "ratio" : 0.25
      } ],
      "orig_item" : {
        "quantity" : 12.0,
        "item_code" : "32323",
        "item_name" : "可乐",
        "qpc" : "1*1",
        "unit" : "份"
      },
      "fault_tolerant_info" : "string"
    } ],
    "mobile" : "15855885589",
    "salechannel" : "mdj",
    "deliveryman" : "李三",
    "quotas" : [ {
      "action" : "expect_shipping",
      "time" : "2021-09-26 16:40:19",
      "remark" : "无",
      "action_name" : "期望拣货完成时间"
    } ],
    "tags" : [ {
      "name" : "首单"
    } ],
    "store_id" : "0002",
    "type_caption" : "一小时达",
    "ship_location" : "store",
    "ship_location_caption" : "上海",
    "customer_info" : "string",
    "private_customer_info" : "string",
    "payment_type" : "货到付款",
    "delivery_type" : "送货上门",
    "status_caption" : "已取消",
    "create_time" : "2017-11-27 18:38:42",
    "ship_time" : "2017-11-27 18:38:42",
    "sign_time" : "2017-11-27 18:38:42",
    "exception_type" : "stopped",
    "exception_info" : "string",
    "invoice" : {
      "required" : false,
      "details" : [ {
        "amount" : 12.02,
        "content" : "某某公司",
        "title" : "plain"
      } ]
    },
    "freight" : 12.03,
    "expected_delivered_date" : "2014-02-03",
    "expected_delivered_time_slot" : "11:00-12:00",
    "payable_amount" : 12.02,
    "customer_note" : "无",
    "private_mobile" : "189389928893",
    "private_street" : "脱敏地址**",
    "salechannel_name" : "美到家",
    "cancel_type" : "customerCancel",
    "carrier_type" : "express",
    "carrier_state" : "pickupFailed",
    "deliveryman_mobile" : "15655895658",
    "carrier_id" : "self",
    "carrier_name" : "顺丰",
    "waybill_id" : "123456",
    "carrier_exception_remark" : "门店不存在",
    "multi_store" : false,
    "fault_tolerant_info" : "string",
    "shop_id" : "string",
    "packages" : [ {
      "sku_id" : "2015456648",
      "barcode" : "6931798836288",
      "sku_name" : "可降解打包袋（大号）",
      "qty" : 1.0,
      "amount" : 0.5
    } ]
  } ]
}

1.11.32. 批量查询打印接口

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/orders/printdatas
1.11.32.1. 说明

批量查询打印接口

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

ids
必填

订单号

< string > array(multi)

Query

names
可选

打印模版名称name：拣货单、外卖订单、运单，长度不超过40，打印多个用英文逗号隔开如：拣货单,外卖订单。不传表示打印全部

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

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

200

successful operation

DeliverOrderPrintDataList
1.11.32.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/orders/printdatas?ids=string&operator_id=string
1.11.32.5. HTTP响应示例
响应 200
{
  "orders" : [ {
    "parts" : [ "string" ],
    "order_id" : "21212",
    "time" : "2019-07-03 13:06:46"
  } ]
}

1.11.33. 分页查询订单

POST /{tenant_id}/storedelivery/deliverservice/store/{store_id}/orders/query
1.11.33.1. 说明

分页查询订单

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

definition
必填

查询定义

QueryDefinition
1.11.33.3. 响应
HTTP代码 说明 类型

200

successful operation

DeliverOrderPaging
1.11.33.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/orders/query?operator_id=string
请求 body
{
  "conditions" : [ {
    "name" : "aaa",
    "param" : "2018-05-04 14:25:25"
  } ],
  "orders" : [ {
    "field" : "created",
    "direction" : "asc"
  } ],
  "page" : 0,
  "page_size" : 10
}
1.11.33.5. HTTP响应示例
响应 200
{
  "paging" : {
    "page" : 0,
    "page_size" : 20,
    "page_count" : 20,
    "record_count" : 20,
    "has_more" : false
  },
  "records" : [ {
    "id" : "1001001",
    "status" : "confirming",
    "total" : 12.03,
    "items" : [ {
      "quantity" : 12.0,
      "total" : 12.25,
      "itemCustomField" : {
        "sfield1" : "aaa",
        "sfield2" : "bbb",
        "sfield3" : "ccc",
        "sfield4" : "ddd",
        "sfield5" : "eee",
        "sfield6" : "ggg",
        "sfield7" : "eee",
        "sfield8" : "fff",
        "nfield1" : 23.0,
        "nfield2" : 34.0,
        "item_code" : "323231"
      },
      "tags" : [ {
        "name" : "首单"
      } ],
      "item_no" : "1",
      "item_code" : "32323",
      "item_name" : "可乐",
      "spec" : "1*1",
      "barcode" : "32323",
      "unit_price" : 32.05,
      "fav_price" : 12.54,
      "fav_total" : 12.25,
      "image_url" : "http://aaa/bbb.png",
      "details" : [ {
        "id" : "323231",
        "title" : "aaa",
        "quantity" : 12.0,
        "ratio" : 0.25
      } ],
      "orig_item" : {
        "quantity" : 12.0,
        "item_code" : "32323",
        "item_name" : "可乐",
        "qpc" : "1*1",
        "unit" : "份"
      },
      "fault_tolerant_info" : "string"
    } ],
    "mobile" : "15855885589",
    "salechannel" : "mdj",
    "deliveryman" : "李三",
    "quotas" : [ {
      "action" : "expect_shipping",
      "time" : "2021-09-26 16:40:19",
      "remark" : "无",
      "action_name" : "期望拣货完成时间"
    } ],
    "tags" : [ {
      "name" : "首单"
    } ],
    "store_id" : "0002",
    "type_caption" : "一小时达",
    "ship_location" : "store",
    "ship_location_caption" : "上海",
    "customer_info" : "string",
    "private_customer_info" : "string",
    "payment_type" : "货到付款",
    "delivery_type" : "送货上门",
    "status_caption" : "已取消",
    "create_time" : "2017-11-27 18:38:42",
    "ship_time" : "2017-11-27 18:38:42",
    "sign_time" : "2017-11-27 18:38:42",
    "exception_type" : "stopped",
    "exception_info" : "string",
    "invoice" : {
      "required" : false,
      "details" : [ {
        "amount" : 12.02,
        "content" : "某某公司",
        "title" : "plain"
      } ]
    },
    "freight" : 12.03,
    "expected_delivered_date" : "2014-02-03",
    "expected_delivered_time_slot" : "11:00-12:00",
    "payable_amount" : 12.02,
    "customer_note" : "无",
    "private_mobile" : "189389928893",
    "private_street" : "脱敏地址**",
    "salechannel_name" : "美到家",
    "cancel_type" : "customerCancel",
    "carrier_type" : "express",
    "carrier_state" : "pickupFailed",
    "deliveryman_mobile" : "15655895658",
    "carrier_id" : "self",
    "carrier_name" : "顺丰",
    "waybill_id" : "123456",
    "carrier_exception_remark" : "门店不存在",
    "multi_store" : false,
    "fault_tolerant_info" : "string",
    "shop_id" : "string",
    "packages" : [ {
      "sku_id" : "2015456648",
      "barcode" : "6931798836288",
      "sku_name" : "可降解打包袋（大号）",
      "qty" : 1.0,
      "amount" : 0.5
    } ]
  } ]
}

1.11.34. 退款(含退款详情)

PUT /{tenant_id}/storedelivery/deliverservice/store/{store_id}/refund/{id}
1.11.34.1. 说明

退款(含退款详情)

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

Path

id
必填

退换货申请单ID

string

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Body

details
可选

退款支付方式详情

RefundPaymentDetail
1.11.34.3. 响应
HTTP代码 说明 类型

default

successful operation

无内容
1.11.34.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/refund/string?operator_id=string
请求 body
{
  "payments" : [ {
    "name" : "支付宝",
    "amount" : 12.03,
    "card_number" : "22121",
    "store_pay" : false,
    "need_cash" : false
  } ]
}

1.11.35. 取得可以用的销售渠道

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/salechannels
1.11.35.1. 说明

取得可以用的销售渠道

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

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

200

successful operation

SaleChannelList
1.11.35.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/salechannels
1.11.35.5. HTTP响应示例
响应 200
{
  "channels" : [ {
    "id" : "string",
    "name" : "string"
  } ]
}

1.11.36. 自提检查

GET /{tenant_id}/storedelivery/deliverservice/store/{store_id}/selftake/check
1.11.36.1. 说明

自提检查

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

Path

store_id
必填

门店ID

string

Path

tenant_id
必填

租户ID

string

Query

operator_id
必填

操作人ID，长度不超过20

string

Query

operator_name
可选

操作人姓名，长度不超过50

string

Query

salechannel
必填

订单来源:取值范围:mdj(美到家)、jdo2o(京东到家)、tbkb(淘宝口碑)

string

Query

selftake_code
必填

自提码

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

200

successful operation

CheckResult
1.11.36.4. HTTP请求示例
请求 path
/string/storedelivery/deliverservice/store/string/selftake/check?operator_id=string&salechannel=string&selftake_code=string
1.11.36.5. HTTP响应示例
响应 200
{
  "accepted" : true,
  "message" : "恭喜您，验证通过"
}

1.12. 订单服务

1.12.1. 根据运单号获取订单号

GET /{tenant_id}/soms/logisticService/getOrderIdsByWaybillId
1.12.1.1. 说明

根据运单号获取订单号

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

Path

tenant_id
必填

租户ID

string

Query

waybill_id
必填

运单号

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

200

successful operation

< string > array
1.12.1.4. HTTP请求示例
请求 path
/string/soms/logisticService/getOrderIdsByWaybillId?waybill_id=string
1.12.1.5. HTTP响应示例
响应 200
[ "string" ]

1.12.2. 获得订单里快递包裹信息

GET /{tenant_id}/soms/logisticService/order/{id}/getCarrierProducts
1.12.2.1. 说明

获得订单里快递包裹信息

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

waybill_id
必填

运单号

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

200

successful operation

< OrderLogisticItem > array
1.12.2.4. HTTP请求示例
请求 path
/string/soms/logisticService/order/string/getCarrierProducts?waybill_id=string
1.12.2.5. HTTP响应示例
响应 200
[ {
  "uuid" : "string",
  "order_item_id" : "string",
  "sku_id" : "string",
  "delivery_qty" : 0.0
} ]

1.12.3. 获取订单的其中的一个物流信息

GET /{tenant_id}/soms/logisticService/order/{id}/logistic
1.12.3.1. 说明

获取订单的其中的一个物流信息

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

waybill_id
必填

运单号

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

200

successful operation

OrderLogistic
1.12.3.4. HTTP请求示例
请求 path
/string/soms/logisticService/order/string/logistic?waybill_id=string
1.12.3.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "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"
  },
  "packages" : [ {
    "type" : "string",
    "id" : "string"
  } ],
  "items" : [ {
    "uuid" : "string",
    "order_item_id" : "string",
    "sku_id" : "string",
    "delivery_qty" : 0.0
  } ],
  "tenant_id" : "string",
  "order_id" : "string",
  "waybill_id" : "string"
}

1.12.4. 获取快递订单全部物流信息

GET /{tenant_id}/soms/logisticService/order/{id}/logistics
1.12.4.1. 说明

获取订单的全部物流信息

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用,隔开。需要返回的部分,items(发货明细)

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

200

successful operation

< OrderLogistic > array
1.12.4.4. HTTP请求示例
请求 path
/string/soms/logisticService/order/string/logistics
1.12.4.5. HTTP响应示例
响应 200
[ {
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "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"
  },
  "packages" : [ {
    "type" : "string",
    "id" : "string"
  } ],
  "items" : [ {
    "uuid" : "string",
    "order_item_id" : "string",
    "sku_id" : "string",
    "delivery_qty" : 0.0
  } ],
  "tenant_id" : "string",
  "order_id" : "string",
  "waybill_id" : "string"
} ]

1.12.5. 更新物流

POST /{tenant_id}/soms/logisticService/order/{id}/updates
1.12.5.1. 说明

更新物流

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

更新请求

SomsRequestListOrderLogisticUpdate
1.12.5.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.12.5.4. HTTP请求示例
请求 path
/string/soms/logisticService/order/string/updates?operator=string
请求 body
{
  "data" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "waybill_id" : "string",
    "packages" : [ {
      "type" : "string",
      "id" : "string"
    } ]
  } ]
}
1.12.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.6. 分页条件查询

POST /{tenant_id}/soms/logisticService/orderLogistics/query
1.12.6.1. 说明

分页条件查询物流表

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

Path

tenant_id
必填

租户ID

string

Query

page
必填

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

integer (int32)

Query

page_size
必填

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

integer (int32)

Body

filter
必填

查询条件

OrderLogisticFilter
1.12.6.3. 响应
HTTP代码 说明 类型

200

successful operation

soms分页查询结果OrderLogistic
1.12.6.4. HTTP请求示例
请求 path
/string/soms/logisticService/orderLogistics/query?page=0&page_size=0
请求 body
{
  "carrier_states" : [ "initial" ],
  "carrier_types" : [ "self" ],
  "created_start" : "2016-03-02 12:00:01"
}
1.12.6.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",
    "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"
    },
    "packages" : [ {
      "type" : "string",
      "id" : "string"
    } ],
    "items" : [ {
      "uuid" : "string",
      "order_item_id" : "string",
      "sku_id" : "string",
      "delivery_qty" : 0.0
    } ],
    "tenant_id" : "string",
    "order_id" : "string",
    "waybill_id" : "string"
  } ]
}

1.12.7. 保存或更新物流信息

POST /{tenant_id}/soms/logisticService/saveOrUpdate
1.12.7.1. 说明

保存或更新物流信息

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

orderLogistic
必填

物流信息

OrderLogistic
1.12.7.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.12.7.4. HTTP请求示例
请求 path
/string/soms/logisticService/saveOrUpdate?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "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"
  },
  "packages" : [ {
    "type" : "string",
    "id" : "string"
  } ],
  "items" : [ {
    "uuid" : "string",
    "order_item_id" : "string",
    "sku_id" : "string",
    "delivery_qty" : 0.0
  } ],
  "tenant_id" : "string",
  "order_id" : "string",
  "waybill_id" : "string"
}
1.12.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.8. 获取催单

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

获取催单

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

Path

id
必填

催单ID

string

Path

tenant_id
必填

租户Id

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

200

successful operation

OrderRemind
1.12.8.4. HTTP请求示例
请求 path
/string/soms/orderremindservice/orderremind/string
1.12.8.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.12.9. 催单回复

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

催单回复

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

Path

id
必填

催单ID

string

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

催单

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

200

successful operation

ActionResult
1.12.9.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.12.9.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.10. 查询催单

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

查询催单

1.12.10.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.12.10.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderRemindPaging
1.12.10.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.12.10.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.12.11. 订单占货情况检查

POST /{tenant_id}/soms/orderservice/check/order/stock/lock
1.12.11.1. 说明

订单占货情况检查

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

Path

tenant_id
必填

租户ID

string

Body

body
可选

订单占货情况检查请求
1.12.11.3. 响应
HTTP代码 说明 类型

200

successful operation

订单占货情况检查响应
1.12.11.4. HTTP请求示例
请求 path
/string/soms/orderservice/check/order/stock/lock
请求 body
{
  "order_ids" : [ "string" ]
}
1.12.11.5. HTTP响应示例
响应 200
{
  "success" : true,
  "message" : "string",
  "data" : [ {
    "success" : true,
    "message" : "string",
    "order_id" : "string",
    "stock_state" : "initial(未占货),locked(已占货),shipped(已发货),aborted(已作废)",
    "lock_result" : "lockPart(部分占货)、lockAll(全部成功)、none(未占货)",
    "lock_items" : [ {
      "sku_id" : "string",
      "qty" : 0.0,
      "type" : "wrh(仓库库存)、store(门店库存)",
      "result" : "lockPart(部分占货)、lockAll(全部成功)、none(未占货)"
    } ]
  } ]
}

1.12.12. 提交订单（旧版）

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

提交订单（旧版）

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order
必填

订单

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

200

successful operation

IdWrapper
1.12.12.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",
      "title" : "plain",
      "content" : "上海股份有限公司",
      "amount" : 12.03,
      "tax" : 2.32,
      "remark" : "plain",
      "time" : "2019-07-15 16:56:23",
      "url" : "a.jpg",
      "email" : "chw@qq.com",
      "kind" : "paper",
      "title_type" : "person",
      "buyer_tax_code" : "1232000046600736XP",
      "taxer_id" : "1212345046600736XP",
      "print_number" : "123456",
      "securaty_code" : "2114445",
      "check_code" : "201622"
    } ],
    "error_reason" : "string",
    "apply_qrcode" : "string"
  },
  "payment" : {
    "type" : "online",
    "state" : "paid",
    "payee" : {
      "id" : "string",
      "name" : "string"
    },
    "amount" : 14.02,
    "freight" : 14.02,
    "details" : [ {
      "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" : [ {
      "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",
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "receiver" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "福州市/厦门市",
        "district" : "连江县/思明区",
        "town" : "string",
        "street" : "观日路46号603",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      },
      "oaid" : "string"
    },
    "waybills" : [ {
      "packages" : [ {
        "type" : "string",
        "id" : "string"
      } ],
      "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",
    "third_order_id" : "1223654",
    "main_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"
    },
    "platform_group" : "string"
  },
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "front" : {
      "spec" : "蓝色;微甜  少冰/多糖",
      "spec2" : "500g",
      "unit" : "string",
      "sku_id" : "052700601",
      "item_id" : "052700601",
      "station_type" : "wrh",
      "station_id" : "1230980"
    },
    "details" : [ {
      "id" : "121212",
      "title" : "矿泉水",
      "quantity" : 4.0,
      "ratio" : 3.0,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋",
        "sale_mode" : "normal"
      },
      "front_spec" : "辣",
      "upc" : "4897060263713"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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
    },
    "weight" : 100.0,
    "deliveryQty" : 1.0,
    "item_no" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.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" : "保温袋",
      "sale_mode" : "normal"
    },
    "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_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "fault_tolerant_info" : "string",
    "salesman" : {
      "id" : "string",
      "name" : "string"
    },
    "salesman_type" : "author",
    "extra_info" : "{\"inv_mgr\": false}",
    "tags" : "标签",
    "relation_sale_order_id" : "1231232131",
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "orig_weight" : 100.0,
    "item_stock_state" : "部分占货",
    "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(商品异常)、carrier(配送异常)",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "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的参与详情"
      },
      "merchant_act_id" : "1111",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（平台）",
        "discount" : 1.0
      } ],
      "share_details" : "[]"
    } ]
  },
  "deliveryResult" : "none,shipPart,shipAll",
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "approve_state" : "none",
  "customer_note" : "note",
  "seller_note" : "note",
  "salesman" : {
    "id" : "string",
    "name" : "string",
    "type" : "saleman",
    "org" : {
      "id" : "string",
      "name" : "string"
    },
    "org_type" : "门店"
  },
  "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,
  "shop_amount" : 120.01,
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "shop_package_discount" : 33.33,
  "ptm_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",
        "sku_id" : "052700601",
        "item_id" : "052700601",
        "station_type" : "wrh",
        "station_id" : "1230980"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋",
          "sale_mode" : "normal"
        },
        "front_spec" : "辣",
        "upc" : "4897060263713"
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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
      },
      "weight" : 100.0,
      "deliveryQty" : 1.0,
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.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" : "保温袋",
        "sale_mode" : "normal"
      },
      "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_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "salesman_type" : "author",
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "relation_sale_order_id" : "1231232131",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "orig_weight" : 100.0,
      "item_stock_state" : "部分占货",
      "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",
        "sku_id" : "052700601",
        "item_id" : "052700601",
        "station_type" : "wrh",
        "station_id" : "1230980"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋",
          "sale_mode" : "normal"
        },
        "front_spec" : "辣",
        "upc" : "4897060263713"
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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
      },
      "weight" : 100.0,
      "deliveryQty" : 1.0,
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.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" : "保温袋",
        "sale_mode" : "normal"
      },
      "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_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "salesman_type" : "author",
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "relation_sale_order_id" : "1231232131",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "orig_weight" : 100.0,
      "item_stock_state" : "部分占货",
      "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"
  } ],
  "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",
    "member_grade" : "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" : {
    "discounts" : "[{}]",
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : [ {
      "qty" : 1.0,
      "amount" : 1.0,
      "sku_id" : "213323232",
      "sku_name" : "213323232"
    } ],
    "package_type" : "保温袋"
  },
  "item_logistics" : [ {
    "qty" : 0.0,
    "sku_id" : "string",
    "logistics_code" : "string"
  } ],
  "calc_data" : true,
  "wrh_id" : "4184",
  "wrh_name" : "cc",
  "wrh_state" : "initial",
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string",
    "encrypt_telephone" : "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"
  } ],
  "is_split" : true,
  "stock_state" : "initial",
  "address_change_fee" : 0.0,
  "order_params" : [ {
    "paramKey" : "string",
    "paramValue" : "string"
  } ]
}
1.12.12.5. HTTP响应示例
响应 200
{
  "id" : "string"
}

1.12.13. 自提检查

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

自提检查

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

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

1.12.14. 订单检测

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

addresscheck:检测地址是否可送、deliverycheck:检测承运商是否能送、deliverycalc:计算预计配送信息

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

订单检测

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

200

successful operation

OrderCheckResponse
1.12.14.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" : "连江县/思明区",
    "town" : "string",
    "street" : "观日路46号603",
    "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.12.14.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.12.15. 批量修改订单下单门店

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

批量修改订单下单门店

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

修改内容

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

200

successful operation

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

1.12.16. 批量取指定订单

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

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

1.12.16.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.12.16.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderList
1.12.16.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/orders?id=string
1.12.16.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",
        "title" : "plain",
        "content" : "上海股份有限公司",
        "amount" : 12.03,
        "tax" : 2.32,
        "remark" : "plain",
        "time" : "2019-07-15 16:56:23",
        "url" : "a.jpg",
        "email" : "chw@qq.com",
        "kind" : "paper",
        "title_type" : "person",
        "buyer_tax_code" : "1232000046600736XP",
        "taxer_id" : "1212345046600736XP",
        "print_number" : "123456",
        "securaty_code" : "2114445",
        "check_code" : "201622"
      } ],
      "error_reason" : "string",
      "apply_qrcode" : "string"
    },
    "payment" : {
      "type" : "online",
      "state" : "paid",
      "payee" : {
        "id" : "string",
        "name" : "string"
      },
      "amount" : 14.02,
      "freight" : 14.02,
      "details" : [ {
        "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" : [ {
        "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",
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "receiver" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "福州市/厦门市",
          "district" : "连江县/思明区",
          "town" : "string",
          "street" : "观日路46号603",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        },
        "oaid" : "string"
      },
      "waybills" : [ {
        "packages" : [ {
          "type" : "string",
          "id" : "string"
        } ],
        "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",
      "third_order_id" : "1223654",
      "main_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"
      },
      "platform_group" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "sku_id" : "052700601",
        "item_id" : "052700601",
        "station_type" : "wrh",
        "station_id" : "1230980"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋",
          "sale_mode" : "normal"
        },
        "front_spec" : "辣",
        "upc" : "4897060263713"
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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
      },
      "weight" : 100.0,
      "deliveryQty" : 1.0,
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.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" : "保温袋",
        "sale_mode" : "normal"
      },
      "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_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "salesman_type" : "author",
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "relation_sale_order_id" : "1231232131",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "orig_weight" : 100.0,
      "item_stock_state" : "部分占货",
      "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(商品异常)、carrier(配送异常)",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（平台）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "deliveryResult" : "none,shipPart,shipAll",
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "customer_note" : "note",
    "seller_note" : "note",
    "salesman" : {
      "id" : "string",
      "name" : "string",
      "type" : "saleman",
      "org" : {
        "id" : "string",
        "name" : "string"
      },
      "org_type" : "门店"
    },
    "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,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "shop_package_discount" : 33.33,
    "ptm_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",
          "sku_id" : "052700601",
          "item_id" : "052700601",
          "station_type" : "wrh",
          "station_id" : "1230980"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋",
            "sale_mode" : "normal"
          },
          "front_spec" : "辣",
          "upc" : "4897060263713"
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "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的参与详情"
            },
            "merchant_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
        },
        "weight" : 100.0,
        "deliveryQty" : 1.0,
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.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" : "保温袋",
          "sale_mode" : "normal"
        },
        "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_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "salesman_type" : "author",
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "relation_sale_order_id" : "1231232131",
        "settle_unit" : {
          "type" : "store",
          "code" : "0001",
          "name" : "门店1"
        },
        "orig_weight" : 100.0,
        "item_stock_state" : "部分占货",
        "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",
          "sku_id" : "052700601",
          "item_id" : "052700601",
          "station_type" : "wrh",
          "station_id" : "1230980"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋",
            "sale_mode" : "normal"
          },
          "front_spec" : "辣",
          "upc" : "4897060263713"
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "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的参与详情"
            },
            "merchant_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
        },
        "weight" : 100.0,
        "deliveryQty" : 1.0,
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.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" : "保温袋",
          "sale_mode" : "normal"
        },
        "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_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "salesman_type" : "author",
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "relation_sale_order_id" : "1231232131",
        "settle_unit" : {
          "type" : "store",
          "code" : "0001",
          "name" : "门店1"
        },
        "orig_weight" : 100.0,
        "item_stock_state" : "部分占货",
        "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"
    } ],
    "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",
      "member_grade" : "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" : {
      "discounts" : "[{}]",
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : [ {
        "qty" : 1.0,
        "amount" : 1.0,
        "sku_id" : "213323232",
        "sku_name" : "213323232"
      } ],
      "package_type" : "保温袋"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "wrh_name" : "cc",
    "wrh_state" : "initial",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string",
      "encrypt_telephone" : "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"
    } ],
    "is_split" : true,
    "stock_state" : "initial",
    "address_change_fee" : 0.0,
    "order_params" : [ {
      "paramKey" : "string",
      "paramValue" : "string"
    } ]
  } ],
  "empty" : true
}

1.12.17. 补发订单

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

补发订单

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

订单补发请求

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

200

successful operation

OrderReissueResponse
1.12.17.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" : "连江县/思明区",
      "town" : "string",
      "street" : "观日路46号603",
      "postcode" : "363423",
      "latitude" : "45.3,范围0-90",
      "longtitude" : "121.2,范围0-180",
      "coordinate_type" : "GCJ02",
      "private_street" : "脱敏地址**"
    },
    "oaid" : "string"
  },
  "source_order_id" : "121212",
  "responsible_party" : "carrier",
  "reissue_reason" : "弄丢了",
  "reissue_order_items" : [ {
    "quantity" : 13.0,
    "item_no" : "1",
    "sku_id" : "132323"
  } ],
  "seller_note" : "商家备注"
}
1.12.17.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "string"
}

1.12.18. 提交订单（新版）

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

提交订单（新版）

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

order
必填

订单

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

200

successful operation

OrderSubmitResponse
1.12.18.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",
      "title" : "plain",
      "content" : "上海股份有限公司",
      "amount" : 12.03,
      "tax" : 2.32,
      "remark" : "plain",
      "time" : "2019-07-15 16:56:23",
      "url" : "a.jpg",
      "email" : "chw@qq.com",
      "kind" : "paper",
      "title_type" : "person",
      "buyer_tax_code" : "1232000046600736XP",
      "taxer_id" : "1212345046600736XP",
      "print_number" : "123456",
      "securaty_code" : "2114445",
      "check_code" : "201622"
    } ],
    "error_reason" : "string",
    "apply_qrcode" : "string"
  },
  "payment" : {
    "type" : "online",
    "state" : "paid",
    "payee" : {
      "id" : "string",
      "name" : "string"
    },
    "amount" : 14.02,
    "freight" : 14.02,
    "details" : [ {
      "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" : [ {
      "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",
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "receiver" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "福州市/厦门市",
        "district" : "连江县/思明区",
        "town" : "string",
        "street" : "观日路46号603",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      },
      "oaid" : "string"
    },
    "waybills" : [ {
      "packages" : [ {
        "type" : "string",
        "id" : "string"
      } ],
      "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",
    "third_order_id" : "1223654",
    "main_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"
    },
    "platform_group" : "string"
  },
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "front" : {
      "spec" : "蓝色;微甜  少冰/多糖",
      "spec2" : "500g",
      "unit" : "string",
      "sku_id" : "052700601",
      "item_id" : "052700601",
      "station_type" : "wrh",
      "station_id" : "1230980"
    },
    "details" : [ {
      "id" : "121212",
      "title" : "矿泉水",
      "quantity" : 4.0,
      "ratio" : 3.0,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋",
        "sale_mode" : "normal"
      },
      "front_spec" : "辣",
      "upc" : "4897060263713"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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
    },
    "weight" : 100.0,
    "deliveryQty" : 1.0,
    "item_no" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.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" : "保温袋",
      "sale_mode" : "normal"
    },
    "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_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "fault_tolerant_info" : "string",
    "salesman" : {
      "id" : "string",
      "name" : "string"
    },
    "salesman_type" : "author",
    "extra_info" : "{\"inv_mgr\": false}",
    "tags" : "标签",
    "relation_sale_order_id" : "1231232131",
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "orig_weight" : 100.0,
    "item_stock_state" : "部分占货",
    "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(商品异常)、carrier(配送异常)",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "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的参与详情"
      },
      "merchant_act_id" : "1111",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（平台）",
        "discount" : 1.0
      } ],
      "share_details" : "[]"
    } ]
  },
  "deliveryResult" : "none,shipPart,shipAll",
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "approve_state" : "none",
  "customer_note" : "note",
  "seller_note" : "note",
  "salesman" : {
    "id" : "string",
    "name" : "string",
    "type" : "saleman",
    "org" : {
      "id" : "string",
      "name" : "string"
    },
    "org_type" : "门店"
  },
  "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,
  "shop_amount" : 120.01,
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "shop_package_discount" : 33.33,
  "ptm_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",
        "sku_id" : "052700601",
        "item_id" : "052700601",
        "station_type" : "wrh",
        "station_id" : "1230980"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋",
          "sale_mode" : "normal"
        },
        "front_spec" : "辣",
        "upc" : "4897060263713"
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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
      },
      "weight" : 100.0,
      "deliveryQty" : 1.0,
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.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" : "保温袋",
        "sale_mode" : "normal"
      },
      "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_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "salesman_type" : "author",
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "relation_sale_order_id" : "1231232131",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "orig_weight" : 100.0,
      "item_stock_state" : "部分占货",
      "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",
        "sku_id" : "052700601",
        "item_id" : "052700601",
        "station_type" : "wrh",
        "station_id" : "1230980"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋",
          "sale_mode" : "normal"
        },
        "front_spec" : "辣",
        "upc" : "4897060263713"
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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
      },
      "weight" : 100.0,
      "deliveryQty" : 1.0,
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.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" : "保温袋",
        "sale_mode" : "normal"
      },
      "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_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "salesman_type" : "author",
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "relation_sale_order_id" : "1231232131",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "orig_weight" : 100.0,
      "item_stock_state" : "部分占货",
      "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"
  } ],
  "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",
    "member_grade" : "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" : {
    "discounts" : "[{}]",
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : [ {
      "qty" : 1.0,
      "amount" : 1.0,
      "sku_id" : "213323232",
      "sku_name" : "213323232"
    } ],
    "package_type" : "保温袋"
  },
  "item_logistics" : [ {
    "qty" : 0.0,
    "sku_id" : "string",
    "logistics_code" : "string"
  } ],
  "calc_data" : true,
  "wrh_id" : "4184",
  "wrh_name" : "cc",
  "wrh_state" : "initial",
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string",
    "encrypt_telephone" : "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"
  } ],
  "is_split" : true,
  "stock_state" : "initial",
  "address_change_fee" : 0.0,
  "order_params" : [ {
    "paramKey" : "string",
    "paramValue" : "string"
  } ]
}
1.12.18.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "order_id" : "string"
}

1.12.19. 取指定订单

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

取指定订单

1.12.19.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（运单打印信息）、exceptions（异常信息）

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

200

successful operation

Order
1.12.19.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/{id}
1.12.19.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",
      "title" : "plain",
      "content" : "上海股份有限公司",
      "amount" : 12.03,
      "tax" : 2.32,
      "remark" : "plain",
      "time" : "2019-07-15 16:56:23",
      "url" : "a.jpg",
      "email" : "chw@qq.com",
      "kind" : "paper",
      "title_type" : "person",
      "buyer_tax_code" : "1232000046600736XP",
      "taxer_id" : "1212345046600736XP",
      "print_number" : "123456",
      "securaty_code" : "2114445",
      "check_code" : "201622"
    } ],
    "error_reason" : "string",
    "apply_qrcode" : "string"
  },
  "payment" : {
    "type" : "online",
    "state" : "paid",
    "payee" : {
      "id" : "string",
      "name" : "string"
    },
    "amount" : 14.02,
    "freight" : 14.02,
    "details" : [ {
      "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" : [ {
      "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",
    "station" : {
      "id" : "string",
      "name" : "string"
    },
    "receiver" : {
      "contact" : {
        "name" : "李飞",
        "telephone" : "189389928893",
        "mobile" : "189389928893",
        "email" : "55151@qq.com",
        "fax" : "123123",
        "private_name" : "脱敏名称**",
        "private_mobile" : "189389928893"
      },
      "address" : {
        "country" : "中国",
        "province" : "福建省",
        "city" : "福州市/厦门市",
        "district" : "连江县/思明区",
        "town" : "string",
        "street" : "观日路46号603",
        "postcode" : "363423",
        "latitude" : "45.3,范围0-90",
        "longtitude" : "121.2,范围0-180",
        "coordinate_type" : "GCJ02",
        "private_street" : "脱敏地址**"
      },
      "oaid" : "string"
    },
    "waybills" : [ {
      "packages" : [ {
        "type" : "string",
        "id" : "string"
      } ],
      "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",
    "third_order_id" : "1223654",
    "main_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"
    },
    "platform_group" : "string"
  },
  "items" : [ {
    "uuid" : "string",
    "spec" : "1*1",
    "unit" : "瓶",
    "barcode" : "123456",
    "quantity" : 1.0,
    "total" : 2.0,
    "front" : {
      "spec" : "蓝色;微甜  少冰/多糖",
      "spec2" : "500g",
      "unit" : "string",
      "sku_id" : "052700601",
      "item_id" : "052700601",
      "station_type" : "wrh",
      "station_id" : "1230980"
    },
    "details" : [ {
      "id" : "121212",
      "title" : "矿泉水",
      "quantity" : 4.0,
      "ratio" : 3.0,
      "package_info" : {
        "thermosphere" : "string",
        "quantity" : 125.0,
        "total" : 205.44,
        "packageName" : "保温袋",
        "sale_mode" : "normal"
      },
      "front_spec" : "辣",
      "upc" : "4897060263713"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_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
    },
    "weight" : 100.0,
    "deliveryQty" : 1.0,
    "item_no" : "1",
    "sku_id" : "00321",
    "product_id" : "2123",
    "item_title" : "葡萄",
    "unit_price" : 2.0,
    "purchase_price" : 2.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" : "保温袋",
      "sale_mode" : "normal"
    },
    "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_item" : {
      "type" : "multi",
      "barcode" : "121221",
      "price" : 33.22,
      "quantity" : 3.0,
      "sku_id" : "121221",
      "item_title" : "【组合】洗护套装",
      "image_url" : "string",
      "combined_id" : "121221"
    },
    "fault_tolerant_info" : "string",
    "salesman" : {
      "id" : "string",
      "name" : "string"
    },
    "salesman_type" : "author",
    "extra_info" : "{\"inv_mgr\": false}",
    "tags" : "标签",
    "relation_sale_order_id" : "1231232131",
    "settle_unit" : {
      "type" : "store",
      "code" : "0001",
      "name" : "门店1"
    },
    "orig_weight" : 100.0,
    "item_stock_state" : "部分占货",
    "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(商品异常)、carrier(配送异常)",
    "caption" : "商品异常",
    "remark" : "商品异常",
    "time" : "2017-12-26 16:40:19",
    "operator" : "zuhu",
    "order_id" : "123456"
  } ],
  "promotion" : {
    "favs" : [ {
      "id" : "1111",
      "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的参与详情"
      },
      "merchant_act_id" : "1111",
      "prom_cls" : "string",
      "voucher_code" : "111111111",
      "settle_details" : [ {
        "role" : "shop（商家）、platform（平台）、agent（平台）",
        "discount" : 1.0
      } ],
      "share_details" : "[]"
    } ]
  },
  "deliveryResult" : "none,shipPart,shipAll",
  "order_store" : {
    "id" : "string",
    "name" : "string"
  },
  "approve_state" : "none",
  "customer_note" : "note",
  "seller_note" : "note",
  "salesman" : {
    "id" : "string",
    "name" : "string",
    "type" : "saleman",
    "org" : {
      "id" : "string",
      "name" : "string"
    },
    "org_type" : "门店"
  },
  "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,
  "shop_amount" : 120.01,
  "freight_discount" : 33.33,
  "package_discount" : 33.33,
  "shop_package_discount" : 33.33,
  "ptm_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",
        "sku_id" : "052700601",
        "item_id" : "052700601",
        "station_type" : "wrh",
        "station_id" : "1230980"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋",
          "sale_mode" : "normal"
        },
        "front_spec" : "辣",
        "upc" : "4897060263713"
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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
      },
      "weight" : 100.0,
      "deliveryQty" : 1.0,
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.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" : "保温袋",
        "sale_mode" : "normal"
      },
      "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_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "salesman_type" : "author",
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "relation_sale_order_id" : "1231232131",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "orig_weight" : 100.0,
      "item_stock_state" : "部分占货",
      "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",
        "sku_id" : "052700601",
        "item_id" : "052700601",
        "station_type" : "wrh",
        "station_id" : "1230980"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋",
          "sale_mode" : "normal"
        },
        "front_spec" : "辣",
        "upc" : "4897060263713"
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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
      },
      "weight" : 100.0,
      "deliveryQty" : 1.0,
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.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" : "保温袋",
        "sale_mode" : "normal"
      },
      "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_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "salesman_type" : "author",
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "relation_sale_order_id" : "1231232131",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "orig_weight" : 100.0,
      "item_stock_state" : "部分占货",
      "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"
  } ],
  "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",
    "member_grade" : "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" : {
    "discounts" : "[{}]",
    "settle_date" : "2022-08-25 00:00:00",
    "station_settle_mode" : "online"
  },
  "package_info" : {
    "required" : false,
    "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
    "details" : [ {
      "qty" : 1.0,
      "amount" : 1.0,
      "sku_id" : "213323232",
      "sku_name" : "213323232"
    } ],
    "package_type" : "保温袋"
  },
  "item_logistics" : [ {
    "qty" : 0.0,
    "sku_id" : "string",
    "logistics_code" : "string"
  } ],
  "calc_data" : true,
  "wrh_id" : "4184",
  "wrh_name" : "cc",
  "wrh_state" : "initial",
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string",
    "encrypt_telephone" : "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"
  } ],
  "is_split" : true,
  "stock_state" : "initial",
  "address_change_fee" : 0.0,
  "order_params" : [ {
    "paramKey" : "string",
    "paramValue" : "string"
  } ]
}

1.12.20. 取消订单

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

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

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

取消订单请求对象

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

200

successful operation

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

1.12.21. 更新订单承运信息

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

更新订单承运信息

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

ActionResult
1.12.21.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"
    } ]
  },
  "re_calc_carrier" : true
}
1.12.21.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.22. 更新订单配送状态

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

更新订单配送状态

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

ActionResult
1.12.22.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",
  "front_state" : "订单完成",
  "ship_time" : "2022-07-18 20:34:00"
}
1.12.22.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.23. 确认自提

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

确认自提

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求对象

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

200

successful operation

ActionResult
1.12.23.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/selftake?operator=string
请求 body
{
  "store_id" : "454534"
}
1.12.23.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.24. 订单发货

POST /{tenant_id}/soms/orderservice/order/{id}/action/ship
1.12.24.1. 说明

订单发货，支持多个运单号

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

订单发货

ShipRequest
1.12.24.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.12.24.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/action/ship?operator=string
请求 body
{
  "waybills" : [ {
    "number" : "string",
    "carrier" : {
      "id" : "string",
      "name" : "string"
    },
    "weight" : {
      "unit" : "string",
      "value" : 0.0
    },
    "products" : [ {
      "skuId" : "string",
      "itemTitle" : "string",
      "quantity" : 0.0
    } ]
  } ],
  "wrh" : {
    "id" : "string",
    "name" : "string"
  },
  "operator" : "laowang"
}
1.12.24.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

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

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

更新订单门店作业状态

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

门店作业请求

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

200

successful operation

ActionResult
1.12.25.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.12.25.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.26. 商家主动发起退款

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

商家主动发起退款

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

request
必填

申请请求对象

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

200

successful operation

ActionResult
1.12.26.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,
    "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.12.26.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.27. 取消承运商配送申请

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

取消承运商配送申请

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

取消承运商调度请求

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

200

successful operation

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

1.12.28. 获取订单配送踪迹

GET /{tenant_id}/soms/orderservice/order/{id}/delivery/trace
1.12.28.1. 说明

获取承运商配送轨迹：顺丰快递、美团快递、蜂鸟快递、京东快递等

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

waybill_id
可选

运单号

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

200

successful operation

DeliveryTraceResponse
1.12.28.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/delivery/trace
1.12.28.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "deliveryman" : "123434354",
  "longitude" : 111.5,
  "latitude" : 355.5,
  "traces" : [ {
    "time" : "2022-04-07 08:39:07",
    "address" : "福建,厦门市",
    "message" : "顺丰速运 已收取快件",
    "status" : "在途"
  } ],
  "order_id" : "123434354",
  "waybill_id" : "123434354",
  "deliveryman_phone" : "123434354",
  "trace_url" : "http://aaa/bbb",
  "pre_delivery_time" : "2022-04-05 11:11:11"
}

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

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

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

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Query

waybill_id
可选

运单号

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

200

successful operation

OrderKdTrace
1.12.29.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/kd/trace?operator=string
1.12.29.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "state" : "canceled",
  "carrier" : {
    "id" : "string",
    "name" : "string"
  },
  "deliveryman" : "123434354",
  "longitude" : 111.5,
  "latitude" : 355.5,
  "details" : [ {
    "time" : "2022-04-07 08:39:07",
    "address" : "福建,厦门市",
    "message" : "顺丰速运 已收取快件",
    "status" : "在途"
  } ],
  "waybill_id" : "213232",
  "deliveryman_phone" : "123434354",
  "trace_url" : "http://aaa/bbb",
  "pre_delivery_time" : "2022-04-02 00:00:00"
}

1.12.30. 获取订单的运单轨迹信息

GET /{tenant_id}/soms/orderservice/order/{id}/kd/traces
1.12.30.1. 说明

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

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

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

200

successful operation

OrderKdTraceList
1.12.30.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/kd/traces?operator=string
1.12.30.5. HTTP响应示例
响应 200
{
  "traces" : [ {
    "success" : true,
    "code" : "string",
    "message" : "string",
    "state" : "canceled",
    "carrier" : {
      "id" : "string",
      "name" : "string"
    },
    "deliveryman" : "123434354",
    "longitude" : 111.5,
    "latitude" : 355.5,
    "details" : [ {
      "time" : "2022-04-07 08:39:07",
      "address" : "福建,厦门市",
      "message" : "顺丰速运 已收取快件",
      "status" : "在途"
    } ],
    "waybill_id" : "213232",
    "deliveryman_phone" : "123434354",
    "trace_url" : "http://aaa/bbb",
    "pre_delivery_time" : "2022-04-02 00:00:00"
  } ]
}

1.12.31. 更换承运商

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

更换承运商

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

承运商修改请求

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

200

successful operation

ActionResult
1.12.31.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",
  "carrier_note" : "string"
}
1.12.31.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.32. 订单付款

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

订单付款

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

Path

id
必填

订单号

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

支付请求对象

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

200

successful operation

ActionResult
1.12.32.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/pay?operator=string
请求 body
{
  "payee" : {
    "id" : "string",
    "name" : "string"
  },
  "details" : [ {
    "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"
  } ],
  "pay_state" : "paid",
  "pay_time" : "2019-12-12 12:12:00",
  "pay_bill_id" : "123434354"
}
1.12.32.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.33. 订单修改收货信息

POST /{tenant_id}/soms/orderservice/order/{order_id}/mod/receiver
1.12.33.1. 说明

订单修改收货信息

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

Path

order_id
必填

订单ID

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

updateParam
必填

收货信息修改参数

收货信息修改参数
1.12.33.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.12.33.4. HTTP请求示例
请求 path
/string/soms/orderservice/order/string/mod/receiver?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" : "连江县/思明区",
      "town" : "string",
      "street" : "观日路46号603",
      "postcode" : "363423",
      "latitude" : "45.3,范围0-90",
      "longtitude" : "121.2,范围0-180",
      "coordinate_type" : "GCJ02",
      "private_street" : "脱敏地址**"
    },
    "oaid" : "string"
  },
  "name" : {
    "value" : "string"
  },
  "mobile" : {
    "value" : "string"
  },
  "province" : {
    "value" : "string"
  },
  "city" : {
    "value" : "string"
  },
  "district" : {
    "value" : "string"
  },
  "street" : {
    "value" : "string"
  },
  "postCode" : {
    "value" : "string"
  },
  "check_action" : "platform",
  "encrypt_detail" : {
    "secretKey" : "string",
    "encrypt_street" : "string",
    "encrypt_name" : "string",
    "encrypt_mobile" : "string",
    "encrypt_telephone" : "string"
  }
}
1.12.33.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.12.34. 查询订单（ES查询）

POST /{tenant_id}/soms/orderservice/orders/esQuery
1.12.34.1. 说明

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

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

Path

tenant_id
必填

租户ID

string

Query

desc
必填

倒序

boolean

Query

page_size
必填

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

integer (int32)

Query

scrollId
可选

游标Id，第一次传-1

string

Query

scrollTime
可选

游标有效时间

string

Query

sort_key
可选

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

string

Body

filter
必填

查询条件

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

200

successful operation

OrderEsPaging
1.12.34.4. HTTP请求示例
请求 path
/string/soms/orderservice/orders/esQuery?desc=true&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",
  "shop_id_in" : "[0002,0003]",
  "pre_type" : "normal",
  "station_ids" : [ "string" ],
  "approve_states" : [ "none" ],
  "delivery_states" : [ "none" ],
  "delivery_results" : [ "none" ],
  "delivery_types" : [ "selftake" ],
  "carrier_states" : [ "initial" ],
  "carrier_types" : [ "self" ],
  "payment_states" : [ "notPay" ],
  "payment_types" : [ "cod" ],
  "receiver_mobile" : "18857485554",
  "receiver_mobile_like" : "5554",
  "receiver_name" : "张三",
  "carrier_id" : "0003",
  "carrier_merchant_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",
  "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_id_match" : "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" : "拼团订单",
  "type_id_eq" : "ECOM",
  "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_third_order_id_eq" : "32323232323323",
  "front_sku_id" : "string",
  "sku_id" : "string",
  "sku_id_in" : "[\"sku1\", \"sku2\"]",
  "source_order_id_eq" : "213",
  "source_order_id_in" : [ "string" ],
  "ship_mode" : "string",
  "wrh_id_eq" : "string",
  "wrh_id_in" : [ "string" ],
  "platform_group_eq" : "O2O",
  "member_grade_eq" : "12253",
  "stock_state" : "initial",
  "package_count_gt" : "initial",
  "has_billing_exception" : false,
  "is_split" : true
}
1.12.34.5. HTTP响应示例
响应 200
{
  "total" : 100,
  "page" : 1,
  "scrollId" : "string",
  "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",
        "title" : "plain",
        "content" : "上海股份有限公司",
        "amount" : 12.03,
        "tax" : 2.32,
        "remark" : "plain",
        "time" : "2019-07-15 16:56:23",
        "url" : "a.jpg",
        "email" : "chw@qq.com",
        "kind" : "paper",
        "title_type" : "person",
        "buyer_tax_code" : "1232000046600736XP",
        "taxer_id" : "1212345046600736XP",
        "print_number" : "123456",
        "securaty_code" : "2114445",
        "check_code" : "201622"
      } ],
      "error_reason" : "string",
      "apply_qrcode" : "string"
    },
    "payment" : {
      "type" : "online",
      "state" : "paid",
      "payee" : {
        "id" : "string",
        "name" : "string"
      },
      "amount" : 14.02,
      "freight" : 14.02,
      "details" : [ {
        "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" : [ {
        "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",
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "receiver" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "福州市/厦门市",
          "district" : "连江县/思明区",
          "town" : "string",
          "street" : "观日路46号603",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        },
        "oaid" : "string"
      },
      "waybills" : [ {
        "packages" : [ {
          "type" : "string",
          "id" : "string"
        } ],
        "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",
      "third_order_id" : "1223654",
      "main_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"
      },
      "platform_group" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "sku_id" : "052700601",
        "item_id" : "052700601",
        "station_type" : "wrh",
        "station_id" : "1230980"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋",
          "sale_mode" : "normal"
        },
        "front_spec" : "辣",
        "upc" : "4897060263713"
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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
      },
      "weight" : 100.0,
      "deliveryQty" : 1.0,
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.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" : "保温袋",
        "sale_mode" : "normal"
      },
      "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_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "salesman_type" : "author",
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "relation_sale_order_id" : "1231232131",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "orig_weight" : 100.0,
      "item_stock_state" : "部分占货",
      "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(商品异常)、carrier(配送异常)",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（平台）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "deliveryResult" : "none,shipPart,shipAll",
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "customer_note" : "note",
    "seller_note" : "note",
    "salesman" : {
      "id" : "string",
      "name" : "string",
      "type" : "saleman",
      "org" : {
        "id" : "string",
        "name" : "string"
      },
      "org_type" : "门店"
    },
    "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,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "shop_package_discount" : 33.33,
    "ptm_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",
          "sku_id" : "052700601",
          "item_id" : "052700601",
          "station_type" : "wrh",
          "station_id" : "1230980"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋",
            "sale_mode" : "normal"
          },
          "front_spec" : "辣",
          "upc" : "4897060263713"
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "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的参与详情"
            },
            "merchant_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
        },
        "weight" : 100.0,
        "deliveryQty" : 1.0,
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.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" : "保温袋",
          "sale_mode" : "normal"
        },
        "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_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "salesman_type" : "author",
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "relation_sale_order_id" : "1231232131",
        "settle_unit" : {
          "type" : "store",
          "code" : "0001",
          "name" : "门店1"
        },
        "orig_weight" : 100.0,
        "item_stock_state" : "部分占货",
        "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",
          "sku_id" : "052700601",
          "item_id" : "052700601",
          "station_type" : "wrh",
          "station_id" : "1230980"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋",
            "sale_mode" : "normal"
          },
          "front_spec" : "辣",
          "upc" : "4897060263713"
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "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的参与详情"
            },
            "merchant_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
        },
        "weight" : 100.0,
        "deliveryQty" : 1.0,
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.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" : "保温袋",
          "sale_mode" : "normal"
        },
        "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_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "salesman_type" : "author",
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "relation_sale_order_id" : "1231232131",
        "settle_unit" : {
          "type" : "store",
          "code" : "0001",
          "name" : "门店1"
        },
        "orig_weight" : 100.0,
        "item_stock_state" : "部分占货",
        "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"
    } ],
    "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",
      "member_grade" : "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" : {
      "discounts" : "[{}]",
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : [ {
        "qty" : 1.0,
        "amount" : 1.0,
        "sku_id" : "213323232",
        "sku_name" : "213323232"
      } ],
      "package_type" : "保温袋"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "wrh_name" : "cc",
    "wrh_state" : "initial",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string",
      "encrypt_telephone" : "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"
    } ],
    "is_split" : true,
    "stock_state" : "initial",
    "address_change_fee" : 0.0,
    "order_params" : [ {
      "paramKey" : "string",
      "paramValue" : "string"
    } ]
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.12.35. 查询订单（ES查询）

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

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

1.12.35.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.12.35.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderPaging
1.12.35.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",
  "shop_id_in" : "[0002,0003]",
  "pre_type" : "normal",
  "station_ids" : [ "string" ],
  "approve_states" : [ "none" ],
  "delivery_states" : [ "none" ],
  "delivery_results" : [ "none" ],
  "delivery_types" : [ "selftake" ],
  "carrier_states" : [ "initial" ],
  "carrier_types" : [ "self" ],
  "payment_states" : [ "notPay" ],
  "payment_types" : [ "cod" ],
  "receiver_mobile" : "18857485554",
  "receiver_mobile_like" : "5554",
  "receiver_name" : "张三",
  "carrier_id" : "0003",
  "carrier_merchant_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",
  "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_id_match" : "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" : "拼团订单",
  "type_id_eq" : "ECOM",
  "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_third_order_id_eq" : "32323232323323",
  "front_sku_id" : "string",
  "sku_id" : "string",
  "sku_id_in" : "[\"sku1\", \"sku2\"]",
  "source_order_id_eq" : "213",
  "source_order_id_in" : [ "string" ],
  "ship_mode" : "string",
  "wrh_id_eq" : "string",
  "wrh_id_in" : [ "string" ],
  "platform_group_eq" : "O2O",
  "member_grade_eq" : "12253",
  "stock_state" : "initial",
  "package_count_gt" : "initial",
  "has_billing_exception" : false,
  "is_split" : true
}
1.12.35.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",
        "title" : "plain",
        "content" : "上海股份有限公司",
        "amount" : 12.03,
        "tax" : 2.32,
        "remark" : "plain",
        "time" : "2019-07-15 16:56:23",
        "url" : "a.jpg",
        "email" : "chw@qq.com",
        "kind" : "paper",
        "title_type" : "person",
        "buyer_tax_code" : "1232000046600736XP",
        "taxer_id" : "1212345046600736XP",
        "print_number" : "123456",
        "securaty_code" : "2114445",
        "check_code" : "201622"
      } ],
      "error_reason" : "string",
      "apply_qrcode" : "string"
    },
    "payment" : {
      "type" : "online",
      "state" : "paid",
      "payee" : {
        "id" : "string",
        "name" : "string"
      },
      "amount" : 14.02,
      "freight" : 14.02,
      "details" : [ {
        "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" : [ {
        "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",
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "receiver" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "福州市/厦门市",
          "district" : "连江县/思明区",
          "town" : "string",
          "street" : "观日路46号603",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        },
        "oaid" : "string"
      },
      "waybills" : [ {
        "packages" : [ {
          "type" : "string",
          "id" : "string"
        } ],
        "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",
      "third_order_id" : "1223654",
      "main_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"
      },
      "platform_group" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "sku_id" : "052700601",
        "item_id" : "052700601",
        "station_type" : "wrh",
        "station_id" : "1230980"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋",
          "sale_mode" : "normal"
        },
        "front_spec" : "辣",
        "upc" : "4897060263713"
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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
      },
      "weight" : 100.0,
      "deliveryQty" : 1.0,
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.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" : "保温袋",
        "sale_mode" : "normal"
      },
      "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_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "salesman_type" : "author",
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "relation_sale_order_id" : "1231232131",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "orig_weight" : 100.0,
      "item_stock_state" : "部分占货",
      "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(商品异常)、carrier(配送异常)",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（平台）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "deliveryResult" : "none,shipPart,shipAll",
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "customer_note" : "note",
    "seller_note" : "note",
    "salesman" : {
      "id" : "string",
      "name" : "string",
      "type" : "saleman",
      "org" : {
        "id" : "string",
        "name" : "string"
      },
      "org_type" : "门店"
    },
    "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,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "shop_package_discount" : 33.33,
    "ptm_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",
          "sku_id" : "052700601",
          "item_id" : "052700601",
          "station_type" : "wrh",
          "station_id" : "1230980"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋",
            "sale_mode" : "normal"
          },
          "front_spec" : "辣",
          "upc" : "4897060263713"
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "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的参与详情"
            },
            "merchant_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
        },
        "weight" : 100.0,
        "deliveryQty" : 1.0,
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.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" : "保温袋",
          "sale_mode" : "normal"
        },
        "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_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "salesman_type" : "author",
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "relation_sale_order_id" : "1231232131",
        "settle_unit" : {
          "type" : "store",
          "code" : "0001",
          "name" : "门店1"
        },
        "orig_weight" : 100.0,
        "item_stock_state" : "部分占货",
        "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",
          "sku_id" : "052700601",
          "item_id" : "052700601",
          "station_type" : "wrh",
          "station_id" : "1230980"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋",
            "sale_mode" : "normal"
          },
          "front_spec" : "辣",
          "upc" : "4897060263713"
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "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的参与详情"
            },
            "merchant_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
        },
        "weight" : 100.0,
        "deliveryQty" : 1.0,
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.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" : "保温袋",
          "sale_mode" : "normal"
        },
        "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_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "salesman_type" : "author",
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "relation_sale_order_id" : "1231232131",
        "settle_unit" : {
          "type" : "store",
          "code" : "0001",
          "name" : "门店1"
        },
        "orig_weight" : 100.0,
        "item_stock_state" : "部分占货",
        "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"
    } ],
    "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",
      "member_grade" : "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" : {
      "discounts" : "[{}]",
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : [ {
        "qty" : 1.0,
        "amount" : 1.0,
        "sku_id" : "213323232",
        "sku_name" : "213323232"
      } ],
      "package_type" : "保温袋"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "wrh_name" : "cc",
    "wrh_state" : "initial",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string",
      "encrypt_telephone" : "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"
    } ],
    "is_split" : true,
    "stock_state" : "initial",
    "address_change_fee" : 0.0,
    "order_params" : [ {
      "paramKey" : "string",
      "paramValue" : "string"
    } ]
  } ],
  "page_count" : 5,
  "page_size" : 20
}

1.12.36. 批量取指定订单(新)

POST /{tenant_id}/soms/orderservice/v2/order/orders
1.12.36.1. 说明

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

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

Path

tenant_id
必填

租户ID

string

Query

parts
可选

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

string

Body

orderIds
必填

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

SomsRequestListString
1.12.36.3. 响应
HTTP代码 说明 类型

200

successful operation

OrderList
1.12.36.4. HTTP请求示例
请求 path
/string/soms/orderservice/v2/order/orders
请求 body
{
  "data" : [ "string" ]
}
1.12.36.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",
        "title" : "plain",
        "content" : "上海股份有限公司",
        "amount" : 12.03,
        "tax" : 2.32,
        "remark" : "plain",
        "time" : "2019-07-15 16:56:23",
        "url" : "a.jpg",
        "email" : "chw@qq.com",
        "kind" : "paper",
        "title_type" : "person",
        "buyer_tax_code" : "1232000046600736XP",
        "taxer_id" : "1212345046600736XP",
        "print_number" : "123456",
        "securaty_code" : "2114445",
        "check_code" : "201622"
      } ],
      "error_reason" : "string",
      "apply_qrcode" : "string"
    },
    "payment" : {
      "type" : "online",
      "state" : "paid",
      "payee" : {
        "id" : "string",
        "name" : "string"
      },
      "amount" : 14.02,
      "freight" : 14.02,
      "details" : [ {
        "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" : [ {
        "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",
      "station" : {
        "id" : "string",
        "name" : "string"
      },
      "receiver" : {
        "contact" : {
          "name" : "李飞",
          "telephone" : "189389928893",
          "mobile" : "189389928893",
          "email" : "55151@qq.com",
          "fax" : "123123",
          "private_name" : "脱敏名称**",
          "private_mobile" : "189389928893"
        },
        "address" : {
          "country" : "中国",
          "province" : "福建省",
          "city" : "福州市/厦门市",
          "district" : "连江县/思明区",
          "town" : "string",
          "street" : "观日路46号603",
          "postcode" : "363423",
          "latitude" : "45.3,范围0-90",
          "longtitude" : "121.2,范围0-180",
          "coordinate_type" : "GCJ02",
          "private_street" : "脱敏地址**"
        },
        "oaid" : "string"
      },
      "waybills" : [ {
        "packages" : [ {
          "type" : "string",
          "id" : "string"
        } ],
        "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",
      "third_order_id" : "1223654",
      "main_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"
      },
      "platform_group" : "string"
    },
    "items" : [ {
      "uuid" : "string",
      "spec" : "1*1",
      "unit" : "瓶",
      "barcode" : "123456",
      "quantity" : 1.0,
      "total" : 2.0,
      "front" : {
        "spec" : "蓝色;微甜  少冰/多糖",
        "spec2" : "500g",
        "unit" : "string",
        "sku_id" : "052700601",
        "item_id" : "052700601",
        "station_type" : "wrh",
        "station_id" : "1230980"
      },
      "details" : [ {
        "id" : "121212",
        "title" : "矿泉水",
        "quantity" : 4.0,
        "ratio" : 3.0,
        "package_info" : {
          "thermosphere" : "string",
          "quantity" : 125.0,
          "total" : 205.44,
          "packageName" : "保温袋",
          "sale_mode" : "normal"
        },
        "front_spec" : "辣",
        "upc" : "4897060263713"
      } ],
      "promotion" : {
        "favs" : [ {
          "id" : "1111",
          "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的参与详情"
          },
          "merchant_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
      },
      "weight" : 100.0,
      "deliveryQty" : 1.0,
      "item_no" : "1",
      "sku_id" : "00321",
      "product_id" : "2123",
      "item_title" : "葡萄",
      "unit_price" : 2.0,
      "purchase_price" : 2.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" : "保温袋",
        "sale_mode" : "normal"
      },
      "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_item" : {
        "type" : "multi",
        "barcode" : "121221",
        "price" : 33.22,
        "quantity" : 3.0,
        "sku_id" : "121221",
        "item_title" : "【组合】洗护套装",
        "image_url" : "string",
        "combined_id" : "121221"
      },
      "fault_tolerant_info" : "string",
      "salesman" : {
        "id" : "string",
        "name" : "string"
      },
      "salesman_type" : "author",
      "extra_info" : "{\"inv_mgr\": false}",
      "tags" : "标签",
      "relation_sale_order_id" : "1231232131",
      "settle_unit" : {
        "type" : "store",
        "code" : "0001",
        "name" : "门店1"
      },
      "orig_weight" : 100.0,
      "item_stock_state" : "部分占货",
      "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(商品异常)、carrier(配送异常)",
      "caption" : "商品异常",
      "remark" : "商品异常",
      "time" : "2017-12-26 16:40:19",
      "operator" : "zuhu",
      "order_id" : "123456"
    } ],
    "promotion" : {
      "favs" : [ {
        "id" : "1111",
        "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的参与详情"
        },
        "merchant_act_id" : "1111",
        "prom_cls" : "string",
        "voucher_code" : "111111111",
        "settle_details" : [ {
          "role" : "shop（商家）、platform（平台）、agent（平台）",
          "discount" : 1.0
        } ],
        "share_details" : "[]"
      } ]
    },
    "deliveryResult" : "none,shipPart,shipAll",
    "order_store" : {
      "id" : "string",
      "name" : "string"
    },
    "approve_state" : "none",
    "customer_note" : "note",
    "seller_note" : "note",
    "salesman" : {
      "id" : "string",
      "name" : "string",
      "type" : "saleman",
      "org" : {
        "id" : "string",
        "name" : "string"
      },
      "org_type" : "门店"
    },
    "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,
    "shop_amount" : 120.01,
    "freight_discount" : 33.33,
    "package_discount" : 33.33,
    "shop_package_discount" : 33.33,
    "ptm_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",
          "sku_id" : "052700601",
          "item_id" : "052700601",
          "station_type" : "wrh",
          "station_id" : "1230980"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋",
            "sale_mode" : "normal"
          },
          "front_spec" : "辣",
          "upc" : "4897060263713"
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "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的参与详情"
            },
            "merchant_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
        },
        "weight" : 100.0,
        "deliveryQty" : 1.0,
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.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" : "保温袋",
          "sale_mode" : "normal"
        },
        "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_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "salesman_type" : "author",
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "relation_sale_order_id" : "1231232131",
        "settle_unit" : {
          "type" : "store",
          "code" : "0001",
          "name" : "门店1"
        },
        "orig_weight" : 100.0,
        "item_stock_state" : "部分占货",
        "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",
          "sku_id" : "052700601",
          "item_id" : "052700601",
          "station_type" : "wrh",
          "station_id" : "1230980"
        },
        "details" : [ {
          "id" : "121212",
          "title" : "矿泉水",
          "quantity" : 4.0,
          "ratio" : 3.0,
          "package_info" : {
            "thermosphere" : "string",
            "quantity" : 125.0,
            "total" : 205.44,
            "packageName" : "保温袋",
            "sale_mode" : "normal"
          },
          "front_spec" : "辣",
          "upc" : "4897060263713"
        } ],
        "promotion" : {
          "favs" : [ {
            "id" : "1111",
            "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的参与详情"
            },
            "merchant_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
        },
        "weight" : 100.0,
        "deliveryQty" : 1.0,
        "item_no" : "1",
        "sku_id" : "00321",
        "product_id" : "2123",
        "item_title" : "葡萄",
        "unit_price" : 2.0,
        "purchase_price" : 2.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" : "保温袋",
          "sale_mode" : "normal"
        },
        "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_item" : {
          "type" : "multi",
          "barcode" : "121221",
          "price" : 33.22,
          "quantity" : 3.0,
          "sku_id" : "121221",
          "item_title" : "【组合】洗护套装",
          "image_url" : "string",
          "combined_id" : "121221"
        },
        "fault_tolerant_info" : "string",
        "salesman" : {
          "id" : "string",
          "name" : "string"
        },
        "salesman_type" : "author",
        "extra_info" : "{\"inv_mgr\": false}",
        "tags" : "标签",
        "relation_sale_order_id" : "1231232131",
        "settle_unit" : {
          "type" : "store",
          "code" : "0001",
          "name" : "门店1"
        },
        "orig_weight" : 100.0,
        "item_stock_state" : "部分占货",
        "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"
    } ],
    "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",
      "member_grade" : "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" : {
      "discounts" : "[{}]",
      "settle_date" : "2022-08-25 00:00:00",
      "station_settle_mode" : "online"
    },
    "package_info" : {
      "required" : false,
      "type" : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)",
      "details" : [ {
        "qty" : 1.0,
        "amount" : 1.0,
        "sku_id" : "213323232",
        "sku_name" : "213323232"
      } ],
      "package_type" : "保温袋"
    },
    "item_logistics" : [ {
      "qty" : 0.0,
      "sku_id" : "string",
      "logistics_code" : "string"
    } ],
    "calc_data" : true,
    "wrh_id" : "4184",
    "wrh_name" : "cc",
    "wrh_state" : "initial",
    "encrypt_detail" : {
      "secretKey" : "string",
      "encrypt_street" : "string",
      "encrypt_name" : "string",
      "encrypt_mobile" : "string",
      "encrypt_telephone" : "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"
    } ],
    "is_split" : true,
    "stock_state" : "initial",
    "address_change_fee" : 0.0,
    "order_params" : [ {
      "paramKey" : "string",
      "paramValue" : "string"
    } ]
  } ],
  "empty" : true
}

1.13. 巨益回调服务

1.13.1. 巨益订单发货回传

POST /{tenant_id}/eshop/callback/juyi/order/ship
1.13.1.1. 说明

巨益订单发货回传

1.13.1.2. 参数
类型 名称 类型

Body

body
可选

string

Body

body
可选

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

200

successful operation

ActionResult
1.13.1.4. HTTP请求示例
请求 path
/{tenant_id}/eshop/callback/juyi/order/ship
请求 body
{
  "carrier" : {
    "id" : "string",
    "name" : "string"
  },
  "wrh" : {
    "id" : "string",
    "name" : "string"
  },
  "platform_id" : "mingchuang",
  "shop_id" : "2019",
  "trade_id" : "123456",
  "waybill_id" : "string",
  "juyi_carrier_waybills" : [ {
    "carrier" : {
      "id" : "string",
      "name" : "string"
    },
    "products" : [ {
      "sub_source_order_code" : "string",
      "sku_id" : "string",
      "item_title" : "string",
      "quantity" : 0.0
    } ],
    "waybill_id" : "string"
  } ]
}
1.13.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.13.2. 巨益通知释放订单占货

POST /{tenant_id}/eshop/callback/juyi/order/stock/unlock
1.13.2.1. 说明

巨益通知释放订单占货

1.13.2.2. 参数
类型 名称 类型

Body

body
可选

string

Body

body
可选

巨益库存释放请求
1.13.2.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.13.2.4. HTTP请求示例
请求 path
/{tenant_id}/eshop/callback/juyi/order/stock/unlock
请求 body
{
  "order_id" : "string"
}
1.13.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.13.3. 库存回调

POST /{tenant_id}/eshop/callback/juyi/platform/updateInvs
1.13.3.1. 说明

库存回调

1.13.3.2. 参数
类型 名称 类型

Body

body
可选

string

Body

body
可选

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

200

successful operation

ActionResult
1.13.3.4. HTTP请求示例
请求 path
/{tenant_id}/eshop/callback/juyi/platform/updateInvs
请求 body
{
  "invs" : [ {
    "qty" : 0.0,
    "sku_id" : "2007200410101",
    "out_sku_id" : "6941501567286"
  } ],
  "platform_id" : "巨益的平台编码,如其他平台对应的编码是OTHER",
  "shop_id" : "巨益的店铺编码"
}
1.13.3.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.13.4. 退单拦截发货结果

POST /{tenant_id}/eshop/callback/juyi/rtn/intercept/result
1.13.4.1. 说明

退单拦截发货同步中台

1.13.4.2. 参数
类型 名称 类型

Body

body
可选

string

Body

body
可选

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

200

successful operation

ActionResult
1.13.4.4. HTTP请求示例
请求 path
/{tenant_id}/eshop/callback/juyi/rtn/intercept/result
请求 body
{
  "success" : true,
  "message" : "string",
  "platform_id" : "mingchuang",
  "shop_id" : "2019",
  "rtn_id" : "123456"
}
1.13.4.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.13.5. 退单确认收货

POST /{tenant_id}/eshop/callback/juyi/rtn/receive
1.13.5.1. 说明

退单确认收货

1.13.5.2. 参数
类型 名称 类型

Body

body
可选

string

Body

body
可选

JuyiRtnReceiveRequest
1.13.5.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.13.5.4. HTTP请求示例
请求 path
/{tenant_id}/eshop/callback/juyi/rtn/receive
请求 body
{
  "wrh" : {
    "id" : "string",
    "name" : "string"
  },
  "platform_id" : "mingchuang",
  "shop_id" : "2019",
  "rtn_id" : "123456"
}
1.13.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.13.6. 提交订单回调结果

POST /{tenant_id}/eshop/callback/juyi/sync/order/result
1.13.6.1. 说明

订单回调结果

1.13.6.2. 参数
类型 名称 类型

Body

body
可选

string

Body

body
可选

JuYiSyncOrderCallback
1.13.6.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.13.6.4. HTTP请求示例
请求 path
/{tenant_id}/eshop/callback/juyi/sync/order/result
请求 body
{
  "success" : true,
  "message" : "string",
  "order_id" : "string"
}
1.13.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.13.7. 提交仅退款或者退款退货回调结果

POST /{tenant_id}/eshop/callback/juyi/sync/rtn/result
1.13.7.1. 说明

提交仅退款或者退款退货回调结果

1.13.7.2. 参数
类型 名称 类型

Body

body
可选

string

Body

body
可选

JuYiSyncRtnCallback
1.13.7.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.13.7.4. HTTP请求示例
请求 path
/{tenant_id}/eshop/callback/juyi/sync/rtn/result
请求 body
{
  "success" : true,
  "message" : "string",
  "rtn_id" : "string"
}
1.13.7.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.13.8. 上传库存流水

POST /{tenant_id}/eshop/callback/juyi/uploadInvHst
1.13.8.1. 说明

上传库存流水

1.13.8.2. 参数
类型 名称 类型

Body

body
可选

string

Body

body
可选

JuyiUploadInvHstRequest
1.13.8.3. 响应
HTTP代码 说明 类型

200

successful operation

ActionResult
1.13.8.4. HTTP请求示例
请求 path
/{tenant_id}/eshop/callback/juyi/uploadInvHst
请求 body
{
  "platform_id" : "巨益的平台编码,如其他平台对应的编码是OTHER",
  "shop_id" : "巨益的店铺编码",
  "inv_hsts" : [ {
    "time" : "2019-03-02 12:00:01",
    "flow_id" : "2007200410101",
    "bussiness_type" : "采购入库",
    "sku_id" : "2007200410101",
    "out_sku_id" : "6941501567286",
    "change_qty" : 0.0,
    "relation_id" : "202308181139",
    "out_wrh_id" : "202308181139",
    "out_wrh_name" : "202308181139"
  } ]
}
1.13.8.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string"
}

1.14. 门店作业规则服务

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

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

查询门店作业规则服务

1.14.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.14.1.3. 响应
HTTP代码 说明 类型

200

successful operation

< StoreOperationRule > array
1.14.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.14.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.14.2. 获取门店作业规则

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

获取门店作业规则

1.14.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.14.2.3. 响应
HTTP代码 说明 类型

200

successful operation

StoreOperationRule
1.14.2.4. HTTP请求示例
请求 path
/string/soms/storeoperationruleservice/rule?platform_id=string&shop_id=string&store_id=string&type=string
1.14.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.14.3. 删除门店作业规则

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

删除门店作业规则

1.14.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.14.3.3. 响应
HTTP代码 说明 类型

default

successful operation

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

1.14.4. 保存门店作业规则

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

保存门店作业规则

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

store_operation_rule_save
必填

自提规则

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

default

successful operation

无内容
1.14.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
    }
  }
}

1.15. 采购订单服务

1.15.1. 提交采购订单

POST /{tenant_id}/soms/purchaseservice/purchase
1.15.1.1. 说明

提交采购订单

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

Path

tenant_id
必填

租户Id

string

Query

operator
必填

操作人

string

Body

purchase
必填

订单

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

200

successful operation

PurchaseResponse
1.15.1.4. HTTP请求示例
请求 path
/string/soms/purchaseservice/purchase?operator=string
请求 body
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "2022030502",
  "type" : "string",
  "state" : "string",
  "vendor" : {
    "code" : "string",
    "name" : "string"
  },
  "items" : [ {
    "qty" : 1.0,
    "sku_id" : "00321",
    "ship_qty" : 1.0,
    "receive_qty" : 1.0
  } ],
  "relations" : [ {
    "bill_type" : "order",
    "bill_id" : "1234567890"
  } ],
  "remark" : "销售触发采购",
  "source_id" : "2022030501",
  "source_system" : "SAP",
  "is_virtual_mode" : false,
  "vend_unit_type" : "wrh",
  "vend_unit" : {
    "code" : "string",
    "name" : "string"
  },
  "ship_wrh" : {
    "code" : "string",
    "name" : "string"
  },
  "purchaser" : {
    "code" : "string",
    "name" : "string"
  },
  "purchase_unit_type" : "store",
  "purchase_unit" : {
    "code" : "string",
    "name" : "string"
  },
  "purchase_date" : "{}",
  "receive_wrh" : {
    "code" : "string",
    "name" : "string"
  },
  "ship_state" : "shipped",
  "expect_ship_time" : "2022-03-05 08:00:00",
  "receive_state" : "received",
  "return_state" : "none",
  "relation_order_type" : "purchasesuggest",
  "relation_order_id" : "123456"
}
1.15.1.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "id" : "88822222222"
}

1.15.2. 异步占货

POST /{tenant_id}/soms/purchaseservice/purchase/asyncLock
1.15.2.1. 说明

异步占货

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

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求

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

200

successful operation

SomsResponseVoid
1.15.2.4. HTTP请求示例
请求 path
/string/soms/purchaseservice/purchase/asyncLock?operator=string
请求 body
{
  "tenantId" : "冗余字段，外部不需要传",
  "id" : "string",
  "items" : [ {
    "skuId" : "string",
    "qty" : 0.0,
    "wrhId" : "string"
  } ],
  "relationItems" : [ {
    "suggestId" : "string",
    "wrhId" : "string",
    "skuId" : "string",
    "qty" : 0.0
  } ]
}
1.15.2.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : { }
}

1.15.3. 查询采购订单

POST /{tenant_id}/soms/purchaseservice/purchase/query
1.15.3.1. 说明

查询采购订单

1.15.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
可选

排序字段 支持：modified,created 字段排序,默认created排序

string

Body

filter
必填

查询条件

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

200

successful operation

SomsPageResponsePurchase
1.15.3.4. HTTP请求示例
请求 path
/string/soms/purchaseservice/purchase/query?desc=true&page=0&page_size=0
请求 body
{
  "id_start_with" : "string",
  "id_eq" : "string",
  "state_eq" : "string",
  "source_system_eq" : "string",
  "type_eq" : "string",
  "source_id_in" : [ "string" ],
  "source_id_start_with" : "string",
  "vend_unit_type_eq" : "string",
  "vend_unit_code_start_with" : "string",
  "purchase_unit_type_eq" : "string",
  "purchase_unit_code_start_with" : "string",
  "ship_state_eq" : "string",
  "receive_state_eq" : "string",
  "relation_order_id_start_with" : "string",
  "expect_ship_time_start" : "2016-03-02 12:00:01",
  "expect_ship_time_end" : "2016-03-02 12:00:01",
  "created_start" : "2016-03-02 12:00:01",
  "created_end" : "2016-03-02 12:00:01",
  "bill_id_eq" : "xxxxxxxx",
  "parts" : "items"
}
1.15.3.5. HTTP响应示例
响应 200
{
  "echoCode" : 0,
  "echoMessage" : "string",
  "success" : true,
  "page" : 0,
  "pageSize" : 0,
  "pageCount" : 0,
  "total" : 0,
  "data" : [ {
    "created" : "2020-06-17 10:00:00",
    "modified" : "2020-06-17 10:00:00",
    "creator" : "string",
    "modifier" : "string",
    "id" : "2022030502",
    "type" : "string",
    "state" : "string",
    "vendor" : {
      "code" : "string",
      "name" : "string"
    },
    "items" : [ {
      "qty" : 1.0,
      "sku_id" : "00321",
      "ship_qty" : 1.0,
      "receive_qty" : 1.0
    } ],
    "relations" : [ {
      "bill_type" : "order",
      "bill_id" : "1234567890"
    } ],
    "remark" : "销售触发采购",
    "source_id" : "2022030501",
    "source_system" : "SAP",
    "is_virtual_mode" : false,
    "vend_unit_type" : "wrh",
    "vend_unit" : {
      "code" : "string",
      "name" : "string"
    },
    "ship_wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "purchaser" : {
      "code" : "string",
      "name" : "string"
    },
    "purchase_unit_type" : "store",
    "purchase_unit" : {
      "code" : "string",
      "name" : "string"
    },
    "purchase_date" : "{}",
    "receive_wrh" : {
      "code" : "string",
      "name" : "string"
    },
    "ship_state" : "shipped",
    "expect_ship_time" : "2022-03-05 08:00:00",
    "receive_state" : "received",
    "return_state" : "none",
    "relation_order_type" : "purchasesuggest",
    "relation_order_id" : "123456"
  } ]
}

1.15.4. 取指定采购订单

GET /{tenant_id}/soms/purchaseservice/purchase/{id}
1.15.4.1. 说明

取指定采购订单

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

Path

id
必填

单据id

string

Path

tenant_id
必填

租户ID

string

Query

parts
可选

返回多个部分用,隔开。需要返回的部分,items(商品详情)

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

200

successful operation

Purchase
1.15.4.4. HTTP请求示例
请求 path
/string/soms/purchaseservice/purchase/string
1.15.4.5. HTTP响应示例
响应 200
{
  "created" : "2020-06-17 10:00:00",
  "modified" : "2020-06-17 10:00:00",
  "creator" : "string",
  "modifier" : "string",
  "id" : "2022030502",
  "type" : "string",
  "state" : "string",
  "vendor" : {
    "code" : "string",
    "name" : "string"
  },
  "items" : [ {
    "qty" : 1.0,
    "sku_id" : "00321",
    "ship_qty" : 1.0,
    "receive_qty" : 1.0
  } ],
  "relations" : [ {
    "bill_type" : "order",
    "bill_id" : "1234567890"
  } ],
  "remark" : "销售触发采购",
  "source_id" : "2022030501",
  "source_system" : "SAP",
  "is_virtual_mode" : false,
  "vend_unit_type" : "wrh",
  "vend_unit" : {
    "code" : "string",
    "name" : "string"
  },
  "ship_wrh" : {
    "code" : "string",
    "name" : "string"
  },
  "purchaser" : {
    "code" : "string",
    "name" : "string"
  },
  "purchase_unit_type" : "store",
  "purchase_unit" : {
    "code" : "string",
    "name" : "string"
  },
  "purchase_date" : "{}",
  "receive_wrh" : {
    "code" : "string",
    "name" : "string"
  },
  "ship_state" : "shipped",
  "expect_ship_time" : "2022-03-05 08:00:00",
  "receive_state" : "received",
  "return_state" : "none",
  "relation_order_type" : "purchasesuggest",
  "relation_order_id" : "123456"
}

1.15.5. 收货

POST /{tenant_id}/soms/purchaseservice/purchase/{id}/receive
1.15.5.1. 说明

收货

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

Path

id
必填

id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

string

Body

request
必填

请求

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

200

successful operation

SomsResponseVoid
1.15.5.4. HTTP请求示例
请求 path
/string/soms/purchaseservice/purchase/string/receive?operator=string
请求 body
{
  "receive_wrh" : {
    "code" : "string",
    "name" : "string"
  },
  "receive_state" : "received",
  "items" : [ {
    "sku_id" : "00321",
    "receive_qty" : 1.0
  } ]
}
1.15.5.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : { }
}

1.15.6. 发货

POST /{tenant_id}/soms/purchaseservice/purchase/{id}/ship
1.15.6.1. 说明

发货

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

Path

id
必填

id

string

Path

tenant_id
必填

租户ID

string

Query

operator
必填

操作人

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

200

successful operation

SomsResponseVoid
1.15.6.4. HTTP请求示例
请求 path
/string/soms/purchaseservice/purchase/string/ship?operator=string
1.15.6.5. HTTP响应示例
响应 200
{
  "success" : true,
  "code" : "string",
  "message" : "string",
  "data" : { }
}

商户接口

Unresolved directive in index.adoc - include::/hdapp/jenkins/agent/ssd1/workspace/SOMS/soms-dly-doc-develop/target/asciidoc/merchant/paths.adoc[]

对象定义

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
可选

详细地址
样例 : "观日路46号603"

string

town
可选

样例 : "string"

string

2.3. AdjustDetail

名称 说明 类型

after
可选

调整后
样例 : "12"

string

before
可选

调整前
样例 : "10"

string

field
可选

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

string

2.4. AuthInfo

平台授权信息

名称 说明 类型

app_key
必填

appKey
样例 : "1001001"

string

app_secret
必填

appSecret
样例 : "1001001"

string

platform_id
必填

平台id
样例 : "1001001"

string

session_key
必填

sessionKey
样例 : "1001001"

string

shop_id
必填

店铺id
样例 : "1001001"

string

2.5. BaseResponseAuthInfo

名称 说明 类型

data
可选

响应数据
样例 : AuthInfo

AuthInfo

message
可选

响应信息
样例 : "string"

string

success
可选

是否成功
默认值 : false
样例 : true

boolean

2.6. BaseResponsePrintInfo

名称 说明 类型

data
可选

响应数据
样例 : PrintInfo

PrintInfo

message
可选

响应信息
样例 : "string"

string

success
可选

是否成功
默认值 : false
样例 : true

boolean

2.7. BatchLockStockResponse

批量占货结果

名称 说明 类型

code
可选

样例 : "string"

string

details
可选

占货结果详情
样例 : [ "BatchLockStockResult" ]

< BatchLockStockResult > array

lock_result
可选

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

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.8. BatchLockStockResult

单据占货结果

名称 说明 类型

lock_id
可选

占货ID
样例 : "string"

string

lock_result
可选

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

string

order_id
必填

订单号
样例 : "4545454545454542"

string

outoflock_items
可选

缺货明细
样例 : [ "OutOfLockItem" ]

< OutOfLockItem > array

stock_state
可选

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

enum (initial, locked, shipped, aborted)

2.9. BatchUnLockStockResponse

批量释放占货结果

名称 说明 类型

code
可选

样例 : "string"

string

errors
可选

样例 : [ "ErrorRecord" ]

< ErrorRecord > array

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.10. Brand

品牌资料

名称 说明 类型

id
必填

品牌标识
样例 : "3434343434"

string

name
必填

名称
样例 : "耐克"

string

parentId
可选

父品牌ID
样例 : "324232"

string

remark
可选

备注
样例 : "无"

string

2.11. 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.12. BrandPaging

品牌查询过滤器

名称 说明 类型

brands
可选

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

< Brand > array

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

页数
样例 : 10

integer (int32)

page_size
可选

分页大小
样例 : 10

integer (int32)

total
可选

总记录数
样例 : 100

integer (int64)

2.13. CRMInfo

会员权益信息

名称 说明 类型

coupon_info
可选

券信息
样例 : CouponInfo

CouponInfo

score_info
可选

积分信息
样例 : ScoreInfo

ScoreInfo

2.14. CRMInfoModificationRequest

名称 说明 类型

score
可选

样例 : 0.0

number

2.15. CancelCarrierRequest

取消承运商配送请求对象

名称 说明 类型

auto_dispatch
可选

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

boolean

carrier_id
必填

承运商Id
样例 : "343434343"

string

reason
可选

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

string

2.16. CancelOrderRequest

取消订单请求

名称 说明 类型

frontRtnId
可选

平台退单号
样例 : "599565656"

string

reason
可选

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

string

type
可选

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

string

2.17. CancelRtnRequest

取消退货请求对象

名称 说明 类型

approve_state
可选

样例 : "none"

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

operator_role
可选

样例 : "string"

string

reason
可选

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

string

sellerInfo
可选

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

SellerInfo

2.18. 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.19. CarrierDetail

承运商详情

名称 说明 类型

action
可选

调整方式，recall（重新呼叫）
样例 : "recall"

string

carrier_id
可选

承运商代码
样例 : "sf"

string

carrier_name
可选

承运商名称
样例 : "顺丰速运"

string

carrier_type
可选

承运方式，self（商家自送）、thirdparty（第三方配送）、express（快递配送）
样例 : "express"

string

deliveryman
可选

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

string

deliveryman_id
可选

配送员Id
样例 : "32332"

string

deliveryman_mobile
可选

配送员电话
样例 : "1565586545"

string

2.20. CarrierDetailInfo

更新承运商

名称 说明 类型

carrier_id
可选

承运商代码
样例 : "sf"

string

carrier_name
可选

承运商名称
样例 : "顺丰速运"

string

waybill_id
可选

运单号
样例 : "32332"

string

2.21. CarrierList

承运商列表

名称 说明 类型

carriers
可选

承运商列表
样例 : [ "IdName" ]

< IdName > array

2.22. CarrierModificationRequest

承运商修改请求对象

名称 说明 类型

carrier
可选

承运商
样例 : IdName

IdName

carrier_note
可选

承运商备注
样例 : "string"

string

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.23. CarrierOrderInfo

承运单历史

名称 说明 类型

carrier_id
可选

承运商代码
样例 : "sf"

string

carrier_name
可选

承运商名称
样例 : "顺丰速运"

string

carrier_state
可选

承运状态
样例 : "created"

string

created
可选

创建时间
样例 : "2022-08-30 00:00:00"

string (date-time)

deliveryman
可选

配送员姓名
样例 : "123434354"

string

deliveryman_phone
可选

配送员手机号
样例 : "123434354"

string

details
可选

运单轨迹信息
样例 : [ "OrderKdTraceDetail" ]

< OrderKdTraceDetail > array

exception_remark
可选

异常说明
样例 : "运力不足"

string

modified
可选

最后一次修改时间
样例 : "2022-08-30 00:00:00"

string (date-time)

waybill_id
可选

运单号
样例 : "32332"

string

2.24. CarrierOrderResponse

订单配送单信息

名称 说明 类型

carrier_orders
可选

承运单列表
样例 : [ "CarrierOrderInfo" ]

< CarrierOrderInfo > array

message
可选

样例 : "string"

string

order_id
可选

订单号
样例 : "123434354"

string

success
可选

默认值 : false
样例 : true

boolean

waybill_id
可选

运单号
样例 : "123434354"

string

2.25. CarrierProduct

名称 说明 类型

itemTitle
可选

样例 : "string"

string

quantity
可选

样例 : 0.0

number

skuId
可选

样例 : "string"

string

2.26. CarrierRequest

更新订单承运商物流状态

名称 说明 类型

carrier
必填

承运商
样例 : Carrier

Carrier

carrier_note
可选

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

string

delivery_id
可选

配送ID
样例 : "123"

string

exception_remark
可选

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

string

operator
可选

操作人
样例 : "user"

string

print_info
可选

运单打印信息
样例 : WaybillPrintInfo

WaybillPrintInfo

re_calc_carrier
可选

是否重新计算承运
默认值 : false
样例 : true

boolean

tags
可选

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

< OrderTag > array

waybill_id
可选

运单号
样例 : "123"

string

2.27. CarrierWaybill

名称 说明 类型

carrier
可选

样例 : IdName

IdName

number
可选

样例 : "string"

string

products
可选

样例 : [ "CarrierProduct" ]

< CarrierProduct > array

weight
可选

样例 : MeasureUnit

MeasureUnit

2.28. Category

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

parentId
可选

样例 : "string"

string

remark
可选

样例 : "string"

string

sap_code
可选

样例 : "string"

string

2.29. 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.30. CategoryPaging

名称 说明 类型

categories
可选

样例 : [ "Category" ]

< Category > array

page
可选

样例 : 0

integer (int32)

page_count
可选

样例 : 0

integer (int32)

page_size
可选

样例 : 0

integer (int32)

total
可选

样例 : 0

integer (int64)

2.31. CheckPackageRequest

打包袋检查请求

名称 说明 类型

skus
可选

打包袋商品，订单维度的打包袋商品列表全传
样例 : [ "CheckPackageSku" ]

< CheckPackageSku > array

2.32. CheckPackageResult

打包袋检查结果

名称 说明 类型

message
可选

处理描述
样例 : "string"

string

result
可选

处理结果：success-全部成功，part_success-部分成功（具体哪个失败需要识别skus）、fail-全部失败（不返回skus,失败原因直接查看message即可）
样例 : "string"

string

skus
可选

打包袋商品处理结果
样例 : [ "CheckPackageSkuResult" ]

< CheckPackageSkuResult > array

2.33. CheckPackageSku

打包袋商品检查

名称 说明 类型

qty
可选

打包袋商品数量
样例 : 0.0

number

sku_id
可选

打包袋商品货号
样例 : "string"

string

2.34. CheckPackageSkuResult

打包袋检查结果

名称 说明 类型

message
可选

样例 : "string"

string

sku_id
可选

打包袋商品货号
样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.35. CheckResult

检查结果

名称 说明 类型

accepted
可选

检查是否通过
默认值 : false
样例 : true

boolean

message
可选

提示信息
样例 : "恭喜您，验证通过"

string

2.36. CodeName

名称 说明 类型

code
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.37. ConfirmRefundRequest

确认退款请求对象

名称 说明 类型

operator_role
可选

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

string

payments
可选

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

< RefundPayment > array

refundState
必填

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

enum (none, refunded)

2.38. Contact

用户联系方式

名称 说明 类型

email
可选

邮箱
样例 : "55151@qq.com"

string

fax
可选

传真
样例 : "123123"

string

mobile
可选

手机
样例 : "189389928893"

string

name
可选

姓名
样例 : "李飞"

string

private_mobile
可选

加密手机号
样例 : "189389928893"

string

private_name
可选

脱敏名称
样例 : "脱敏名称**"

string

telephone
可选

电话
样例 : "189389928893"

string

2.39. 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.40. 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.41. CouponInfo

券信息

名称 说明 类型

details
可选

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

< CouponDetail > array

use_total
可选

券抵用总金额
样例 : 1.0

number

2.42. CustomField

自定义属性值

名称 说明 类型

id
可选

自定义id
样例 : "1212"

string

name
可选

自定义名称
样例 : "143434"

string

value
可选

自定义值
样例 : "1212"

string

2.43. Customer

客户

名称 说明 类型

contact
可选

联系方式
样例 : Contact

Contact

id
可选

代码
样例 : "10001"

string

2.44. DeliverDetail

签收详情

名称 说明 类型

deliver_id
必填

送货人ID, 长度20字符
样例 : "22121"

string

deliver_name
可选

送货人姓名,长度32字符
样例 : "李某"

string

on_duty_emps
可选

当班的人员
样例 : [ "IdName" ]

< IdName > array

payments
必填

付款方式详情
样例 : [ "DeliverPaymentDetail" ]

< DeliverPaymentDetail > array

2.45. DeliverFailDetail

订单未投递成功详情

名称 说明 类型

reason
可选

原因说明
样例 : "商品破损"

string

type
必填

原因类型，取值：refused(客户拒收)，redeliver（未妥投）
样例 : "refused"

string

2.46. DeliverFailReason

投递失败原因

名称 说明 类型

reason
可选

原因说明
样例 : "原因说明"

string

type
必填

取值范围:refused(客户拒收)、redeliver(未妥投)
样例 : "redeliver"

string

2.47. DeliverFailReasonList

原因列表对象

名称 说明 类型

reasons
可选

原因列表
样例 : [ "DeliverFailReason" ]

< DeliverFailReason > array

2.48. DeliverInvoice

发票

名称 说明 类型

details
可选

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

< DeliverInvoiceDetail > array

required
必填

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

boolean

2.49. DeliverInvoiceDetail

发票详情

名称 说明 类型

amount
必填

发票金额
样例 : 12.02

number

content
可选

发票内容
样例 : "某某公司"

string

title
可选

发票抬头
样例 : "plain"

string

2.50. DeliverOrder

客户订单

名称 说明 类型

cancel_type
可选

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

string

carrier_exception_remark
可选

承运异常信息
样例 : "门店不存在"

string

carrier_id
可选

承运商代码,取值为self（门店自送）、thirdparty（第三方配送）等其他第三方承运商ID
样例 : "self"

string

carrier_name
可选

承运商名称
样例 : "顺丰"

string

carrier_state
可选

承运状态取值为initial（初始状态）、pickup（已揽件）、pickupFailed（揽件失败）
样例 : "pickupFailed"

string

carrier_type
可选

承运商类型,取值为self（门店自送）、thirdparty（第三方配送）、express（快递配送）
样例 : "express"

string

create_time
可选

下单时间，格式是：yyyy-MM-dd HH:mm:ss
样例 : "2017-11-27 18:38:42"

string

customer_info
必填

客户信息（收件人信息）
样例 : "string"

string

customer_note
可选

客户备注
样例 : "无"

string

delivery_type
必填

送货方式，取值:送货上门|到店自提
样例 : "送货上门"

string

deliveryman
可选

配送员
样例 : "李三"

string

deliveryman_mobile
可选

配送员电话
样例 : "15655895658"

string

exception_info
可选

异常信息
样例 : "string"

string

exception_type
可选

异常类型:取值范围:redeliver(未妥投)、refused(客户拒收)、timeout(超期未提)、stopped(发货后取消)、listingException(上架异常)
样例 : "stopped"

string

expected_delivered_date
可选

期望送达日期
样例 : "2014-02-03"

string

expected_delivered_time_slot
可选

期望送达时间时间段
样例 : "11:00-12:00"

string

fault_tolerant_info
可选

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

string

freight
可选

运费
样例 : 12.03

number

id
必填

订单号
样例 : "1001001"

string

invoice
可选

发票
样例 : DeliverInvoice

DeliverInvoice

items
必填

商品详情
样例 : [ "DeliverOrderItem" ]

< DeliverOrderItem > array

mobile
可选

客户电话(收货人电话)
样例 : "15855885589"

string

multi_store
可选

是否支持跨店调度配送，默认false
默认值 : false
样例 : false

boolean

packages
可选

订单打包袋列表
样例 : [ "OrderPackageBag" ]

< OrderPackageBag > array

payable_amount
可选

尾款
样例 : 12.02

number

payment_type
必填

支付方式的标题，取值:货到付款|在线支付
样例 : "货到付款"

string

private_customer_info
必填

客户脱敏信息（收件人脱敏信息）
样例 : "string"

string

private_mobile
可选

隐私号
样例 : "189389928893"

string

private_street
可选

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

string

quotas
可选

订单限定
样例 : [ "DeliverOrderQuota" ]

< DeliverOrderQuota > array

salechannel
可选

订单来源:取值范围:mdj(美到家)、jdo2o(京东到家)、tbkb(淘宝口碑)
样例 : "mdj"

string

salechannel_name
可选

平台名称:取值范围:美到家、京东到家、淘宝口碑
样例 : "美到家"

string

ship_location
可选

发货地,取值范围,dc(库房发货)、store(门店直送)
样例 : "store"

string

ship_location_caption
可选

发货地显示标题
样例 : "上海"

string

ship_time
可选

发货时间，格式是：yyyy-MM-dd HH:mm:ss
样例 : "2017-11-27 18:38:42"

string

shop_id
可选

商家ID
样例 : "string"

string

sign_time
可选

签收时间，格式是：yyyy-MM-dd HH:mm:ss
样例 : "2017-11-27 18:38:42"

string

status
必填

订单状态,取值范围:confirming(待确认)、shipping(待发货)、storenotsigned(未签收)、storesigned(门店签收)、prepared(已上架)、delivering(已登记)、delivered(已妥投)、refused(客户拒收)、redeliver(未妥投)、canceled(已取消)、stopped(终止配送)
样例 : "confirming"

string

status_caption
必填

订单状态显示名称
样例 : "已取消"

string

store_id
必填

门店ID
样例 : "0002"

string

tags
可选

订单标签
样例 : [ "订单标签" ]

< 订单标签 > array

total
必填

订单金额
样例 : 12.03

number

type_caption
可选

订单类型说明，取值:一小时达|非一小时达
样例 : "一小时达"

string

waybill_id
可选

运单号
样例 : "123456"

string

2.51. DeliverOrderDecryptRequest

类型 : object

2.52. DeliverOrderDecryptResponse

名称 说明 类型

customer_info
可选

客户信息（收件人信息）
样例 : "string"

string

receiver_mobile
可选

样例 : "string"

string

receiver_street
可选

样例 : "string"

string

2.53. DeliverOrderItem

客户订单商品明细

名称 说明 类型

barcode
可选

条形码
样例 : "32323"

string

details
可选

原料明细
样例 : [ "DeliverOrderItemDetail" ]

< DeliverOrderItemDetail > array

fault_tolerant_info
可选

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

string

fav_price
必填

优惠后单价
样例 : 12.54

number

fav_total
必填

优惠后金额
样例 : 12.25

number

image_url
可选

商品图片信息
样例 : "http://aaa/bbb.png"

string

itemCustomField
可选

商品自定义属性
样例 : ItemCustomField

ItemCustomField

item_code
必填

货号
样例 : "32323"

string

item_name
可选

品名
样例 : "可乐"

string

item_no
可选

序号
样例 : "1"

string

orig_item
可选

原单商品信息
样例 : DeliverOrderOrigItem

DeliverOrderOrigItem

quantity
必填

数量
样例 : 12.0

number

spec
可选

规格
样例 : "1*1"

string

tags
可选

商品行标签
样例 : [ "订单标签" ]

< 订单标签 > array

total
必填

金额
样例 : 12.25

number

unit_price
必填

单价
样例 : 32.05

number

2.54. DeliverOrderItemDetail

原料明细

名称 说明 类型

id
必填

原料商品货号
样例 : "323231"

string

quantity
必填

原料商品数量
样例 : 12.0

number

ratio
必填

比例
样例 : 0.25

number

title
必填

名称
样例 : "aaa"

string

2.55. DeliverOrderItemMod

商品修改详情

名称 说明 类型

items
必填

商品修改详情
样例 : [ "DeliverOrderModItem" ]

< DeliverOrderModItem > array

payments
可选

付款方式详情
样例 : [ "DeliverPaymentDetail" ]

< DeliverPaymentDetail > array

reason
可选

调整原因
样例 : "补差"

string

type
可选

调整类型：weight_diff（称重差异），stock_none(缺货)
样例 : "weight_diff"

string

2.56. DeliverOrderModItem

名称 说明 类型

details
可选

调整明细
样例 : [ "DeliverOrderModItemDetail" ]

< DeliverOrderModItemDetail > array

item_code
必填

货号
样例 : "32323"

string

item_no
可选

序号
样例 : "1"

string

quantity
必填

数量
样例 : 12.0

number

2.57. DeliverOrderModItemDetail

名称 说明 类型

after
可选

调整后
样例 : "12"

string

before
可选

调整前
样例 : "10"

string

field
可选

调整字段
样例 : "total,fav_total,quantity"

string

2.58. DeliverOrderOrigItem

原商品行信息

名称 说明 类型

item_code
必填

货号
样例 : "32323"

string

item_name
可选

品名
样例 : "可乐"

string

qpc
可选

规格
样例 : "1*1"

string

quantity
必填

数量
样例 : 12.0

number

unit
可选

单位
样例 : "份"

string

2.59. DeliverOrderPaging

订单分页结果

名称 说明 类型

paging
可选

分页对象
样例 : Paging

Paging

records
可选

客户订单列表
样例 : [ "DeliverOrder" ]

< DeliverOrder > array

2.60. DeliverOrderPrintData

订单打印数据

名称 说明 类型

order_id
可选

订单号
样例 : "21212"

string

parts
可选

每联的打印数据
样例 : [ "string" ]

< string > array

time
可选

打印数据的生成时间，格式是：yyyy-MM-dd HH:mm:ss
样例 : "2019-07-03 13:06:46"

string

2.61. DeliverOrderPrintDataList

订单打印数据列表

名称 说明 类型

orders
可选

订单打印数据列表
样例 : [ "DeliverOrderPrintData" ]

< DeliverOrderPrintData > array

2.62. DeliverOrderQuota

订单限定

名称 说明 类型

action
可选

操作：expect_shipping
样例 : "expect_shipping"

string

action_name
可选

操作名称：期望拣货完成时间
样例 : "期望拣货完成时间"

string

remark
可选

备注
样例 : "无"

string

time
可选

日期
样例 : "2021-09-26 16:40:19"

string (date-time)

2.63. DeliverPaymentDetail

付款方式详情

名称 说明 类型

amount
必填

金额
样例 : 12.03

number

card_number
可选

卡号
样例 : "22121"

string

name
必填

支付方式名称
样例 : "支付宝"

string

need_cash
可选

是否需要缴款
默认值 : false
样例 : false

boolean

store_pay
可选

是否门店收款/付款
默认值 : false
样例 : false

boolean

2.64. 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)

front_state
可选

平台状态
样例 : "订单完成"

string

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.65. 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（门店发货，快递配送）
样例 : "wrhShipCarrierDeli"

enum (wrhShipCarrierDeli, wrhShipStationDeli, stationShipStationDeli, stationShipCarrierDeli)

ship_id
可选

发货码
样例 : "23232323"

string

ship_mode
可选

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

enum (wrhShip, stationShip)

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)

waybill_id
可选

运单号
样例 : "123"

string

waybill_print_info
可选

运单打印信息
样例 : WaybillPrintInfo

WaybillPrintInfo

waybills
可选

样例 : [ "Waybill" ]

< Waybill > array

wrh_order_id
可选

仓库单号
样例 : "32323"

string

2.66. DeliveryTraceResponse

订单配送踪迹

名称 说明 类型

code
可选

样例 : "string"

string

deliveryman
可选

配送员姓名
样例 : "123434354"

string

deliveryman_phone
可选

配送员手机号
样例 : "123434354"

string

latitude
可选

纬度
样例 : 355.5

number

longitude
可选

经度
样例 : 111.5

number

message
可选

样例 : "string"

string

order_id
可选

鼎力云订单号
样例 : "123434354"

string

pre_delivery_time
可选

预计送达时间
样例 : "2022-04-05 11:11:11"

string (date-time)

success
可选

默认值 : false
样例 : true

boolean

trace_url
可选

跟踪连接
样例 : "http://aaa/bbb"

string

traces
可选

样例 : [ "OrderKdTraceDetail" ]

< OrderKdTraceDetail > array

waybill_id
可选

承运单号
样例 : "123434354"

string

2.67. DiscountSettleDetail

优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

role
可选

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

string

2.68. DiscountShareDetail

整合优惠结算详情

名称 说明 类型

discount
可选

承担优惠金额
样例 : 1.0

number

type
可选

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

string

2.69. EncryptDetail

加密信息

名称 说明 类型

encrypt_mobile
可选

样例 : "string"

string

encrypt_name
可选

样例 : "string"

string

encrypt_street
可选

样例 : "string"

string

encrypt_telephone
可选

样例 : "string"

string

secretKey
可选

样例 : "string"

string

2.70. ErrorRecord

错误记录

名称 说明 类型

code
可选

样例 : "string"

string

id
可选

样例 : "string"

string

message
可选

样例 : "string"

string

2.71. ExtraField

自定义字段

名称 说明 类型

id
可选

自定义id
样例 : "distance_freight"

string

name
可选

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

string

value
可选

自定义值
样例 : "0.01"

string

2.72. FavDetail

优惠详情

名称 说明 类型

amount
可选

优惠金额
样例 : 10.5

number

factor
可选

优惠参与信息
样例 : FavFactor

FavFactor

id
可选

优惠ID
样例 : "1111"

string

merchant_act_id
可选

商家活动ID
样例 : "1111"

string

prom_cls
可选

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

string

remark
可选

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

string

settle_details
可选

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

< DiscountSettleDetail > array

share_details
可选

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

< DiscountShareDetail > array

type
可选

优惠类型
样例 : "string"

string

voucher_code
可选

凭证代码
样例 : "111111111"

string

2.73. 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.74. FavFactorItem

参与优惠商品明细

名称 说明 类型

amount
可选

参与促销金额
样例 : 1.0

number

item_id
可选

行标识
样例 : "1"

string

item_no
必填

行号
样例 : 1

integer (int32)

qty
可选

参与促销数量
样例 : 1.0

number

2.75. FrontItem

平台商品行信息

名称 说明 类型

item_id
必填

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

string

sku_id
可选

平台SKU ID
样例 : "052700601"

string

spec
可选

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

string

spec2
可选

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

string

station_id
可选

平台站点Id
样例 : "1230980"

string

station_type
可选

平台站点类型
样例 : "wrh"

string

unit
可选

单位
样例 : "string"

string

2.76. 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)

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

platform_group
可选

平台分组标识
样例 : "string"

string

state
可选

状态
样例 : "已付款"

string

station_id
可选

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

string

station_order_no
可选

平台门店订单序号
样例 : "1"

string

third_order_id
可选

第三方OMS系统单号，如巨益、聚水潭等
样例 : "1223654"

string

2.77. 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

platform_group
可选

平台分组标识
样例 : "string"

string

rtn_id
可选

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

string

state
可选

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

string

station_id
可选

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

string

third_rtn_id
可选

第三方OMS系统售后单号，如巨益、聚水潭等
样例 : "12212456112"

string

type
可选

平台类型
样例 : IdName

IdName

2.78. IdName

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

2.79. IdNameRange

名称 说明 类型

id_names
可选

样例 : [ "IdName" ]

< IdName > array

limit
可选

默认值 : false
样例 : true

boolean

2.80. IdWrapper

名称 说明 类型

id
可选

样例 : "string"

string

2.81. IdsWrapper

名称 说明 类型

ids
可选

样例 : [ "string" ]

< string > array

2.82. ImageDetail

名称 说明 类型

image_base64
可选

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

string

name
必填

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

string

sort
可选

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

integer (int32)

url
可选

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

string

2.83. InputCode

输入码

名称 说明 类型

code
可选

条码
样例 : "232323"

string

qpc
可选

规格
样例 : 0.0

number

qpc_str
可选

规格说明
样例 : "string"

string

type
可选

输入码类型
样例 : "EAN"

string

unit
可选

单位
样例 : "string"

string

weight
可选

重量
样例 : 0.0

number

2.84. Invoice

发票信息

名称 说明 类型

apply_qrcode
可选

开票二维码
样例 : "string"

string

details
可选

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

< InvoiceDetail > array

error_reason
可选

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

string

required
必填

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

boolean

result
可选

开票结果
样例 : "成功"

string

2.85. InvoiceDetail

发票详情

名称 说明 类型

amount
必填

发票金额
样例 : 12.03

number

buyer_tax_code
可选

购买方税号
样例 : "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

tax
可选

税费
样例 : 2.32

number

taxer_id
可选

纳税人识别号
样例 : "1212345046600736XP"

string

time
可选

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

string (date-time)

title
可选

发票抬头
样例 : "plain"

string

title_type
可选

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

enum (person, company)

type
可选

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

enum (plain, VAT)

url
可选

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

string

2.86. ItemCustomField

商品自定义属性

名称 说明 类型

item_code
可选

商品货号
样例 : "323231"

string

nfield1
可选

数值自定义属性
样例 : 23.0

number

nfield2
可选

数值自定义属性
样例 : 34.0

number

sfield1
可选

字符换自定义属性
样例 : "aaa"

string

sfield2
可选

字符换自定义属性
样例 : "bbb"

string

sfield3
可选

字符换自定义属性
样例 : "ccc"

string

sfield4
可选

字符换自定义属性
样例 : "ddd"

string

sfield5
可选

字符换自定义属性
样例 : "eee"

string

sfield6
可选

字符换自定义属性
样例 : "ggg"

string

sfield7
可选

字符换自定义属性
样例 : "eee"

string

sfield8
可选

字符换自定义属性
样例 : "fff"

string

2.87. ItemPromotion

商品行促销信息

名称 说明 类型

apported_discount_amount
可选

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

number

discount_amount
可选

商品优惠金额
样例 : 0.1

number

favs
可选

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

< FavDetail > array

2.88. JuYiSyncOrderCallback

名称 说明 类型

message
可选

同步失败原因
样例 : "string"

string

order_id
必填

中台订单号，巨益交易号
样例 : "string"

string

success
必填

同步结果，成功:true，失败：false
默认值 : false
样例 : true

boolean

2.89. JuYiSyncRtnCallback

名称 说明 类型

message
可选

同步失败原因
样例 : "string"

string

rtn_id
必填

中台退单号，巨益外部单号
样例 : "string"

string

success
必填

同步结果，成功:true，失败：false
默认值 : false
样例 : true

boolean

2.90. JuyiCarrierProduct

商品明细

名称 说明 类型

item_title
可选

商品名称
样例 : "string"

string

quantity
可选

商品数量
样例 : 0.0

number

sku_id
可选

商品货号
样例 : "string"

string

sub_source_order_code
可选

巨益的子订单号，用于关联匹配商品行
样例 : "string"

string

2.91. JuyiCarrierWaybill

包裹发货结果

名称 说明 类型

carrier
可选

承运商信息
样例 : IdName

IdName

products
可选

商品明细列表
样例 : [ "JuyiCarrierProduct" ]

< JuyiCarrierProduct > array

waybill_id
可选

快递单号
样例 : "string"

string

2.92. JuyiInvHst

名称 说明 类型

bussiness_type
必填

业务类型
样例 : "采购入库"

string

change_qty
必填

库存变更数量
样例 : 0.0

number

flow_id
必填

流水号，流水号唯一
样例 : "2007200410101"

string

out_sku_id
可选

外部编码，巨益侧铺货关系的规格编码
样例 : "6941501567286"

string

out_wrh_id
可选

外部仓库ID(虚拟仓库ID)
样例 : "202308181139"

string

out_wrh_name
可选

外部仓库名称(虚拟仓库名称)
样例 : "202308181139"

string

relation_id
可选

关联单据ID
样例 : "202308181139"

string

sku_id
必填

商品货号，巨益侧铺货关系平台规格ID
样例 : "2007200410101"

string

time
可选

变更时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2019-03-02 12:00:01"

string (date-time)

2.93. JuyiOrderShipRequest

名称 说明 类型

carrier
可选

承运商信息
样例 : IdName

IdName

juyi_carrier_waybills
可选

样例 : [ "JuyiCarrierWaybill" ]

< JuyiCarrierWaybill > array

platform_id
必填

平台编码
样例 : "mingchuang"

string

shop_id
必填

店铺编码
样例 : "2019"

string

trade_id
必填

巨益交易号
样例 : "123456"

string

waybill_id
可选

快递单号
样例 : "string"

string

wrh
可选

发货实体仓库
样例 : IdName

IdName

2.94. JuyiRtnInterceptRequest

名称 说明 类型

message
可选

拦截失败原因
样例 : "string"

string

platform_id
必填

平台编码
样例 : "mingchuang"

string

rtn_id
必填

退单ID
样例 : "123456"

string

shop_id
必填

店铺编码
样例 : "2019"

string

success
必填

拦截结果
默认值 : false
样例 : true

boolean

2.95. JuyiRtnReceiveRequest

名称 说明 类型

platform_id
必填

平台编码
样例 : "mingchuang"

string

rtn_id
必填

退单ID
样例 : "123456"

string

shop_id
必填

店铺编码
样例 : "2019"

string

wrh
可选

收货实体仓库
样例 : IdName

IdName

2.96. JuyiSkuInv

名称 说明 类型

out_sku_id
可选

外部编码，巨益侧铺货关系的规格编码
样例 : "6941501567286"

string

qty
必填

剩余可用数量
样例 : 0.0

number

sku_id
必填

商品货号，巨益侧铺货关系平台规格ID
样例 : "2007200410101"

string

2.97. JuyiSkuInvsRequest

名称 说明 类型

invs
可选

更新库存记录，不能为空，最大100条
样例 : [ "JuyiSkuInv" ]

< JuyiSkuInv > array

platform_id
可选

平台编码
样例 : "巨益的平台编码,如其他平台对应的编码是OTHER"

string

shop_id
可选

店铺编码
样例 : "巨益的店铺编码"

string

2.98. JuyiUploadInvHstRequest

名称 说明 类型

inv_hsts
可选

库存流水记录，不能为空，最大100条
样例 : [ "JuyiInvHst" ]

< JuyiInvHst > array

platform_id
可选

平台编码
样例 : "巨益的平台编码,如其他平台对应的编码是OTHER"

string

shop_id
可选

店铺编码
样例 : "巨益的店铺编码"

string

2.99. KickBackResultRequest

仓库踢回结果请求

名称 说明 类型

msg
可选

踢回失败说明
样例 : "string"

string

success
可选

踢回结果
默认值 : false
样例 : true

boolean

2.100. ListingExceptionDetail

上架异常详情

名称 说明 类型

reason
必填

异常原因
样例 : "商品不存在，上架异常"

string

2.101. LockStockResult

占货结果

名称 说明 类型

code
可选

样例 : "string"

string

lock_id
可选

占货ID
样例 : "string"

string

lock_result
可选

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

string

message
可选

样例 : "string"

string

stock_state
可选

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

enum (initial, locked, shipped, aborted)

success
可选

默认值 : false
样例 : true

boolean

2.102. Measure

重量对象

名称 说明 类型

unit
可选

单位
样例 : "kg"

string

value
可选

值
样例 : 12.0

number

2.103. MeasureUnit

名称 说明 类型

unit
可选

样例 : "string"

string

value
可选

样例 : 0.0

number

2.104. MemberInfo

积分信息

名称 说明 类型

card_no
可选

实体卡卡号
样例 : "22323"

string

member_gid
可选

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

string

member_grade
可选

会员等级
样例 : "12253"

string

member_id
可选

会员卡卡号
样例 : "12253"

string

outer_member_id
可选

外部会员id
样例 : "12253"

string

2.105. MockInfo

压测

名称 说明 类型

persist
可选

默认值 : false
样例 : true

boolean

2.106. ModifyPackageRequest

打包袋修改请求

名称 说明 类型

skus
可选

打包袋商品，按顺序全量覆盖
样例 : [ "ModifyPackageSku" ]

< ModifyPackageSku > array

2.107. ModifyPackageSku

打包袋商品修改

名称 说明 类型

qty
可选

打包袋商品数量
样例 : 0.0

number

sku_id
可选

打包袋商品货号
样例 : "string"

string

2.108. Option

文案选项

名称 说明 类型

caption
可选

说明
样例 : "说明"

string

extra
可选

扩展信息
样例 : OptionExtra

OptionExtra

type
可选

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

string

value
可选

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

string

2.109. OptionExtra

扩展条件

名称 说明 类型

auto
可选

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

boolean

conditions
可选

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

< OptionExtraCondition > array

2.110. OptionExtraCondition

评价等级条件

名称 说明 类型

satisfie_level
可选

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

string

2.111. OptionList

文案选项列表

名称 说明 类型

options
可选

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

< Option > array

2.112. Order

订单

名称 说明 类型

address_change_fee
可选

地址变更费
样例 : 0.0

number

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

deliveryResult
可选

发货结果
样例 : "none,shipPart,shipAll"

enum (none, shipPart, shipAll)

encrypt_detail
可选

加密详情
样例 : EncryptDetail

EncryptDetail

exception_codes
可选

异常代码，sku（商品异常）、amount（金额异常）、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

is_split
可选

拆单标识。为true时，标识该订单是拆单后的订单
默认值 : 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_params
可选

订单扩展参数
样例 : [ "OrderParam" ]

< OrderParam > array

order_store
可选

客户下单门店
样例 : IdName

IdName

orig_total
可选

订单原金额(优惠之前)
样例 : 120.01

number

package_discount
可选

包装优惠金额
样例 : 33.33

number

package_info
可选

订单打包信息
样例 : OrderPackageInfo

OrderPackageInfo

payment
必填

支付信息
样例 : Payment

Payment

print_bills
可选

打印单据
样例 : [ "PrintBill" ]

< PrintBill > array

promotion
可选

订单促销
样例 : OrderPromotion

OrderPromotion

ptm_package_discount
可选

平台包装优惠信息
样例 : 33.33

number

quotas
可选

订单指标
样例 : [ "OrderQuota" ]

< OrderQuota > array

real_total
必填

实际销售商品金额(扣除所有优惠)，等于items中pay_amount之和
样例 : 120.01

number

reissue_reason
可选

补发原因
样例 : "string"

string

responsible_party
可选

补发责任方
样例 : "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

shop_package_discount
可选

商家包装优惠金额
样例 : 33.33

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)

stock_state
可选

占货状态
样例 : "initial"

enum (initial, lockPart, lockAll, none)

suspend_info
可选

挂起信息
样例 : SuspendInfo

SuspendInfo

tags
可选

订单标签
样例 : [ "OrderTag" ]

< OrderTag > array

user_number
可选

使用人数,餐具数量
样例 : 2

integer (int32)

weight
可选

订单重量，单位：g
样例 : 500.0

number

wrh_id
可选

发货仓库编号
样例 : "4184"

string

wrh_name
可选

发货仓库名称
样例 : "cc"

string

wrh_state
可选

仓库状态
样例 : "initial"

enum (initial, notified, applyKickBack, shipped)

2.113. OrderActionApplyItem

订单申请明细对象

名称 说明 类型

item_code
必填

订单商品行货号
样例 : "0001"

string

order_item_no
必填

订单商品行行号，帮助定位退货商品行
样例 : "1"

string

quantity
必填

订单商品行数量
样例 : 2.0

number

2.114. OrderActionApplyRequest

订单申请请求对象

名称 说明 类型

items
可选

申请明细
样例 : [ "OrderActionApplyItem" ]

< OrderActionApplyItem > array

reason
可选

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

string

2.115. 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.116. 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.117. 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.118. OrderBatchLockRequest

批量占货参数

名称 说明 类型

allow_part
可选

允许部分单据占货，默认false
默认值 : false
样例 : false

boolean

orders
可选

占货单据列表
样例 : [ "OrderDataParam" ]

< OrderDataParam > array

2.119. OrderBatchUnLockRequest

批量释放占货

名称 说明 类型

unlocks
可选

样例 : [ "OrderUnlock" ]

< OrderUnlock > array

2.120. 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.121. 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
可选

收货联系方式
样例 : Contact

Contact

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.122. 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.123. 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.124. OrderCommentDetail

名称 说明 类型

labels
可选

评价标签
样例 : [ "string" ]

< string > array

score
可选

评价得分
样例 : 0

integer (int32)

type
可选

评价类型
样例 : "string"

string

2.125. 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)

created_end
可选

创建时间截止于
样例 : "2016-03-02 12:00:01"

string (date-time)

created_start
可选

创建时间起始于
样例 : "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

processStateIn
可选

状态存在
样例 : [ "string" ]

< string > array

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.126. OrderCommentPaging

订单评价分页对象

名称 说明 类型

comments
可选

订单评价列表
样例 : [ "OrderComment" ]

< OrderComment > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

total
可选

总条数
样例 : 100

integer (int64)

2.127. OrderDataItem

明细

名称 说明 类型

qty
必填

库存
样例 : 32.0

number

shop_id
可选

平台商家id
样例 : "12121212"

string

sku_id
必填

商品ID
样例 : "12"

string

2.128. 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.129. OrderEsPaging

es订单分页对象

名称 说明 类型

orders
可选

订单列表
样例 : [ "Order" ]

< Order > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

scrollId
可选

游标id
样例 : "string"

string

total
可选

总条数
样例 : 100

integer (int64)

2.130. OrderException

名称 说明 类型

caption
可选

异常标题
样例 : "商品异常"

string

code
必填

异常代码
样例 : "sku(商品异常)、carrier(配送异常)"

string

operator
可选

操作人
样例 : "zuhu"

string

order_id
可选

订单号
样例 : "123456"

string

remark
可选

异常说明
样例 : "商品异常"

string

time
可选

异常时间
样例 : "2017-12-26 16:40:19"

string (date-time)

2.131. 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.132. 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_merchant_id
可选

承运商家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

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_results
可选

发货结果，取值:none(未发货)、shipPart(部分发货)、shipAll(发货完成)、invalidState(非法的配送状态)
样例 : [ "none" ]

< enum (none, shipPart, shipAll) > array

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

front_third_order_id_eq
可选

平台第三方订单号等于
样例 : "32323232323323"

string

handover_operator
可选

交接人
样例 : "张三"

string

hasInvoice
可选

是否拥有发票
默认值 : false
样例 : false

boolean

has_billing
可选

是否有凭证信息,false搜索没有、true搜索有
默认值 : false
样例 : true

boolean

has_billing_exception
可选

是否凭证异常
默认值 : false
样例 : false

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

is_split
可选

默认值 : false
样例 : true

boolean

member_grade_eq
可选

会员等级等于
样例 : "12253"

string

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_id_match
可选

订单精确查询
样例 : "1000002111"

string

order_ids
可选

订单号
样例 : [ "string" ]

< string > array

package_count_gt
可选

购物袋数量大于
样例 : "initial"

number

payment_states
可选

付款状态，取值范围：notPay(未付款)、earnest(已付定金)、paid(已付全款)
样例 : [ "notPay" ]

< enum (notPay, earnest, paid) > array

payment_types
可选

付款类型，取值范围：cod(货到付款)、online(在线支付)、earnest(预售)
样例 : [ "cod" ]

< enum (cod, online, earnest) > array

platform_group_eq
可选

平台分组等于（O2O、EC）
样例 : "O2O"

string

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

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
可选

发货方式
样例 : "string"

string

shipping_operator
可选

集货人
样例 : "张三"

string

shop_id
可选

商家ID 等于
样例 : "0002"

string

shop_id_in
可选

商家ID 包含
样例 : "[0002,0003]"

< string > array

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

stock_state
可选

占货状态
样例 : "initial"

enum (initial, lockPart, lockAll, none)

suspended
可选

是否挂起
默认值 : false
样例 : true

boolean

type_eq
可选

订单类型
样例 : "拼团订单"

string

type_id_eq
可选

订单类型ID
样例 : "ECOM"

string

waybill_id
可选

运单号
样例 : "0003"

string

wrh_id_eq
可选

仓库代码 等于
样例 : "string"

string

wrh_id_in
可选

仓库代码 包含
样例 : [ "string" ]

< string > array

2.133. OrderItem

商品行

名称 说明 类型

apported_discount_amount
必填

整单优惠分摊金额，如：订单满减，整单分摊到明细
样例 : 12.02

number

barcode
可选

商品条码
样例 : "123456"

string

consume_scores
可选

消费积分
样例 : 12.2

number

deliveryQty
可选

发货数量
样例 : 1.0

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_stock_state
可选

占货状态
样例 : "部分占货"

enum (initial, lockPart, lockAll, none)

item_title
可选

商品标题
样例 : "葡萄"

string

orig_barcode
可选

转换前商品条码
样例 : "1212"

string

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
样例 : 100.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

relation_item_id
可选

关联商品行号
样例 : "2123"

string

relation_sale_order_id
可选

关联的销售订单
样例 : "1231232131"

string

relation_sku_id
可选

关联商品货号
样例 : "2123"

string

salesman
可选

推销员
样例 : IdName

IdName

salesman_type
可选

售卖员类型
样例 : "author"

string

settle_discountAmount
可选

平台优惠金额
样例 : 122.22

number

settle_price
可选

平台结算价格，为空等于售价
样例 : 122.2222

number

settle_total
可选

平台结算金额=客户实付商品金额+平台优惠补贴
样例 : 122.22

number

settle_unit
可选

结算单位
样例 : SettleUnit

SettleUnit

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

unit
可选

单位：个、份等
样例 : "瓶"

string

unit_price
必填

商品销售价格（扣除优惠券前的价格）
样例 : 2.0

number

uuid
可选

样例 : "string"

string

weight
可选

单件重量，单位g
样例 : 100.0

number

2.134. OrderItemChange

换货明细

名称 说明 类型

change_items
可选

目标商品行
样例 : [ "OrderItem" ]

< OrderItem > array

items
可选

来源商品行
样例 : [ "OrderItem" ]

< OrderItem > array

reason
可选

原因
样例 : "string"

string

2.135. OrderItemDetail

原料商品信息

名称 说明 类型

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

title
必填

名称
样例 : "矿泉水"

string

upc
可选

国际码
样例 : "4897060263713"

string

2.136. OrderItemLogistics

订单明细物流信息

名称 说明 类型

logistics_code
可选

样例 : "string"

string

qty
可选

样例 : 0.0

number

sku_id
可选

样例 : "string"

string

2.137. OrderItemRtnApply

退款申请明细对象

名称 说明 类型

item_no
可选

订单行号
样例 : "1"

string

quantity
可选

数量
样例 : 1.0

number

refund_amount
可选

退款金额
样例 : 12.03

number

sku_id
必填

商品标识
样例 : "2123"

string

weight
可选

重量,单位g
样例 : 1.0

number

2.138. OrderItemTag

订单明细标签

名称 说明 类型

name
可选

标签名称
样例 : "盲盒"

string

2.139. OrderKdTrace

订单快递跟踪

名称 说明 类型

carrier
可选

承运商
样例 : IdName

IdName

code
可选

样例 : "string"

string

deliveryman
可选

配送员姓名
样例 : "123434354"

string

deliveryman_phone
可选

配送员手机号
样例 : "123434354"

string

details
可选

订单快递跟踪详情
样例 : [ "OrderKdTraceDetail" ]

< OrderKdTraceDetail > array

latitude
可选

纬度
样例 : 355.5

number

longitude
可选

经度
样例 : 111.5

number

message
可选

样例 : "string"

string

pre_delivery_time
可选

预计送达时间
样例 : "2022-04-02 00:00:00"

string (date-time)

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

trace_url
可选

跟踪连接
样例 : "http://aaa/bbb"

string

waybill_id
可选

快递单号
样例 : "213232"

string

2.140. OrderKdTraceDetail

订单快递跟踪详情

名称 说明 类型

address
可选

地点
样例 : "福建,厦门市"

string

message
可选

内容
样例 : "顺丰速运 已收取快件"

string

status
可选

状态
样例 : "在途"

string

time
可选

时间
样例 : "2022-04-07 08:39:07"

string (date-time)

2.141. OrderKdTraceList

订单快递跟踪

名称 说明 类型

traces
可选

样例 : [ "OrderKdTrace" ]

< OrderKdTrace > array

2.142. OrderList

订单集合对象

名称 说明 类型

empty
可选

默认值 : false
样例 : true

boolean

orders
可选

订单列表
样例 : [ "Order" ]

< Order > array

2.143. 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.144. OrderLogistic

订单物流

名称 说明 类型

carrier
可选

承运信息
样例 : Carrier

Carrier

created
可选

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

string (date-time)

creator
可选

样例 : "string"

string

items
可选

包裹明细
样例 : [ "OrderLogisticItem" ]

< OrderLogisticItem > array

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

order_id
可选

订单id
样例 : "string"

string

packages
可选

包裹信息
样例 : [ "WaybillPackage" ]

< WaybillPackage > array

tenant_id
可选

租户ID
样例 : "string"

string

waybill_id
可选

承运单号
样例 : "string"

string

2.145. OrderLogisticFilter

物流表过滤器

名称 说明 类型

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_start
可选

创建起始时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

2.146. OrderLogisticItem

名称 说明 类型

delivery_qty
可选

发货数量
样例 : 0.0

number

order_item_id
可选

订单行Id
样例 : "string"

string

sku_id
可选

商品id
样例 : "string"

string

uuid
可选

样例 : "string"

string

2.147. OrderLogisticUpdate

物流更新请求

名称 说明 类型

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

packages
可选

根据运单号需要更新的包裹信息，空不更新
样例 : [ "WaybillPackage" ]

< WaybillPackage > array

waybill_id
可选

运单号
样例 : "string"

string

2.148. 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

2.149. OrderPackageBag

订单打包袋

名称 说明 类型

amount
可选

打包袋金额
样例 : 0.5

number

barcode
可选

条码
样例 : "6931798836288"

string

qty
可选

数量
样例 : 1.0

number

sku_id
可选

货号
样例 : "2015456648"

string

sku_name
可选

打包袋名称
样例 : "可降解打包袋（大号）"

string

2.150. OrderPackageInfo

订单打包信息

名称 说明 类型

details
可选

包装明细
样例 : [ "PackageDetail" ]

< PackageDetail > array

package_type
可选

指定打包袋类型：保温袋、纸袋、PLA环保袋
样例 : "保温袋"

string

required
可选

是否需要打包袋
默认值 : false
样例 : false

boolean

type
可选

类型
样例 : "系统自动计算，order（订单）、refund(仅退款)、refundAndRtn(退款退货)"

string

2.151. OrderPaging

订单分页对象

名称 说明 类型

orders
可选

订单列表
样例 : [ "Order" ]

< Order > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

total
可选

总条数
样例 : 100

integer (int64)

2.152. OrderParam

订单参数

名称 说明 类型

paramKey
可选

参数key
样例 : "string"

string

paramValue
可选

参数值
样例 : "string"

string

2.153. OrderPreSlot

订单预计送达信息

名称 说明 类型

pre_date
可选

预计送达日期
样例 : "今天（周三）"

string

pre_ends
可选

预计送达时间
样例 : "[\"立即送出\",\"12:00\",\"13:00\"]"

< string > array

2.154. OrderPromotion

订单优惠

名称 说明 类型

favs
可选

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

< FavDetail > array

2.155. OrderQuota

订单指标

名称 说明 类型

action
可选

操作：expect_shipping
样例 : "expect_shipping"

string

action_name
可选

操作名称：期望拣货完成时间
样例 : "期望拣货完成时间"

string

remark
可选

备注
样例 : "无"

string

time
可选

日期
样例 : "2021-09-26 16:40:19"

string (date-time)

2.156. OrderRefund

退款申请

名称 说明 类型

order_id
必填

订单号
样例 : "32323"

string

payment_details
可选

退款付款明细
样例 : [ "DeliverPaymentDetail" ]

< DeliverPaymentDetail > array

products
可选

退款商品行
样例 : [ "RefundProduct" ]

< RefundProduct > array

refundReq_id
必填

申请单号
样例 : "32323"

string

refund_total
必填

退款金额
样例 : 12.02

number

2.157. OrderRefundList

退款申请列表（财务同意，未退款的仅退款申请列表）

名称 说明 类型

values
可选

退款申请列表
样例 : [ "OrderRefund" ]

< OrderRefund > array

2.158. 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.159. OrderReissueResponse

补发订单响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.160. 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.161. 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.162. OrderRemindPaging

催单分页对象

名称 说明 类型

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

reminds
可选

订单列表
样例 : [ "OrderRemind" ]

< OrderRemind > array

total
可选

总条数
样例 : 100

integer (int64)

2.163. OrderSelftakeCheckRequest

自提检查请求对象

名称 说明 类型

front_order_id
可选

平台订单号
样例 : "5745323545453"

string

platform_id
可选

平台ID
样例 : "meituan"

string

selftake_code
必填

自提码
样例 : "123456"

string

store_id
必填

门店ID
样例 : "232434"

string

2.164. OrderSelftakeCheckResponse

自提检查返回结果对象

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

订单号
样例 : "5745323545453"

string

success
可选

默认值 : false
样例 : true

boolean

2.165. OrderSelftakeRequest

自提请求对象

名称 说明 类型

store_id
可选

门店ID
样例 : "454534"

string

2.166. OrderSettleDiscount

对账优惠信息

名称 说明 类型

amount
可选

优惠金额
样例 : 1.0

number

details
可选

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

< DiscountSettleDetail > array

scope
可选

优惠范围
样例 : "order（订单）、item（商品）、package（包装）、freight(运费)"

string

2.167. OrderSettleInfo

对账信息

名称 说明 类型

discounts
可选

优惠结算明细
样例 : "[{}]"

< OrderSettleDiscount > array

settle_date
可选

账单日期
样例 : "2022-08-25 00:00:00"

string (date-time)

station_settle_mode
可选

门店分账模式：online（线上分账模式）、offline（线下分账模式）
样例 : "online"

string

2.168. OrderStoreMod

订单下单门店

名称 说明 类型

order_id
可选

订单号
样例 : "1212"

string

order_store
可选

下单门店
样例 : IdName

IdName

2.169. OrderStoreModError

修改订单下单门店失败明细

名称 说明 类型

id
可选

订单号
样例 : "1212"

string

message
可选

原因
样例 : "订单不存在"

string

2.170. OrderStoreModRequest

修改订单下单门店

名称 说明 类型

mods
可选

订单修改列表，一次修改记录不能超过100
样例 : [ "OrderStoreMod" ]

< OrderStoreMod > array

2.171. OrderStoreModResponse

修改订单下单门店响应

名称 说明 类型

code
可选

样例 : "string"

string

errors
可选

失败明细，如果sucess=false，errors为空表示整体失败，否则errors记录具体失败明细
样例 : [ "OrderStoreModError" ]

< OrderStoreModError > array

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.172. OrderSubmitResponse

订单新建响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

order_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.173. OrderTag

订单

名称 说明 类型

name
可选

标签名称
样例 : "首单"

string

2.174. OrderUnlock

取消占货参数

名称 说明 类型

order_id
必填

订单号
样例 : "4545454545454542"

string

reason
可选

释放原因
样例 : "订单取消"

string

2.175. OutOfLockItem

缺货明细

名称 说明 类型

sku_id
可选

样例 : "string"

string

2.176. PackageDetail

打包商品明细

名称 说明 类型

amount
可选

打包袋金额
样例 : 1.0

number

qty
可选

打包袋数量
样例 : 1.0

number

sku_id
可选

打包袋ID
样例 : "213323232"

string

sku_name
可选

打包袋名称
样例 : "213323232"

string

2.177. PackageInfo

商品打包信息

名称 说明 类型

packageName
可选

打包袋名称
样例 : "保温袋"

string

quantity
可选

包装盒数量
样例 : 125.0

number

sale_mode
可选

打包袋销售模式：normal单独收费、binding.sku捆绑商品收费
样例 : "normal"

string

thermosphere
可选

温层
样例 : "string"

string

total
可选

包装费用
样例 : 205.44

number

2.178. Packing

包装规格

名称 说明 类型

quantity
必填

包装数量，默认1
样例 : 12.0

number

spec
可选

包装规格说明，比如1*8，默认1*1
样例 : "1*1"

string

spec2
可选

包装规格
样例 : "200ml"

string

unit
可选

单位
样例 : "瓶"

string

2.179. Paging

分页对象

名称 说明 类型

has_more
可选

是否还有更多数据未被发现
默认值 : false
样例 : false

boolean

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

页数
样例 : 20

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

record_count
可选

查询结果集总记录数
样例 : 20

integer (int64)

2.180. 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.181. 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.182. PaymentDetail

支付详情

名称 说明 类型

account_name
可选

账号名称
样例 : "工行"

string

account_no
可选

账号
样例 : "002002"

string

amount
必填

金额
样例 : 12.33

number

cashier
可选

是否缴款 ,此字段用于刻画收款人收的钱是否需要上缴，如收的是现金就需要上缴，刷卡则就不需要上缴
默认值 : false
样例 : true

boolean

discount_amount
可选

支付优惠金额
样例 : 100.0

number

flowno
可选

业务流水号
样例 : "3223232323"

string

name
必填

支付方式名称
样例 : "支付宝"

string

out_pay_id
可选

第三方支付流水号
样例 : "3223232323"

string

pay_id
可选

支付id
样例 : "3223232323"

string

score
可选

积分数量
样例 : 100.0

number

2.183. 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
样例 : "string"

string

printer
可选

打印机类型：JPOS（JPOS打印机），默认JPOS
样例 : "string"

string

ticket_type
可选

票据类型：小票、杯贴
样例 : "小票"

string

title
可选

显示名称
样例 : "外卖订单"

string

type
可选

样例 : "string"

string

2.184. PrintInfo

抖音电子面单打印数据

名称 说明 类型

template_info
可选

样例 : TemplateInfo

TemplateInfo

waybill_infos
可选

订单打印信息
样例 : WaybillInfos

WaybillInfos

2.185. Purchase

名称 说明 类型

created
可选

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

string (date-time)

creator
可选

样例 : "string"

string

expect_ship_time
可选

期望发货时间
样例 : "2022-03-05 08:00:00"

string (date-time)

id
可选

单据Id，不传时，由系统自动生成
样例 : "2022030502"

string

is_virtual_mode
可选

是否虚拟采购模式
默认值 : false
样例 : false

boolean

items
必填

商品行
样例 : [ "PurchaseItem" ]

< PurchaseItem > array

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

purchase_date
可选

采购日期
样例 : "{}"

string (date-time)

purchase_unit
可选

采购单位
样例 : CodeName

CodeName

purchase_unit_type
可选

采购单位类型，取值范围:store(门店)、wrh(仓库)
样例 : "store"

string

purchaser
可选

采购方
样例 : CodeName

CodeName

receive_state
可选

收货状态：received(收货完成)
样例 : "received"

string

receive_wrh
可选

收货仓库
样例 : CodeName

CodeName

relation_order_id
可选

来源单据ID，如建议单ID
样例 : "123456"

string

relation_order_type
可选

来源单据类型
样例 : "purchasesuggest"

string

relations
必填

关联单据
样例 : [ "PurchaseRelation" ]

< PurchaseRelation > array

remark
可选

说明
样例 : "销售触发采购"

string

return_state
可选

退货状态：none(未退货)
样例 : "none"

string

ship_state
可选

发货状态：shipped(已发货)
样例 : "shipped"

string

ship_wrh
可选

发货仓库
样例 : CodeName

CodeName

source_id
可选

来源采购订单ID
样例 : "2022030501"

string

source_system
可选

默认：SAP,单据来源系统
样例 : "SAP"

string

state
可选

状态，新建可不填,默认取值为:confirmed。取值范围:confirmed(已确认)、approved(已审核)、finished(已完成)、canceled(已取消)
样例 : "string"

string

type
可选

默认：transfer，采购类型：取值为:transfer(采购调拨)、rtn(采购退货)
样例 : "string"

string

vend_unit
可选

供应单位
样例 : CodeName

CodeName

vend_unit_type
可选

供应单位类型，取值范围:vendor(供应商)、store(门店)、wrh(仓库)
样例 : "wrh"

string

vendor
可选

供应商
样例 : CodeName

CodeName

2.186. PurchaseFilter

采购订单查询条件

名称 说明 类型

bill_id_eq
可选

关联业务单号
样例 : "xxxxxxxx"

string

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)

expect_ship_time_end
可选

期望发货结束时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

expect_ship_time_start
可选

期望发货开始时间,格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

id_eq
可选

单据Id 等于
样例 : "string"

string

id_start_with
可选

单据Id like
样例 : "string"

string

parts
可选

返回多个部分用,隔开。需要返回的部分,items(商品详情)
样例 : "items"

string

purchase_unit_code_start_with
可选

采购单位编码 起始于
样例 : "string"

string

purchase_unit_type_eq
可选

采购单位类型
样例 : "string"

string

receive_state_eq
可选

收货状态：received(收货完成)
样例 : "string"

string

relation_order_id_start_with
可选

关联单号
样例 : "string"

string

ship_state_eq
可选

发货状态：shipped(已发货)
样例 : "string"

string

source_id_in
可选

来源采购订单ID
样例 : [ "string" ]

< string > array

source_id_start_with
可选

来源采购订单等于
样例 : "string"

string

source_system_eq
可选

单据来源系统
样例 : "string"

string

state_eq
可选

单据状态
样例 : "string"

string

type_eq
可选

采购类型
样例 : "string"

string

vend_unit_code_start_with
可选

供应单位编码 起始于
样例 : "string"

string

vend_unit_type_eq
可选

供应单位类型
样例 : "string"

string

2.187. PurchaseItem

采购商品行

名称 说明 类型

qty
可选

数量
样例 : 1.0

number

receive_qty
可选

实收数量
样例 : 1.0

number

ship_qty
可选

实发数量
样例 : 1.0

number

sku_id
必填

商品标识（货号）
样例 : "00321"

string

2.188. PurchaseItemLockRequest

采购占货明细

名称 说明 类型

qty
必填

计划占货数量
样例 : 0.0

number

skuId
必填

skuId
样例 : "string"

string

wrhId
必填

仓库id(默认虚拟仓)
样例 : "string"

string

2.189. PurchaseLockRelationItem

采购占货关联明细

名称 说明 类型

qty
必填

占用库存数量
样例 : 0.0

number

skuId
必填

商品id
样例 : "string"

string

suggestId
可选

采购建议ID
样例 : "string"

string

wrhId
必填

仓库id
样例 : "string"

string

2.190. PurchaseLockRequest

采购占货，特殊原因（openapi请求），字段没有加下划线

名称 说明 类型

id
可选

样例 : "string"

string

items
可选

样例 : [ "PurchaseItemLockRequest" ]

< PurchaseItemLockRequest > array

relationItems
可选

样例 : [ "PurchaseLockRelationItem" ]

< PurchaseLockRelationItem > array

tenantId
可选

租户
样例 : "冗余字段，外部不需要传"

string

2.191. PurchaseReceiveItem

收货明细行

名称 说明 类型

receive_qty
可选

入库数量
样例 : 1.0

number

sku_id
必填

商品标识（货号）
样例 : "00321"

string

2.192. PurchaseReceiveRequest

采购收货明细

名称 说明 类型

items
可选

样例 : [ "PurchaseReceiveItem" ]

< PurchaseReceiveItem > array

receive_state
可选

入库状态：received(收货完成)
样例 : "received"

string

receive_wrh
可选

入库仓库
样例 : CodeName

CodeName

2.193. PurchaseRelation

名称 说明 类型

bill_id
必填

单号
样例 : "1234567890"

string

bill_type
必填

单据类型
样例 : "order"

string

2.194. PurchaseResponse

新建响应

名称 说明 类型

code
可选

样例 : "string"

string

id
可选

单据Id
样例 : "88822222222"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.195. PurchaseSuggest

采购建议单

名称 说明 类型

created
可选

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

string (date-time)

creator
可选

样例 : "string"

string

expect_ship_time
可选

期望发货时间
样例 : "2022-03-05 08:00:00"

string (date-time)

id
可选

单据Id，新建可不传，不传由系统自动生成
样例 : "88822222222"

string

items
必填

商品行
样例 : [ "PurchaseSuggestItem" ]

< PurchaseSuggestItem > array

lock_state
可选

none
样例 : "占货状态：none（缺货）、part（部分占货）、all（全部占货）"

string

modified
可选

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

string (date-time)

modifier
可选

样例 : "string"

string

purchaser
可选

采购方
样例 : CodeName

CodeName

receive_wrh
可选

入库仓库
样例 : CodeName

CodeName

relation_items
可选

关联单据明细
样例 : [ "RelationItem" ]

< RelationItem > array

remark
可选

说明
样例 : "销售触发采购"

string

ship_state
可选

发货状态：shipped(已发货)
样例 : "shipped"

string

ship_time
可选

发货时间
样例 : "2022-03-05 08:00:00"

string (date-time)

ship_wrh
可选

发货仓库
样例 : CodeName

CodeName

state
可选

状态，新建可不填,默认取值为:confirmed。取值范围:confirmed(已确认)、approved(已审核)、finished(已完成)、canceled(已取消)
样例 : "string"

string

vendor
可选

供应商
样例 : CodeName

CodeName

2.196. PurchaseSuggestFilter

采购建议单过滤器

名称 说明 类型

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)

expect_ship_time_end
可选

期望发货时间结束时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

expect_ship_time_start
可选

期望发货时间起始时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

id
可选

采购建议单号
样例 : "32323232323323"

string

id_refix
可选

单号起始搜索
样例 : "32323232323323"

string

ids
可选

采购建议单号
样例 : "32323232323323"

< string > array

lock_state
可选

占货状态
样例 : "32323232323323"

string

order_id_in
可选

包含单据
样例 : [ "string" ]

< string > array

purchaser_code
可选

采购方
样例 : "8568"

string

receive_wrh_code
可选

入库仓
样例 : "8568"

string

ship_state
可选

发货状态
样例 : "32323232323323"

string

ship_time_end
可选

发货时间结束时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

ship_time_start
可选

发货时间起始时间，格式为：yyyy-MM-dd HH:mm:ss
样例 : "2016-03-02 12:00:01"

string (date-time)

ship_wrh_code
可选

发货仓库
样例 : "12"

string

sku_id_in
可选

包含货号
样例 : [ "string" ]

< string > array

state
可选

样例 : "string"

string

vendor_code
可选

供应商
样例 : "12"

string

2.197. PurchaseSuggestItem

建议采购商品行

名称 说明 类型

qty
必填

建议采购数量
样例 : 1.0

number

relation_qty
可选

关联数量
样例 : 0.0

number

sku_id
必填

商品标识（货号）
样例 : "00321"

string

2.198. PurchaseSuggestPaging

销售单分页对象

名称 说明 类型

list
可选

采购建议单列表
样例 : [ "PurchaseSuggest" ]

< PurchaseSuggest > array

page
可选

页码
样例 : 1

integer (int32)

page_count
可选

总页数
样例 : 5

integer (int32)

page_size
可选

分页大小
样例 : 20

integer (int32)

total
可选

总条数
样例 : 100

integer (int64)

2.199. PurchaseSuggestRelationFilter

采购建议单关联明细过滤器

名称 说明 类型

order_id_eq
可选

关联明细订单号
样例 : "32323232323323"

string

order_id_in
可选

关联明细订单号列表
样例 : [ "string" ]

< string > array

sku_id_eq
可选

关联明细货号
样例 : "32323232323323"

string

sku_id_in
可选

关联明细货号列表
样例 : [ "string" ]

< string > array

suggest_id
可选

采购建议单号
样例 : "32323232323323"

string

2.200. PurchaseSuggestResponse

新建采购建议响应

名称 说明 类型

code
可选

样例 : "string"

string

id
可选

单据Id
样例 : "88822222222"

string

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.201. QueryCondition

查询条件

名称 说明 类型

name
必填

查询条件名
样例 : "aaa"

string

param
可选

查询条件参数，日期类型使用格式：yyyy-MM-dd HH:mm:ss
样例 : "2018-05-04 14:25:25"

string

2.202. QueryDefinition

查询定义对象

名称 说明 类型

conditions
必填

条件列表
样例 : [ "QueryCondition" ]

< QueryCondition > array

orders
必填

排序列表
样例 : [ "QueryOrder" ]

< QueryOrder > array

page
必填

当前页码，必须大于等于0
样例 : 0

integer (int32)

page_size
必填

分页大小，范围是[0,100]
样例 : 10

integer (int32)

2.203. QueryOrder

排序条件对象

名称 说明 类型

direction
可选

排序条件，取值范围:asc(升序)、desc(降序)
样例 : "asc"

enum (asc, desc)

field
可选

排序字段
样例 : "created"

string

2.204. ReasonList

原因列表

名称 说明 类型

empty
可选

默认值 : false
样例 : true

boolean

values
可选

原因列表
样例 : [ "string" ]

< string > array

2.205. Receiver

收货人

名称 说明 类型

address
必填

地址
样例 : Address

Address

contact
必填

联系方式
样例 : Contact

Contact

oaid
可选

地址
样例 : "string"

string

2.206. Refund

退款信息

名称 说明 类型

amount
必填

实际退货金额（包含运费）
样例 : 12.03

number

classification
可选

退款类别，取值范围:normal(正常)、balance(补差)，为空表示正常
样例 : "normal"

enum (normal, balance)

extra
可选

退款其他费用
样例 : [ "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_fieight
可选

结算运费
样例 : 12.03

number

shop_amount
可选

商家货款金额
样例 : 120.01

number

state
必填

退款状态，取值范围:none(未退款)、refunded(已退款)
样例 : "none"

enum (none, refunded)

2.207. RefundPayment

退款支付明细

名称 说明 类型

account_name
可选

账号名称
样例 : "工行"

string

account_no
可选

账号
样例 : "002002"

string

amount
必填

退款金额
样例 : 12.33

number

name
必填

支付方式名称
样例 : "支付宝"

string

out_pay_id
可选

第三方支付流水号
样例 : "3223232323"

string

pay_id
可选

支付id
样例 : "3223232323"

string

score
可选

积分数量
样例 : 100.0

number

2.208. RefundPaymentDetail

退款支付方式详情

名称 说明 类型

payments
可选

退款详情列表
样例 : [ "DeliverPaymentDetail" ]

< DeliverPaymentDetail > array

2.209. RefundProduct

退款商品

名称 说明 类型

qty
必填

数量
样例 : 12.0

number

skuId
必填

货号
样例 : "00212"

string

total
必填

金额
样例 : 12.25

number

2.210. ReissueOrderItem

补发商品明细

名称 说明 类型

item_no
必填

行号
样例 : "1"

string

quantity
必填

数量
样例 : 13.0

number

sku_id
必填

货号
样例 : "132323"

string

2.211. RelationItem

关联单据明细

名称 说明 类型

order_id
必填

单号
样例 : "string"

string

order_type
必填

单据类型
样例 : "order(订单),saleorder(销售订单)"

string

qty
必填

关联数量
样例 : 0.0

number

sku_id
必填

商品货号
样例 : "string"

string

suggest_id
必填

采购建议单号
样例 : "string"

string

2.212. ReplyRemindRequest

名称 说明 类型

reply_content
可选

回复内容
样例 : "string"

string

reply_operator
可选

回复操作人
样例 : "string"

string

reply_time
可选

回复时间
样例 : "2020-06-17 10:00:00"

string (date-time)

2.213. ReturnDelivery

退货信息

名称 说明 类型

carrier
可选

承运商
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "note"

string

is_buyer_received
可选

顾客是否收到货
默认值 : false
样例 : false

boolean

return_mobile
可选

退货联系人
样例 : "18856556655"

string

returner
可选

退货人
样例 : Receiver

Receiver

state
可选

退货状态，取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货)
样例 : "none"

enum (none, customerShipped, received)

station
可选

退货站点
样例 : IdName

IdName

station_type
可选

站点类型，取值范围:store(门店)、wrh(仓库)
样例 : "string"

string

waybill_id
可选

承运单号
样例 : "XXXXXXXXX"

string

wrh_rtn_id
可选

仓库退货单号
样例 : "XXXXXXXXX"

string

2.214. ReturnRequest

退货请求对象

名称 说明 类型

carrier
可选

承运商
样例 : Carrier

Carrier

carrier_note
可选

承运商备注
样例 : "note"

string

operator_role
可选

样例 : "string"

string

return_state
必填

退货状态，取值范围:none(未退货)、customerShipped(客户已发货)、received(已收货)
样例 : "none"

enum (none, customerShipped, received)

station
可选

退回站点
样例 : IdName

IdName

stationType
可选

退回站点类型
样例 : "string"

string

2.215. Rtn

退换货单

名称 说明 类型

address_change_fee
可选

地址变更费
样例 : 120.01

number

appeal
可选

是否申诉
默认值 : false
样例 : false

boolean

apply_reason
可选

申请原因
样例 : "不想要了"

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

is_can_return_goods
可选

默认值 : false
样例 : true

boolean

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

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)

type_change_reason
可选

类型变更原因
样例 : "漏发"

string

voucher_urls
可选

凭证Url(图片)
样例 : [ "string" ]

< string > array

wrh_id
可选

收货仓库编号
样例 : "string"

string

wrh_name
可选

收货仓库名称
样例 : "string"

string

wrh_state
可选

仓库状态,取值参考RtnWrhState
样例 : "initial"

string

2.216. RtnApproveRequest

退单审核请求对象

名称 说明 类型

approve_state
必填

审核状态:none（未审核）,serviceApproved（客服已审核）,serviceRefuse（客服已拒绝）,financeApproved（财务已审核）,financeRefuse（财务已拒绝）
样例 : "serviceApproved"

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

is_returns_goods
可选

退货配置
样例 : "false"

string

operator_role
可选

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

string

reason
可选

原因
样例 : "已发货，不能退"

string

2.217. RtnChangeTypeRequest

修改退单类型请求对象

名称 说明 类型

change_reason
可选

变更原因
样例 : "漏发"

string

change_type
必填

退单变更类型
样例 : "refundAndRtn"

enum (refund, refundAndRtn)

2.218. 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

front_third_rtn_id_eq
可选

第三方退单号等于
样例 : "123213123"

string

front_third_rtn_id_in
可选

第三方退单号范围
样例 : [ "string" ]

< string > array

has_billing
可选

是否有凭证信息
默认值 : false
样例 : false

boolean

has_billing_exception
可选

是否有凭证异常
默认值 : 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)

member_grade_eq
可选

会员等级等于
样例 : "12253"

string

order_id
可选

订单号
样例 : "123456"

string

order_id_in
可选

订单号
样例 : "123456"

< string > array

order_id_match
可选

订单号精确
样例 : "123456"

string

platform_group_eq
可选

平台分组等于（O2O、EC）
样例 : "O2O"

string

platform_id
可选

平台ID
样例 : "jdo2o"

string

pre_page
可选

上一次页数
样例 : 1

integer (int32)

product_contains
可选

商品包括
样例 : "sku2323"

string

refund_phases
可选

退款申请阶段，取值范围:onsale(售中)发货之前、aftersale(售后)发货之后
样例 : [ "onsale" ]

< enum (onsale, aftersale) > array

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_id_match
可选

退单号精确
样例 : "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

types
可选

退货类型
样例 : [ "refund" ]

< enum (refund, refundAndRtn) > array

waybill_id
可选

退回物流单号
样例 : "32323434"

string

2.219. 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

refund_amount
必填

实际退款金额 （订单优惠后的金额）
样例 : 12.03

number

relation_item_id
可选

关联商品行号
样例 : "2123"

string

relation_sku_id
可选

关联的货号
样例 : "2123"

string

salesman_id
可选

售卖员Id
样例 : "123"

string

salesman_name
可选

售卖员名字
样例 : "榕榕"

string

salesman_type
可选

售卖员类型
样例 : "author"

string

settle_price
可选

结算价格
样例 : 12.03

number

settle_total
可选

结算金额
样例 : 12.03

number

settle_unit
可选

结算单位
样例 : SettleUnit

SettleUnit

shop_price
可选

货款价格
样例 : 11.22

number

shop_total
可选

货款金额
样例 : 11.22

number

sku_id
必填

商品标识
样例 : "123456"

string

spec
可选

商品规格
样例 : "1*1"

string

tags
可选

标签
样例 : "标签"

< 退单明细标签 > array

total
必填

退款金额（参考金额）
样例 : 12.03

number

unit
可选

单位：个、份等
样例 : "瓶"

string

unit_price
必填

价格
样例 : 12.03

number

uuid
可选

样例 : "string"

string

2.220. RtnItemDetail

退款商品行明细

名称 说明 类型

id
必填

商品货号
样例 : "01123"

string

quantity
必填

商品数量
样例 : 0.01

number

ratio
必填

原料比例，数值3表示，一个组合商品，包含3个原料商品
样例 : 2.0

number

title
必填

名称
样例 : "01123"

string

2.221. RtnList

退换货单集合

名称 说明 类型

rtns
可选

退换货单列表
样例 : [ "Rtn" ]

< Rtn > array

2.222. RtnMemberInfo

积分信息

名称 说明 类型

card_no
可选

实体卡卡号
样例 : "22323"

string

member_grade
可选

会员等级
样例 : "12253"

string

2.223. RtnModificationRequest

修改退货单请求对象

名称 说明 类型

address_change_fee
可选

地址变更费
样例 : 10.01

number

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

rtnId
可选

退换货单ID
样例 : "4356465768"

string

settle_amount
可选

结算金额
样例 : 12.03

number

voucher_urls
可选

凭证Url(图片)
样例 : [ "string" ]

< string > array

2.224. RtnNotifyWrhRequest

通知仓库请求对象

类型 : object

2.225. 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.226. RtnPaging

退单分页对象

名称 说明 类型

page
可选

页码
样例 : 0

integer (int32)

page_count
可选

总页数
样例 : 0

integer (int32)

page_size
可选

页大小
样例 : 0

integer (int32)

rtns
可选

退单列表
样例 : [ "Rtn" ]

< Rtn > array

total
可选

总条数
样例 : 0

integer (int64)

2.227. 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.228. RtnPrintDataList

退单打印数据列表对象

名称 说明 类型

rtns
可选

退单打印数据列表
样例 : [ "RtnPrintData" ]

< RtnPrintData > array

2.229. RtnPromotion

退单优惠

名称 说明 类型

favs
可选

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

< FavDetail > array

2.230. RtnSettleInfo

对账信息

名称 说明 类型

settle_date
可选

账单日期
样例 : "2022-08-25 00:00:00"

string (date-time)

station_settle_mode
可选

门店分账模式：online（线上分账模式）、offline（线下分账模式）
样例 : "online"

string

2.231. RtnSubmitResponse

退单新建响应

名称 说明 类型

code
可选

样例 : "string"

string

message
可选

样例 : "string"

string

rtn_id
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.232. RtnUpdateDeliveryRequest

修改物流物流退回信息请求对象

名称 说明 类型

carrier
可选

承运商
样例 : IdName

IdName

mobile
可选

手机号
样例 : "18859540085"

string

state
可选

退货状态：none（未退货）、customerShipped（客户已发货）、received（已收货）
样例 : "received"

enum (none, customerShipped, received)

waybill_id
可选

承运单号
样例 : "43444444444232323"

string

2.233. SaleChannelList

取得可用的销售渠道

名称 说明 类型

channels
可选

销售渠道列表
样例 : [ "IdName" ]

< IdName > array

2.234. SalesmanInfo

名称 说明 类型

id
可选

样例 : "string"

string

name
可选

样例 : "string"

string

org
可选

销售员所属组织
样例 : IdName

IdName

org_type
可选

所属组织类型：门店,总部
样例 : "门店"

string

type
可选

type：类型
样例 : "saleman"

string

2.235. ScoreInfo

积分信息

名称 说明 类型

total
可选

获得积分
样例 : 1.0

number

2.236. SelftakeConfirmDetail

自提确认详情

名称 说明 类型

payments
必填

付款方式详情
样例 : [ "DeliverPaymentDetail" ]

< DeliverPaymentDetail > array

2.237. 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.238. SelftakeRuleDef

自提规则定义

名称 说明 类型

check_selftake_code
可选

是否校验自提码
默认值 : false
样例 : true

boolean

2.239. SellerInfo

收货失败：原因/凭证

名称 说明 类型

seller_note
可选

收货失败原因
样例 : "收货失败原因"

string

seller_voucher_urls
可选

卖家收货失败凭证：图片地址
样例 : "卖家收货失败凭证：图片地址"

< string > array

2.240. SettleUnit

结算单位

名称 说明 类型

code
可选

单位代码，取值门店代码
样例 : "0001"

string

name
可选

单位门店，取值门店名称
样例 : "门店1"

string

type
可选

类型：store
样例 : "store"

string

2.241. ShipRequest

订单发货请求对象

名称 说明 类型

operator
可选

操作人
样例 : "laowang"

string

waybills
可选

订单发货信息
样例 : [ "CarrierWaybill" ]

< CarrierWaybill > array

wrh
可选

发货仓库
样例 : IdName

IdName

2.242. Size

尺寸对象

名称 说明 类型

height
可选

高
样例 : 12.0

number

length
可选

长
样例 : 12.0

number

unit
可选

单位
样例 : "mm"

string

width
可选

宽
样例 : 15.0

number

2.243. Sku

商品对象

名称 说明 类型

barcode
可选

条码
样例 : "1152"

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

is_inv_unit
可选

是否为最小库存管理单位
默认值 : false
样例 : true

boolean

kind_types
可选

商品种类
样例 : [ "string" ]

< string > array

member_price
可选

标准会员价
样例 : 53.22

number

modified
可选

最后修改时间
样例 : "2018-11-11 21:12:55"

string (date-time)

modifier
可选

最后修改人
样例 : "123"

string

name
必填

名称
样例 : "矿泉水"

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

state
可选

状态
样例 : "string"

string

sub_image_urls
可选

子图url
样例 : [ "string" ]

< string > array

suggest_price
可选

建议售价
样例 : 53.22

number

tax_rate
可选

税率,如果是13%，传0.13
样例 : 0.13

number

tax_sort_code
可选

税率分类码
样例 : "string"

string

title
可选

在前台展示的名称
样例 : "矿泉水"

string

upc
可选

国标码
样例 : "69…​"

string

weight
可选

重量
样例 : Measure

Measure

2.244. SkuCombinedItem

名称 说明 类型

id
可选

样例 : "string"

string

price
可选

样例 : 0.0

number

product_type
可选

样例 : "normal"

enum (normal, fresh, combined)

quantity
可选

样例 : 0.0

number

title
可选

样例 : "string"

string

2.245. 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.246. 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_like
可选

货号类似于
样例 : "233"

string

sku_ids
可选

商品ID
样例 : [ "string" ]

< string > array

title_like
可选

展示名称类似于
样例 : "aaa"

string

2.247. SkuImage

商品图片对象

名称 说明 类型

detail_images
可选

详情图片
样例 : [ "ImageDetail" ]

< ImageDetail > array

image
可选

主图
样例 : ImageDetail

ImageDetail

sku_id
可选

样例 : "string"

string

sub_images
可选

子图
样例 : [ "ImageDetail" ]

< ImageDetail > array

2.248. SkuImageList

商品图片列表对象

名称 说明 类型

sku_images
可选

上传的商品图片列表
样例 : [ "SkuImage" ]

< SkuImage > array

upload_type
可选

上传方式 url 或 base64 ,默认url
样例 : "string"

string

2.249. SkuList

商品列表对象

名称 说明 类型

skus
可选

商品列表
样例 : [ "Sku" ]

< Sku > array

2.250. 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.251. 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.252. SkuQuantityList

当前可用库存集合

名称 说明 类型

skus
可选

当前可用库存集合
样例 : [ "SkuQuantity" ]

< SkuQuantity > array

2.253. SomsPageResponsePurchase

名称 说明 类型

data
可选

样例 : [ "Purchase" ]

< Purchase > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

默认值 : false
样例 : true

boolean

total
可选

样例 : 0

integer (int32)

2.254. SomsPageResponseRelationItem

名称 说明 类型

data
可选

样例 : [ "RelationItem" ]

< RelationItem > array

echoCode
可选

样例 : 0

integer (int32)

echoMessage
可选

样例 : "string"

string

page
可选

样例 : 0

integer (int32)

pageCount
可选

样例 : 0

integer (int32)

pageSize
可选

样例 : 0

integer (int32)

success
可选

默认值 : false
样例 : true

boolean

total
可选

样例 : 0

integer (int32)

2.255. SomsRequestListOrderLogisticUpdate

名称 说明 类型

data
可选

请求数据
样例 : [ "OrderLogisticUpdate" ]

< OrderLogisticUpdate > array

2.256. SomsRequestListRelationItem

名称 说明 类型

data
可选

请求数据
样例 : [ "RelationItem" ]

< RelationItem > array

2.257. SomsRequestListString

名称 说明 类型

data
可选

请求数据
样例 : [ "string" ]

< string > array

2.258. SomsResponseVoid

名称 说明 类型

code
可选

样例 : "string"

string

data
可选

样例 : [_void]

Void

message
可选

样例 : "string"

string

success
可选

默认值 : false
样例 : true

boolean

2.259. StoreOperationRequest

门店作业请求

名称 说明 类型

operation
必填

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

string

operation_state
必填

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

string

store_id
必填

门店ID
样例 : "21213323"

string

2.260. StoreOperationRtnRule

名称 说明 类型

allow_float
可选

默认值 : false
样例 : true

boolean

allow_part_refund
可选

默认值 : false
样例 : true

boolean

manual_receive
可选

默认值 : false
样例 : true

boolean

2.261. 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.262. StoreOperationRuleDef

名称 说明 类型

rtn_rule
可选

样例 : StoreOperationRtnRule

StoreOperationRtnRule

2.263. StoreOperationRuleFilter

名称 说明 类型

platformIdEq
可选

样例 : "string"

string

shopIdEq
可选

样例 : "string"

string

stateEq
可选

样例 : "string"

string

storeIdEq
可选

样例 : "string"

string

storeIdIn
可选

样例 : [ "string" ]

< string > array

typeEq
可选

样例 : "string"

string

2.264. StoreOperationRuleSave

名称 说明 类型

def
可选

def
样例 : StoreOperationRuleDef

StoreOperationRuleDef

platform_id
可选

平台ID
样例 : "33454"

string

shop_id
可选

商家代码
样例 : "storeRtnRule"

string

store_id
可选

门店代码
样例 : "0001"

string

type
可选

类型
样例 : "33454"

string

2.265. SuggestApproveRequest

采购建议单

类型 : object

2.266. SuspendInfo

挂起信息

名称 说明 类型

caption
必填

挂起原因标题，显示用
样例 : "string"

string

code
必填

挂起原因代码，每一种挂起原因用代码表示
样例 : "string"

string

suspended
可选

是否挂起
默认值 : false
样例 : true

boolean

time
可选

挂起时间
样例 : "2017-12-26 16:40:19"

string (date-time)

2.267. TemplateInfo

打印模板信息

名称 说明 类型

preview_url
可选

preview_url
样例 : "string"

string

template_code
可选

模板代码
样例 : "string"

string

template_id
可选

模板ID
样例 : "string"

string

template_name
可选

模板名称
样例 : "string"

string

template_type
可选

模板类型
样例 : "string"

string

template_url
可选

模板url
样例 : "string"

string

version
可选

模板版本
样例 : "string"

string

2.268. UpdateReplyContentRequest

名称 说明 类型

reply_content
可选

回复内容
样例 : "string"

string

2.269. Waybill

运单

名称 说明 类型

packages
可选

样例 : [ "WaybillPackage" ]

< WaybillPackage > array

waybill_id
可选

运单号
样例 : "123"

string

2.270. WaybillInfos

订单打印信息

名称 说明 类型

order_id
可选

订单号
样例 : "string"

string

print_data
可选

面单数据信息-加密密文
样例 : "string"

string

sign
可选

print_data的签名
样例 : "string"

string

track_no
可选

运单号
样例 : "string"

string

2.271. WaybillPackage

运单包裹

名称 说明 类型

id
可选

包裹ID
样例 : "string"

string

type
可选

类型：platform-平台
样例 : "string"

string

2.272. WaybillPrintData

运单打印详情

名称 说明 类型

data
可选

数据
样例 : "string"

string

type
可选

request|response
样例 : "string"

string

2.273. WaybillPrintInfo

运单打印数据

名称 说明 类型

datas
可选

打印数据
样例 : [ "WaybillPrintData" ]

< WaybillPrintData > array

2.274. soms分页查询结果Count

名称 说明 类型

data
可选

数据
样例 : [ "Count" ]

< Count > array

page
可选

页码
样例 : 0

integer (int32)

pageCount
可选

页数
样例 : 2

integer (int32)

pageSize
可选

页面大小
样例 : 100

integer (int32)

total
可选

总数
样例 : "1000L"

integer (int64)

2.275. soms分页查询结果OrderLogistic

名称 说明 类型

data
可选

数据
样例 : [ "OrderLogistic" ]

< OrderLogistic > array

page
可选

页码
样例 : 0

integer (int32)

pageCount
可选

页数
样例 : 2

integer (int32)

pageSize
可选

页面大小
样例 : 100

integer (int32)

total
可选

总数
样例 : "1000L"

integer (int64)

2.276. 修改对象字段：String

如果整个对象为空，则表示本次不修改该字段；如果对象不为空，则表示把字段改为value的值

名称 说明 类型

value
可选

要修改成什么值
样例 : "string"

string

2.277. 占货明细

名称 说明 类型

qty
可选

占货数量
样例 : 0.0

number

result
可选

占货结果
样例 : "lockPart(部分占货)、lockAll(全部成功)、none(未占货)"

string

sku_id
可选

货号
样例 : "string"

string

type
可选

占货类型
样例 : "wrh(仓库库存)、store(门店库存)"

string

2.278. 巨益库存释放请求

名称 说明 类型

order_id
必填

订单号
样例 : "string"

string

2.279. 收货信息修改参数

名称 说明 类型

check_action
可选

检查更新动作：none:不检查，platform:检查更新平台，carrier：检查更新承运，默认检查更新平台，多个英文逗号分隔，只要包含none都不检查
样例 : "platform"

string

city
可选

市
样例 : 修改对象字段：String

修改对象字段：String

district
可选

区/县
样例 : 修改对象字段：String

修改对象字段：String

encrypt_detail
可选

订单加密信息，抖音使用
样例 : EncryptDetail

EncryptDetail

mobile
可选

收货人手机号
样例 : 修改对象字段：String

修改对象字段：String

name
可选

收货人姓名
样例 : 修改对象字段：String

修改对象字段：String

postCode
可选

邮编
样例 : 修改对象字段：String

修改对象字段：String

province
可选

省
样例 : 修改对象字段：String

修改对象字段：String

receiver
可选

收货人
样例 : Receiver

Receiver

street
可选

街道/详细地址
样例 : 修改对象字段：String

修改对象字段：String

2.280. 有订单号和信息的对象

名称 说明 类型

lock_items
可选

占货明细
样例 : [ "占货明细" ]

< 占货明细 > array

lock_result
可选

占货结果
样例 : "lockPart(部分占货)、lockAll(全部成功)、none(未占货)"

string

message
可选

样例 : "string"

string

order_id
可选

样例 : "string"

string

stock_state
可选

占货状态
样例 : "initial(未占货),locked(已占货),shipped(已发货),aborted(已作废)"

string

success
可选

默认值 : false
样例 : true

boolean

2.281. 盲盒

名称 说明 类型

sku_id
必填

盲盒的skuId，每个订单上这个值是唯一的
样例 : "202214816_7"

string

2.282. 统计服务过滤器

名称 说明 类型

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.283. 订单占货情况检查响应

名称 说明 类型

data
可选

占货结果
样例 : [ "有订单号和信息的对象" ]

< 有订单号和信息的对象 > array

message
可选

请求失败时，该字段为失败原因
样例 : "string"

string

success
可选

表示本次请求是否成功
默认值 : false
样例 : true

boolean

2.284. 订单占货情况检查请求

名称 说明 类型

order_ids
可选

要检查的订单，不超过50个
样例 : [ "string" ]

< string > array

2.285. 订单标签

名称 说明 类型

name
可选

名称
样例 : "首单"

string

2.286. 订单盲盒列表

名称 说明 类型

data
可选

对象列表
样例 : [ "盲盒" ]

< 盲盒 > array

2.287. 退单明细标签

名称 说明 类型

name
可选

名称
样例 : "盲盒"

string

Unresolved directive in index.adoc - include::/hdapp/jenkins/agent/ssd1/workspace/SOMS/soms-dly-doc-develop/target/asciidoc/merchant/definitions.adoc[]