QUICKSTART
API Quick Start
Authentication
SignString
OAuth
Overview
Getting Started
Scope List
Rate Limit
Body Envelope
Request Errors
CHANGELOG
Changelog
REFERENCE
API Overview
v3
Rates
Get rates
get
Calculate rates
post
Get a rate
get
Labels
Get labels
get
Create a label
post
Get a label
get
Manifests
Get manifests
get
Create a manifest
post
Get a manifest
get
Couriers
Get all couriers
get
Cancel Labels
Get the cancelled labels
get
Cancel a label
post
Get a cancelled label
get
Pickups
Get pickups
get
Create a pickup
post
Get a pickup
get
Cancel Pickups
Get the cancelled pickups
get
Cancel a pickup
post
Get a cancelled pickup
get
Shipper Accounts
Get shipper accounts
get
Create a shipper account
post
Get a shipper account
get
Delete a shipper account
delete
Update a shipper account's information
put
Update a shipper account's credentials
patch
Update a shipper account's settings
patch
Specific Shipper Accounts
Create a FedEx shipper account
post
Update a FedEx shipper account
post
Address Validations (Beta)
Create an address validation
post
Locations
Get locations
get
MODEL
Envelope
Meta
v3
Error
v3
Primitive
Billing
v3
Customs
v3
Shipment
v3
Address
v3
Parcel
v3
Item
v3
Courier
v3
Reference
v3
Money
v3
PaymentMethodAccount
v3
Dimension
v3
Weight
v3
Volume
v3
Aes
v3
NoEei
v3
Resource
Rate
v3
RateRecord
v3
Label
v3
Manifest
v3
ShipperAccount
v3
CancelLabel
v3
AddressValidation (Beta)
v3
Location
v3
Pickup
v3
CancelPickup
v3
Carrier Guide
Supported Carriers
ENUM
Shipper Accounts Credentials
Service Types and Service Options List
All Service Options
Webhook
Webhook Overview
Webhook Specifications
Webhook Signature
Webhook Outgoing IPs
SDK
Java SDK
Node.js SDK
Open Source
phone
email-verifier
Support
Contact Support

Location

Location object: the description of location information

Location object: the description of location information

location_id
string

Location ID

name
string

Name of location

distance
number

Distance of location

Example:
0.3259
distance_unit
string

Distance unit of location

Allowed values:
kmmi
Example:
km
phone
string or null

Contact phone of location

services
array[string]

Supported services of location

address
object
street
string or null

Street of address

Example:
33 PARK PL
postal_code
string or null

Postal code of address

Example:
10007-2485
city
string or null

City of address

Example:
NEW YORK
state
string or null

State of address

Example:
NY
country
string

Country in ISO 3166-1 alpha 3 code

Example:
USA
latitude
number or null

Latitude number

Example:
-74.0095291
longitude
number or null

Longitude number

Example:
40.71355056
business_hours
array[object]

Bussiness Hours of location

day_of_week
string
Allowed values:
MonTueWedThuFriSatSun
Example:
Mon
open_time
string

Location open time, HH:MM

Example:
09:00
close_time
string

Location end time, HH:MM

Example:
17:00
instructions
string or null

Walking directions or handling instructions for this location

location_type
string or null

Location type

Example:
the_ups_store
business_classification
string or null

Business classification type of location

Example:
pack_and_ship
courier_specific
object or null

Carrier-specific data for this location. Returns null if no carrier-specific fields are available for the slug.

ups
object

UPS-specific fields for this location. Only present when the slug = ups.

Example
preparing...