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": {
    },
  • "carrier": "USPS",
  • "carrierFacilityOptions": [
    ]
}
Response samples
application/json
{
  • "address": {
    },
  • "carrier": "USPS",
  • "carrierFacilityOptions": [
    ],
  • "carrierFacilitySuggestions": [
    ]
}