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

taobao.logistics.file.upload.apply (文件上传URL申请)

申请文件上传签名URL

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
file_upload_apply_req FileUploadApplyReqDto 可选 文件上传申请请求
  • └ request_id
  • String
  • 必须
  • f2668878-437c-4580-9a6f-917906f18ea7
  • 调用方生成的请求ID,用于唯一标识一次上传操作
  • └ owner_code
  • String
  • 可选
  • AX766232
  • 货主编码
  • └ resource_code
  • String
  • 必须
  • STA
  • 仓/配等资源编码
  • └ resource_type
  • String
  • 必须
  • WAREHOUSE
  • 资源类型(WAREHOUSE=仓、 DELIVERY=配)
  • biz_context
  • FileOperationContextDto
  • 必须
  • 文件上传的业务上下文
  • context
  • └ order_code
  • String
  • 可选
  • QG8877623
  • 文件关联的上下文作业单号
  • └ order_type
  • String
  • 必须
  • TOB_CLEARANCE
  • 文件关联的上下文作业单类型(orderCode有值时必填)
  • └ operate_time
  • String
  • 可选
  • 2024-01-23 21:25:30
  • 目标文件关联的业务操作时间(YYYY-MM-DD HH24:MI:SS)
  • └ extend_props
  • String
  • 可选
  • {}
  • 扩展属性, Map对应的Json
  • file_meta
  • FileMetaDataDto
  • 必须
  • 待上传文件的元数据信息
  • fileMeta
  • └ content_length
  • Number
  • 必须
  • 1024
  • 待上传文件字节数大小,单位Byte
  • └ content_type
  • String
  • 必须
  • image/jpeg
  • 待上传文件的MIME类型
  • └ content_md5
  • String
  • 必须
  • 202CB962AC59075B964B07152D234B70
  • 待上传文件MD5摘要
  • └ file_name
  • String
  • 必须
  • 理货差异货品条码.jpeg
  • 文件名称描述
  • └ extend_props
  • String
  • 可选
  • {}
  • 扩展属性, Map对应的Json
  • └ extend_props
  • String
  • 可选
  • {}
  • 扩展属性, Map对应的Json

响应参数

名称 类型 示例值 描述
spi_result SpiResult spiResult
  • └ success
  • Boolean
  • true
  • 是否成功: true-成功;false-失败
  • file_upload_apply_resp
  • FileUploadApplyRespDto
  • -
  • 接口返回数据
  • └ signed_url
  • String
  • https://xxx?Expires=1706001694&OSSAccessKeyId=TMP.3Ki9vTq5aHK6eb&Signature=GXjs4MFiyyKnUkgw3Lg5GYrGP7A%3D
  • 文件上传的签名URL
  • └ file_key
  • String
  • test/order/pic.jpeg
  • 文件Key
  • └ token
  • String
  • f28385356763e103050cc1307ea87830eade302bfbbb34f3362ff34d1e7fbaa2
  • 文件上传授权Token
  • └ expire_time
  • Number
  • 1706001694
  • 授权URL的过期时间戳,单位s
  • └ error_code
  • String
  • ERROR_OWNER_NOT_EXIST
  • 接口错误码
  • └ error_message
  • String
  • 货主不存在
  • 接口错误描述

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsFileUploadApplyRequest req = new LogisticsFileUploadApplyRequest();
LogisticsFileUploadApplyRequest.FileUploadApplyReqDto obj1 = new LogisticsFileUploadApplyRequest.FileUploadApplyReqDto();
obj1.setRequestId("f2668878-437c-4580-9a6f-917906f18ea7");
obj1.setOwnerCode("AX766232");
obj1.setResourceCode("STA");
obj1.setResourceType("WAREHOUSE");
LogisticsFileUploadApplyRequest.FileOperationContextDto obj2 = new LogisticsFileUploadApplyRequest.FileOperationContextDto();
obj2.setOrderCode("QG8877623");
obj2.setOrderType("TOB_CLEARANCE");
obj2.setOperateTime("2024-01-23 21:25:30");
obj2.setExtendProps("{}");
obj1.setBizContext(obj2);
LogisticsFileUploadApplyRequest.FileMetaDataDto obj3 = new LogisticsFileUploadApplyRequest.FileMetaDataDto();
obj3.setContentLength(1024L);
obj3.setContentType("image/jpeg");
obj3.setContentMd5("202CB962AC59075B964B07152D234B70");
obj3.setFileName("理货差异货品条码.jpeg");
obj3.setExtendProps("{}");
obj1.setFileMeta(obj3);
obj1.setExtendProps("{}");
req.setFileUploadApplyReq(obj1);
LogisticsFileUploadApplyResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<logistics_file_upload_apply_response>
    <spi_result>
        <success>true</success>
        <file_upload_apply_resp>
            <signed_url>https://xxx?Expires=1706001694&amp;OSSAccessKeyId=TMP.3Ki9vTq5aHK6eb&amp;Signature=GXjs4MFiyyKnUkgw3Lg5GYrGP7A%3D</signed_url>
            <file_key>test/order/pic.jpeg</file_key>
            <token>f28385356763e103050cc1307ea87830eade302bfbbb34f3362ff34d1e7fbaa2</token>
            <expire_time>1706001694</expire_time>
        </file_upload_apply_resp>
        <error_code>ERROR_OWNER_NOT_EXIST</error_code>
        <error_message>货主不存在</error_message>
    </spi_result>
</logistics_file_upload_apply_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

返回
顶部