文档中心 > API类目 > 淘宝物流API

alibaba.logistics.mail.order.delivery.preference.add (运单物流偏好数据新增)

运单物流偏好数据新增

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
mail_order_delivery_preference_top_request_dto MailOrderDeliveryPreferenceTopRequestDTO 必须 运单物流偏好请求入参模型
  • └ request_id
  • String
  • 必须
  • 可以使用uuid
  • 请求id
  • mail_order_delivery_preference_d_t_o_list
  • MailOrderDeliveryPreferenceDTO []
  • 必须
  • 运单物流偏好数据模型
  • └ cp_code
  • String
  • 必须
  • ZTO中通 YTO圆通
  • 物流服务商code
  • └ contact_preference
  • String
  • 可选
  • needTel 需要电联,notNeedTel 不需要电联
  • 电联偏好
  • └ unique_key
  • String
  • 必须
  • 数据唯一键,调用方保证唯一,用于数据幂等
  • 数据唯一键,调用方保证唯一,用于数据幂等
  • └ delivery_preference
  • String
  • 可选
  • homeDelivery 送货上门,selfPick 放代收点
  • 上门偏好
  • └ logistics_node
  • String
  • 必须
  • tmsDelivery 配派送,contactBeforeSign 签收前电联
  • 物流节点
  • └ mail_order_id
  • String
  • 必须
  • 运单号
  • 运单号
  • └ preference_source
  • String
  • 必须
  • userSetting 用户设置,mailOrderSetting 运单设置
  • 偏好来源

响应参数

名称 类型 示例值 描述
api_result AscpCustomerServiceResult 运单偏好数据保存接口返回值
  • data
  • MailOrderDeliveryPreferenceTopResponseDTO
  • 运单偏好数据保存结果模型
  • └ success_mail_order_unique_key_list
  • String []
  • 新增成功运单数据uniqueKey列表
  • └ failed_mail_order_unique_key_list
  • String []
  • 新增失败运单数据uniqueKey列表
  • └ failed_mail_order_reason_map
  • String
  • key:1234 value:ADD_MAIL_ORDER_DELIVERY_PREFERENCE_FAILED 错误码梳理如下:1)UNIQUE_KEY_IS_NULL 数据unique_key唯一键不能为空 2)MAIL_ORDER_ID_IS_NULL 运单号不能为空 3)CP_CODE_IS_NULL cpCode不能为空 4)LOGISTICS_NODE_IS_NULL 物流节点不能为空 5)PREFERENCE_SOURCE_IS_NULL 物流偏好来源不能为空
  • 新增失败原因(key:运单数据uniqueKey,value:失败原因)
  • └ error
  • String
  • 错误码 如果是批量运单数据新增请求,如果部分运单新增成功,部分运单数据新增失败,错误码会返回PART_SUCCESS,新增失败的运单数据uniqueKey和失败原因可以在failed_mail_order_reason_map 获取到。如果是单笔运单数据新增请求,错误码会返回BIZ_ERROR
  • 请求错误码
  • └ message
  • String
  • 错误码 如果是批量运单数据新增请求,如果部分运单新增成功,部分运单数据新增失败,错误信息会返回【部分成功】,新增失败的运单数据uniqueKey和失败原因可以在failed_mail_order_reason_map 获取到。如果是单笔运单数据新增请求,错误信息会返回【业务异常】
  • 请求错误信息
  • └ success
  • Boolean
  • 如果是批量运单数据新增请求,全部运单数据新增成功才会返回true 成功,部分成功或者都不成功,返回false
  • 请求是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaLogisticsMailOrderDeliveryPreferenceAddRequest req = new AlibabaLogisticsMailOrderDeliveryPreferenceAddRequest();
AlibabaLogisticsMailOrderDeliveryPreferenceAddRequest.MailOrderDeliveryPreferenceTopRequestDTO obj1 = new AlibabaLogisticsMailOrderDeliveryPreferenceAddRequest.MailOrderDeliveryPreferenceTopRequestDTO();
obj1.setRequestId("可以使用uuid");
List<AlibabaLogisticsMailOrderDeliveryPreferenceAddRequest.MailOrderDeliveryPreferenceDTO> list3 = new ArrayList<AlibabaLogisticsMailOrderDeliveryPreferenceAddRequest.MailOrderDeliveryPreferenceDTO>();
AlibabaLogisticsMailOrderDeliveryPreferenceAddRequest.MailOrderDeliveryPreferenceDTO obj4 = new AlibabaLogisticsMailOrderDeliveryPreferenceAddRequest.MailOrderDeliveryPreferenceDTO();
list3.add(obj4);
obj4.setCpCode("ZTO中通 YTO圆通");
obj4.setContactPreference("needTel 需要电联,notNeedTel 不需要电联");
obj4.setUniqueKey("数据唯一键,调用方保证唯一,用于数据幂等");
obj4.setDeliveryPreference("homeDelivery 送货上门,selfPick 放代收点");
obj4.setLogisticsNode("tmsDelivery 配派送,contactBeforeSign 签收前电联");
obj4.setMailOrderId("运单号");
obj4.setPreferenceSource("userSetting 用户设置,mailOrderSetting 运单设置");
obj1.setMailOrderDeliveryPreferenceDTOList(list3);
req.setMailOrderDeliveryPreferenceTopRequestDto(obj1);
AlibabaLogisticsMailOrderDeliveryPreferenceAddResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_logistics_mail_order_delivery_preference_add_response>
    <api_result>
        <data>
            <failed_mail_order_reason_map>key:1234 value:ADD_MAIL_ORDER_DELIVERY_PREFERENCE_FAILED 错误码梳理如下:1)UNIQUE_KEY_IS_NULL 数据unique_key唯一键不能为空 2)MAIL_ORDER_ID_IS_NULL 运单号不能为空 3)CP_CODE_IS_NULL cpCode不能为空 4)LOGISTICS_NODE_IS_NULL 物流节点不能为空 5)PREFERENCE_SOURCE_IS_NULL 物流偏好来源不能为空</failed_mail_order_reason_map>
        </data>
        <error>错误码 如果是批量运单数据新增请求,如果部分运单新增成功,部分运单数据新增失败,错误码会返回PART_SUCCESS,新增失败的运单数据uniqueKey和失败原因可以在failed_mail_order_reason_map 获取到。如果是单笔运单数据新增请求,错误码会返回BIZ_ERROR</error>
        <message>错误码 如果是批量运单数据新增请求,如果部分运单新增成功,部分运单数据新增失败,错误信息会返回【部分成功】,新增失败的运单数据uniqueKey和失败原因可以在failed_mail_order_reason_map 获取到。如果是单笔运单数据新增请求,错误信息会返回【业务异常】</message>
        <success>如果是批量运单数据新增请求,全部运单数据新增成功才会返回true 成功,部分成功或者都不成功,返回false</success>
    </api_result>
</alibaba_logistics_mail_order_delivery_preference_add_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

返回
顶部