批量取号

POST/ark/open_api/v3/common_controller

请求参数

cpCode

string

快递公司编码

必需

sender

object

必需

寄件人地址必须和订购关系的地址保持一致

address

object

必需

mobile

string

手机号码，明文

可选

name

string

姓名，明文

必需

phone

string

电话号码

可选

tradeOrderInfoList

array [object {6}]

必需

请求面单列表（上限10个）

logisticsServices

string

可选

物流服务，见对接说明附录物流增值服务

objectId

string

可选

请求ID，保证一次批量请求不重复，返回结果基于该值取到对应的快递单号

orderInfo

object

必需

packageInfo

object

必需

recipient

object

必需

收件人信息，支持明文、密文、openAddressId + tradeOrderList三种

templateId

string

电子面单模板ID

可选

extraInfo

string

可选

拓展信息，特殊场景下使

customerCode

string

可选

月结卡号，直营快递公司一般要求必填

brandCode

string

可选

品牌编码，顺丰要求必填

productCode

string

可选

产品编码，仅部分快递公司支持传入，见对接说明附录物流产品类型

callDoorPickUp

string

可选

是否预约上门，仅部分快递公司支持传入

doorPickUpTime

string

可选

预约上门取件时间，'yyyy-MM-dd HH:mm:ss'，仅部分快递公司支持传入

doorPickUpEndTime

string

可选

预约上门取件截止时间，'yyyy-MM-dd HH:mm:ss'，仅部分快递公司支持传入

sellerName

string

必需

店铺名称，对参数内容没有限制

branchCode

string

可选

网点编码，加盟型快递公司一般要求必填

{
  "cpCode": "zto",
  "sender": {
    "address": {
      "city": "",
      "detail": "",
      "district": "",
      "province": "",
      "town": ""
    },
    "mobile": "",
    "name": "",
    "phone": ""
  },
  "tradeOrderInfoList": [
    {
      "logisticsServices": "{\"增值服务1的code\":{增值服务1的值},\"增值服务2的code\":{增值服务2的值} }",
      "objectId": "1",
      "orderInfo": {
        "orderChannelsType": "XIAO_HONG_SHU",
        "tradeOrderList": [
          "string"
        ],
        "buyerMemo": [
          "string"
        ],
        "sellerMemo": [
          "string"
        ]
      },
      "packageInfo": {
        "id": "",
        "items": [
          {
            "count": "",
            "name": "",
            "specification": ""
          }
        ],
        "volume": "",
        "weight": "",
        "length": "",
        "width": "",
        "height": "",
        "totalPackagesCount": "",
        "packagingDescription": "",
        "goodsDescription": "家具",
        "goodValue": ""
      },
      "recipient": {
        "address": {
          "city": "",
          "detail": "",
          "district": "",
          "province": "",
          "town": ""
        },
        "mobile": "",
        "name": "",
        "phone": "",
        "openAddressId": ""
      },
      "templateId": "1"
    }
  ],
  "extraInfo": "",
  "customerCode": "",
  "brandCode": "",
  "productCode": "",
  "callDoorPickUp": "",
  "doorPickUpTime": "",
  "doorPickUpEndTime": "",
  "sellerName": "",
  "branchCode": ""
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

error_code

string

返回值code

必需

success

string

请求是否成功

必需

error_msg

string

错误信息

必需

data

object

必需

wayBillList

array [object {7}]

面单列表

必需

subErrorCode

string

子错误码

必需

{
  "error_code": "0",
  "success": "true",
  "error_msg": "",
  "data": {
    "wayBillList": [
      {
        "objectId": "1",
        "waybillCode": "78689455849606",
        "printData": "{\\\"encryptedData\\\":\\\"打印数据密文\\\",\\\"signature\\\":\\\"MD:lH0r2gNxcIuY7dY3VvV4ag==\\\",\\\"templateURL\\\":\\\"http://cloudprint.cainiao.com/template/standard/644703\\\",\\\"ver\\\":\\\"waybill_print_xiaohongshu_secret\\\"}",
        "parentWaybillCode": "",
        "extraInfo": "",
        "cpCode": "",
        "customerPrintData": "{\\\"data\\\":{\\\"item\\\":[\\\"商品名称\\\"],\\\"order\\\":[\\\"P000000001\\\"]},\\\"templateURL\\\":\\\"https://cloudprint.cainiao.com/template/standard/629505/24\\\"}"
      }
    ],
    "subErrorCode": ""
  }
}

最后修改时间： 1 年前