Skip to main content
GET
/
api
/
v1
/
Shipments
/
Carriers
/
HoldAtLocations
{
  "isSuccess": true,
  "message": "<string>",
  "payload": [
    {
      "line1": "<string>",
      "city": "<string>",
      "stateCode": "<string>",
      "postalCode": "<string>",
      "carrier": "FedEx",
      "carrierLocationId": "<string>",
      "distanceMiles": 123,
      "line2": "<string>",
      "line3": "<string>",
      "countryCode": "US"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Enter the Bearer AccessToken; Example: 'Bearer 12345abcdef'

Query Parameters

​
carrier
enum<string>
required

FedEx or UPS. Defaults to FedEx

Available options:
FedEx,
UPS
​
line1
string
required

Address Line 1

​
line2
string

Address line 2.

​
line3
string

Address line 3.

​
city
string
required

City name.

Maximum string length: 100
​
stateCode
string
required

Two-character state code.

Required string length: 2
​
postalCode
string
required

Postal code.

Required string length: 5 - 11
​
countryCode
string
default:US

Country code (Only US is currently supported).

Required string length: 2

Response

200 - application/json

A list of addresses for FedEx or UPS stores near an address

Generic container for all service responses

​
isSuccess
boolean

Was the request successful. If not, the message will have more information.

​
message
string | null

Any error message

​
payload
object[] | null

The payload object of the response