GET
/
1.0
/
location
Get locations 
curl --request GET \
  --url https://api.shipbob.com/1.0/location \
  --header 'Authorization: Bearer <token>'
[
  {
    "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"
  }
]
Use this API to interact with the physical locations across ShipBob’s fulfillment network. An active ShipBob location is operational for fulfillment processes, including receiving inventory and processing returns. It’s important to note that some locations, access is granted to all merchants by default, while some locations require special request for merchants to be granted access. For each location, determine if it can be leveraged for the user by viewing the access_granted & receiving_enabled fields.

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) 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

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