文档中心 > API类目 > 菜鸟发货工作台API

cainiao.consignplatform.order.create (菜鸟发货工作台创建订单)

菜鸟发货工作台,商家或者isv通过api进行订单写入操作

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
create_request OrderCreateRequest 必须 订单创建入参
  • └ user_memo
  • String
  • 可选
  • 衣服
  • 商家备注
  • receive_address
  • AddressDtoForTop
  • 必须
  • 收件地址
  • └ country_name
  • String
  • 必须
  • 中国
  • 国家
  • └ prov_name
  • String
  • 必须
  • 浙江省
  • 省份
  • └ city_name
  • String
  • 必须
  • 杭州市
  • 城市
  • └ area_name
  • String
  • 必须
  • 西湖区
  • └ town_name
  • String
  • 可选
  • 蒋村街道
  • 街道
  • └ address_detail
  • String
  • 必须
  • 文一西路西溪首座
  • 详细地址
  • └ outer_order_id
  • String
  • 必须
  • 110022
  • 外部订单id,会用来做幂等,需要保证唯一
  • receiver
  • PersonDto
  • 必须
  • 收件人
  • └ phone
  • String
  • 可选
  • 0571-00000001
  • 收件固定电话
  • └ mobile_phone
  • String
  • 必须
  • 18612345678
  • 收件电话
  • └ user_name
  • String
  • 必须
  • 测试用户b
  • 收件人
  • sub_order_list
  • SubOrderDto []
  • 可选
  • 子订单列表
  • └ outer_order_id
  • String
  • 必须
  • 110022-1
  • 外部子订单id
  • └ amount
  • Number
  • 必须
  • 1
  • 商品数量
  • └ goods_name
  • String
  • 必须
  • 红色卫衣
  • 商品名称
  • └ price
  • Number
  • 可选
  • 1000
  • 商品价格(单位分)
  • └ picture_url
  • String
  • 可选
  • https://img.alicdn.com/tfs/TB1alJFS8LoK1RjSZFuXXXn0XXa-690-500.png
  • 商品图片链接
  • └ goods_id
  • String
  • 必须
  • abc123
  • 商品id
  • └ category
  • Number
  • 必须
  • 6
  • 商品类别。1 日用品; 2 食品; 3 文件; 4 衣物; 5 数码产品; 6 其他
  • └ buyer_memo
  • String
  • 可选
  • 尽快发货
  • 买家留言
  • └ order_source
  • String
  • 必须
  • TMJL
  • 订单来源

响应参数

名称 类型 示例值 描述
fail_message String 参数无效 失败信息
fail_code String PARAM_INVALID 失败code
result Boolean false 创建是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoConsignplatformOrderCreateRequest req = new CainiaoConsignplatformOrderCreateRequest();
CainiaoConsignplatformOrderCreateRequest.OrderCreateRequest obj1 = new CainiaoConsignplatformOrderCreateRequest.OrderCreateRequest();
obj1.setUserMemo("衣服");
CainiaoConsignplatformOrderCreateRequest.AddressDtoForTop obj2 = new CainiaoConsignplatformOrderCreateRequest.AddressDtoForTop();
obj2.setCountryName("中国");
obj2.setProvName("浙江省");
obj2.setCityName("杭州市");
obj2.setAreaName("西湖区");
obj2.setTownName("蒋村街道");
obj2.setAddressDetail("文一西路西溪首座");
obj1.setReceiveAddress(obj2);
obj1.setOuterOrderId("110022");
CainiaoConsignplatformOrderCreateRequest.PersonDto obj3 = new CainiaoConsignplatformOrderCreateRequest.PersonDto();
obj3.setPhone("0571-00000001");
obj3.setMobilePhone("18612345678");
obj3.setUserName("测试用户b");
obj1.setReceiver(obj3);
List<CainiaoConsignplatformOrderCreateRequest.SubOrderDto> list5 = new ArrayList<CainiaoConsignplatformOrderCreateRequest.SubOrderDto>();
CainiaoConsignplatformOrderCreateRequest.SubOrderDto obj6 = new CainiaoConsignplatformOrderCreateRequest.SubOrderDto();
list5.add(obj6);
obj6.setOuterOrderId("110022-1");
obj6.setAmount(1L);
obj6.setGoodsName("红色卫衣");
obj6.setPrice(1000L);
obj6.setPictureUrl("https://img.alicdn.com/tfs/TB1alJFS8LoK1RjSZFuXXXn0XXa-690-500.png");
obj6.setGoodsId("abc123");
obj6.setCategory(6L);
obj1.setSubOrderList(list5);
obj1.setBuyerMemo("尽快发货");
obj1.setOrderSource("TMJL");
req.setCreateRequest(obj1);
CainiaoConsignplatformOrderCreateResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_consignplatform_order_create_response>
    <fail_message>参数无效</fail_message>
    <fail_code>PARAM_INVALID</fail_code>
    <result>false</result>
</cainiao_consignplatform_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>

错误码解释

错误码 错误描述 解决方案
IB_PARAM_VALIDATE_FAIL 参数异常 按照提示补齐参数即可

API工具

如何获得此API

FAQ

返回
顶部