Get locations | ShipBob Developer API

[
  {
    "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"
  }
]

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Query parameters

IncludeInactivebooleanOptional

Whether the inactive locations should be included or not

ReceivingEnabledbooleanOptional

Return all the receiving enabled locations

AccessGrantedbooleanOptional

Return all the access granted locations

Response

Success

Locations.LocationViewModelobject

Locations.InternalLocationViewModelobject

Locations.InternalLocationViewModelV2object

Locations.LocationViewModelV2object

Errors

401

Unauthorized Error

403

Forbidden Error