注意:- 从亚太地区到美国或波多黎各的 FedEx International Connect Plus (FICP) 服务货件,若关税与税金由收件人支付,则需要提供 FedEx 账号:
- 如果任何货件货品的制造国家/地区是中国/中国香港
此API可让您创建开放货件,并允许在一段时间内向其添加包裹,无需一次性输入所有货件和包裹信息。货件将保持开放状态五天,在该时间段内,它可以接受包裹添加和修改操作。货件确认后,即可生成标签、AWB或报告等托运文件。五天时间结束后,您必须确认该货件,否则便会将其清除。
注意:如果自货件创建之时起到第五天结束前未获确认,开放货件将被清除。
当您想在一段时间内向某个货件添加多个包裹,并且不确定要添加的包裹数量或托运完成日期时,将使用Open Ship API。这样,在准备托运之前,您可以花一整天的时间灵活地准备货件。
开放托运货件通常是一票多件货件,但也可以是单件包裹货件(也称为单件货件)。
要将一票多件货件(MPS)托运至单一收件人,请使用Open Ship API并将个别包裹添加到货件中,或者添加多个包裹(如果要寄给同一个收件人)。
以下是与开放货件相关的服务:
以下是与Open Ship API相关的功能:
管理开放货件
此功能可让寄件人创建、修改、删除开放货件,并检索已创建的开放货件以进行审核或验证。通过该功能可确认已完成货件,以将货件数据传输给FedEx,并生成相应的货件文件。此外,还可以识别并报告交易中的任何错误,并提供相应状态。
此功能的重要信息为accountNumber、Shipment Data、groupPackageCount、index,以表示货件的主包裹。此功能的结果将确保货件数据上传到FedEx系统,以及生成相应的追踪号码、标签和货件报告。
管理开放货件包裹
此功能可让您在已创建的开放货件中添加、修改和删除包裹。此外,还可以检索现有开放货件的现有包裹。
获取开放货件结果(异步)
通过此功能可异步检索已确认的货件结果。确认包含40个或以上包裹的开放货件后,API会异步处理货件。
异步处理货件时,对此请求的回复只会确认请求已成功排入队列,但货件可能会成功处理,也可能不会成功处理。作为响应,它将返回jobId,以便稍后检索结果。此功能使用jobId检索开放货件结果(创建、修改及确认),这些结果可能是标签、货件报告。此外,还可以识别并报告货件中的任何错误,并提供相应状态。
注意:如果异步货件响应中存在错误,请修复该错误并提交新的货件请求。
本节详细介绍Open Ship API的工作流程。Open Ship工作流程以两种方式管理或使用两个处理选项:
40个或以下包裹的工作流程
此确认开放货件端点是此流程的最后一个端点,可验证货件和包裹信息,并成功生成该货件的标签和所有其他报告。该端点还可提供验证期间返回的错误详细信息。可使用端点修改开放货件或修改开放货件包裹并再次确认货件请求是否成功来修复这些错误。
40个以上包裹的工作流程
获取开放货件结果端点是此流程的最后一个端点,可检索已确认的开放货件结果,例如已确认开放货件的标签和所有其他报告。如果响应中返回了错误详细信息,则可以使用端点修改开放货件或修改开放货件包裹修复这些错误,然后使用端点确认开放货件确认货件,最后使用端点获取开放货件结果检索已确认开放货件结果以获得成功请求。
以下是与Open Ship API相关的功能:
创建开放货件
使用此端点可创建包含所需货件信息的开放货件,并至少定义货件中的一个包裹。
以下是用于创建开放货件的所需输入信息:
针对此请求的成功响应将处理货件并生成追踪号码,该号码即为第一个包裹的主追踪号码。请注意,响应中不会生成标签。
添加开放货件包裹
使用此端点可在货件确认之前向现有开放货件请求添加一个或多个包裹。在当天准备货件时,您可以为每个包裹发送单独的添加包裹请求。您也可以在添加包裹请求中发送多个包裹。
注意:货件的包裹总数不得超过开放货件包裹限制。
以下是用于向开放货件添加包裹的所需输入信息:
针对此请求的成功响应将为新添加的包裹生成追踪号码。
修改开放货件包裹
使用此端点可在货件确认之前修改现有Open Ship货件中的一个或多个包裹的详细信息。此详细信息也包括主包裹详细信息,即向开放货件添加的第一个包裹。
下面是与此请求关联的必要输入信息:
成功请求将更新目标包裹并返回更新后的货件详细信息。
删除开放货件包裹
使用此端点可在货件确认之前从已创建的开放货件中删除一个或多个包裹。
下面是与此请求关联的必要输入信息:
成功请求将删除目标包裹,并在输出中将元素deletedPackagesFromOpenshipment的状态返回为true。
注意:如果货件中的主包裹被删除,序列中的下一个包裹将成为主包裹,并重新获分配主追踪号码,号码序列会减去已删除包裹的数量。
检索开放货件包裹
使用此端点可从已创建的开放货件中检索一个或多个包裹,以进行审核或验证。
下面是与此请求关联的必要输入信息:
成功请求将检索目标包裹。
修改开放货件
使用此端点可在货件确认之前使用所需托运信息修改开放货件请求。
下面是与此请求关联的必要输入信息:
成功请求将更新货件详细信息至已创建的开放货件,并在输出中返回已修改包裹的追踪号码和更新后的交易货件详细信息。
检索开放货件
使用此端点可检索已创建的开放货件,以进行审核或验证。
下面是与此请求关联的必要输入信息:
成功请求将检索目标开放货件详细信息。
删除开放货件
使用此端点可在货件确认之前删除开放货件请求。
下面是与此请求关联的必要输入信息:
成功请求将删除开放货件和所有关联包裹,并在输出中将元素deletedOpenshipment的状态返回为true。
确认开放货件
使用此端点可在所有包裹均添加到货件请求中后验证Open Ship货件数据并将其上传到FedEx系统。
下面是与此请求关联的必要输入信息:
针对40个或以下包裹的成功确认响应将上传货件数据至FedEx系统,并生成包裹标签及所有其他货件报告。
针对40个以上包裹的成功确认响应将确认请求已成功排入队列并返回jobId,以在稍后检索结果。
注意: 开放货件中应至少包含一个包裹,然后才能确认货件。
获取货件结果
使用此端点可获取已确认的Open Ship货件数据。此端点只能在货件包含40个以上包裹且开放货件确认中返回jobId时使用。
下面是与此请求关联的必要输入信息:
针对此请求的成功响应将返回已确认的开放货件结果,例如已确认的开放货件的包裹标签和所有其他货件报告。如果响应中返回了错误详细信息,则可以使用端点修改开放货件或修改开放货件包裹修复这些错误,然后使用端点确认开放货件确认货件,最后使用端点获取开放货件结果检索已确认开放货件结果。
一票多件开放货件(MPS)由托运给同一个收件人的两个或更多个包裹组成。货件请求中的第一个包裹视为主包裹。
创建一票多件货件:
货件确认后,请使用以下其中一个处理选项:
同步货件处理
同步处理是其中一种最佳处理方法,如果货件包含40个或以下包裹(totalPackageCount<=40)且含有受限货品,则会在内部使用此方法。
包含40个或以下包裹的货件请求在确认时会同步处理,并立即生成标签、货件文件/报告。如果寄件人时间紧迫,并且标签必须在货件确认后立即打印,此即为最佳流程。
注意:40个包裹上限是指示性限制,并非固定的限制。该限制还取决于货件中的包裹和货品的组合。有关详细信息,请联系您的FedEx支持团队。
示例:您的开放货件请求包含10个包裹。如果您在添加所有10个包裹后确认货件,将会同步处理该货件。响应中会创建10个标签,并且会依请求在响应中提供标签URL或编码标签。
以下高级别工作流程示范了同步开放货件处理:
注意:
异步货件处理
当包裹总数超过40(即totalPackageCount>40)时,API会在内部异步处理货件。如果您的包裹数量很大,并且您要定期提交大宗货件,这是一个非常方便的方法。一旦提交,此大宗货件提交将使用各种昂贵的FedEx资源和操作。利用此处理选项,FedEx可在内部确保这些大宗货件得到轻松处理,并且您还可以定期获取标签数据。
异步处理货件时,对此请求的回复只会确认请求已成功排入队列,但货件可能会成功处理,也可能不会成功处理,并返回jobId,以在稍后检索结果。
注意:此过程需要一些时间来成功完成货件处理,然后您才能检索结果。
若要检索异步货件结果,请使用端点获取开放货件结果并在请求中提供jobId和accountNumber详细信息。此请求的响应将返回包含标签详细信息或货件错误详细信息的货件结果数据。
示例:您的货件包含45个包裹,提交后,将进行异步处理。在响应中,将返回jobId。然后,您应使用端点获取开放货件结果来检索货件结果和标签数据。
以下高级别工作流程示范了异步托运处理:
注意:
Print As You Go (PASGO)
利用 Print As You Go (PASGO) 功能,可以创建包裹并将其添加到 PASGO MPS 开放货件,并且可在添加每个包裹时随即打印标签。这意味着,您可以随印随发标签,而无需等待货件关闭。
重要事项:
FedEx API支持多种标签。FedEx API支持三类标签选项,包括热敏标签、普通纸标签和可自定义标签。您可以使用Open Ship API端点来生成各种标签。
FedEx提供两种标签格式用于支持托运服务:
热敏标签
FedEx API可让您使用各种热敏标签打印机来打印所有托运类型的托运标签,例如FedEx Express®、FedEx Ground®和FedEx International Ground®。
FedEx API支持以下热敏标签大小:
标签贴纸类型:4X8.5英寸和4X10.5英寸(包含使用相同条形码的额外文件标签)。主标签上会显示一个条形码,另一个条形码显示在文件标签上。此标签贴纸类型值对于轮胎包裹很有用,因为一个标签可贴在轮胎胎面,另一个文件标签及复制的条形码和操作说明可贴在轮胎侧壁。使用这些标签贴纸类型可减少轮胎重贴标签的次数,并提升了立体扫描优化恢复。有关标签贴纸的详细信息,请参考标签贴纸类型。
注意:文件标签是一种附带其他托运信息的可去除粘性标签,使用热敏打印机打印托运标签时,可为标签贴纸选择此标签。
热敏标签元素
热敏托运标签包含三个基本元素:
生成热敏标签的重要信息
以下是生成热敏标签所需的重要信息:
有效值:
ImageType:根据您使用的打印机格式化热敏标签时的必需信息;可提供要返回的数据流类型或位图类型。
有效值:
注意:货件所需的所有标签都在一个缓冲区中生成并返回。
受支持的热敏打印机
建议对FedEx API使用以下热敏打印机:
注意:这些打印机都与ASCII Eltron编程语言(EPL2)页面模式兼容。热敏打印机既可以作为连接至系统串行端口的直接写入打印机,也可以作为本机Windows安装的打印机用于连接LPT、串行或USB。FedEx提供的打印机的固件版本可能因地区而异。
每项服务打印的热敏标签数量
下表列出了各特殊服务所需的每种标签类型的数量。所有必要的标签都通过调用FedEx Common Label Server (CLS)生成,CLS会返回一个缓冲区(C.O.D.退件标签除外)。
每项美国服务打印的热敏标签数量
服务类型 |
热敏标签(FedEx CLS将在响应中返回相应的标签数量) |
FedEx Express美国 |
1个托运标签 |
FedEx Ground美国/ FedEx Home Delivery |
1个托运标签 |
每项美国出口国际服务打印的热敏标签数量
服务类型 |
热敏标签(FedEx CLS将在响应中返回相应的标签数量) |
FedEx Express美国出口国际 |
1个托运标签 2个收件人标签 |
FedEx Express美国出口国际代理人自选选项 |
1个托运标签 2个收件人标签 |
FedEx Ground美国出口国际 |
1个托运标签 |
FedEx Ground美国出口国际货到付款 |
1个托运标签 2个C.O.D.退件标签 |
每项加拿大境内服务打印的热敏标签数量
服务类型 |
热敏标签(FedEx CLS将在响应中返回相应的标签数量) |
FedEx Express加拿大境内 |
非危险品/干冰货件: 1个托运标签 |
FedEx Ground加拿大境内 |
1个托运标签 |
FedEx Ground加拿大境内货到付款 |
1个托运标签 2个C.O.D.退件标签 |
每项加拿大出口国际服务打印的热敏标签数量
服务类型 |
热敏标签(FedEx CLS将在响应中返回相应的标签数量) |
FedEx Express加拿大出口国际 |
非危险品/干冰货件: 1个托运标签 2个收件人标签 |
FedEx Express加拿大出口国际代理人自选 |
非危险品/干冰货件: 1个托运标签 2个收件人标签 |
FedEx Ground加拿大出口国际 |
1个托运标签 |
每个菲律宾和泰国进口货件打印的热敏标签数量
服务类型 |
热敏标签(FedEx CLS将在响应中返回相应的标签数量) |
菲律宾入境货件 |
2个印有帐号的托运标签 打印1个不含帐号的收件人标签 3份商业发票副本 |
泰国入境货品货件 |
打印3个含帐号的托运标签 打印1个不含帐号的收件人标签 |
泰国入境文件货件 |
2个印有帐号的托运标签 打印1个不含帐号的收件人标签 |
文件标签
如果使用热敏打印机来打印托运标签,您可以选择包含文件标签的标签贴纸(一种附带其他托运信息的可去除粘性标签)。您可以在托运数据中配置此托运信息,也可以选择打印特定于您的托运需求的可配置数据。
激光标签
FedEx API支持使用激光打印机打印标签。这些标签通常打印在U.S. Letter或A4纸上,然后对半折叠以放入标准的FedEx标签袋中。使用激光打印机打印的标签会以PDF的格式生成,因此不需要缩放或调整大小。有关标签贴纸的详细信息,请参考标签贴纸类型。
先决条件
下列要求适用于PDF标签:
PDF标签选项不必指定图像方向参数(宽度和高度)或屏幕分辨率,便可在浏览器中正常显示标签。
激光标签元素
激光托运标签包含三个基本元素:
生成激光标签的重要信息
生成激光标签需要以下FedEx API元素:
有效值为:
注意:如果您请求普通纸标签,则返回的数据是采用Base64编码的标签图像,您必须先进行Base64解码才能显示该标签文件。
受支持的激光打印机
大部分激光打印机都支持此标签类型;但如果要通过喷墨打印机进行打印,则不接受这些标签。
注意:如果您使用的是彩色激光打印机,则色彩定义应设置为黑色,即使打印机只安装了黑色墨盒也是如此。
各项服务需要的激光标签数量
下表列出了各特殊服务所需的每种标签类型的数量。所有必要的标签都通过调用FedEx Common Label Server (CLS)生成,CLS会返回一个缓冲区(C.O.D.退件标签除外)。
每项美国服务打印的激光标签数量
服务类型 |
激光标签 - PDF格式 |
FedEx Ground / FedEx Home Delivery美国 |
1个托运标签 |
每项美国出口国际服务打印的激光标签数量
服务类型 |
激光标签 - PDF格式 |
FedEx Express美国出口国际 |
回复中有1个托运标签;必须至少打印3个标签 – 包裹上1个标签以及文件袋上2个标签。 |
FedEx Express美国出口国际代理人自选 |
回复中有1个托运标签;必须至少打印3个标签 – 包裹上1个标签以及文件袋上2个标签。 |
FedEx Ground美国出口国际 |
1个托运标签 |
FedEx Ground美国出口国际货到付款 |
1个托运标签 2个C.O.D.退件标签 |
每项墨西哥境内服务打印的激光标签数量
服务类型 |
激光标签 - PDF格式 |
FedEx Express墨西哥境内 |
FedEx Express墨西哥境内 非危险品/干冰货件: 1个托运标签 |
每项加拿大境内服务打印的激光标签数量
服务类型 |
激光标签 - PDF格式 |
FedEx Express加拿大境内 |
FedEx Express加拿大境内 非危险品/干冰货件: 1个托运标签 |
FedEx Ground加拿大境内 |
1个托运标签 |
FedEx Ground加拿大境内货到付款 |
1个托运标签 2个C.O.D.退件标签 |
每项加拿大出口国际服务打印的激光标签数量
服务类型 |
激光标签 - PDF格式 |
FedEx Express加拿大出口国际 |
FedEx Express加拿大出口国际 非危险品/干冰货件: 1个托运标签 2个收件人标签 |
FedEx Express加拿大出口国际代理人自选 |
FedEx Express加拿大出口国际代理人自选 非危险品/干冰货件: 1个托运标签 2个收件人标签 |
FedEx Ground加拿大出口国际 |
1个托运标签 |
每项加拿大出口国际服务打印的激光标签数量
服务类型 |
激光标签 - PDF格式 |
FedEx Express加拿大出口国际 |
FedEx Express加拿大出口国际 非危险品/干冰货件: 1个托运标签 2个收件人标签 |
FedEx Express加拿大出口国际代理人自选 |
FedEx Express加拿大出口国际代理人自选 非危险品/干冰货件: 1个托运标签 2个收件人标签 |
FedEx Ground加拿大出口国际 |
1个托运标签 |
每个菲律宾和泰国进口货件打印的激光标签数量
服务类型 |
热敏标签(FedEx CLS将在响应中返回相应的标签数量) |
菲律宾入境货件 |
2个印有帐号的托运标签 打印1个不含帐号的收件人标签 3份商业发票副本 |
泰国入境货品货件 |
打印3个含帐号的托运标签 打印1个不含帐号的收件人标签 |
泰国入境文件货件 |
2个印有帐号的托运标签 打印1个不含帐号的收件人标签 |
自定义标签
FedEx允许您对FedEx生成的标签进行自定义。您可以添加与您业务相关的文本,并选择在FedEx文件和标签的热敏标签自定义部分上使用的条形码(符号)类型。
为了支持您的托运应用程序,FedEx Open Ship API提供了两个选项可供您自定义托运标签:
注意:无法更改标签的人工读取内容和标签公共部分中的条形码。
自定义验证器标签
您可以创建包裹级别和货件级别的非托运自定义标签,方法是指定所需的自定义信息、如何格式化该信息以及要将其放在自定义标签上的位置。自定义标签受限于热敏标签格式。
自定义热敏标签
FedEx API提供了两种热敏标签格式,您可以使用图形或文本文件进行自定义,而无需创建自定义标签。这些标签支持所有FedEx托运服务。这些格式包括:
这些标签类型提供 2 英寸的可自定义部分。此功能适用于在设置为 203 DPI 或 300 DPI 的热敏打印机上打印的热敏标签。
自定义标签规则
这些标签格式的使用规则如下:
注意:应只添加单比特位色彩图像,因为标签将以黑白颜色打印。
自定义标签图形项目元素
API可为FedEx Express和FedEx Ground标签提供PNG(可移植网络图形)图像。PNG标签图形是API支持的热敏或普通纸标签的副本。此标签选项可让您将PNG标签图形置于标签贴纸上,而无需创建自定义标签。
当使用嵌入在托运文件中的4x6英寸PNG图形时,适用以下要求:
标签贴纸
4x6 英寸 PNG 标签只应与即撕即贴标签贴纸配合使用。FedEx Ground 和 FedEx Express 标签验证团队将拒绝不是在即撕即贴标签贴纸上打印的 4x6 英寸 PNG 标签,包括任何打印在普通纸上的标签。
打印机
建议使用激光打印机来打印标签。不应使用喷墨打印机,因为它们在创建可扫描条形码时会产生不一致。除非色彩定义设置为黑色,否则不能使用彩色打印机打印4x6英寸PNG标签,即使打印机只安装了黑色墨盒也是如此。要产生可供FedEx集散中心扫描的正确条形码定义,就必须进行此设置。
缩放
在托运交易中返回的图像的每英寸点数(DPI)为200,尺寸为4(宽)x6(高)英寸或800x1200像素。此标签的方向为纵向,适合打印在4x6英寸标签区域中。打印出来后,标签尺寸将为4x6英寸。
为了采用所需DPI生成标签和条形码,您必须在打印之前缩放图像(或调整其大小)。缩放图像的方式取决于您用来查看和打印标签的应用程序。要以英寸为单位缩放4x6英寸标签的PNG图像:精确使用4英寸宽和6英寸长。
标签复查核对清单
所有条形码
验证要点:
打印质量
导致标签被拒的常见问题:
Ground标签的人工读取详细信息
对于FedEx Ground标签的人工读取内容,需要验证以下项目:
Express标签的人工读取详细信息
标签上必须打印以下元素才能通过验证:
以下规则适用于Open Ship API:
Response