文档中心 > API类目 > 本地生活API

alibaba.alsc.consumerecord.sync (外域订单同步本地生活消费记录)

外部第三方将本地生活app端下单数据同步到本地生活消费记录中心

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
param_record_open_sync_request RecordOpenSyncRequest 必须 外部订单同步本地生活消费记录请求
  • └ biz_source
  • String
  • 必须
  • ELEME
  • 业务方
  • └ ext_info
  • String
  • 可选
  • {"silenceSync":"true"}
  • 同步请求扩展信息
  • └ open_app_key
  • String
  • 可选
  • 32295684
  • 加密openId的appKey
  • └ open_user_id
  • String
  • 必须
  • AAG02pTDANOJ9yfQt3FeJDSP
  • 开放平台用户id
  • └ owner_type
  • String
  • 必须
  • ELEME
  • 用户账号类型
  • record_open_info
  • AlscConsumeRecordOpenInfo
  • 必须
  • 同步消费记录模型
  • └ biz_content
  • String
  • 可选
  • {"nickName":"NaNa","isSyncOrder":"true"}
  • 消费记录业务上下文
  • └ biz_no
  • String
  • 必须
  • 8005021289962264134
  • 业务单据号
  • └ biz_no_type
  • String
  • 必须
  • ALSC_ORDER
  • 业务单据类型
  • └ biz_source
  • String
  • 必须
  • ELEME
  • 业务方
  • └ biz_status
  • String
  • 必须
  • WAIT_CONSUME
  • 消费记录业务状态
  • └ biz_sub_type
  • String
  • 可选
  • SELF_TAKE
  • 业务子类型
  • └ biz_type
  • String
  • 必须
  • TAKE_OUT
  • 业务类型
  • delivery_open_info
  • DeliveryOpenInfo
  • 可选
  • 物流单模型
  • └ deliver_man
  • String
  • 可选
  • 小张
  • 配送员名称
  • └ deliver_time
  • Date
  • 可选
  • 2020-12-12 12:12:12
  • 开始配送时间
  • └ ext_info
  • String
  • 可选
  • {"addressPhone":"17364789376"}
  • 物流单扩展信息
  • └ fee
  • Number
  • 可选
  • 300
  • 物流费
  • └ phone
  • String
  • 可选
  • 17495037490
  • 配送员联系电话
  • └ ext_info
  • String
  • 可选
  • {"tagOption":"6","tags":"[\"REAL_LOCAL_HAVANA\",\"SHOW_IN_ELEME\"]","option":"8"}
  • 消费记录扩展信息
  • └ gmt_biz_create
  • Date
  • 必须
  • 2020-12-12 12:12:12
  • 业务创建时间
  • └ gmt_biz_modified
  • Date
  • 必须
  • 2020-12-12 12:12:12
  • 业务最后修改时间
  • └ opposite_id
  • String
  • 可选
  • 291693107
  • 对侧ID
  • └ opposite_id_type
  • String
  • 可选
  • SELLER_ID
  • 对侧ID类型
  • order_open_info
  • OrderOpenInfo
  • 可选
  • 主单模型
  • action_open_infos
  • ActionOpenInfo []
  • 可选
  • 行动点模型
  • └ action_desc
  • String
  • 可选
  • 查看详情
  • 行动点描述
  • └ action_type
  • String
  • 可选
  • ORDER_DETAIL
  • 行动点类型
  • └ highlight
  • Boolean
  • 可选
  • false
  • 文案是否高亮
  • └ jump_url
  • String
  • 可选
  • miniApp":"alipays://platformapi/startapp?appId=2018090761255717
  • 跳转链接
  • └ biz_context
  • String
  • 可选
  • {"nickName":"NaNa","isSyncOrder":"true"}
  • 主单业务上下文
  • └ biz_status
  • String
  • 必须
  • WAIT_CONSUME
  • 主单业务状态
  • └ biz_status_desc
  • String
  • 必须
  • 待消费
  • 主单状态中文描述
  • └ ext_info
  • String
  • 可选
  • {"nickName":"NaNa","isSyncOrder":"true"}
  • 主单扩展信息
  • fund_open_info
  • FundOpenInfo
  • 可选
  • 主单资金明细
  • └ amount
  • Number
  • 可选
  • 1200
  • 总金额
  • └ buyer_pay_amt
  • Number
  • 可选
  • 1000
  • 用户实付
  • └ merchant_subsidy
  • Number
  • 可选
  • 100
  • 商户补贴
  • └ platform_subsidy
  • Number
  • 可选
  • 100
  • 平台补贴
  • └ order_channel
  • String
  • 必须
  • ALIPAY
  • 下单渠道
  • └ order_detail_url
  • String
  • 必须
  • miniApp":"alipays://platformapi/startapp?appId=2018090761255717
  • 订单详情页跳转链接
  • └ order_sub_channel
  • String
  • 可选
  • MINI_APP_ALIPAY
  • 下单子渠道
  • └ subject
  • String
  • 必须
  • 单人和牛畅吃套餐
  • 订单标题
  • payment_open_infos
  • PaymentOpenInfo []
  • 可选
  • 支付单模型
  • └ biz_context
  • String
  • 可选
  • {"isPayOrder":"true"}
  • 支付单业务上下文
  • └ ext_info
  • String
  • 可选
  • {"isPayOrder":"true"}
  • 支付单扩展信息
  • fund_open_info
  • FundOpenInfo
  • 可选
  • 支付单资金明细
  • └ amount
  • Number
  • 可选
  • 1200
  • 总金额
  • └ buyer_pay_amt
  • Number
  • 可选
  • 1000
  • 用户实付
  • └ merchant_subsidy
  • Number
  • 可选
  • 100
  • 商户补贴
  • └ platform_subsidy
  • Number
  • 可选
  • 100
  • 平台补贴
  • └ pay_time
  • Date
  • 可选
  • 2020-12-12 12:12:12
  • 支付时间
  • └ payer_account_no
  • String
  • 可选
  • 2088902083258508
  • 付款者账户号
  • └ status
  • String
  • 可选
  • SUCCESS
  • 支付状态
  • └ trade_no
  • String
  • 可选
  • 4200001019202105075356531105
  • 交易号
  • └ trade_type
  • String
  • 可选
  • ALIPAY
  • 交易类型
  • └ rate_status
  • String
  • 可选
  • NOT_RATE
  • 评价状态
  • └ record_type
  • String
  • 可选
  • BUYER_ORDER
  • 消费记录类型
  • refund_open_infos
  • RefundOpenInfo []
  • 可选
  • 退款单模型
  • └ biz_context
  • String
  • 可选
  • {"isRefundOrder":"true"}
  • 退款单业务上下文
  • └ ext_info
  • String
  • 可选
  • {"isRefundOrder":"true"}
  • 退款单扩展信息
  • fund_open_info
  • FundOpenInfo
  • 可选
  • 退款单资金明细
  • └ amount
  • Number
  • 可选
  • 1200
  • 总金额
  • └ buyer_pay_amt
  • Number
  • 可选
  • 1000
  • 用户实付
  • └ merchant_subsidy
  • Number
  • 可选
  • 100
  • 商户补贴
  • └ platform_subsidy
  • Number
  • 可选
  • 100
  • 平台补贴
  • └ refund_amount
  • Number
  • 可选
  • 1100
  • 退款金额
  • └ refund_order_id
  • String
  • 可选
  • 190514008380086296
  • 退款单id
  • └ refund_real_amount
  • Number
  • 可选
  • 1000
  • 退款实付
  • └ status
  • String
  • 可选
  • SUCCESS
  • 退款状态
  • shop_open_info
  • ShopOpenInfo
  • 必须
  • 店铺模型
  • └ ext_info
  • String
  • 可选
  • {"addressPhone":"17364789376"}
  • 店铺扩展信息
  • └ pid
  • String
  • 可选
  • 2088531206951521
  • 店铺Pid
  • └ shop_id
  • String
  • 必须
  • 536902422
  • 店铺ID
  • └ shop_logo_url
  • String
  • 必须
  • https://fuss10.elemecdn.com/e/d9/0659bc0c0fc6c2045d86dd2736cfajpeg.jpeg
  • 店铺logo图片
  • └ shop_name
  • String
  • 必须
  • 华莱士·全鸡汉堡(萧山开元广场店)
  • 店铺名称
  • sub_order_open_infos
  • SubOrderOpenInfo []
  • 必须
  • 子单模型
  • └ biz_context
  • String
  • 可选
  • {"nickName":"NaNa","isSyncOrder":"true"}
  • 子单业务上下文
  • └ biz_status
  • String
  • 必须
  • COMPLETED
  • 子单业务状态
  • └ biz_status_desc
  • String
  • 必须
  • 已完成
  • 子单状态中文描述
  • └ consume_desc
  • String
  • 可选
  • 请尽快消费
  • consumeDesc
  • └ ext_info
  • String
  • 可选
  • {"nickName":"NaNa","isSyncOrder":"true"}
  • 子单扩展信息
  • fund_open_info
  • FundOpenInfo
  • 可选
  • 子单资金明细
  • └ amount
  • Number
  • 可选
  • 1200
  • 总金额
  • └ buyer_pay_amt
  • Number
  • 可选
  • 1000
  • 用户实付
  • └ merchant_subsidy
  • Number
  • 可选
  • 100
  • 商户补贴
  • └ platform_subsidy
  • Number
  • 可选
  • 100
  • 平台补贴
  • └ item_id
  • String
  • 必须
  • 642016974699
  • 商品ID
  • └ item_name
  • String
  • 必须
  • 香辣鸡排堡+鸡肉卷+中可乐
  • 商品名称
  • └ item_pic_url
  • String
  • 必须
  • i2/2201245230411/O1CN011EuHJGzjCzMstuW_!!2201245230411-0-koubei.jpg
  • 图片地址
  • └ price
  • Number
  • 必须
  • 1590
  • 单价
  • └ quantity
  • Number
  • 必须
  • 1
  • 数量
  • └ valid_desc
  • String
  • 可选
  • 请尽快消费
  • 子单记录的时间提示
  • └ valid_end
  • Date
  • 可选
  • 2020-12-12 12:12:12
  • 有效期结束时间
  • └ valid_start
  • Date
  • 可选
  • 2020-12-12 12:12:12
  • 有效期开始时间
  • └ visibility
  • Boolean
  • 可选
  • true
  • 订单是否可见

响应参数

名称 类型 示例值 描述
result SingleDataResult {"data":"true","result_status":"1"} 同步返回结果
  • └ data
  • Boolean
  • true
  • 返回数据
  • └ error_code
  • String
  • SR_INVALID_PARAMETER
  • 错误码
  • └ error_msg
  • String
  • 同步消费记录参数校验异常
  • 错误信息
  • └ result_status
  • Number
  • 1
  • 结果码

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaAlscConsumerecordSyncRequest req = new AlibabaAlscConsumerecordSyncRequest();
AlibabaAlscConsumerecordSyncRequest.RecordOpenSyncRequest obj1 = new AlibabaAlscConsumerecordSyncRequest.RecordOpenSyncRequest();
obj1.setBizSource("ELEME");
obj1.setExtInfo("{\"silenceSync\":\"true\"}");
obj1.setOpenAppKey("32295684");
obj1.setOpenUserId("AAG02pTDANOJ9yfQt3FeJDSP");
obj1.setOwnerType("ELEME");
AlibabaAlscConsumerecordSyncRequest.AlscConsumeRecordOpenInfo obj2 = new AlibabaAlscConsumerecordSyncRequest.AlscConsumeRecordOpenInfo();
obj2.setBizContent("{\"nickName\":\"NaNa\",\"isSyncOrder\":\"true\"}");
obj2.setBizNo("8005021289962264134");
obj2.setBizNoType("ALSC_ORDER");
obj2.setBizSource("ELEME");
obj2.setBizStatus("WAIT_CONSUME");
obj2.setBizSubType("SELF_TAKE");
obj2.setBizType("TAKE_OUT");
AlibabaAlscConsumerecordSyncRequest.DeliveryOpenInfo obj3 = new AlibabaAlscConsumerecordSyncRequest.DeliveryOpenInfo();
obj3.setDeliverMan("小张");
obj3.setDeliverTime(StringUtils.parseDateTime("2020-12-12 12:12:12"));
obj3.setExtInfo("{\"addressPhone\":\"17364789376\"}");
obj3.setFee(300L);
obj3.setPhone("17495037490");
obj2.setDeliveryOpenInfo(obj3);
obj2.setExtInfo("{\"tagOption\":\"6\",\"tags\":\"[\\"REAL_LOCAL_HAVANA\\",\\"SHOW_IN_ELEME\\"]\",\"option\":\"8\"}");
obj2.setGmtBizCreate(StringUtils.parseDateTime("2020-12-12 12:12:12"));
obj2.setGmtBizModified(StringUtils.parseDateTime("2020-12-12 12:12:12"));
obj2.setOppositeId("291693107");
obj2.setOppositeIdType("SELLER_ID");
AlibabaAlscConsumerecordSyncRequest.OrderOpenInfo obj4 = new AlibabaAlscConsumerecordSyncRequest.OrderOpenInfo();
List<AlibabaAlscConsumerecordSyncRequest.ActionOpenInfo> list6 = new ArrayList<AlibabaAlscConsumerecordSyncRequest.ActionOpenInfo>();
AlibabaAlscConsumerecordSyncRequest.ActionOpenInfo obj7 = new AlibabaAlscConsumerecordSyncRequest.ActionOpenInfo();
list6.add(obj7);
obj7.setActionDesc("查看详情");
obj7.setActionType("ORDER_DETAIL");
obj7.setHighlight(false);
obj7.setJumpUrl("miniApp\":\"alipays://platformapi/startapp?appId=2018090761255717");
obj4.setActionOpenInfos(list6);
obj4.setBizContext("{\"nickName\":\"NaNa\",\"isSyncOrder\":\"true\"}");
obj4.setBizStatus("WAIT_CONSUME");
obj4.setBizStatusDesc("待消费");
obj4.setExtInfo("{\"nickName\":\"NaNa\",\"isSyncOrder\":\"true\"}");
AlibabaAlscConsumerecordSyncRequest.FundOpenInfo obj8 = new AlibabaAlscConsumerecordSyncRequest.FundOpenInfo();
obj8.setAmount(1200L);
obj8.setBuyerPayAmt(1000L);
obj8.setMerchantSubsidy(100L);
obj8.setPlatformSubsidy(100L);
obj4.setFundOpenInfo(obj8);
obj4.setOrderChannel("ALIPAY");
obj4.setOrderDetailUrl("miniApp\":\"alipays://platformapi/startapp?appId=2018090761255717");
obj4.setOrderSubChannel("MINI_APP_ALIPAY");
obj4.setSubject("单人和牛畅吃套餐");
obj2.setOrderOpenInfo(obj4);
List<AlibabaAlscConsumerecordSyncRequest.PaymentOpenInfo> list10 = new ArrayList<AlibabaAlscConsumerecordSyncRequest.PaymentOpenInfo>();
AlibabaAlscConsumerecordSyncRequest.PaymentOpenInfo obj11 = new AlibabaAlscConsumerecordSyncRequest.PaymentOpenInfo();
list10.add(obj11);
obj11.setBizContext("{\"isPayOrder\":\"true\"}");
obj11.setExtInfo("{\"isPayOrder\":\"true\"}");
AlibabaAlscConsumerecordSyncRequest.FundOpenInfo obj13 = new AlibabaAlscConsumerecordSyncRequest.FundOpenInfo();
obj13.setAmount(1200L);
obj13.setBuyerPayAmt(1000L);
obj13.setMerchantSubsidy(100L);
obj13.setPlatformSubsidy(100L);
list12.setFundOpenInfo(obj13);
obj11.setPayTime(StringUtils.parseDateTime("2020-12-12 12:12:12"));
obj11.setPayerAccountNo("2088902083258508");
obj11.setStatus("SUCCESS");
obj11.setTradeNo("4200001019202105075356531105");
obj11.setTradeType("ALIPAY");
obj2.setPaymentOpenInfos(list10);
obj2.setRateStatus("NOT_RATE");
obj2.setRecordType("BUYER_ORDER");
List<AlibabaAlscConsumerecordSyncRequest.RefundOpenInfo> list15 = new ArrayList<AlibabaAlscConsumerecordSyncRequest.RefundOpenInfo>();
AlibabaAlscConsumerecordSyncRequest.RefundOpenInfo obj16 = new AlibabaAlscConsumerecordSyncRequest.RefundOpenInfo();
list15.add(obj16);
obj16.setBizContext("{\"isRefundOrder\":\"true\"}");
obj16.setExtInfo("{\"isRefundOrder\":\"true\"}");
AlibabaAlscConsumerecordSyncRequest.FundOpenInfo obj18 = new AlibabaAlscConsumerecordSyncRequest.FundOpenInfo();
obj18.setAmount(1200L);
obj18.setBuyerPayAmt(1000L);
obj18.setMerchantSubsidy(100L);
obj18.setPlatformSubsidy(100L);
list17.setFundOpenInfo(obj18);
obj16.setRefundAmount(1100L);
obj16.setRefundOrderId("190514008380086296");
obj16.setRefundRealAmount(1000L);
obj16.setStatus("SUCCESS");
obj2.setRefundOpenInfos(list15);
AlibabaAlscConsumerecordSyncRequest.ShopOpenInfo obj19 = new AlibabaAlscConsumerecordSyncRequest.ShopOpenInfo();
obj19.setExtInfo("{\"addressPhone\":\"17364789376\"}");
obj19.setPid("2088531206951521");
obj19.setShopId("536902422");
obj19.setShopLogoUrl("https://fuss10.elemecdn.com/e/d9/0659bc0c0fc6c2045d86dd2736cfajpeg.jpeg");
obj19.setShopName("华莱士·全鸡汉堡(萧山开元广场店)");
obj2.setShopOpenInfo(obj19);
List<AlibabaAlscConsumerecordSyncRequest.SubOrderOpenInfo> list21 = new ArrayList<AlibabaAlscConsumerecordSyncRequest.SubOrderOpenInfo>();
AlibabaAlscConsumerecordSyncRequest.SubOrderOpenInfo obj22 = new AlibabaAlscConsumerecordSyncRequest.SubOrderOpenInfo();
list21.add(obj22);
obj22.setBizContext("{\"nickName\":\"NaNa\",\"isSyncOrder\":\"true\"}");
obj22.setBizStatus("COMPLETED");
obj22.setBizStatusDesc("已完成");
obj22.setConsumeDesc("请尽快消费");
obj22.setExtInfo("{\"nickName\":\"NaNa\",\"isSyncOrder\":\"true\"}");
AlibabaAlscConsumerecordSyncRequest.FundOpenInfo obj24 = new AlibabaAlscConsumerecordSyncRequest.FundOpenInfo();
obj24.setAmount(1200L);
obj24.setBuyerPayAmt(1000L);
obj24.setMerchantSubsidy(100L);
obj24.setPlatformSubsidy(100L);
list23.setFundOpenInfo(obj24);
obj22.setItemId("642016974699");
obj22.setItemName("香辣鸡排堡+鸡肉卷+中可乐");
obj22.setItemPicUrl("i2/2201245230411/O1CN011EuHJGzjCzMstuW_!!2201245230411-0-koubei.jpg");
obj22.setPrice(1590L);
obj22.setQuantity(1L);
obj22.setValidDesc("请尽快消费");
obj22.setValidEnd(StringUtils.parseDateTime("2020-12-12 12:12:12"));
obj22.setValidStart(StringUtils.parseDateTime("2020-12-12 12:12:12"));
obj2.setSubOrderOpenInfos(list21);
obj2.setVisibility(true);
obj1.setRecordOpenInfo(obj2);
req.setParamRecordOpenSyncRequest(obj1);
AlibabaAlscConsumerecordSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_alsc_consumerecord_sync_response>
    <result>
        <data>true</data>
        <error_code>SR_INVALID_PARAMETER</error_code>
        <error_msg>同步消费记录参数校验异常</error_msg>
        <result_status>1</result_status>
    </result>
</alibaba_alsc_consumerecord_sync_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部