预约取件
在指定地址预约 USPS 承运商取件
预约承运商取件,让 USPS 从您的地址收取包裹。目前仅支持 USPS。
需要标签验证
您必须至少拥有一个有效的 USPS 标签(状态为 generated 或 printed),且其发货地址与取件的 ZIP 邮政编码相匹配。没有匹配标签的请求将返回 NO_ACTIVE_LABELS 错误。
参数
请求体
carrier
string (USPS)
承运商代码。目前仅支持 USPS。默认为 USPS。
pickup_date
string
必填
取件日期,格式为 YYYY-MM-DD。必须为今天或未来日期。
pickup_address
object
必填
取件地点,包含 name、street1、city、state、zip 和 phone。
package_count
integer
要取件的包裹数量。默认为匹配的有效标签数量。
total_weight
number
所有包裹的总重量,单位为 oz。
packages
array
按服务类型细分。每项:{ service_type, count, weight }。
pickup_time_window
object
首选时间窗口:{ start_time, end_time },格式为 HH:MM。默认为 08:00-18:00。
special_instructions
string
给承运商司机的说明(例如“包裹放在前台”)。
返回
201
取件预约成功
400
请求无效,或取件地址处没有有效的 USPS 标签
401
需要身份验证
422
取件验证失败
相关
pickup
usps
schedule
POST/api/v1/pickups