文档中心 > API类目 > 盒马接力go对接API

alibaba.wdk.vertical.nb.order.create (盒马NB渠道侧创单)

盒马NB渠道侧创单

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
request_param CreateOrderRequest 必须 盒马NB外侧创单请求入参
  • └ out_main_order_id
  • String
  • 必须
  • XX20210000001
  • 必传-外部主单id(不能超过30位)
  • └ out_user_id
  • String
  • 必须
  • XX1321001
  • 必传-外部用户唯一id(不超过32位)
  • delivery_params
  • DeliveryParams
  • 必须
  • 物流信息参数
  • station_params
  • StationParams
  • 可选
  • 自提点参数
  • └ station_code
  • String
  • 可选
  • CSSJ201200006
  • 必传-自提点编码
  • └ station_place
  • String
  • 可选
  • 嘉兴市南湖区城东路179号
  • 自提点地址
  • └ station_poi
  • String
  • 可选
  • 120.763192,30.764503
  • 自提点POI
  • └ expect_arrive_time
  • String
  • 可选
  • 2021-06-07 08:00-20:00
  • 必传-期望送达时间片
  • └ commander_name
  • String
  • 可选
  • 张三
  • 传自提点名称
  • └ station_name
  • String
  • 可选
  • 嘉兴站自提点
  • 自提点名称
  • └ channel_shop_id
  • String
  • 必须
  • HM20210001
  • 必传-渠道店id
  • └ channel
  • String
  • 必须
  • APP
  • 必传-示例固定值
  • └ terminal
  • String
  • 必须
  • jlgo_wx_applet
  • 必传-示例固定值
  • └ scenario_group
  • String
  • 必须
  • HEMA_SELFTAKE
  • 必传-示例固定值
  • receiver_params
  • ReceiverParams
  • 可选
  • 收货人参数
  • └ phone
  • String
  • 可选
  • 121****1331
  • 必传-收货人手机号
  • └ name
  • String
  • 可选
  • 小茗同学
  • 必传-收货人姓名
  • delivery_address_params
  • DeliveryAddressParams
  • 可选
  • 地址组件信息
  • └ address_detail
  • String
  • 可选
  • 盒马空投点(8号楼)阿里巴巴西溪园区内8号楼1楼东侧
  • 详细地址
  • └ mobile
  • String
  • 可选
  • 13964793128
  • 收件人手机号
  • └ sgp
  • String
  • 可选
  • 盒马空投点(8号楼)
  • 地址摘要
  • └ sgll
  • String
  • 可选
  • 120.029623,30.278964
  • 经纬度
  • └ full_name
  • String
  • 可选
  • 曹操
  • 收件人
  • out_items_info_list
  • OutItemParams []
  • 必须
  • 外部子单信息集合
  • └ item_id
  • String
  • 必须
  • s20210006
  • 必传-itemId
  • └ sku_id
  • String
  • 必须
  • s2021200001
  • skuId
  • └ quantity
  • Number
  • 必须
  • 1
  • 购买数量
  • └ out_sub_order_id
  • String
  • 必须
  • XX202000001
  • 外部子订单id
  • item_ex_params
  • ItemExParams
  • 必须
  • 子订单拓展字段
  • └ custom_price
  • Number
  • 必须
  • 1000
  • 实付金额(单位分)
  • └ inventory_quantity
  • String
  • 必须
  • 1
  • 库存数量-和quantity一致
  • └ out_mobile
  • String
  • 可选
  • 13212311111
  • 外部手机号
  • └ expect_arrive_date
  • String
  • 必须
  • 2021-09-08
  • 期望送达日期
  • └ expect_arrive_time
  • String
  • 必须
  • 08:00-20:00
  • 期望送达时间
  • └ ip
  • String
  • 可选
  • 11.22.22.33
  • 用户操作ip
  • └ user_agent
  • String
  • 可选
  • Mozilla/5.0 (iPhone; CPU iPhone OS 11_0 like Mac OS X) AppleWebKit/604.1.38 (KHTML, like Gecko) Version/11.0
  • 前端ua
  • └ out_shop_type
  • String
  • 可选
  • HYD
  • 外部商家类型
  • └ third_union_id
  • String
  • 可选
  • 123
  • 外部unionId
  • └ user_avatar
  • String
  • 可选
  • http://11
  • 用户头像
  • grouping_activity_ext_param
  • GroupingActivityExtParam
  • 可选
  • 拼团活动下单入参
  • └ grouping_activity_instance_id
  • String
  • 可选
  • 1
  • 拼团活动实例id
  • └ grouping_activity_id
  • String
  • 可选
  • 1
  • 拼团活动模版id
  • └ total_price
  • Number
  • 可选
  • 12
  • 总价, 单位为分
  • └ source
  • String
  • 可选
  • JLGO
  • 拼团场景传nbpt,其他场景JLGO
  • share_info
  • ShareInfo
  • 可选
  • shareInfo
  • 分享回流相关信息
  • └ share_id_type
  • String
  • 可选
  • shareIdType
  • 分享id类型,HEMA_SECRET_USERID、JLGO_USERID
  • └ share_id
  • String
  • 可选
  • shareId
  • 分享id

响应参数

名称 类型 示例值 描述
result Result 接口返回model
  • └ code
  • String
  • code
  • code
  • data
  • OutCreateOrderResponse
  • 1234
  • 返回素材id
  • └ out_main_order_id
  • String
  • XX20210000001
  • 外部主订单
  • └ hm_main_order_id
  • String
  • HM20210006688
  • 盒马主订单id
  • out_sub_order_params
  • OutSubOrderParams []
  • params
  • 子订单信息集
  • └ item_id
  • String
  • s20210006
  • itemId
  • └ hm_sub_order_id
  • String
  • HM2021008866
  • 盒马子订单id
  • └ out_sub_order_id
  • String
  • XX202000001
  • 外部子订单id
  • └ success
  • Boolean
  • false
  • 是否成功
  • └ message
  • String
  • xx
  • message

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaWdkVerticalNbOrderCreateRequest req = new AlibabaWdkVerticalNbOrderCreateRequest();
AlibabaWdkVerticalNbOrderCreateRequest.CreateOrderRequest obj1 = new AlibabaWdkVerticalNbOrderCreateRequest.CreateOrderRequest();
obj1.setOutMainOrderId("XX20210000001");
obj1.setOutUserId("XX1321001");
AlibabaWdkVerticalNbOrderCreateRequest.DeliveryParams obj2 = new AlibabaWdkVerticalNbOrderCreateRequest.DeliveryParams();
AlibabaWdkVerticalNbOrderCreateRequest.StationParams obj3 = new AlibabaWdkVerticalNbOrderCreateRequest.StationParams();
obj3.setStationCode("CSSJ201200006");
obj3.setStationPlace("嘉兴市南湖区城东路179号");
obj3.setStationPoi("120.763192,30.764503");
obj3.setExpectArriveTime("2021-06-07 08:00-20:00");
obj3.setCommanderName("张三");
obj3.setStationName("嘉兴站自提点");
obj2.setStationParams(obj3);
obj2.setChannelShopId("HM20210001");
obj2.setChannel("APP");
obj2.setTerminal("jlgo_wx_applet");
obj2.setScenarioGroup("HEMA_SELFTAKE");
AlibabaWdkVerticalNbOrderCreateRequest.ReceiverParams obj4 = new AlibabaWdkVerticalNbOrderCreateRequest.ReceiverParams();
obj4.setPhone("121****1331");
obj4.setName("小茗同学");
obj2.setReceiverParams(obj4);
AlibabaWdkVerticalNbOrderCreateRequest.DeliveryAddressParams obj5 = new AlibabaWdkVerticalNbOrderCreateRequest.DeliveryAddressParams();
obj5.setAddressDetail("盒马空投点(8号楼)阿里巴巴西溪园区内8号楼1楼东侧");
obj5.setMobile("13964793128");
obj5.setSgp("盒马空投点(8号楼)");
obj5.setSgll("120.029623,30.278964");
obj5.setFullName("曹操");
obj2.setDeliveryAddressParams(obj5);
obj1.setDeliveryParams(obj2);
List<AlibabaWdkVerticalNbOrderCreateRequest.OutItemParams> list7 = new ArrayList<AlibabaWdkVerticalNbOrderCreateRequest.OutItemParams>();
AlibabaWdkVerticalNbOrderCreateRequest.OutItemParams obj8 = new AlibabaWdkVerticalNbOrderCreateRequest.OutItemParams();
list7.add(obj8);
obj8.setItemId("s20210006");
obj8.setSkuId("s2021200001");
obj8.setQuantity(1L);
obj8.setOutSubOrderId("XX202000001");
AlibabaWdkVerticalNbOrderCreateRequest.ItemExParams obj10 = new AlibabaWdkVerticalNbOrderCreateRequest.ItemExParams();
obj10.setCustomPrice(1000L);
obj10.setInventoryQuantity("1");
list9.setItemExParams(obj10);
obj1.setOutItemsInfoList(list7);
obj1.setOutMobile("13212311111");
obj1.setExpectArriveDate("2021-09-08");
obj1.setExpectArriveTime("08:00-20:00");
obj1.setIp("11.22.22.33");
obj1.setUserAgent("Mozilla/5.0 (iPhone; CPU iPhone OS 11_0 like Mac OS X) AppleWebKit/604.1.38 (KHTML, like Gecko) Version/11.0");
obj1.setOutShopType("HYD");
obj1.setThirdUnionId("123");
obj1.setUserAvatar("http://11");
AlibabaWdkVerticalNbOrderCreateRequest.GroupingActivityExtParam obj11 = new AlibabaWdkVerticalNbOrderCreateRequest.GroupingActivityExtParam();
obj11.setGroupingActivityInstanceId("1");
obj11.setGroupingActivityId("1");
obj11.setTotalPrice(12L);
obj1.setGroupingActivityExtParam(obj11);
obj1.setSource("JLGO");
AlibabaWdkVerticalNbOrderCreateRequest.ShareInfo obj12 = new AlibabaWdkVerticalNbOrderCreateRequest.ShareInfo();
obj12.setShareIdType("shareIdType");
obj12.setShareId("shareId");
obj1.setShareInfo(obj12);
req.setRequestParam(obj1);
AlibabaWdkVerticalNbOrderCreateResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_wdk_vertical_nb_order_create_response>
    <result>
        <code>code</code>
        <data>
            <out_main_order_id>XX20210000001</out_main_order_id>
            <hm_main_order_id>HM20210006688</hm_main_order_id>
            <out_sub_order_params>
                <out_sub_order_params>
                    <item_id>s20210006</item_id>
                    <hm_sub_order_id>HM2021008866</hm_sub_order_id>
                    <out_sub_order_id>XX202000001</out_sub_order_id>
                </out_sub_order_params>
            </out_sub_order_params>
        </data>
        <success>false</success>
        <message>xx</message>
    </result>
</alibaba_wdk_vertical_nb_order_create_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

返回
顶部