Hold For Pickup 设施资讯API  

 

USPS Web Tools™

应用程序编程接口

User Guide

 Version 6.1 (7/13/2023)

 

 

 

 

 

Table of Contents

1.0         Introduction. 3

1.1            Before you get started: 3

2.0         等待取货设施信息API 3

2.1            Overview. 3

2.1.1      API Signature. 3

2.2            Request Descriptions. 3

2.2.1      Sample Request 4

2.3            反应描述. 5

2.3.1      Sample Response. 6

 

 

1.0   Introduction

This 文件中包含一份网投十大娱乐平台等待取货设施信息的参考指南 API. See the Developer's Guide 学习管理程序 获得对Web Tools api的访问以及调用的基本机制 api和处理结果.

Note: The Request 参数部分表示用于生成实时请求的XML输入标记 以及对允许的值的限制. 将出现错误消息 如果输入错误的值返回. 另外，要注意最大值 某些标签允许的字符数量. 如果用户输入的信息多于这些 ，则不会产生错误. Web工具将简单地传入 字符不超过允许的最大数量，而忽略其余部分. This is 很重要，因为结果值可能会阻止正确的响应.

 

在构建XML请求时，要特别注意 注意标签的顺序和包装. 如果，将返回错误消息 输入错误的值. 中的所有数据和属性值 本文件仅作说明之用，并应由您的文件所取代 actual values. 例如，一行示例代码可以是:

 

EJ123456780US

 

In this instance, you 是否将“EJ123456780US”替换为包裹的追踪ID.

1.1   Before you get started:

有关登记及领取的资料 开始使用Web工具，请参考 Step-By-Step guide found on the 技术文档. If 如果您需要进一步的帮助，请十大网堵平台USPS互联网客户十大网堵平台中心 Center (ICCC) http://Emailus.mygreenkeeper.com/.

 

2.0   等待取货设施信息API

2.1     Overview

等候取件十大网堵平台可于 大约31,000个USPS地点. 这个API将列出美国邮政十大网堵平台 提供暂存取件十大网堵平台的设施. 回应包括 基于邮政编码(五位数或九位数)或城市/州的设施，最多不超过 number of locations. 货物可由收件人或快递员提取 指定人员在指定的等候接机地点，时间为上午10点.m., noon, or 3 p.m.，基于与邮件类关联的十大网堵平台标准. Hold For 提货货物被发送到指定的等待提货位置，例如邮局 办公室，在那里货物可以在五个日历天内提取. Hold For 提货十大网堵平台让客户在方便的时候提货， 确保他们的货物被安全保管.

 

Note:“等待提货”不适用于 国际或APO/FPO目的地.

 

Note这个API提供了查找Hold For Pickup的功能 设施，而不是自己创建等待取件标签.

 

2.1.1   API Signature

Scheme

Host

Path

API

XML

http://

secure.shippingapis.com

/ShippingAPI.dll?

API=HFPFacilityInfo

&XML=(see below)

2.2     Request Descriptions

Tag Name

Occurs

Description

Type

Validation

HFPFacilityInfoRequest

Required

API=HFPFacilityInfo

(Alias)

 

HFPFacilityInfoRequest / USERID

Required

This attribute 指定您的Web Tools用户ID. See the Developer's Guide 获取有关获取USERID的信息.

For Example: USERID="XXXXXXX"

NMTOKEN

 

HFPFacilityInfoRequest / PASSWORD

Optional

This attribute 指定您的Web Tools密码. See the Developer's Guide 查阅有关密码的资料.

For Example: PASSWORD="XXXXXXX"

NMTOKEN

 

HFPFacilityInfoRequest / PickupCity

Required

Either City/State or 必须指定邮政编码. 当只提供城市和州，所有取货 地址在该城市和州内的设施将被退回.


For example: Boston 

String

minLength=1
maxLength=28
whiteSpace=collapse  

HFPFacilityInfoRequest / PickupState

Required

Either City/State or 必须指定邮政编码.


For example: MA 

String

minLength=2

maxLength=2
pattern=\w{2}
pattern=  

HFPFacilityInfoRequest / PickupZIP

Required

Either City/State or 必须指定邮政编码. 当提供PickupZIP而没有PickupZIP4时，所有 十大网堵平台于邮政编码返回的取件设施.


For example: 02111 

String

minLength=0
pattern=\d{5}
pattern=  

HFPFacilityInfoRequest / PickupZIP4

Required

If PickupZIP is 指定，则也可以指定PickupZIP4. 这将与单个匹配 有九位数邮政编码的取货设施.


For example: 9998 

String

minLength=0
pattern=\d{4}
pattern=  

HFPFacilityInfoRequest / Service

Optional

For future use. May be omitted.

String

default=EXPRESS
enumeration=EXPRESS

HFPFacilityInfoRequest

Required

 

(Alias)

 

2.2.1   Sample Request

Request: HFPFacilityInfo

33952

2.3     反应描述

Tag Name

Occurs

Description

Type

Validation

HFPFacilityInfoResponse

Required

 

(Alias)

 

HFPFacilityInfoResponse / PickupCity

Required

The criteria used to 获取设备列表在这里. 城市/州或邮政编码 (five or nine digit).  

String

 

HFPFacilityInfoResponse / PickupState

Required

The criteria used to 获取设备列表在这里. 城市/州或邮政编码 (five or nine digit).  

String

 

HFPFacilityInfoResponse / PickupZIP

Required

The criteria used to 获取设备列表在这里. 城市/州或邮政编码 (five or nine digit).  

String

 

HFPFacilityInfoResponse / PickupZIP4

Required

The criteria used to 获取设备列表在这里. 城市/州或邮政编码 (five or nine digit).  

String

 

HFPFacilityInfoResponse / Service

Optional

Echoed back from request.  

String

 

HFPFacilityInfoResponse / Facility

Optional repeating up to 50 times

Facility addresses 没有特定的返回顺序. 如果没有返回，则没有设施 匹配请求中给出的标准. 如果超过50个 发现的设施，前50个将连同超过的最大值一起归还 LogMessage标签中的advisory.  

(Group)

 

HFPFacilityInfoResponse / Facility / FacilityID

Required

ID of Pickup Facility.

String

 

HFPFacilityInfoResponse / Facility / FacilityName

Required

Name of Pickup Facility  

String

 

HFPFacilityInfoResponse / Facility / FacilityAddress

Required

Pickup Facility Address  

String

 

HFPFacilityInfoResponse / Facility / FacilityCity

Required

Pickup Facility City  

String

 

HFPFacilityInfoResponse / Facility / FacilityState

Required

Pickup Facility State  

String

 

HFPFacilityInfoResponse / Facility / FacilityZIP

Required

Pickup Facility ZIP Code  

String

 

HFPFacilityInfoResponse / Facility / FacilityZIP4

Required

Pickup Facility ZIP Code+4  

String

 

HFPFacilityInfoResponse / Facility / has10am承诺

Required

Indicative of 设施的等待取货可用性. A value of "true" 表示包裹可在当地时间上午10点取件.  

Boolean

 

HFPFacilityInfoResponse / LogMessage

Optional

A text message for 这个API的集成商. 它可能包含有关此的其他信息 特定的请求/响应，或网投十大娱乐平台API的一般信息. With typical 实现时，无论何时遇到此标记，都会将消息写入 用于以后分析的控制台日志文件.  

String

 

HFPFacilityInfoResponse

Required

 

(Alias)

 

2.3.1   Sample Response

Response: HFPFacilityInfo

33952

1438805

PORT CHARLOTTE BRANCH

3740 TAMIAMI TRL

PORT CHARLOTTE

FL

33952

9998

false

1378061

PORT CHARLOTTE ANNEX

18100 PAULSON DR

PORT CHARLOTTE

FL

33954

9998

false

/HFPFacilityInfoResponse>