Track API
简介
追踪号码是代表每个包裹的唯一编号,可让您查询包裹在国家/地区之间或在某个国家/地区内的运输情况。FedEx 追踪选项可为您提供 FedEx Express®, FedEx Ground®, FedEx Home Delivery®, FedEx Freight® 和 FedEx Ground® Economy (以前称为 FedEx SmartPost®) 货件的准确且即时的追踪信息。
追踪API详细信息
FedEx追踪可帮助您深入了解货件的位置。凭借追踪通知功能,您可以申请通过电子邮件和手机随时接收有关您货件的各类通知。
您也可以使用参考编号来追踪货件状态,这些参考编号可以是采购订单(PO)号码、客户参考编号、发票、提货单(BOL)、部件编号或运输控制编号(TCN)等。如果使用追踪号码以外的信息追踪货件,则还需要提供寄件人的帐号,并且应该包含安全追踪内容。
利用货件详细信息:状态更新、搜索功能和其他有助于管理您货件的工具。
- 最多可追踪 30 个 FedEx Express、FedEx Ground、FedEx Home Delivery、FedEx Freight、FedEx Ground® Economy 和 FedEx Office 货件/订单追踪号码的状态。
- 申请接收通知,接收有关货件/订单状态的电子邮件。
- 在日历或列表视图中查看状态更新,帮助您更高效地制定计划。
- 按参考编号、货件日期、公司名称及其他变量进行过滤。
- 查看/打印或以电子邮件发送FedEx递送签收证明函。即使没有提供签名,您仍然可以查看/打印、通过电子邮件或传真方式发送可用的递送证明信息。传真选项不适用于多个递送签收证明请求。
- 请求将符合条件的包裹暂寄存在FedEx服务站以待取件(仅限美国)。
- 追踪包裹递送安排。即,准时送达、预计提早送达或任何延误及详细信息
FedEx追踪方法
为帮助您放心托运,FedEx提供了多种方法可让您追踪货件的大概位置。
下面列出了这些追踪方法:
按追踪号码追踪
此选项适用于FedEx Express、FedEx Ground货件和FedEx Ground® Economy(以前称为FedEx SmartPost®)货件。您可以使用此追踪方法来追踪由联邦快递托运的任何包裹。
您最多可以输入30个FedEx Express、FedEx Ground、FedEx Home Delivery、FedEx Ground® Economy或FedEx Custom Critical®追踪号码,任意组合。请确保每行仅输入一个追踪号码。
注意:FedEx Ground®服务仅在美国和加拿大提供。FedEx Home Delivery、FedEx Ground® Economy和FedEx Custom Critical服务仅在美国提供。
按上门留条号码追踪
此选项适用于FedEx Express及FedEx Ground美国和加拿大货件。使用此选项可按FedEx上门留条号码追踪货件的状态。如果收件人不在无法接收包裹,将会于收件人地址处留下一张上门留条。在FedEx系统中,上门留条号码与包裹的原始追踪号码关联。
此追踪功能让您无需使用关联的追踪号码,只通过上门留条号码就能追踪货件。使用上门留条追踪时,无需提供其他搜索元素。您可以通过输入有效的上门留条号码,来请求追踪由FedEx托运的任何包裹的扫描信息。
上门留条号码以“DT”开头,后跟12位数字。您可以在请求中输入多个上门留条号码,以获得更多详细信息。您可以一次最多输入30个上门留条追踪号码的任意组合,请确保每行输入一个上门留条号码。
按FedEx Office订单号码追踪
一次最多可输入30个FedEx Office订单号码的组合。您需要确保每行仅输入一个FedEx Office订单号码。请勿在订单号码之间加入连字符和空格。
注意:FedEx Office订单仅在美国提供。按追踪号码以外的信息追踪也称为按参考编号追踪。这些参考编号可以是以下任一项:采购订单(PO)号码、客户参考编号、账单、提货单(BOL)或部件编号。此选项适用于FedEx Express、FedEx Ground和FedEx Ground® Economy。
注意:上门留条仅在美国和加拿大提供。
利用参考信息查询货件
按追踪号码以外的信息追踪也称为按参考编号追踪。这些参考编号可以是以下任一项:采购订单 (PO) 号码、客户参考编号、账单、提货单 (BOL)、部件编号。此选项适用于 FedEx Express, FedEx Freight, FedEx Ground, 和 FedEx Ground® Economy。
按运输控制编号(TCN)追踪
只要输入运输控制编号(TCN)便可追踪您的政府订单。
注意:请勿在此编号之前输入空格或字母“TCN”。
请求递送签收证明(SPOD)
使用递送签收证明选项,可以在货件送达后,获得收件人的签名图像(如果提供签名)。FedEx Express和FedEx Ground货件的SPOD保留期限为自寄件之日起16个月内。其中包含签名图像和关联的货件数据。在部分国家/地区可能不会显示签名图像和额外的收件人信息,这会在SPOD上(如果提供)予以指明。
SPOD 信息将显示为字节数组而不是图像。字节数组是一个 base64 编码的字符串,需要解码才能得到最终的 PDF 或 PNG 格式的签名图片。
按一票多件货件(MPS)追踪号码追踪
此选项适用于 FedEx Express 美国和国际一票多件货件、FedEx Ground 美国和国际一票多件货件、FedEx Express International C.O.D. 一票多件货件、FedEx Freight 和 FedEx International C.O.D. 一票多件货件。
通过MPS追踪,您可以按主追踪号码或者其中一个关联的子包裹顺序追踪号码来追踪货件。
- 按主追踪号码追踪时,将返回所有关联的子追踪号码的追踪数据。
- 按子追踪号码追踪时,将返回与该追踪号码关联的包裹的特定详细信息。
要追踪MPS包裹,请使用主追踪号码并使用包裹标识符类型值作为STANDARD_MPS。
追踪API的工作原理
追踪API提供以下选项来主动追踪您的货件:
按追踪号码追踪
您可以使用此选项,根据各托运服务的追踪号码或上门留条号码或FedEx Office订单号码来追踪包裹。
与此请求关联的重要输入信息如下:
- 追踪号码(最多允许输入30个追踪号码)
- 要包含的扫描详细信息(True/False)
此请求的结果会针对所有输入的追踪号码提供追踪结果以及下列重要信息:最新状态、上次更新目的地/位置、与目的地的距离、任何特殊处理详细信息、扫描事件和退件信息(如遇退件)等。
按参考编号追踪
您可以使用此选项根据追踪号码以外的替代参考编号(如客户参考编号等)来追踪包裹。
与此请求关联的重要输入信息如下:
- 参考编号类型和值(BILL_OF_LADING、CUSTOMER_REFERENCE、INVOICE、PURCHASE_ORDER)
- FedEx帐号
- 要包含的扫描详细信息(True/False)
此请求的结果会针对所有输入的参考编号提供追踪结果以及下列重要信息:详细的追踪条目信息、最新状态、上次更新目的地/位置、与目的地的距离、任何特殊处理详细信息、扫描事件和退件信息(如遇退件)等。
按运输控制编号追踪
您可以使用此选项根据追踪控制编号来追踪包裹。
与此请求关联的重要输入信息如下:
- 运输控制编号(N552428361Y555XXX) – 每个请求仅支持一个TCN。
- 要包含的扫描详细信息(True/False)
此请求的结果会针对输入的追踪控制编号提供追踪结果以及下列重要信息:详细的追踪条目信息、最新状态、上次更新目的地/位置、与目的地的距离、任何特殊处理详细信息、扫描事件和退件信息(如遇退件)等。
追踪一票多件货件(MPS)
您可以使用此选项来追踪一票多件货件、组MPS,或与退件关联的出境货件。
与此请求关联的重要输入信息如下:
- 主追踪号码
- 关联的货件类型 – MPS、组MPS或与退件关联的出境货件(如:STANDARD_MPS)
- 要包含的扫描详细信息(True/False)
此请求的结果会针对输入的主追踪号码提供追踪结果以及下列重要信息:详细的追踪条目信息、最新状态、上次更新目的地/位置、与目的地的距离、任何特殊处理详细信息、扫描事件和退件信息(如遇退件)等。
追踪文件
您可通过此选项申请以下任何一种文件:
- 递送签收证明 (SPOD)
- 提货单 (BOL)
- 货运账单文件 (FBD)
与此请求关联的重要输入信息如下:
- 文件类型(SIGNATURE_PROOF_OF_DELIVERY、BILL_OF_LADING 或 FREIGHT_BILLING_DOCUMENT)
- 追踪号码
- 文件格式(PDF/PNG)
如果选择 SPOD 作为文件类型,则会在货件送达后收到获取收件人的签名图像(如提供签名)。
如果选择提货单作为文件类型,则会收到一份文件,内含货件详细信息以及附有条款和条件的合法运输合同。
如果选择货运账单文件作为文件类型,则会收到货件账单。
发送通知
您可以使用此选项设置并自定义将会收到的货件追踪事件通知。
使用通知可以让FedEx通过电子邮件,自动将重要的货件事件(例如清关延误、尝试递送次数、海关放行和预警)通知给您和/或您的客户和/或其他第三方。
FedEx会为正在创建的货件、预计送达时间、已托运、任何异常和递送提供电子邮件通知。
如果您要向收件人发送电子邮件通知,可在货件申请中指定收件人电子邮箱,并使用任何或所有这些通知类型。FedEx Express、FedEx Freight、FedEx Ground 和 FedEx Ground® Economy 支持此类通知。联邦快递还针对“预计送达时间”提供了新的电子邮件通知,它会在送达之日触发电子邮件。
与此请求关联的重要输入信息如下:
- 寄件人姓名
- 电子邮件
- 通知事件(ON_DELIVERY、ON_ESTIMATED_DELIVERY、ON_EXCEPTION、ON_TENDER)
- 追踪号码
此请求的成功结果会针对指定事件设置通知,并在发生事件时向指定电子邮件地址发送通知。
追踪摘要结果
一次追踪多个货件时,摘要结果屏幕会显示FedEx货件的日期/时间、状态、目的地和/或FedEx Office订单的订单号码、订单状态和日期/时间。
要获得货件追踪的详细结果,请发送追踪请求并在其中包含追踪号码和/或FedEx订单号码。
您还可以通过电子邮件接收全部选定的已送达FedEx Express和FedEx Ground货件的派送签收证明函。请注意,对于FedEx Ground® Economy货件不会提供派送签收证明。
追踪递送安排(准时/延误)
您可以获得单件/MPS货件的实时递送安排预计,如递送延误、准时和提早送达。当您按追踪号码、参考信息或追踪控制编号(TCN)来追踪包裹时,此功能可用。
如果包裹准时送达或预计提早送达,则追踪响应元素trackResults\scanEvents\delayDetail\status的值将分别为ON_TIME和EARLY。
如果您的包裹因为任何原因而延误,追踪响应将提供必要的延误详细信息(如果有)及原因。在此情况下,追踪响应元素trackResults\scanEvents\delayDetail\status的值将为DELAYED,并会提供延误类别(类型),例如WEATHER(天气原因),和其他延误类别(子类型),例如SNOW(下雪)。
FedEx预计送达时间范围(EDTW)
FedEx预计送达时间范围(EDTW)可根据客户请求的特定地点的已送达货件的历史数据,提供货件送达的时间范围,帮助收件人规划他们日程安排。
注意:预计送达时间可能视递送地点而异。
EDTW适用于以下区域和运营公司:
- 区域:递送到以下国家/地区的包裹:
- 美国
- 加拿大
- 比利时
- 德国
- 荷兰
- 运营公司:下面是提供EDTW功能的服务:
- FedEx Express
- FedEx Ground
- FedEx Home Delivery (FHD)服务
注意:由于各种原因和包裹处理,例如FHD货件的请求预约、指定日期或晚间递送,或将递送目的地更改为FedEx暂寄存在服务站(HAL)以待客户前往最近的FedEx授权寄件中心(FASC)、FedEx人工服务寄件中心(仅限Express包裹)、FedEx Office和FedEx OnSite服务站取件,并非所有追踪号码都会返回EDTW详情。请联系您的FedEx代表,以了解详细信息。
EDTW技术详情:
不需要在追踪请求中包含任何特定输入,因为大部分追踪号码都会根据货件事件返回EDTW信息。
追踪输出/响应中的下列信息可用于获取EDTW:
您应使用output/completeTrackResults/trackResults下的追踪响应中返回的对象estimatedDeliveryTimeWindow中的下列EDTW元素:
· window/begins – EDTW开始日期/时间戳范围。例如:“2019-05-07T08:00:07”
· window/ends – EDTW结束日期/时间戳范围。例如:“2019-05-15T15:00:07”
EDTW优点:
下面列出了EDTW的优点:
- 采用EDTW可减少解决货件延误的时间。
- 无需等待电话查询包裹送达时间。
- 减少了包裹损坏风险及被窃的可能性。
递送签收证明
当您的货件成功送达并获得签名后,如果通过安全追踪发出请求,则将随货件返回签名(取决于是否提供签名)。此选项仅适用于FedEx Express和FedEx Ground货件。
要确认货件是否已签收,您还可以使用递送签收证明选项来在线获取此证明函、将其打印出来、以电子邮件或传真进行发送。
下面是一些有用的提示:
- 追踪与递送签收证明的区别:
您可以在货件递送期间及送达后的90天内随时通过追踪功能来查看货件的状态。货件送达后,您可以使用递送签收证明获取收件人的签名图像(如果提供签名)。
- 递送签收证明数据的有效性:
FedEx Express和FedEx Ground货件的递送签收证明最多可保留16个月。此数据包含签名图像和关联的货件信息。在部分国家/地区可能不会显示签名图像和相关的收件人信息。这会在递送签收证明(如果提供)中予以指明。
- 多个递送签收证明请求
您一次最多可以请求30个递送签收证明函。
- 如果有多个请求要求获取递送签收证明函,可能需要数分钟时间进行处理。
- 请注意,传真选项不适用于多个递送签收证明请求。
- 系统只会针对已送达的货件提供递送签收证明函。目前对于尚在运送途中的货件,除非送达目的地,否则不会提供SPOD。
签名类型
下面是FedEx货件支持的签名类型和功能:
- 需要间接签收
FedEx从递送地址的人员处取得签名;或者从邻居、大楼管理员或相邻地址的人员处取得签名;或者收件人也可以留一张FedEx上门留条,以授权在无人签收的情况下放行包裹。此选项仅适用于住宅递送。
- 需要直接签收
FedEx从递送地址的人员处取得签名。如果该地址无人签收,我们会重新尝试递送。
- 需要成年人签收
FedEx从递送地址的成年人(年满21岁且拥有所需的由政府签发并附有照片的身份证明)处取得签名。如果该地址处没有符合条件的收件人,我们会再次尝试递送。
- 无需签收
即使没有提供签名,您仍然可以查看/打印、通过电子邮件或传真方式发送可用的递送证明信息。如果七个工作日后仍未提供签名,请致电客户服务。请注意,如果货件已放行(寄件人或收件人签署了免签协议),则系统可能不会提供签名。
- 递送签收证明摘要
您无需提供FedEx寄件人或付款人的9位帐号,便能获取包含摘要信息的递送签收证明函。该证明函会显示有限的货件信息,例如寄件人和收件人所在的城市、州/省和国家/地区信息。在部分国家/地区可能不会显示签名图像。这会在递送签收证明函(如果提供)中予以指明。
- 递送签收证明详细信息
您可以提供9位数的FedEx帐号或登录到fedex.com来获取包含详细信息的递送签收证明函。如果该帐号或您的登录与货件寄件人或付款人相符,您便可以查看详细的递送签收证明信息,其中包括寄件人和收件人(如果有)双方完整的联系人姓名、公司名称、街道地址、城市、州/省、邮政编码以及国家/地区信息。
注意:部分国家/地区可能不会显示签名图像和额外的收件人信息。这会在递送签收证明函(如果提供)中予以指明。 - 收件人
您可以添加递送证明函的收件人信息。
- 您的货件备注
添加特定于追踪号码的个人备注,以提醒有关您货件的重要详细信息。这些备注只有您可见,并可在FedEx追踪系统中执行搜索时使用。
利用参考信息查询货件
您可以根据执行托运操作时输入的参考编号来追踪包裹。
此选项适用于 FedEx Express、FedEx Freight 和 FedEx Ground 货件。您可以根据执行托运操作时输入的参考编号来追踪包裹。
“按参考编号追踪”可以使用下列任一来源:
- 寄件人/客户参考编号
注意:对于 FedEx Express, FedEx Freight 和 FedEx Ground shipment,客户的参考编号将被编码为寄件人参考编号和客户参考编号。 - 发票号码
- PO
- 部门(不适用于FedEx Ground® Economy)
- 部件编号(不适用于FedEx Ground® Economy)
- 退货授权 (RMA) (不适用于 FedEx Freight®)
- TCN (不适用于 FedEx Freight 和 FedEx Ground® Economy)
- BOL(不适用于FedEx Ground® Economy)
注意:
- 如果在此请求中输入了某个追踪号码,则该追踪号码始终优先于参考编号元素。因此,如果为货件输入的某个追踪号码不包括您请求的参考数据,则会返回该追踪号码且不显示错误消息。要限制针对特定参考编号的追踪回复数量,可为此搜索输入一个日期范围。
- 虽然货件帐号不是必要元素,但它可让按参考编号追踪变得更轻松。如果未指定货件帐号,则必须指定目的地邮政编码和国家/地区代码,以及寄件日期范围(开始日期和结束日期)。
包含帐号的参考编号
您可以使用参考帐号进行追踪。此请求必须包含的信息有参考编号值、帐号、寄件开始日期和结束日期。所有与帐号及参考编号相关的货件均会显示出来。
不含帐号的参考编号
您可以不使用参考帐号进行追踪。此请求必须包含的信息有参考编号值、目的地邮政编码、目的地国家/地区代码、寄件开始日期和结束日期。请输入寄件日期(+/- 15天)、目的地国家/地区以及目的地邮政编码。并非所有的国家/地区均支持邮政编码。请先选择目的地国家/地区以确定邮政编码要求。
注意:如果不用帐号而是根据参考编号追踪,则系统只显示唯一相符的货件。如果同一个参考编号查找到多个结果,则您在单击“全部重新提交”前必须选择一个FedEx服务。如果没有找到唯一的匹配结果,系统会提示您输入帐号。
追踪关联货件
FedEx会为您提供方便的一票多件货件状态追踪信息。一票多件货件的每个货件都会作为关联货件链接在一起(追踪其中某个货件的状态即可获得所有关联的一票多件货件的信息)。
主追踪号码:一票多件货件中的第一个追踪号码,与货件的所有追踪号码关联。
批量追踪
批量追踪服务可让您发送多个追踪号码以追踪货件。需要为请求和回复元素提供有关批量追踪的其他批量信息。
例如,在请求中,可以针对批量追踪包含多个请求选择详细信息元素。单个追踪交易中的包裹数上限为30个。
新追踪响应中的每个通知级别如下所示
- 回复的通知元素提供总体交易状态
- 回复的已完成追踪详细信息>>通知元素提供单个追踪请求状态
- 回复的已完成追踪详细信息>>追踪详细信息>>通知 = 特定追踪号码状态
注意:
- 如果在方法级别(回复>>通知)出现失败或错误通知,则会忽略剩余的响应/负载。
- 如果在单个回复通知级别出现失败或错误通知,则会忽略剩余的响应/负载。
国际包裹追踪
您可以发出国际包裹追踪请求。您也可以使用参考编号来追踪货件状态,例如采购订单(PO)号码、客户参考编号、发票、提货单(BOL)、部件编号或运输控制编号(TCN)等。追踪包裹时会使用承运人代码、地理坐标、运营公司、包裹标识符等元素。
您可以使用以下方法来追踪国际包裹:
- 按追踪号码追踪可根据各托运服务的追踪号码来为客户提供包裹追踪信息。
- 按追踪控制编号追踪会根据追踪控制编号返回追踪信息。运营公司:FedEx Cargo、Custom Critical、Express和Ground货件。
- 按一票多件货件(MPS)追踪号码追踪可让您按主追踪号码或者子包裹的其中一个关联顺序追踪号码来追踪货件。要追踪MPS包裹,请使用主追踪号码并使用STANDARD_MPS的包裹标识符/类型值。
- 按参考编号追踪会根据追踪号码以外的替代参考编号(如客户参考编号等)返回追踪信息。需提供寄件人帐号或目的地国家/地区代码(对于使用邮政编码的国家/地区需提供邮政编码)。
- 按文件追踪,可申请任何一种文件:签收证明、提货单或货运账单文件。
- 按追踪号码追踪可根据各托运服务的追踪号码来为客户提供包裹追踪信息。
- 按上门留条号码追踪可让您根据FedEx上门留条号码来追踪货件的状态。如果收件人不在无法接收包裹,我们会在收件人地址处留下一张上门留条。此选项适用于FedEx Express及FedEx Ground美国和加拿大货件。
注意:
- 如果使用追踪号码以外的信息追踪货件,则需要提供寄件人的帐号,并且必须包含安全追踪内容。
- FedEx Express货件支持针对墨西哥国内托运获取递送签收证明(SPOD)。
- FedEx Express和FedEx Ground递送签收证明(SPOD)的有效期为自寄件日期起16个月。
要追踪包裹,您在致电FedEx客户服务时须提供下列全部信息。
- 空运提单号码
- 货件日期
- 收件人姓名和地址
- 包裹数和货件总重量
- 货件内容和价值
- 您的姓名和电话号码
请求通知
FedEx提供有方便的电子邮件通知功能(纯文本或HTML),您可以使用这项功能最多通知4位电子邮件收件人。您还可以根据自己的喜好添加个人消息(不支持非英语字符)。通知类型包括:
- 发送当前状态 – 通知当前的追踪详细结果。
- FedEx已经收到该包裹 – 当FedEx已揽收货件时发送通知。
- 发生递送异常 – 当发生清关延误或递送异常(可能会中断包裹运输或递送的未预期事件)时发送通知。如果发生清关延误,一旦国际货件通过清关流程,会自动发送另一条通知。
- 预计送达时间更新 – 在安排的递送日期之前和递送当天,发送提醒。同时在FedEx更新安排的递送日期和/或时间时发送通知。
- 已经完成递送 – 当货件已送达时发送通知。
业务规则
- 将单次追踪请求中的追踪号码数量上限设为30个。如此会减小回复的大小,并缩短交易响应时间。
- 将同一包裹/订单的追踪次数限制为公司所需的必要次数。
- 对于批量追踪,请从批量中删除返回的追踪状态为“已送达”的所有包裹/订单。
- 无法提供追踪记录最常见的原因是作为输入提供的追踪/订单号码不正确。如果您不清楚追踪/订单号码,建议您与寄件人联系。此外,新的包裹/订单可能需要24小时才会出现在系统中。
- FedEx Express、FedEx Ground和FedEx Custom Critical货件送达后,其追踪信息会保留90天。
- 要使用按参考编号追踪功能,必须提供帐号或目的地邮政编码或国家/地区详细信息。
- 只有在将包裹交给 FedEx 后,您才能获得预计送达日期 (EDD)。
JSON API Collection
Track API (1.0.0)
Track Multiple Piece Shipment
This endpoint returns tracking information for multiplee piece shipments, Group MPS, or an outbounddd shipment which is linked to a return shipment.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.
header Parameters
x-customer-transaction-id | string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. |
content-type required | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
x-locale | string Example: en_US This indicates the combination of language code and country code. Click here to see Locales |
authorization required | string Example: Bearer XXX This indicates the authorization token for the input request. |
Request Body schema: application/json
- Full_Schema_Multiple_Piece_Shipment
- Minimum_Payload_Track_Multiple_Piece_Shipment
includeDetailedScans | boolean Indicates if detailed scans are requested or not. |
masterTrackingNumberInfo required | object (MasterTrackingInfo) The detailed master tracking details for the shipment to be tracked. |
associatedType required | string Enum: "OUTBOUND_LINK_TO_RETURN" "STANDARD_MPS" "GROUP_MPS" The associated shipment type, such as MPS, Group MPS, or an outbound shipment which is linked to a return shipment. |
pagingDetails | object (PagingDetails) The details about how to retrieve the subsequent pages when there is more than one page in the TrackReply. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "includeDetailedScans": true,
- "associatedType": "STANDARD_MPS",
- "masterTrackingNumberInfo": {
- "shipDateEnd": "2018-11-03",
- "shipDateBegin": "2018-11-01",
- "trackingNumberInfo": {
- "trackingNumberUniqueId": "245822~123456789012~FDEG",
- "carrierCode": "FDXE",
- "trackingNumber": "858488600850"
- "pagingDetails": {
- "resultsPerPage": 56,
- "pagingToken": "38903279038"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "completeTrackResults": [
- {
- "trackingNumber": "123456789012",
- "trackResults": [
- {
- "trackingNumberInfo": {
- "trackingNumber": "128667043726",
- "carrierCode": "FDXE",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "additionalTrackingInfo": {
- "hasAssociatedShipments": false,
- "nickname": "shipment nickname",
- "packageIdentifiers": [
- {
- "type": "SHIPPER_REFERENCE",
- "value": "ASJFGVAS",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "shipmentNotes": "shipment notes"
- "distanceToDestination": {
- "units": "KM",
- "value": 685.7
- "consolidationDetail": [
- {
- "timeStamp": "2020-10-13T03:54:44-06:00",
- "consolidationID": "47936927",
- "reasonDetail": {
- "description": "Wrong color",
- "type": "REJECTED"
- "packageCount": 25,
- "eventType": "PACKAGE_ADDED_TO_CONSOLIDATION"
- "meterNumber": "8468376",
- "returnDetail": {
- "authorizationName": "Sammy Smith",
- "reasonDetail": [
- {
- "description": "Wrong color",
- "type": "REJECTED"
- "serviceDetail": {
- "description": "FedEx Freight Economy.",
- "shortDescription": "FL",
- "type": "FEDEX_FREIGHT_ECONOMY"
- "destinationLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationType": "FEDEX_SHIPSITE"
- "latestStatusDetail": {
- "scanLocation": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "code": "PU",
- "derivedCode": "PU",
- "ancillaryDetails": [
- {
- "reason": "15",
- "reasonDescription": "Customer not available or business closed",
- "action": "Contact us at <http://www.fedex.com/us/customersupport/call/index.html> to discuss possible delivery or pickup alternatives.",
- "actionDescription": "Customer not Available or Business Closed"
- "statusByLocale": "Picked up",
- "description": "Picked up",
- "delayDetail": {
- "type": "WEATHER",
- "subType": "SNOW",
- "status": "DELAYED"
- "serviceCommitMessage": {
- "message": "No scheduled delivery date available at this time.",
- "type": "ESTIMATED_DELIVERY_DATE_UNAVAILABLE"
- "informationNotes": [
- {
- "code": "CLEARANCE_ENTRY_FEE_APPLIES",
- "description": "this is an informational message"
- "error": {
- "code": "TRACKING.TRACKINGNUMBER.EMPTY",
- "parameterList": [
- {
- "value": "value",
- "key": "key"
- "message": "Please provide tracking number."
- "specialHandlings": [
- {
- "description": "Deliver Weekday",
- "type": "DELIVER_WEEKDAY",
- "paymentType": "OTHER"
- "availableImages": [
- {
- "size": "LARGE",
- "type": "BILL_OF_LADING"
- "deliveryDetails": {
- "receivedByName": "Reciever",
- "destinationServiceArea": "EDDUNAVAILABLE",
- "destinationServiceAreaDescription": "Appointment required",
- "locationDescription": "Receptionist/Front Desk",
- "actualDeliveryAddress": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "deliveryToday": false,
- "locationType": "APARTMENT_OFFICE",
- "signedByName": "Reciever",
- "officeOrderDeliveryMethod": "Courier",
- "deliveryAttempts": "0",
- "deliveryOptionEligibilityDetails": [
- {
- "option": "INDIRECT_SIGNATURE_RELEASE",
- "eligibility": "INELIGIBLE"
- "scanEvents": [
- {
- "date": "2018-02-02T12:01:00-07:00",
- "derivedStatus": "Picked Up",
- "scanLocation": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationId": "SEA",
- "locationType": "CUSTOMS_BROKER",
- "exceptionDescription": "Package available for clearance",
- "eventDescription": "Picked Up",
- "eventType": "PU",
- "derivedStatusCode": "PU",
- "exceptionCode": "A25",
- "delayDetail": {
- "type": "WEATHER",
- "subType": "SNOW",
- "status": "DELAYED"
- "dateAndTimes": [
- {
- "dateTime": "2007-09-27T00:00:00",
- "type": "ACTUAL_DELIVERY"
- "packageDetails": {
- "physicalPackagingType": "BARREL",
- "sequenceNumber": "45",
- "undeliveredCount": "7",
- "packagingDescription": {
- "description": "FedEx Pak",
- "type": "FEDEX_PAK"
- "count": "1",
- "weightAndDimensions": {
- "weight": [
- {
- "unit": "LB",
- "value": "22222.0"
- "dimensions": [
- {
- "length": 100,
- "width": 50,
- "height": 30,
- "units": "CM"
- "packageContent": [
- "wire hangers",
- "buttons"
- "contentPieceCount": "100",
- "declaredValue": {
- "currency": "USD",
- "value": 56.8
- "goodsClassificationCode": "goodsClassificationCode",
- "holdAtLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationType": "FEDEX_SHIPSITE"
- "customDeliveryOptions": [
- {
- "requestedAppointmentDetail": {
- "date": "2019-05-07",
- "window": [
- {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "description": "Redirect the package to the hold location.",
- "type": "REDIRECT_TO_HOLD_AT_LOCATION",
- "status": "HELD"
- "estimatedDeliveryTimeWindow": {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "pieceCounts": [
- {
- "count": "35",
- "description": "picec count description",
- "type": "ORIGIN"
- "originLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "recipientInformation": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "standardTransitTimeWindow": {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "shipmentDetails": {
- "contents": [
- {
- "itemNumber": "RZ5678",
- "receivedQuantity": "13",
- "description": "pulyurethane rope",
- "partNumber": "RK1345"
- "beforePossessionStatus": false,
- "weight": [
- {
- "unit": "LB",
- "value": "22222.0"
- "contentPieceCount": "3333",
- "splitShipments": [
- {
- "pieceCount": "10",
- "statusDescription": "status",
- "timestamp": "2019-05-07T08:00:07",
- "statusCode": "statuscode"
- "reasonDetail": {
- "description": "Wrong color",
- "type": "REJECTED"
- "availableNotifications": [
- "ON_DELIVERY",
- "ON_EXCEPTION"
- "shipperInformation": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "lastUpdatedDestinationAddress": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "alerts": "TRACKING.DATA.NOTFOUND - Tracking data unavailable"
Send Notification
This endpoint helps you setup up, customize the tracking event notifications to be received for a shipment.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.
header Parameters
x-customer-transaction-id | string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. |
content-type required | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
x-locale | string Example: en_US This indicates the combination of language code and country code. Click here to see Locales |
authorization required | string Example: Bearer XXX This indicates the authorization token for the input request. |
Request Body schema: application/json
- Full_Schema_Notification
- Send_Shipment_Notifications
senderContactName required | string Placeholder for Sender contact name. |
senderEMailAddress required | string Email address of the sender from which the shipment notification will be sent. |
trackingEventNotificationDetail required | object (TrackingEventNotificationDetail) Object for holding tracking event Notification details. |
trackingNumberInfo required | object (TrackingNumberInfo) Information uniquely identifying a shipment such as Tracking number, ShipDate, and Tracking number uniqueId. |
shipDateBegin | string ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number in a specific time range. |
shipDateEnd | string ShipDateBegin and ShipDateEnd are recommended to narrow the search, reduce lookup time, and avoid duplicates when searching for a specific tracking number in a specific time range. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "senderContactName": "Sam Smith",
- "senderEMailAddress": "Lsr1234@gmail.com",
- "trackingEventNotificationDetail": {
- "trackingNotifications": [
- {
- "notificationDetail": {
- "localization": {
- "languageCode": "en",
- "localeCode": "US"
- "emailDetail": {
- "emailAddress": "p1@fedex.com",
- "name": "Preethi"
- "notificationType": "HTML"
- "role": "SHIPPER",
- "notificationEventTypes": [
- "ON_DELIVERY",
- "ON_EXCEPTION",
- "ON_ESTIMATED_DELIVERY"
- "currentResultRequestedFlag": true
- "personalMessage": "Personal message content",
- "supportHTML": null
- "trackingNumberInfo": {
- "trackingNumber": "128667043726",
- "carrierCode": "FDXE",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "shipDateBegin": "2019-10-13",
- "shipDateEnd": "2019-10-31"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "TrackingNumberInfo": {
- "trackingNumber": "128667043726",
- "carrierCode": "FDXE",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "destinationAddress": {
- "classification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "recipientDetails": [
- [
- "[\"ON_ESTIMATED_DELIVERY\"]"
- "alerts": "TRACKING.DATA.NOTFOUND - Tracking data unavailable"
Track by References
This endpoint returns tracking information based on alternate references other than Tracking Number such as Customer reference numbers, etc.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.
header Parameters
x-customer-transaction-id | string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. |
content-type required | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
x-locale | string Example: en_US This indicates the combination of language code and country code. Click here to see Locales |
authorization required | string Example: Bearer XXX This indicates the authorization token for the input request. |
Request Body schema: application/json
- Full_Schema_Tracking_References
- Track_by_References_using_accountNumber
- Track_by_References_using_destination
referencesInformation required | object (ReferenceInformation) Specifies the reference details for the tracked shipment. The following rules apply |
includeDetailedScans | boolean Indicates if the detailed scans are being requested or not. If true, the detailed scans will be included in the response returned. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "referencesInformation": {
- "type": "BILL_OF_LADING",
- "value": "56754674567546754",
- "accountNumber": "XXX61073",
- "carrierCode": "FDXE",
- "shipDateBegin": "2019-02-13",
- "shipDateEnd": "2019-02-13",
- "destinationCountryCode": "US",
- "destinationPostalCode": "75063"
- "includeDetailedScans": "true"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "cxsErrors": [
- {
- "code": "TRACKING.TRACKINGNUMBER.EMPTY",
- "parameterList": [
- {
- "value": "value",
- "key": "key"
- "message": "Please provide tracking number."
- "completeTrackResults": [
- {
- "trackingNumber": "123456789012",
- "trackResults": [
- {
- "trackingNumberInfo": {
- "trackingNumber": "128667043726",
- "carrierCode": "FDXE",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "additionalTrackingInfo": {
- "hasAssociatedShipments": false,
- "nickname": "shipment nickname",
- "packageIdentifiers": [
- {
- "type": "SHIPPER_REFERENCE",
- "value": "ASJFGVAS",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "shipmentNotes": "shipment notes"
- "distanceToDestination": {
- "units": "KM",
- "value": 685.7
- "consolidationDetail": [
- {
- "timeStamp": "2020-10-13T03:54:44-06:00",
- "consolidationID": "47936927",
- "reasonDetail": {
- "description": "Wrong color",
- "type": "REJECTED"
- "packageCount": 25,
- "eventType": "PACKAGE_ADDED_TO_CONSOLIDATION"
- "meterNumber": "8468376",
- "returnDetail": {
- "authorizationName": "Sammy Smith",
- "reasonDetail": [
- {
- "description": "Wrong color",
- "type": "REJECTED"
- "serviceDetail": {
- "description": "FedEx Freight Economy.",
- "shortDescription": "FL",
- "type": "FEDEX_FREIGHT_ECONOMY"
- "destinationLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationType": "FEDEX_SHIPSITE"
- "latestStatusDetail": {
- "scanLocation": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "code": "PU",
- "derivedCode": "PU",
- "ancillaryDetails": [
- {
- "reason": "15",
- "reasonDescription": "Customer not available or business closed",
- "action": "Contact us at <http://www.fedex.com/us/customersupport/call/index.html> to discuss possible delivery or pickup alternatives.",
- "actionDescription": "Customer not Available or Business Closed"
- "statusByLocale": "Picked up",
- "description": "Picked up",
- "delayDetail": {
- "type": "WEATHER",
- "subType": "SNOW",
- "status": "DELAYED"
- "serviceCommitMessage": {
- "message": "No scheduled delivery date available at this time.",
- "type": "ESTIMATED_DELIVERY_DATE_UNAVAILABLE"
- "informationNotes": [
- {
- "code": "CLEARANCE_ENTRY_FEE_APPLIES",
- "description": "this is an informational message"
- "error": {
- "code": "TRACKING.TRACKINGNUMBER.EMPTY",
- "parameterList": [
- {
- "value": "value",
- "key": "key"
- "message": "Please provide tracking number."
- "specialHandlings": [
- {
- "description": "Deliver Weekday",
- "type": "DELIVER_WEEKDAY",
- "paymentType": "OTHER"
- "availableImages": [
- {
- "size": "LARGE",
- "type": "BILL_OF_LADING"
- "deliveryDetails": {
- "receivedByName": "Reciever",
- "destinationServiceArea": "EDDUNAVAILABLE",
- "destinationServiceAreaDescription": "Appointment required",
- "locationDescription": "Receptionist/Front Desk",
- "actualDeliveryAddress": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "deliveryToday": false,
- "locationType": "APARTMENT_OFFICE",
- "signedByName": "Reciever",
- "officeOrderDeliveryMethod": "Courier",
- "deliveryAttempts": "0",
- "deliveryOptionEligibilityDetails": [
- {
- "option": "INDIRECT_SIGNATURE_RELEASE",
- "eligibility": "INELIGIBLE"
- "scanEvents": [
- {
- "date": "2018-02-02T12:01:00-07:00",
- "derivedStatus": "Picked Up",
- "scanLocation": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationId": "SEA",
- "locationType": "CUSTOMS_BROKER",
- "exceptionDescription": "Package available for clearance",
- "eventDescription": "Picked Up",
- "eventType": "PU",
- "derivedStatusCode": "PU",
- "exceptionCode": "A25",
- "delayDetail": {
- "type": "WEATHER",
- "subType": "SNOW",
- "status": "DELAYED"
- "dateAndTimes": [
- {
- "dateTime": "2007-09-27T00:00:00",
- "type": "ACTUAL_DELIVERY"
- "packageDetails": {
- "physicalPackagingType": "BARREL",
- "sequenceNumber": "45",
- "undeliveredCount": "7",
- "packagingDescription": {
- "description": "FedEx Pak",
- "type": "FEDEX_PAK"
- "count": "1",
- "weightAndDimensions": {
- "weight": [
- {
- "unit": "LB",
- "value": "22222.0"
- "dimensions": [
- {
- "length": 100,
- "width": 50,
- "height": 30,
- "units": "CM"
- "packageContent": [
- "wire hangers",
- "buttons"
- "contentPieceCount": "100",
- "declaredValue": {
- "currency": "USD",
- "value": 56.8
- "goodsClassificationCode": "goodsClassificationCode",
- "holdAtLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationType": "FEDEX_SHIPSITE"
- "customDeliveryOptions": [
- {
- "requestedAppointmentDetail": {
- "date": "2019-05-07",
- "window": [
- {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "description": "Redirect the package to the hold location.",
- "type": "REDIRECT_TO_HOLD_AT_LOCATION",
- "status": "HELD"
- "estimatedDeliveryTimeWindow": {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "pieceCounts": [
- {
- "count": "35",
- "description": "picec count description",
- "type": "ORIGIN"
- "originLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "recipientInformation": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "standardTransitTimeWindow": {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "shipmentDetails": {
- "contents": [
- {
- "itemNumber": "RZ5678",
- "receivedQuantity": "13",
- "description": "pulyurethane rope",
- "partNumber": "RK1345"
- "beforePossessionStatus": false,
- "weight": [
- {
- "unit": "LB",
- "value": "22222.0"
- "contentPieceCount": "3333",
- "splitShipments": [
- {
- "pieceCount": "10",
- "statusDescription": "status",
- "timestamp": "2019-05-07T08:00:07",
- "statusCode": "statuscode"
- "reasonDetail": {
- "description": "Wrong color",
- "type": "REJECTED"
- "availableNotifications": [
- "ON_DELIVERY",
- "ON_EXCEPTION"
- "shipperInformation": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "lastUpdatedDestinationAddress": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "alerts": "TRACKING.DATA.NOTFOUND - Tracking data unavailable",
- "successful": true
Track by Tracking Control Number
Use this endpoint to return tracking information based on a Tracking Control Number.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.
header Parameters
x-customer-transaction-id | string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. |
content-type required | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
x-locale | string Example: en_US This indicates the combination of language code and country code. Click here to see Locales |
authorization required | string Example: Bearer XXX This indicates the authorization token for the input request. |
Request Body schema: application/json
- Full_Schema_TCN
- Minimum_Payload_Track_By_Tracking_Control_Number
tcnInfo required | object The information associated with the transportation control number. |
includeDetailedScans | boolean Indicates if detailed scans are requested or not. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "tcnInfo": {
- "value": "N552428361Y555XXX",
- "carrierCode": "FDXE",
- "shipDateBegin": "2019-02-13",
- "shipDateEnd": "2019-02-13"
- "includeDetailedScans": true
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "completeTrackResults": [
- {
- "trackingNumber": "123456789012",
- "trackResults": [
- {
- "trackingNumberInfo": {
- "trackingNumber": "128667043726",
- "carrierCode": "FDXE",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "additionalTrackingInfo": {
- "hasAssociatedShipments": false,
- "nickname": "shipment nickname",
- "packageIdentifiers": [
- {
- "type": "SHIPPER_REFERENCE",
- "value": "ASJFGVAS",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "shipmentNotes": "shipment notes"
- "distanceToDestination": {
- "units": "KM",
- "value": 685.7
- "consolidationDetail": [
- {
- "timeStamp": "2020-10-13T03:54:44-06:00",
- "consolidationID": "47936927",
- "reasonDetail": {
- "description": "Wrong color",
- "type": "REJECTED"
- "packageCount": 25,
- "eventType": "PACKAGE_ADDED_TO_CONSOLIDATION"
- "meterNumber": "8468376",
- "returnDetail": {
- "authorizationName": "Sammy Smith",
- "reasonDetail": [
- {
- "description": "Wrong color",
- "type": "REJECTED"
- "serviceDetail": {
- "description": "FedEx Freight Economy.",
- "shortDescription": "FL",
- "type": "FEDEX_FREIGHT_ECONOMY"
- "destinationLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationType": "FEDEX_SHIPSITE"
- "latestStatusDetail": {
- "scanLocation": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "code": "PU",
- "derivedCode": "PU",
- "ancillaryDetails": [
- {
- "reason": "15",
- "reasonDescription": "Customer not available or business closed",
- "action": "Contact us at <http://www.fedex.com/us/customersupport/call/index.html> to discuss possible delivery or pickup alternatives.",
- "actionDescription": "Customer not Available or Business Closed"
- "statusByLocale": "Picked up",
- "description": "Picked up",
- "delayDetail": {
- "type": "WEATHER",
- "subType": "SNOW",
- "status": "DELAYED"
- "serviceCommitMessage": {
- "message": "No scheduled delivery date available at this time.",
- "type": "ESTIMATED_DELIVERY_DATE_UNAVAILABLE"
- "informationNotes": [
- {
- "code": "CLEARANCE_ENTRY_FEE_APPLIES",
- "description": "this is an informational message"
- "error": {
- "code": "TRACKING.TRACKINGNUMBER.EMPTY",
- "parameterList": [
- {
- "value": "value",
- "key": "key"
- "message": "Please provide tracking number."
- "specialHandlings": [
- {
- "description": "Deliver Weekday",
- "type": "DELIVER_WEEKDAY",
- "paymentType": "OTHER"
- "availableImages": [
- {
- "size": "LARGE",
- "type": "BILL_OF_LADING"
- "deliveryDetails": {
- "receivedByName": "Reciever",
- "destinationServiceArea": "EDDUNAVAILABLE",
- "destinationServiceAreaDescription": "Appointment required",
- "locationDescription": "Receptionist/Front Desk",
- "actualDeliveryAddress": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "deliveryToday": false,
- "locationType": "APARTMENT_OFFICE",
- "signedByName": "Reciever",
- "officeOrderDeliveryMethod": "Courier",
- "deliveryAttempts": "0",
- "deliveryOptionEligibilityDetails": [
- {
- "option": "INDIRECT_SIGNATURE_RELEASE",
- "eligibility": "INELIGIBLE"
- "scanEvents": [
- {
- "date": "2018-02-02T12:01:00-07:00",
- "derivedStatus": "Picked Up",
- "scanLocation": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationId": "SEA",
- "locationType": "CUSTOMS_BROKER",
- "exceptionDescription": "Package available for clearance",
- "eventDescription": "Picked Up",
- "eventType": "PU",
- "derivedStatusCode": "PU",
- "exceptionCode": "A25",
- "delayDetail": {
- "type": "WEATHER",
- "subType": "SNOW",
- "status": "DELAYED"
- "dateAndTimes": [
- {
- "dateTime": "2007-09-27T00:00:00",
- "type": "ACTUAL_DELIVERY"
- "packageDetails": {
- "physicalPackagingType": "BARREL",
- "sequenceNumber": "45",
- "undeliveredCount": "7",
- "packagingDescription": {
- "description": "FedEx Pak",
- "type": "FEDEX_PAK"
- "count": "1",
- "weightAndDimensions": {
- "weight": [
- {
- "unit": "LB",
- "value": "22222.0"
- "dimensions": [
- {
- "length": 100,
- "width": 50,
- "height": 30,
- "units": "CM"
- "packageContent": [
- "wire hangers",
- "buttons"
- "contentPieceCount": "100",
- "declaredValue": {
- "currency": "USD",
- "value": 56.8
- "goodsClassificationCode": "goodsClassificationCode",
- "holdAtLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationType": "FEDEX_SHIPSITE"
- "customDeliveryOptions": [
- {
- "requestedAppointmentDetail": {
- "date": "2019-05-07",
- "window": [
- {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "description": "Redirect the package to the hold location.",
- "type": "REDIRECT_TO_HOLD_AT_LOCATION",
- "status": "HELD"
- "estimatedDeliveryTimeWindow": {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "pieceCounts": [
- {
- "count": "35",
- "description": "picec count description",
- "type": "ORIGIN"
- "originLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "recipientInformation": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "standardTransitTimeWindow": {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "shipmentDetails": {
- "contents": [
- {
- "itemNumber": "RZ5678",
- "receivedQuantity": "13",
- "description": "pulyurethane rope",
- "partNumber": "RK1345"
- "beforePossessionStatus": false,
- "weight": [
- {
- "unit": "LB",
- "value": "22222.0"
- "contentPieceCount": "3333",
- "splitShipments": [
- {
- "pieceCount": "10",
- "statusDescription": "status",
- "timestamp": "2019-05-07T08:00:07",
- "statusCode": "statuscode"
- "reasonDetail": {
- "description": "Wrong color",
- "type": "REJECTED"
- "availableNotifications": [
- "ON_DELIVERY",
- "ON_EXCEPTION"
- "shipperInformation": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "lastUpdatedDestinationAddress": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "alerts": "TRACKING.DATA.NOTFOUND - Tracking data unavailable"
Track Document
This endpoint helps you to request a letter that includes the recipient's signature as a proof of delivery.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.
header Parameters
x-customer-transaction-id | string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. |
content-type required | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
x-locale | string Example: en_US This indicates the combination of language code and country code. Click here to see Locales |
authorization required | string Example: Bearer XXX This indicates the authorization token for the input request. |
Request Body schema: application/json
- Full_Schema_SPOD
- Minimum_Payload_Track_Document
- Minimum_Sample_Payload_BOL
- Minimum_Sample_Payload_FBD
trackDocumentDetail required | object This object specifies the tracking document details such as types of documents, for example, SIGNATURE_PROOF_OF_DELIVERY and also the format of tracking document. Supported values are PDF and PNG. Default is PDF. |
trackDocumentSpecification required | Array of objects (TrackDocumentSpecification) This is the placeholder for document specification details required to identify the shipment being tracked. This includes tracking information such as tracking qualifier, carrier code, and tracking number. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "trackDocumentDetail": {
- "documentType": "SIGNATURE_PROOF_OF_DELIVERY",
- "documentFormat": "PNG"
- "trackDocumentSpecification": [
- {
- "trackingNumberInfo": {
- "trackingNumber": "128667043726",
- "carrierCode": "FDXE",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "shipDateBegin": "2020-03-29",
- "shipDateEnd": "2020-04-01",
- "accountNumber": "XXX61073"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "localization": {
- "languageCode": "en",
- "localeCode": "US"
- "documentType": "string",
- "documentFormat": "PNG",
- "document": [
- "string"
- "alerts": "TRACKING.DATA.NOTFOUND - Tracking data unavailable"
Track by Tracking Number
This endpoint provides customers package tracking information based on a tracking number for various shipping services.
Note: FedEx APIs do not support Cross-Origin Resource Sharing (CORS) mechanism.
header Parameters
x-customer-transaction-id | string Example: 624deea6-b709-470c-8c39-4b5511281492 This element allows you to assign a unique identifier to your transaction. This element is also returned in the reply and helps you match the request to the reply. |
content-type required | string Example: application/json This is used to indicate the media type of the resource. The media type is a string sent along with the file indicating format of the file. |
x-locale | string Example: en_US This indicates the combination of language code and country code. Click here to see Locales |
authorization required | string Example: Bearer XXX This indicates the authorization token for the input request. |
Request Body schema: application/json
- Full_Schema_Tracking_Numbers
- Track_by_Tracking_Number
includeDetailedScans required | boolean Indicates if detailed scans are requested or not. |
trackingInfo required | Array of objects (TrackingInfo) The tracking information of the shipment to be tracked. At least one occurrence of TrackingInfo is required. Maximum limit is 30. |
Responses
Success
Bad Request
Unauthorized
Forbidden
Not Found
Failure
Service Unavailable
Sandbox Server
Production Server
Request samples
- Payload
- C#
- JAVA
- JAVASCRIPT
- PHP
- PYTHON
- RUST
- SWIFT
- "includeDetailedScans": true,
- "trackingInfo": [
- {
- "shipDateBegin": "2020-03-29",
- "shipDateEnd": "2020-04-01",
- "trackingNumberInfo": {
- "trackingNumber": "128667043726",
- "carrierCode": "FDXE",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
- 503
- "transactionId": "624deea6-b709-470c-8c39-4b5511281492",
- "customerTransactionId": "AnyCo_order123456789",
- "output": {
- "completeTrackResults": [
- {
- "trackingNumber": "123456789012",
- "trackResults": [
- {
- "trackingNumberInfo": {
- "trackingNumber": "128667043726",
- "carrierCode": "FDXE",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "additionalTrackingInfo": {
- "hasAssociatedShipments": false,
- "nickname": "shipment nickname",
- "packageIdentifiers": [
- {
- "type": "SHIPPER_REFERENCE",
- "value": "ASJFGVAS",
- "trackingNumberUniqueId": "245822~123456789012~FDEG"
- "shipmentNotes": "shipment notes"
- "distanceToDestination": {
- "units": "KM",
- "value": 685.7
- "consolidationDetail": [
- {
- "timeStamp": "2020-10-13T03:54:44-06:00",
- "consolidationID": "47936927",
- "reasonDetail": {
- "description": "Wrong color",
- "type": "REJECTED"
- "packageCount": 25,
- "eventType": "PACKAGE_ADDED_TO_CONSOLIDATION"
- "meterNumber": "8468376",
- "returnDetail": {
- "authorizationName": "Sammy Smith",
- "reasonDetail": [
- {
- "description": "Wrong color",
- "type": "REJECTED"
- "serviceDetail": {
- "description": "FedEx Freight Economy.",
- "shortDescription": "FL",
- "type": "FEDEX_FREIGHT_ECONOMY"
- "destinationLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationType": "FEDEX_SHIPSITE"
- "latestStatusDetail": {
- "scanLocation": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "code": "PU",
- "derivedCode": "PU",
- "ancillaryDetails": [
- {
- "reason": "15",
- "reasonDescription": "Customer not available or business closed",
- "action": "Contact us at <http://www.fedex.com/us/customersupport/call/index.html> to discuss possible delivery or pickup alternatives.",
- "actionDescription": "Customer not Available or Business Closed"
- "statusByLocale": "Picked up",
- "description": "Picked up",
- "delayDetail": {
- "type": "WEATHER",
- "subType": "SNOW",
- "status": "DELAYED"
- "serviceCommitMessage": {
- "message": "No scheduled delivery date available at this time.",
- "type": "ESTIMATED_DELIVERY_DATE_UNAVAILABLE"
- "informationNotes": [
- {
- "code": "CLEARANCE_ENTRY_FEE_APPLIES",
- "description": "this is an informational message"
- "error": {
- "code": "TRACKING.TRACKINGNUMBER.EMPTY",
- "parameterList": [
- {
- "value": "value",
- "key": "key"
- "message": "Please provide tracking number."
- "specialHandlings": [
- {
- "description": "Deliver Weekday",
- "type": "DELIVER_WEEKDAY",
- "paymentType": "OTHER"
- "availableImages": [
- {
- "size": "LARGE",
- "type": "BILL_OF_LADING"
- "deliveryDetails": {
- "receivedByName": "Reciever",
- "destinationServiceArea": "EDDUNAVAILABLE",
- "destinationServiceAreaDescription": "Appointment required",
- "locationDescription": "Receptionist/Front Desk",
- "actualDeliveryAddress": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "deliveryToday": false,
- "locationType": "APARTMENT_OFFICE",
- "signedByName": "Reciever",
- "officeOrderDeliveryMethod": "Courier",
- "deliveryAttempts": "0",
- "deliveryOptionEligibilityDetails": [
- {
- "option": "INDIRECT_SIGNATURE_RELEASE",
- "eligibility": "INELIGIBLE"
- "scanEvents": [
- {
- "date": "2018-02-02T12:01:00-07:00",
- "derivedStatus": "Picked Up",
- "scanLocation": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationId": "SEA",
- "locationType": "CUSTOMS_BROKER",
- "exceptionDescription": "Package available for clearance",
- "eventDescription": "Picked Up",
- "eventType": "PU",
- "derivedStatusCode": "PU",
- "exceptionCode": "A25",
- "delayDetail": {
- "type": "WEATHER",
- "subType": "SNOW",
- "status": "DELAYED"
- "dateAndTimes": [
- {
- "dateTime": "2007-09-27T00:00:00",
- "type": "ACTUAL_DELIVERY"
- "packageDetails": {
- "physicalPackagingType": "BARREL",
- "sequenceNumber": "45",
- "undeliveredCount": "7",
- "packagingDescription": {
- "description": "FedEx Pak",
- "type": "FEDEX_PAK"
- "count": "1",
- "weightAndDimensions": {
- "weight": [
- {
- "unit": "LB",
- "value": "22222.0"
- "dimensions": [
- {
- "length": 100,
- "width": 50,
- "height": 30,
- "units": "CM"
- "packageContent": [
- "wire hangers",
- "buttons"
- "contentPieceCount": "100",
- "declaredValue": {
- "currency": "USD",
- "value": 56.8
- "goodsClassificationCode": "goodsClassificationCode",
- "holdAtLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "locationType": "FEDEX_SHIPSITE"
- "customDeliveryOptions": [
- {
- "requestedAppointmentDetail": {
- "date": "2019-05-07",
- "window": [
- {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "description": "Redirect the package to the hold location.",
- "type": "REDIRECT_TO_HOLD_AT_LOCATION",
- "status": "HELD"
- "estimatedDeliveryTimeWindow": {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "pieceCounts": [
- {
- "count": "35",
- "description": "picec count description",
- "type": "ORIGIN"
- "originLocation": {
- "locationId": "SEA",
- "locationContactAndAddress": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "recipientInformation": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "standardTransitTimeWindow": {
- "description": "Description field",
- "window": {
- "begins": "2021-10-01T08:00:00",
- "ends": "2021-10-15T00:00:00-06:00"
- "type": "ESTIMATED_DELIVERY"
- "shipmentDetails": {
- "contents": [
- {
- "itemNumber": "RZ5678",
- "receivedQuantity": "13",
- "description": "pulyurethane rope",
- "partNumber": "RK1345"
- "beforePossessionStatus": false,
- "weight": [
- {
- "unit": "LB",
- "value": "22222.0"
- "contentPieceCount": "3333",
- "splitShipments": [
- {
- "pieceCount": "10",
- "statusDescription": "status",
- "timestamp": "2019-05-07T08:00:07",
- "statusCode": "statuscode"
- "reasonDetail": {
- "description": "Wrong color",
- "type": "REJECTED"
- "availableNotifications": [
- "ON_DELIVERY",
- "ON_EXCEPTION"
- "shipperInformation": {
- "address": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "lastUpdatedDestinationAddress": {
- "addressClassification": "BUSINESS",
- "residential": false,
- "streetLines": [
- "1043 North Easy Street",
- "Suite 999"
- "city": "SEATTLE",
- "stateOrProvinceCode": "WA",
- "postalCode": "98101",
- "countryCode": "US",
- "countryName": "United States"
- "alerts": "TRACKING.DATA.NOTFOUND - Tracking data unavailable"
Response