V兔API开放平台

参数	类型	必选	描述
shop_id	string	是	店铺 id
sender_info	Struct	是	寄件人信息
-address	Struct	是	寄件人地址信息
--country_code	String	是	国家编码（默认 CHN，目前只有国内业务）
--province_name	String	是	省名称
--city_name	String	是	市名称
--district_name	String	是	区/县名称
--street_name	String	否	街道名称
--detail_address	String	是	剩余详细地址
-contact	Struct	是	寄件人联系信息
--name	String	是	寄件人姓名
--phone	String	否	寄件人固话（和 mobile 二选一）
--mobile	String	否	寄件人移动电话（和 phone 二选一）
logistics_code	String	是	物流服务商编码
order_infos	List	是	详细订单列表
-order_id	String	是	订单号（合单情况下，isv 只需传其中一个订单号，传入的订单号需去掉末尾后缀字母 A)；非抖音订单长度仅支持 32 个字符，格式：数字、大小写字母及“-”、“/”2 种分隔符的组合字符串，例如：Doudian-123456
-pack_id	String	否	包裹 id（只能传入数字、字母和下划线；大小写敏感，即 123A,123a 不可当做相同 ID，否则存在一定可能取号失败）一单一包裹是不需要传，有 2 个以上时，从第二个开始都需要传不同 id
-service_list	List	否	增值服务列表
--service_code	String	否	增值服务类型
--service_value	String	否	增值服务对应的 value 值，如果增值类型涉及金额会校验，单位：分
-product_type	String	否	快递产品类型
-pay_method	Int16	否	支付方式：1-寄付月结，2-寄付现结）若不传，默认为商家与物流商网点约定的支付方式
-pay_amount	Int64	否	运费金额，单位为分
-pod_model_address	Struct	否	回单寄回地址
--country_code	String	否	国家编码（默认 CHN，目前只有国内业务）
--province_name	String	否	省名称
--city_name	String	否	市名称
--district_name	String	否	区/县名称
--street_name	String	否	街道名称
--detail_address	String	否	剩余详细地址
-receiver_info	Struct	是	收件人信息
--address	Struct	是	收件人地址信息
---country_code	String	是	国家编码（默认中国 CHN）
---province_name	String	是	省名称
---city_name	String	是	市名称
---district_name	String	是	区/县名称
---street_name	String	否	街道名称
---detail_address	String	是	剩余详细地址，支持密文
--contact	Struct	是	收件人联系信息
---name	String	否	收件人姓名，支持密文
---phone	String	否	收件人固话（和 mobile 二选一）
---mobile	String	否	收件人移动电话（和 phone 二选一），支持密文
-items	List	否	商品明细列表
--item_name	String	是	商品名称
--item_specs	String	否	商品规格
--item_count	Int32	是	商品数量
--item_volume	Int32	否	单件商品体积（cm3
--item_weight	Int32	否	单件商品重量（g)
--item_net_weight	Int32	否	单件总净重量（g）
-sender_fetch_time	String	否	要求上门取件时间段
-is_sign_back	Int16	否	是否返回签回单（签单返还）的运单号，支持以下值：1：要求 0：不要求"
-remark	String	否	订单备注
-extra	String	否	备用扩展字段
-total_pack_count	Int32	否	包裹数量包含了母单号和子单号数量，所以如果商家发母子件，包裹数量必须 ≥2 才可以不传默认就是一单一包裹
-total_weight	String	否	商品总重量，单位：克（仅支持顺丰物流使用）
-total_length	String	否	商品总长，单位：cm（仅支持顺丰物流使用）
-total_width	String	否	商品总宽，单位：cm（仅支持顺丰物流使用）
-total_height	String	否	商品总高，单位：cm（仅支持顺丰物流使用）
-volume	String	否	商品总体积，单位：cm3（仅支持顺丰物流使用）
-warehouse	Struct	否	仓、门店、总对总发货
--is_sum_up	Bool	是	true 总对总门店发货
--wh_code	String	否	仓库 id 编码
--wh_order_no	String	否	仓库订单号(丹鸟等仓发链路使用)
--delivery_type	String	否	发货方式（用于韵达、京东链路）1 或不传-普通发货 2-门店发货 3-仓库发货
-net_info	Struct	否	总对总信息门店信息
--category	String	否	物流服务商类型，直营/加盟
--net_code	String	否	网点编码，当 category 为加盟类型时，该字段必填；为直营类型时可不传；对总模式该字段均为非必填
--monthly_account	String	否	总对总账号月结账号
--secret_key	String	否	总对总密码
-shipping_code	String	否	物料码
user_id	Int64	否	共享账号场景下需传，代表实际使用取号服务的 shop_id（需与 order_id 匹配）；若无法获取到该 shop_id，value 传值 -1
delivery_req	Struct	否	派送要求（目前仅德邦支持）
-is_center_delivery	Bool	否	true
-is_pickup_self	Bool	否	true
order_channel	String	否	订单渠道来源编码，具体请参考下单渠道来源编码表，当 order_id 订单号为非抖音订单时必传
vvtype	int	否	普通版 1，增强版 2，专业版 3，无效数据或则不传默认为 3 专业版 2:4

请求示例

请求代码示例

cURL请求代码示例

PHP请求代码示例

JAVA请求代码示例

响应参数

名称	类型	示例值	描述
ebill_infos	List	-	电子面单信息列表
-order_id	String	202011809	订单号
-pack_id	String	1	包裹 id
-track_no	String	202011809	运单号
-sort_code	String	400-W00 000	分拣码（三段码）
-package_center_code	String	1	集包地代码
-package_center_name	String	1	集包名称
-short_address_code	String	1	大头笔编码
-short_address_name	String	1	大头笔名称
-extra_resp	String	1	额外打印信息（众邮、京东、丰网使用），具体请参考抖音电商电子面单对接文档附录 4
-sub_waybill_codes	String	13,434,556	子母件列表英文逗号分隔
-order_channel	String	c	2；详情请看文档映射表
-shipping_code	String	34343	快递商侧系统生成的寄件码
err_infos	List	-	错误信息列表
-order_id	String	1	订单号
-pack_id	String	1	包裹 id
-err_code	String	10701	错误码
-err_msg	String	电子面单库存不足	错误信息
-order_channel	String	2	2；详情请看文档映射表
withholding_money	int		该接口扣费金额（点券）

返回数据

{
  "code": 0,
  "msg": "操作成功",
  "msec": 1469,
  "time": 1617270403,
  "data": {
    "ebill_infos": [
      {
        "extra_resp": "1",
        "order_channel": "c",
        "order_id": "202011809",
        "pack_id": "1",
        "package_center_code": "1",
        "package_center_name": "1",
        "shipping_code": "34343",
        "short_address_code": "1",
        "short_address_name": "1",
        "sort_code": "400-W00 000",
        "sub_waybill_codes": "13,434,556",
        "track_no": "202011809"
      }
    ],
    "err_infos": [
      {
        "err_code": "10701",
        "err_msg": "电子面单库存不足",
        "order_channel": "2",
        "order_id": "1",
        "pack_id": "1"
      }
    ]
  }
  }
}

响应代码

代码	代码描述	解决方案
0	成功
100	请求参数错误	检查您的请求参数是否正确
101	请求超时，请重试	检查您的网络情况或者联系客服解决
103	旺旺账号不存在	检查您输入的旺旺号是否正确
200	系统错误，请联系客服	检查您的接口地址填写是否正确，其他问题联系客服解决
202	系统错误，请稍后再试	稍后重试，或则连接对接群
203	暂不支持当前接口
204	请求异常：无该接口权限，请前往官网开通正式接口。	前往官网开通该接口权限
204	请求异常：API 调用次数不足，请前往网站兑换次数。	前往官网充值该接口调用次数
302	未授权店铺	根据返回链接进行扫码授权

商家 ERP/ISV 向字节电子面单系统获取单号和打印信息

请求头参数

请使用新的生成 token 接口 点击查看详情

请求参数

请求示例

请求代码示例

响应参数

返回数据

响应代码

请使用新的生成 token 接口点击查看详情