Skip to main content

同步外部订单

基本信息

接口名称:接收外部订单状  态:已完成
接口路径:POST /paas/micro/order/apiReceiveExternalOrder更新时间:2021-07-12 21:15:37
Mock地址:https://apimock.e-buychina.com/mock/56/paas/micro/order/apiReceiveExternalOrder

请求参数

Headers:

参数名称参数值是否必填
Content-Typeapplication/json

Body:

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring请求AppId最大长度:50
最小长度:1
Mock:@natural
actionstring交易类型最大长度:50
最小长度:1
Mock:apiReceiveExternalOrder
timestampnumber请求时间戳Mock:@timestamp
signTypestring签名类型最大长度:20
最小长度:1
Mock:sha256
signstring签名值最大长度:500
最小长度:1
Mock:@natural
langstring语言最大长度:50
最小长度:1
Mock:zh_CN
contentobject请求报文
  memberIdstring会员id最大长度:100
  directionstring订单方向(Create正单,Refund退单,Update更新)最大长度:100
  merchantIdstring商户
门店id
最大长度:100
  merchantNamestring商户
门店名称
最大长度:100
  orderSnstring订单编号最大长度:100
  orderIdstring订单id最大长度:100
  oriOrderSnstring原订单编号最大长度:100
  oriOrderIdstring原订单id最大长度:100
  orderNamestring订单名称最大长度:100
  paymentNamestring支付方式名称最大长度:100
  paymentSnstring机构交易流水号最大长度:100
  orderStatusstring订单状态(Init,Paid,Sent,Transfer,Transferred,Complete,Cancel,Refund)最大长度:100
  grouponStatusstring拼团状态(0订单已取消 1待付款 2待成团 3待发货 4已完成 5拼团失败 6退款中 7退款失败 8退款成功 9已关闭)最大长度:100
  orderTypestring订单类型(purchase购买, free赠送, groupon拼团, dining桌边点餐, distribution外卖)最大长度:100
  currencystring币种最大长度:100
  orderUrlImagestring订单缩略图最大长度:100
  orderRemarksstring订单备注最大长度:100
  refundStatusstring退款状态(None,Part,All)最大长度:100
  transferMemberIdstring接受转赠的会员id最大长度:100
  memberNamestring会员名称最大长度:100
  memberPhonestring会员手机号最大长度:100
  cancelReasonstring取消原因最大长度:100
  voucherNumberstring订单下卡券数量最大长度:100
  packageIdstring转赠包裹id最大长度:100
  isReceiptstring是否开票(0否 1是)最大长度:100
  thirdPartySerialNumstring发票流水号最大长度:100
  addressDetailsstring配送地址最大长度:100
  latitudestring配送地址维度最大长度:100
  longitudestring配送地址经度最大长度:100
  orderSourcestring订单客户端来源(WechatMiniProgram,AlipayTinyApp,UnionPayMiniProgram,H5)最大长度:100
  extraDetailInfoobject外部订单明细
    goodsDetailarray商品列表明细
      goodsIdstring商品id最大长度:100
      goodsSkustringsku最大长度:100
      goodsNamestring商品名称最大长度:100
      pricenumber标价,单位元Mock:@float
      realAmountnumber实付金额Mock:@float
      discountAmountnumber优惠金额Mock:@float
      remarksstring备注,拓展字段最大长度:100
    paymentDetailarray支付明细
      paymentTypestring支付类型(支付payment,券whale,现金卡cashcard,积分point,权益privilege,通用优惠discount)最大长度:100
      paymentSnstring支付流水号最大长度:100
      totalAmountnumber该支付方式折抵的总金额
      realAmountnumber实付部分
      discountAmountnumber优惠部分
      valuenumber金额
积分值
权益次数
      remarksstring备注,拓展字段最大长度:100
    extraDetailobject其他自定义字段
  orderTimestring订单创建时间最大长度:100
Mock:@datetime
  sendTimestring发货时间最大长度:100
Mock:@datetime
  receiveTimestring确认收货时间最大长度:100
Mock:@datetime
  paymentTimestring支付完成时间最大长度:100
Mock:@datetime
  totalAmountnumber0.0000订单总金额Mock:@float
  discountAmountnumber0.0000优惠总金额Mock:@float
  realAmountnumber0.0000实付金额Mock:@float
  shippingAmountnumber0.0000配送总金额Mock:@float
  refundAmountnumber0.0000已发生退款总金额Mock:@float

返回数据

参数名称类型必填默认值备注其他信息
uuidstring请求序列号最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
successboolean交易成功与否Mock:@boolean
actionstring交易类型最大长度:50
最小长度:1
Mock:apiReceiveExternalOrder
timestampnumber返回时间戳Mock:@timestamp
errorCodestring错误码最大长度:50
Mock:@word
errorMessagestring错误描述最大长度:50
Mock:@csentence
signTypestring签名类型最大长度:20
Mock:sha256
signstring签名值最大长度:500
Mock:@natural
contentobject请求报文
  syncOrderIdstring订单Id最大长度:50
最小长度:1
Mock:@word
  syncOrderNamestring订单名称最大长度:99
最小长度:1
Mock:@string

备注

接收外部订单

变更历史

变更日期变更内容
2021-06-30
2021-06-29
2021-06-11
2021-06-10
2021-06-10
2021-06-10
2021-06-10
2021-06-10
2021-06-09
2021-06-09
2021-05-28
2021-05-28
2021-05-28
2021-05-27
2021-05-27
2021-05-27
2021-05-27
2021-05-27
2021-05-27
2021-05-27
2021-05-27
2021-05-27
2021-05-27
2021-05-27
2021-05-27
2021-05-27
api-id=29782