Carrier facilities

This operation locates Post Offices and other facilities for a given carrier. You can use this operation, for example, to locate all USPS Post Offices near a given postal code.

SecuritybearerAuth

Request

Request Body schema: application/json

required	object (FacilityAddress) Address details used as the reference point for the facility search or returned as part of a carrier facility suggestion.
carrier required	string The carrier for which to locate facilities. This operation currently supports searching for USPS facilities.
	Array of objects (CarrierFacilityOptions) Filters the types of facilities returned. Each object in the array is a name-value pair that specifies a carrier facility option. Each object contains a `name` field (the option) and a `value` field (the option value). Both fields take strings.

Responses

200

Facilities available at the specified location have been fetched successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/carrier-facility

Request samples

application/json

{"address": {"addressLine1": "24182 Kathy Ave",
"addressLine2": "near abc street",
"addressLine3": "near xyz street",
"company": "Pitney Bowes Inc.",
"email": "testuser@gmail.com",
"phone": "6502530000",
"cityTown": "Lake Forest",
"stateProvince": "CA",
"postalCode": "92630",
"countryCode": "US"
},
"carrier": "USPS",
"carrierFacilityOptions": [[{"name": "FACILITY_TYPE",
"value": "POST_OFFICE"
},
{"name": "FACILITY_TYPE_SERVICE",
"value": "LABEL_BROKER_RETAIL"
},
{"name": "FACILITY_WITHIN_RADIUS",
"value": "10"
},
{"name": "NUMBER_OF_FACILITIES",
"value": "1"
}
]
]
}

Response samples

application/json

{"address": {"addressLine1": "24182 Kathy Ave",
"cityTown": "Lake Forest",
"company": "Pitney Bowes Inc.",
"countryCode": "US",
"email": "Kathryn@email.com",
"phone": "6502530000",
"postalCode": "92630",
"residential": false,
"stateProvince": "CA"
},
"carrier": "USPS",
"carrierFacilityOptions": [{"name": "FACILITY_TYPE",
"value": "POST_OFFICE"
},
{"name": "FACILITY_TYPE_SERVICE",
"value": "LABEL_BROKER_RETAIL"
},
{"name": "FACILITY_WITHIN_RADIUS",
"value": "10"
},
{"name": "NUMBER_OF_FACILITIES",
"value": "1"
}
],
"carrierFacilitySuggestions": [{"address": {"addressLine1": "24552 RAYMOND WAY",
"cityTown": "LAKE FOREST",
"postalCode": "92630",
"residential": false,
"stateProvince": "CA"
},
"facilityHours": [{"day": "MONDAY",
"facilityTimings": [{"opensAt": "08:30:00",
"closesAt": "17:00:00"
}
]
},
{"day": "TUESDAY",
"facilityTimings": [{"opensAt": "08:30:00",
"closesAt": "17:00:00"
}
]
},
{"day": "WEDNESDAY",
"facilityTimings": [{"opensAt": "08:30:00",
"closesAt": "17:00:00"
}
]
},
{"day": "THURSDAY",
"facilityTimings": [{"opensAt": "08:30:00",
"closesAt": "17:00:00"
}
]
},
{"day": "FRIDAY",
"facilityTimings": [{"opensAt": "08:30:00",
"closesAt": "17:00:00"
}
]
},
{"day": "SATURDAY",
"facilityTimings": [{"opensAt": "10:00:00",
"closesAt": "15:00:00"
}
]
}
],
"facilityParking": "LOT"
}
]
}