转至元数据结尾
转至元数据起始

接口名称

导出运单详情(自定义模板)(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(允许前端读取文件名)

返回说明:

  • 返回的是 Excel 文件流(.xlsx 格式)
  • 前端或浏览器会根据 Content-Disposition 响应头自动下载文件
  • 无标签