交易数据

Alex大约 22 分钟开发文档API接口文档

交易数据

v1.0.0

Base URLs:

Authentication

购物车表

POST 购物车表-添加

POST /front/trade/cart/add

购物车表-添加

请求参数

名称	位置	类型	必选	说明
activityId	query	integer	否	活动Id-加价购等等加入购物的需要提示
cartQuantity	query	integer	否	购买商品数量
cartType	query	integer	否	购买类型(ENUM):1-购买; 2-积分兑换; 3-赠品; 4-活动促销
itemId	query	integer	否	商品编号

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 批量添加购物车

POST /front/trade/cart/addBatch

批量添加购物车

请求参数

名称	位置	类型	必选	说明
activityId	query	integer	否	活动Id-加价购等等加入购物的需要提示
cartQuantity	query	integer	否	购买商品数量
cartType	query	integer	否	购买类型(ENUM):1-购买; 2-积分兑换; 3-赠品; 4-活动促销
itemId	query	integer	否	商品编号

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 结算确认订单- - 收货地址支付方式配送方式配送时间发票，可选优惠券，礼品卡等等从虚拟商品不经过购物车

GET /front/trade/cart/checkout

结算

请求参数

名称	位置	类型	必选	说明
activityId	query	integer	否	活动编号
cartId	query	string	否	下单商品数据:商品编号
chainId	query	integer	否	门店编号
channelType	query	integer	否	来源渠道 0:正常下单;1:直播渠道
deliveryTypeId	query	integer	否	配送方式
udId	query	integer	否	收货地址编号
userVoucherIds	query	string	否	优惠券

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 购物车表-编辑

POST /front/trade/cart/edit

购物车表-编辑

请求参数

名称	位置	类型	必选	说明
cartId	query	integer	否	编号
cartQuantity	query	integer	否	购买商品数量

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 修改购物车数量

POST /front/trade/cart/editQuantity

修改购物车数量

请求参数

名称	位置	类型	必选	说明
cartId	query	integer	否	编号
cartQuantity	query	integer	否	购买商品数量

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 购物车表-分页列表查询

GET /front/trade/cart/list

购物车表-分页列表查询

请求参数

名称	位置	类型	必选	说明
cartSelect	query	string	否	选中状态(BOOL):0-未选;1-已选
createTimeEnd	query	string	否	创建时间结束值
createTimeStart	query	string	否	创建时间起始值
like[0].column	query	string	否	搜索字段
like[0].like	query	string	否	搜索字符
order[0].sidx	query	string	否	排序字段
order[0].sort	query	string	否	排序方式
page	query	integer	否	分页查询页码
sidx	query	string	否	排序字段
size	query	integer	否	分页查询每页数量
sort	query	string	否	排序方式
udId	query	integer	否	地址编号或者地址数据Map
userId	query	integer	否	买家编号

返回示例

200 Response

{
  "code": 0,
  "data": {
    "in": {
      "activity_id": 0,
      "cal_freight": false,
      "chain_id": 0,
      "delivery_type_id": 0,
      "items": [
        {
          "activity_id": 0,
          "cart_id": 0,
          "cart_quantity": 0,
          "cart_select": false,
          "cart_type": 0,
          "chain_id": 0,
          "item_id": 0,
          "store_id": 0
        }
      ],
      "message": {
        "property1": "string",
        "property2": "string"
      },
      "order_type": 0,
      "payment_type_id": 0,
      "src_order_id": "string",
      "ud_id": 0,
      "user_id": 0,
      "user_invoice_id": 0,
      "user_nickname": "string",
      "user_voucher_ids": [
        0
      ]
    },
    "is_paid": false,
    "items": [
      {
        "store_address": "string",
        "store_area": "string",
        "store_banner": "string",
        "store_category_id": 0,
        "store_circle": "string",
        "store_close_hours": "string",
        "store_close_reason": "string",
        "store_deliver_district_id": "string",
        "store_district_id": "string",
        "store_end_time": "2019-08-24T14:15:22Z",
        "store_free_shipping": 0,
        "store_grade_id": 0,
        "store_id": 0,
        "store_is_open": false,
        "store_is_selfsupport": false,
        "store_latitude": 0,
        "store_logo": "string",
        "store_longitude": 0,
        "store_name": "string",
        "store_notice": "string",
        "store_o2o_flag": false,
        "store_o2o_tags": "string",
        "store_opening_hours": "string",
        "store_payment_state": 0,
        "store_slogan": "string",
        "store_start_time": "2019-08-24T14:15:22Z",
        "store_state_id": 0,
        "store_tel": "string",
        "store_template": "string",
        "store_type": 0,
        "subsite_id": 0
      }
    ],
    "order_discount_amount": 0,
    "order_freight_amount": 0,
    "order_item_amount": 0,
    "order_money_amount": 0,
    "order_points_amount": 0,
    "order_product_amount": 0,
    "order_sp_amount": 0,
    "user_delivery_address": {
      "ud_address": "string",
      "ud_city": "string",
      "ud_city_id": 0,
      "ud_county": "string",
      "ud_county_id": 0,
      "ud_id": 0,
      "ud_intl": "string",
      "ud_is_default": false,
      "ud_latitude": 0,
      "ud_longitude": 0,
      "ud_mobile": "string",
      "ud_name": "string",
      "ud_postalcode": "string",
      "ud_province": "string",
      "ud_province_id": 0,
      "ud_tag_name": "string",
      "ud_telephone": "string",
      "ud_time": "2019-08-24T14:15:22Z",
      "user_id": 0
    },
    "user_id": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 购物车表-通过cart_id删除

POST /front/trade/cart/remove

购物车表-通过cart_id删除

请求参数

名称	位置	类型	必选	说明
cart_id	query	integer	是	cart_id

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 购物车表-批量删除

POST /front/trade/cart/removeBatch

购物车表-批量删除

请求参数

名称	位置	类型	必选	说明
cart_id	query	string	是	cart_id

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 购物车-选中商品

GET /front/trade/cart/sel

购物车-选中商品

请求参数

名称	位置	类型	必选	说明
action	query	string	否	All:全部; store:店铺编号
cartId	query	integer	否	编号
cartSelect	query	string	否	是否选中

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

分销用户信息

GET 用户分销订单列表数据

GET /front/trade/distributionOrder/listsOrder

用户分销订单列表数据

请求参数

名称	位置	类型	必选	说明
buyerUserId	query	integer	否	买家编号
createTimeEnd	query	string	否	创建时间结束值
createTimeStart	query	string	否	创建时间起始值
like[0].column	query	string	否	搜索字段
like[0].like	query	string	否	搜索字符
orderId	query	string	否	订单编号
order[0].sidx	query	string	否	排序字段
order[0].sort	query	string	否	排序方式
page	query	integer	否	分页查询页码
sidx	query	string	否	排序字段
size	query	integer	否	分页查询每页数量
sort	query	string	否	排序方式
storeId	query	integer	否	店铺编号
timeFlag	query	integer	否	时段标记
uoActive	query	string	否	是否有效(BOOL):0-未生效;1-有效
uoBuyCommission	query	number	否	推广员佣金
uoDirectsellerCommission	query	number	否	销售员佣金
uoId	query	integer	否	订单收益编号
uoIsPaid	query	string	否	是否有效(BOOL):0-未支付;1-已支付
uoLevel	query	integer	否	等级
uoPaytime	query	integer	否	支付时间
uoReceivetime	query	integer	否	收货时间
uoRemark	query	string	否	备注
uoTime	query	integer	否	时间
uoTimeEnd	query	integer	否	时间-结束
uoTimeStart	query	integer	否	时间-开始
userId	query	integer	否	用户编号:上级ID,获取佣金推广员

返回示例

200 Response

{
  "code": 0,
  "data": {
    "items": {
      "current": 0,
      "pages": 0,
      "records": [
        {
          "buyer_user_avatar": "string",
          "buyer_user_id": 0,
          "buyer_user_level_name": "string",
          "buyer_user_name": "string",
          "order_id": "string",
          "store_id": 0,
          "uo_active": false,
          "uo_buy_commission": 0,
          "uo_directseller_commission": 0,
          "uo_id": 0,
          "uo_is_paid": false,
          "uo_level": 0,
          "uo_paytime": 0,
          "uo_receivetime": 0,
          "uo_remark": "string",
          "uo_time": 0,
          "user_id": 0
        }
      ],
      "size": 0,
      "total": 0
    },
    "uo_buy_commission_total": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

订单发货物流信息表

GET 快递追踪

GET /front/trade/orderLogistics/trace

快递追踪

请求参数

名称	位置	类型	必选	说明
expressId	query	integer	否	快递编号
logisticsId	query	integer	否	对应快递公司
orderId	query	string	否	订单编号
orderLogisticsId	query	integer	否	订单物流编号
orderTrackingNumber	query	string	否	订单物流单号AIRWAY BILL number

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

订单表

POST 订单详细信息

POST /front/trade/order/add

订单详细信息

请求参数

名称	位置	类型	必选	说明
activityId	query	integer	否	活动编号
cartId	query	string	否	下单商品数据:商品编号
chainId	query	integer	否	门店编号
channelType	query	integer	否	来源渠道 0:正常下单;1:直播渠道
deliveryTypeId	query	integer	否	配送方式
orderMessage	query	string	否	消息
paymentTypeId	query	integer	否	付款方式
udId	query	integer	否	收货地址编号
userInvoiceId	query	integer	否	发票
userVoucherIds	query	string	否	优惠券

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 订单评价

POST /front/trade/order/addOrderComment

订单评价

请求参数

名称	位置	类型	必选	说明
commentContent	query	string	否	评论内容
commentIsAnonymous	query	string	否	匿名评价
item	query	string	否	评论详细 -> 对应OrderCommentItemReq
orderId	query	string	否	订单编号
storeDeliverycredit	query	number	否	物流评价
storeDesccredit	query	number	否	描述相符
storeServicecredit	query	number	否	服务评价

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	CommonRes
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 取消订单

POST /front/trade/order/cancel

取消订单

请求参数

名称	位置	类型	必选	说明
orderCancelReason	query	string	否	取消原因
orderId	query	string	是	订单编号

返回示例

200 Response

{
  "code": 0,
  "data": {
    "orderId": [
      "string"
    ]
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 订单详细信息

GET /front/trade/order/detail

订单详细信息

请求参数

名称	位置	类型	必选	说明
order_id	query	string	是	order_id

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 用户中心订单数量

GET /front/trade/order/getOrderNum

用户中心订单数量

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 订单列表信息

GET /front/trade/order/list

订单列表信息

请求参数

名称	位置	类型	必选	说明
createTimeEnd	query	string	否	创建时间结束值
createTimeStart	query	string	否	创建时间起始值
kindId	query	integer	否	订单种类(ENUM): 1201-实物 ; 1202-教育类 ; 1203-电子卡券 ; 1204-其它
like[0].column	query	string	否	搜索字段
like[0].like	query	string	否	搜索字符
orderEtime	query	integer	否	下单时间
orderId	query	string	否	订单编号
orderStateId	query	integer	否	订单状态(LIST):2011-待订单审核;2013-待财务审核;2020-待配货/待出库审核;2030-待发货;2040-已发货/待收货确认;2060-已完成/已签收;2070-已取消/已作废;
orderStime	query	integer	否	下单时间
orderTitle	query	string	否	订单标题
order[0].sidx	query	string	否	排序字段
order[0].sort	query	string	否	排序方式
page	query	integer	否	分页查询页码
sidx	query	string	否	排序字段
size	query	integer	否	分页查询每页数量
sort	query	string	否	排序方式
storeId	query	integer	否	卖家店铺编号
subsiteId	query	integer	否	所属分站:0-总站
userId	query	integer	否	买家编号
userNickname	query	string	否	买家昵称

返回示例

200 Response

{
  "code": 0,
  "data": {
    "items": [
      {
        "activity_double_points_id": 0,
        "activity_id": "string",
        "activity_manhui_id": "string",
        "activity_type_id": "string",
        "activity_voucher_id": "string",
        "buyer_contacter": "string",
        "buyer_mobile": 0,
        "card_kind_id": 0,
        "cart_type_id": false,
        "chain_code": "string",
        "chain_id": 0,
        "consume_record": [
          {
            "chain_id": 0,
            "consume_record_id": 0,
            "currency_id": 0,
            "currency_symbol_left": "string",
            "order_id": "string",
            "payment_channel_id": 0,
            "payment_met_id": 0,
            "payment_type_id": 0,
            "record_commission_fee": 0,
            "record_date": "2019-08-24T14:15:22Z",
            "record_day": 0,
            "record_desc": "string",
            "record_distribution_commission_fee": 0,
            "record_enable": false,
            "record_money": 0,
            "record_month": 0,
            "record_time": 0,
            "record_title": "string",
            "record_total": 0,
            "record_year": 0,
            "store_id": 0,
            "subsite_id": 0,
            "trade_type_id": 0,
            "user_id": 0,
            "user_nickname": "string"
          }
        ],
        "consume_trade": {
          "buyer_id": 0,
          "buyer_store_id": 0,
          "chain_id": 0,
          "consume_trade_id": 0,
          "currency_id": 0,
          "currency_symbol_left": "string",
          "order_commission_fee": 0,
          "order_id": "string",
          "order_payment_amount": 0,
          "payment_channel_id": 0,
          "recharge_level_id": 0,
          "seller_id": 0,
          "store_id": 0,
          "subsite_id": 0,
          "trade_amount": 0,
          "trade_create_time": 0,
          "trade_delete": false,
          "trade_desc": "string",
          "trade_discount": 0,
          "trade_is_paid": 0,
          "trade_mode_id": 0,
          "trade_paid_time": 0,
          "trade_payment_amount": 0,
          "trade_payment_credit": 0,
          "trade_payment_money": 0,
          "trade_payment_points": 0,
          "trade_payment_recharge_card": 0,
          "trade_payment_redpack": 0,
          "trade_payment_sp": 0,
          "trade_remark": "string",
          "trade_title": "string",
          "trade_type_id": 0
        },
        "currency_id": 0,
        "currency_symbol_left": "string",
        "delivery": {
          "da_address": "string",
          "da_city": "string",
          "da_city_id": 0,
          "da_county": "string",
          "da_county_id": 0,
          "da_intl": "string",
          "da_latitude": 0,
          "da_longitude": 0,
          "da_mobile": "string",
          "da_name": "string",
          "da_postalcode": "string",
          "da_province": "string",
          "da_province_id": 0,
          "da_tag_name": "string",
          "da_telephone": "string",
          "da_time": "2019-08-24T14:15:22Z",
          "order_id": "string"
        },
        "delivery_istimer": false,
        "delivery_time": 0,
        "delivery_time_id": 0,
        "delivery_type_id": 0,
        "distributor_user_id": 0,
        "if_buyer_cancel": false,
        "items": [
          {
            "activity_code": "string",
            "activity_id": 0,
            "activity_type_id": 0,
            "category_id": 0,
            "if_return": false,
            "item_cost_price": 0,
            "item_id": 0,
            "item_name": "string",
            "item_save_price": 0,
            "item_src_id": 0,
            "item_unit_points": 0,
            "item_unit_price": 0,
            "item_unit_sp": 0,
            "order_give_id": 0,
            "order_id": "string",
            "order_item_adjust_fee": 0,
            "order_item_amount": 0,
            "order_item_can_refund_amount": 0,
            "order_item_commission_fee": 0,
            "order_item_commission_fee_refund": 0,
            "order_item_commission_rate": 0,
            "order_item_confirm_file": "string",
            "order_item_confirm_status": false,
            "order_item_discount_amount": 0,
            "order_item_evaluation_status": false,
            "order_item_file": "string",
            "order_item_id": 0,
            "order_item_image": "string",
            "order_item_inventory_lock": 0,
            "order_item_note": "string",
            "order_item_payment_amount": 0,
            "order_item_points_add": 0,
            "order_item_points_fee": 0,
            "order_item_quantity": 0,
            "order_item_reduce": 0,
            "order_item_return_agree_amount": 0,
            "order_item_return_agree_num": 0,
            "order_item_return_num": 0,
            "order_item_return_subtotal": 0,
            "order_item_sale_price": 0,
            "order_item_saler_id": 0,
            "order_item_supplier_sync": false,
            "order_item_voucher": 0,
            "policy_discountrate": 0,
            "product_id": 0,
            "product_item_name": "string",
            "product_name": "string",
            "return_ids": [
              "string"
            ],
            "src_order_id": "string",
            "store_id": 0,
            "user_id": 0
          }
        ],
        "kind_id": 0,
        "log_items": [
          {
            "order_id": "string",
            "order_state_id": 0,
            "order_state_is_sync": false,
            "order_state_log_id": 0,
            "order_state_note": "string",
            "order_state_pre_id": 0,
            "order_state_time": "2019-08-24T14:15:22Z",
            "order_state_type": "string",
            "user_account": "string",
            "user_id": 0
          }
        ],
        "logistics": [
          {
            "express_id": 0,
            "express_name": "string",
            "logistics_address": "string",
            "logistics_contacter": "string",
            "logistics_enable": false,
            "logistics_explain": "string",
            "logistics_id": 0,
            "logistics_mobile": "string",
            "logistics_phone": "string",
            "logistics_postcode": "string",
            "logistics_time": 0,
            "order_id": "string",
            "order_logistics_id": 0,
            "order_tracking_number": "string",
            "ss_id": 0,
            "stock_bill_id": "string"
          }
        ],
        "order_activity_data": "string",
        "order_activity_manhui_state": 0,
        "order_adjust_fee": 0,
        "order_bp_add": 0,
        "order_buyer_evaluation_status": false,
        "order_buyer_hidden": false,
        "order_cancel_identity": false,
        "order_cancel_reason": "string",
        "order_cancel_time": "2019-08-24T14:15:22Z",
        "order_commission_fee": 0,
        "order_commission_fee_refund": 0,
        "order_delay_time": 0,
        "order_desc": "string",
        "order_discount_amount": 0,
        "order_double_points_add": 0,
        "order_erp_id": "string",
        "order_express_print": false,
        "order_finance_review": false,
        "order_fx_is_settlemented": false,
        "order_fx_settlement_time": "2019-08-24T14:15:22Z",
        "order_id": "string",
        "order_is_cb": false,
        "order_is_cb_sync": false,
        "order_is_offline": false,
        "order_is_out": 0,
        "order_is_paid": 0,
        "order_is_received": false,
        "order_is_review": false,
        "order_is_settlemented": false,
        "order_is_shipped": 0,
        "order_is_sync": false,
        "order_is_transfer": false,
        "order_is_transfer_note": "string",
        "order_item_amount": 0,
        "order_lock_status": false,
        "order_message": "string",
        "order_number": "string",
        "order_payment_amount": 0,
        "order_points_add": 0,
        "order_points_fee": 0,
        "order_product_amount": 0,
        "order_rebate": 0,
        "order_received_time": "2019-08-24T14:15:22Z",
        "order_redpacket_price": 0,
        "order_refund_agree_amount": 0,
        "order_refund_agree_cash": 0,
        "order_refund_agree_points": 0,
        "order_refund_amount": 0,
        "order_refund_status": 0,
        "order_resource_ext1": 0,
        "order_resource_ext2": 0,
        "order_resource_ext3": 0,
        "order_return_ids": "string",
        "order_return_num": 0,
        "order_return_status": 0,
        "order_seller_evaluation_status": false,
        "order_settlement_time": "2019-08-24T14:15:22Z",
        "order_shipping_fee": 0,
        "order_shipping_fee_amount": 0,
        "order_shop_hidden": false,
        "order_state_id": 0,
        "order_time": "2019-08-24T14:15:22Z",
        "order_title": "string",
        "order_type": 0,
        "order_withdraw_confirm": false,
        "payment_form_id": false,
        "payment_time": "2019-08-24T14:15:22Z",
        "payment_type_id": 0,
        "product_name": "string",
        "redpacket_id": 0,
        "redpacket_number": "string",
        "redpacket_price": 0,
        "remain_pay_time": 0,
        "return_flag": false,
        "salesperson_id": 0,
        "src_order_id": "string",
        "stock_bill": [
          {
            "admin_id": 0,
            "bill_type_id": 0,
            "employee_id": 0,
            "items": [
              {
                "bill_item_quantity": 0,
                "bill_item_remark": "string",
                "bill_item_subtotal": 0,
                "bill_item_unit_price": 0,
                "bill_type_id": 0,
                "item_id": 0,
                "item_name": "string",
                "order_id": "string",
                "order_item_id": 0,
                "product_id": 0,
                "product_item_name": "string",
                "product_name": "string",
                "stock_bill_id": "string",
                "stock_bill_item_id": 0,
                "stock_transport_type_id": 0,
                "store_id": 0,
                "unit_id": 0,
                "warehouse_id": 0,
                "warehouse_item_quantity": 0
              }
            ],
            "order_id": "string",
            "stock_bill_amount": 0,
            "stock_bill_checked": false,
            "stock_bill_date": "2019-08-24T14:15:22Z",
            "stock_bill_enable": false,
            "stock_bill_id": "string",
            "stock_bill_modify_time": "2019-08-24T14:15:22Z",
            "stock_bill_other_money": 0,
            "stock_bill_remark": "string",
            "stock_bill_src_id": "string",
            "stock_bill_time": 0,
            "stock_transport_type_id": 0,
            "store_id": 0,
            "warehouse_id": 0
          }
        ],
        "store_id": 0,
        "store_is_selfsupport": false,
        "store_name": "string",
        "store_type": false,
        "subsite_id": 0,
        "trade_payment_amount": 0,
        "trade_payment_credit": 0,
        "trade_payment_money": 0,
        "trade_payment_recharge_card": 0,
        "user_id": 0,
        "user_nickname": "string",
        "virtual_service_time": "2019-08-24T14:15:22Z",
        "voucher_id": 0,
        "voucher_number": "string",
        "voucher_price": 0,
        "warehouse_items": [
          {
            "category_id": 0,
            "item_id": 0,
            "product_id": 0,
            "store_id": 0,
            "unit_id": 0,
            "warehouse_id": 0,
            "warehouse_item_cost": 0,
            "warehouse_item_id": 0,
            "warehouse_item_lock_quantity": 0,
            "warehouse_item_quantity": 0,
            "warehouse_item_quantity_max": 0,
            "warehouse_item_quantity_min": 0
          }
        ]
      }
    ],
    "page": 0,
    "records": 0,
    "size": 0,
    "total": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 订单发票管理表-分页列表查询

GET /front/trade/order/listInvoice

订单发票管理表-分页列表查询

请求参数

名称	位置	类型	必选	说明
createTimeEnd	query	string	否	创建时间结束值
createTimeStart	query	string	否	创建时间起始值
invoiceIsElectronic	query	integer	否	电子发票(ENUM):0-纸质发票;1-电子发票
invoiceStatus	query	integer	否	开票状态(BOOL): 0-未开票; 1-已开票;
invoiceTitle	query	string	否	发票抬头
invoiceType	query	integer	否	发票类型(ENUM):1-普通发票;2-增值税专用发票
like[0].column	query	string	否	搜索字段
like[0].like	query	string	否	搜索字符
orderId	query	string	否	订单编号
order[0].sidx	query	string	否	排序字段
order[0].sort	query	string	否	排序方式
page	query	integer	否	分页查询页码
sidx	query	string	否	排序字段
size	query	integer	否	分页查询每页数量
sort	query	string	否	排序方式
userId	query	integer	否	所属用户

返回示例

200 Response

{
  "code": 0,
  "data": {
    "items": [
      {
        "invoice_address": "string",
        "invoice_amount": 0,
        "invoice_bankaccount": "string",
        "invoice_bankname": "string",
        "invoice_company_code": "string",
        "invoice_contact_address": "string",
        "invoice_contact_area": "string",
        "invoice_contact_name": "string",
        "invoice_content": "string",
        "invoice_datetime": "2019-08-24T14:15:22Z",
        "invoice_is_company": false,
        "invoice_is_electronic": 0,
        "invoice_phone": "string",
        "invoice_status": false,
        "invoice_time": 0,
        "invoice_title": "string",
        "invoice_type": 0,
        "order_id": "string",
        "order_invoice_id": 0,
        "order_is_paid": false,
        "store_id": 0,
        "user_email": "string",
        "user_id": 0,
        "user_intl": "string",
        "user_mobile": "string"
      }
    ],
    "page": 0,
    "records": 0,
    "size": 0,
    "total": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 确认收货

POST /front/trade/order/receive

确认收货

请求参数

名称	位置	类型	必选	说明
orderFinanceReason	query	string	否	原因
orderId	query	string	是	订单编号

返回示例

200 Response

{
  "code": 0,
  "data": {
    "orderId": [
      "string"
    ]
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 订单评价-读取订单商品

GET /front/trade/order/storeEvaluationWithContent

订单评价-读取订单商品

请求参数

名称	位置	类型	必选	说明
order_id	query	string	是	order_id

返回示例

200 Response

{
  "code": 0,
  "data": {
    "items": [
      {
        "store_address": "string",
        "store_area": "string",
        "store_banner": "string",
        "store_category_id": 0,
        "store_circle": "string",
        "store_close_hours": "string",
        "store_close_reason": "string",
        "store_deliver_district_id": "string",
        "store_district_id": "string",
        "store_end_time": "2019-08-24T14:15:22Z",
        "store_free_shipping": 0,
        "store_grade_id": 0,
        "store_id": 0,
        "store_is_open": false,
        "store_is_selfsupport": false,
        "store_latitude": 0,
        "store_logo": "string",
        "store_longitude": 0,
        "store_name": "string",
        "store_notice": "string",
        "store_o2o_flag": false,
        "store_o2o_tags": "string",
        "store_opening_hours": "string",
        "store_payment_state": 0,
        "store_slogan": "string",
        "store_start_time": "2019-08-24T14:15:22Z",
        "store_state_id": 0,
        "store_tel": "string",
        "store_template": "string",
        "store_type": 0,
        "subsite_id": 0
      }
    ],
    "no": 0,
    "order_evaluation": {},
    "store_info": {
      "store_address": "string",
      "store_area": "string",
      "store_banner": "string",
      "store_category_id": 0,
      "store_circle": "string",
      "store_close_hours": "string",
      "store_close_reason": "string",
      "store_deliver_district_id": "string",
      "store_district_id": "string",
      "store_end_time": "2019-08-24T14:15:22Z",
      "store_free_shipping": 0,
      "store_grade_id": 0,
      "store_id": 0,
      "store_is_open": false,
      "store_is_selfsupport": false,
      "store_latitude": 0,
      "store_logo": "string",
      "store_longitude": 0,
      "store_name": "string",
      "store_notice": "string",
      "store_o2o_flag": false,
      "store_o2o_tags": "string",
      "store_opening_hours": "string",
      "store_payment_state": 0,
      "store_slogan": "string",
      "store_start_time": "2019-08-24T14:15:22Z",
      "store_state_id": 0,
      "store_tel": "string",
      "store_template": "string",
      "store_type": 0,
      "subsite_id": 0
    },
    "yes": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

退款退货

POST 添加退款退货

POST /front/trade/orderReturn/add

添加退款退货

请求参数

名称	位置	类型	必选	说明
orderId	query	string	否	订单编号
orderItemId	query	integer	否	订单商品表编号
returnAllFlag	query	string	否	退货标记(BOOL):true-全退， false-单品退
returnBuyerMessage	query	string	否	买家退货备注
returnItemImage	query	string	否	退款凭据(DOT)
returnItemNum	query	integer	否	退货商品数量
returnReasonId	query	integer	否	退款理由编号
returnRefundAmount	query	number	否	退款金额
returnTel	query	string	否	联系电话
serviceTypeId	query	integer	否	服务类型(ENUM):1-退款;2-退货;3-换货;4-维修

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 取消退款订单

POST /front/trade/orderReturn/cancel

取消退款订单

请求参数

名称	位置	类型	必选	说明
return_id	query	string	是	return_id

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

POST 确认退货物流单号

POST /front/trade/orderReturn/edit

确认退货物流单号

请求参数

名称	位置	类型	必选	说明
expressId	query	integer	否	快递编号
orderId	query	string	否	订单编号
orderItemId	query	integer	否	订单商品表编号
receivingAddress	query	integer	否	收货地址
returnAllFlag	query	string	否	退货标记(BOOL):true-全退， false-单品退
returnBuyerMessage	query	string	否	买家退货备注
returnFlag	query	integer	否	退货类型(ENUM): 0-不用退货;1-需要退货
returnId	query	string	否	退单号
returnItemImage	query	string	否	退款凭据(DOT)
returnItemNum	query	integer	否	退货商品数量
returnItemStateId	query	integer	否	物流状态(LIST):2030-待发货;2040-已发货/待收货确认;2060-已完成/已签收;2070-已取消/已作废;
returnReasonId	query	integer	否	退款理由编号
returnRefundAmount	query	number	否	退款金额
returnStoreMessage	query	string	否	商家备注
returnTel	query	string	否	联系电话
returnTrackingNumber	query	string	否	物流单号
serviceTypeId	query	integer	否	服务类型(ENUM):1-退款;2-退货;3-换货;4-维修

返回示例

200 Response

{
  "code": 0,
  "data": {},
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
201	Created	Created	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 读取退款退货

GET /front/trade/orderReturn/get

退款退货列表

请求参数

名称	位置	类型	必选	说明
return_id	query	string	是	return_id

返回示例

200 Response

{
  "code": 0,
  "data": {
    "buyer_store_id": 0,
    "buyer_user_id": 0,
    "deposit_trade_no": "string",
    "express_id": 0,
    "items": [
      {
        "can_refund_amount": 0,
        "can_refund_num": 0,
        "item_id": 0,
        "item_name": "string",
        "item_unit_price": 0,
        "order_id": "string",
        "order_item_id": 0,
        "order_item_image": "string",
        "order_item_quantity": 0,
        "order_item_sale_price": 0,
        "product_item_name": "string",
        "product_name": "string",
        "return_item_image_list": [
          "string"
        ],
        "return_item_num": 0,
        "return_item_subtotal": 0,
        "return_reason_list": [
          {
            "return_reason_id": 0,
            "return_reason_name": "string",
            "return_reason_sort": 0
          }
        ],
        "unit_name": "string"
      }
    ],
    "order_id": "string",
    "payment_channel_id": 0,
    "plantform_return_state_id": 0,
    "return_add_time": 0,
    "return_addr": "string",
    "return_addr_contacter": "string",
    "return_buyer_message": "string",
    "return_channel_code": "string",
    "return_channel_flag": 0,
    "return_channel_time": "2019-08-24T14:15:22Z",
    "return_channel_trans_id": "string",
    "return_commision_fee": 0,
    "return_contact_name": "string",
    "return_financial_confirm": false,
    "return_financial_confirm_time": "2019-08-24T14:15:22Z",
    "return_finish_time": "2019-08-24T14:15:22Z",
    "return_flag": 0,
    "return_id": "string",
    "return_is_paid": false,
    "return_is_settlemented": false,
    "return_is_shipping_fee": 0,
    "return_item_state_id": 0,
    "return_num": 0,
    "return_order_lock": 0,
    "return_platform_message": "string",
    "return_post_code": 0,
    "return_reason_id": 0,
    "return_refund_amount": 0,
    "return_refund_point": 0,
    "return_settlement_time": "2019-08-24T14:15:22Z",
    "return_shipping_fee": 0,
    "return_state_id": 0,
    "return_store_message": "string",
    "return_store_time": "2019-08-24T14:15:22Z",
    "return_store_user_id": 0,
    "return_tel": "string",
    "return_tracking_name": "string",
    "return_tracking_number": "string",
    "return_type": 0,
    "return_withdraw_confirm": false,
    "service_type_id": 0,
    "store_id": 0,
    "submit_return_refund_amount": 0,
    "subsite_id": 0,
    "trade_payment_amount": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 退款退货列表

GET /front/trade/orderReturn/list

退款退货列表

请求参数

名称	位置	类型	必选	说明
buyerUserId	query	integer	否	买家编号
createTimeEnd	query	string	否	创建时间结束值
createTimeStart	query	string	否	创建时间起始值
like[0].column	query	string	否	搜索字段
like[0].like	query	string	否	搜索字符
orderId	query	string	否	订单编号
order[0].sidx	query	string	否	排序字段
order[0].sort	query	string	否	排序方式
page	query	integer	否	分页查询页码
returnAddEnd	query	integer	否	退款完成时间-结束
returnAddStart	query	integer	否	退款完成时间-开始
returnChannelCode	query	string	否	退款渠道(ENUM):money-余额;alipay-支付宝;wx_native-微信
returnId	query	string	否	退单号
returnStateId	query	integer	否	卖家处理状态(ENUM): 3100-【客户】提交退单;3105-退单审核;3110-收货确认;3115-退款确认;3120-客户】收款确认;3125-完成
sidx	query	string	否	排序字段
size	query	integer	否	分页查询每页数量
sort	query	string	否	排序方式

返回示例

200 Response

{
  "code": 0,
  "data": {
    "items": [
      {
        "buyer_store_id": 0,
        "buyer_user_id": 0,
        "deposit_trade_no": "string",
        "express_id": 0,
        "items": [
          {
            "can_refund_amount": 0,
            "can_refund_num": 0,
            "item_id": 0,
            "item_name": "string",
            "item_unit_price": 0,
            "order_id": "string",
            "order_item_id": 0,
            "order_item_image": "string",
            "order_item_quantity": 0,
            "order_item_sale_price": 0,
            "product_item_name": "string",
            "product_name": "string",
            "return_item_image_list": [
              "string"
            ],
            "return_item_num": 0,
            "return_item_subtotal": 0,
            "return_reason_list": [
              {
                "return_reason_id": 0,
                "return_reason_name": "string",
                "return_reason_sort": 0
              }
            ],
            "unit_name": "string"
          }
        ],
        "order_id": "string",
        "payment_channel_id": 0,
        "plantform_return_state_id": 0,
        "return_add_time": 0,
        "return_addr": "string",
        "return_addr_contacter": "string",
        "return_buyer_message": "string",
        "return_channel_code": "string",
        "return_channel_flag": 0,
        "return_channel_time": "2019-08-24T14:15:22Z",
        "return_channel_trans_id": "string",
        "return_commision_fee": 0,
        "return_contact_name": "string",
        "return_financial_confirm": false,
        "return_financial_confirm_time": "2019-08-24T14:15:22Z",
        "return_finish_time": "2019-08-24T14:15:22Z",
        "return_flag": 0,
        "return_id": "string",
        "return_is_paid": false,
        "return_is_settlemented": false,
        "return_is_shipping_fee": 0,
        "return_item_state_id": 0,
        "return_num": 0,
        "return_order_lock": 0,
        "return_platform_message": "string",
        "return_post_code": 0,
        "return_reason_id": 0,
        "return_refund_amount": 0,
        "return_refund_point": 0,
        "return_settlement_time": "2019-08-24T14:15:22Z",
        "return_shipping_fee": 0,
        "return_state_id": 0,
        "return_store_message": "string",
        "return_store_time": "2019-08-24T14:15:22Z",
        "return_store_user_id": 0,
        "return_tel": "string",
        "return_tracking_name": "string",
        "return_tracking_number": "string",
        "return_type": 0,
        "return_withdraw_confirm": false,
        "service_type_id": 0,
        "store_id": 0,
        "submit_return_refund_amount": 0,
        "subsite_id": 0,
        "trade_payment_amount": 0
      }
    ],
    "page": 0,
    "records": 0,
    "size": 0,
    "total": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

GET 订单item详情,列出订单的item，及退款详情

GET /front/trade/orderReturn/returnItem

订单item详情,列出订单的item，及退款详情

请求参数

名称	位置	类型	必选	说明
order_id	query	string	是	order_id
order_item_id	query	string	是	order_item_id

返回示例

200 Response

{
  "code": 0,
  "data": {
    "can_refund_amount": 0,
    "can_refund_num": 0,
    "item_id": 0,
    "item_name": "string",
    "item_unit_price": 0,
    "order_id": "string",
    "order_item_id": 0,
    "order_item_image": "string",
    "order_item_quantity": 0,
    "order_item_sale_price": 0,
    "product_item_name": "string",
    "product_name": "string",
    "return_item_image_list": [
      "string"
    ],
    "return_item_num": 0,
    "return_item_subtotal": 0,
    "return_reason_list": [
      {
        "return_reason_id": 0,
        "return_reason_name": "string",
        "return_reason_sort": 0
      }
    ],
    "unit_name": "string"
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline