GET
/
location
curl --request GET \
  --url https://api.shipbob.com/2.0/location \
  --header 'Authorization: <api-key>'
[
  {
    "abbreviation": "string",
    "access_granted": true,
    "attributes": [
      "string"
    ],
    "id": 0,
    "is_active": true,
    "is_receiving_enabled": true,
    "is_shipping_enabled": true,
    "name": "string",
    "region": {
      "id": 0,
      "name": "string"
    },
    "services": [
      {
        "address": {
          "address1": "string",
          "address2": "string",
          "city": "string",
          "country": "string",
          "email": "string",
          "name": "string",
          "phone_number": "string",
          "state": "string",
          "zip_code": "string"
        },
        "enabled": true,
        "service_type": "Receiving"
      }
    ],
    "timezone": "string"
  }
]

Authorizations

​
Authorization
string
header
required

Provide your personal access token in the format 'Bearer {your_personal_access_token}'

Query Parameters

​
IncludeInactive
boolean

Whether the inactive locations should be included or not

​
ReceivingEnabled
boolean

Return all the receiving enabled locations

​
AccessGranted
boolean

Return all the access granted locations

Response

200
application/json
Success
​
abbreviation
string | null

Abbreviation of the location. Combination of nearest Airport Code and the sequence number.

​
access_granted
boolean

Indicates whether or not the user is authorized to interact at all with the location

​
attributes
string[] | null

Available attributes for the location

​
id
integer

Id of the location in ShipBob’s database

​
is_active
boolean

Indicates if the location is operationally active or inactive

​
is_receiving_enabled
boolean

Indicates if the receiving is enabled for FC

​
is_shipping_enabled
boolean

Indicates if the shipping is enabled for FC

​
name
string | null

Name of the location. Follows the naming convention City (State Code) for domestic FCs and City (Country Code) for international FCs

​
region
object
​
services
object[] | null

Services provided by the location

​
timezone
string | null

Time zone of the location

Was this page helpful?