导出运单详情(自定义模板)(Export Shipment Detail V2)
/api/shipper/v1/export/shipmentDetailv2 |
POST |
该接口用于根据自定义模板导出运单详细数据,返回 Excel 文件流。
参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
sessionId | String | 是 | 登录会话ID |
language | String | 是 | 语言 |
Content-Type | String | 是 | application/json;charset=UTF-8 |
Accept | String | 是 | application/json, text/plain, / |
语言取值:
值 | 说明 |
|---|---|
zh_CN | 中文 |
en_US | 英文 |
参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
templateId | String | 是 | 自定义模板ID |
type | Number | 是 | 导出功能类型,0=运单 |
queryType | String | 是 | 查询类型 |
dateType | String | 是 | 日期类型 |
startDate | String | 否 | 开始时间,格式:yyyy-MM-dd HH:mm:ss |
endDate | String | 否 | 结束时间,格式:yyyy-MM-dd HH:mm:ss |
pageNum | Number | 否 | 页码,默认1 |
pageSize | Number | 否 | 每页数量,默认100 |
status | Array | 否 | 订单状态列表 |
shippers | Array | 否 | 发件人ID列表 |
billingPartys | Array | 否 | 付款方ID列表 |
channels | Array | 否 | 服务渠道ID列表 |
recipientName | String | 否 | 收件人姓名 |
city | String | 否 | 收件城市 |
state | String | 否 | 收件州/省 |
postcode | String | 否 | 收件邮编 |
countrys | Array | 否 | 目的国家列表 |
sku | String | 否 | SKU |
helds | Array | 否 | 扣留状态列表 |
operator | String | 否 | 操作员 |
platform | String | 否 | 平台 |
injectPort | String | 否 | 注入口岸 |
virtualChannels | Array | 否 | 虚拟服务列表 |
articleId | String | 否 | 货物ID |
description | String | 否 | 描述 |
nativeDescription | String | 否 | 原始描述 |
receivingPartys | Array | 否 | 收货方列表 |
salesAccountStr | String | 否 | 销售账号 |
shipperName | String | 否 | 发件人名称 |
sortCode | String | 否 | 排序码 |
includes | Array | 否 | 包含状态列表 |
excludes | Array | 否 | 不包含状态列表 |
excludeVirtual | Boolean | 否 | 是否排除虚拟服务 |
serviceOption | String | 否 | 服务选项 |
source | String | 否 | 来源 |
relabelStatus | Array | 否 | 换标状态列表 |
trackingNos | Array | 否 | 跟踪号列表 |
uuids | Array | 是 | 订单UUID列表 |
queryType 查询类型:
trackingNo | 跟踪号 |
referenceNo | 参考号 |
referNo1 | 参考号1 |
returnTrackingNo | 退件跟踪号 |
returnRefNo1 | 退件参考号1 |
referNoPrefix | 参考号前缀 |
referNo1Prefix | 参考号1前缀 |
consignmentID | 跟踪号前缀 |
connoteID | 母单号 |
masterReference | 主参考号 |
dateType 日期类型:
dateCreated | 创建时间 |
dateLabelled | 打印标签时间 |
dateReceived | 收货时间 |
dateDespatched | 发货时间 |
dateDelivered | 签收时间 |
dateReturned | 退回时间 |
dateClosed | 预报时间 |
inductedTime | 引入时间 |
请求示例
curl 'https://tracking-qa.etowertech.com/api/aggregator/v1/export/shipmentDetailv2' \
-H 'Accept: application/json, text/plain, */*' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'language: zh_CN' \
-H 'sessionId: vP1l43F_OqvoTUWBcaAtyg' \
--data-raw '{
"templateId": "MWf7KzoPs7yfT02bQcMOkQ",
"type": 0,
"queryType": "trackingNo",
"dateType": "dateCreated",
"startDate": "",
"endDate": "",
"pageNum": 1,
"pageSize": 100,
"status": [],
"uuids": ["8UlguctX_qNjQa2gQ8Gxuw"]
}'
|
响应类型: application/xlsx(Excel文件流)
响应头:
参数 | 说明 |
|---|---|
Content-Disposition | 文件名,如:attachment; filename=Batch%20Update%20Tracking%20No20260324.xlsx |
Content-Type | application/xlsx |
Content-Length | 文件大小 |
Access-Control-Expose-Headers | Content-Disposition(允许前端读取文件名) |
返回说明: