小包批次创建

该接口仅支持小包转运物流模式

接口描述

第三方商家调用该接口将包裹号和重量传至小红书,生成小包批次。请保存小包批次号(TPS号)以创建发运。

批量订单上传有可能因某些订单状态不合法(如已取消),导致订单无法加入已生成的批次内,这种情况不影响已经生成批次的订单。批次号返回格式请参考返回示例。

URL

/ark/open_api/v0/packages/transfer_batches

请求方法

POST

请求body (content-type:application/json;charset=utf8)

{
    "packages":[
        {
            "package_id": "P492576266631666666",
            "weight": 2
        },
        {
            "package_id": "P492576266631888888",
            "weight": 1.5
        }
    ]
}

Request Parameters

字段名称 类型 说明
package_id String 包裹ID(必填)
weight Float 包裹重量,单位kg(必填)

返回示例 状态码 200 (content-type: application/json; charset=utf8)

{
    "error_code": 0,
    "data": "TPS1286666",
    "error_msg": null,
    "success": true
}

返回示例 状态码 200 (content-type: application/json; charset=utf8)

由于批次生成可能因为网络等其他原因失败,无法被加入批次的订单将会以以下数据结构抛出。 上传生成批次的订单号部分成功的时,success值仍然会true,已生成的批次号也会显示,开发者需根据data结构中error_msgs的标准json对象,以map键值对获取失败订单的原因,并做相应业务处理。

{
    "error_code": 0,
    "data": {
        "total":100,
        "success_count":99,
        "batch":"TPS10000002",
        "error_msgs":{
          "P492576266631666665":"订单不存在或状态错误"
        }
    },
    "error_msg": null,
    "success": true
}

返回示例 状态码 200 (content-type: application/json; charset=utf8)

上传所有生成批次的订单失败的情况,将会把所有错误以如下结构抛出。

{
    "error_code": -7031,
    "data":null,
    "error_msg": {
        "P492576266631666666":"订单不存在或状态错误",
        "P492576266631666667":"订单不存在或状态错误",
        "P492576266631666669":"订单已生成批次号:TPS000002"
    },
    "success": false
}

返回参数

字段名称 类型 说明
total Int 上传订单号总数
success_count Int 上传订单号成功生成批次数
error_msgs Map 上传失败订单的错误信息,以订单号(key),错误信息(message)显示