API ReferenceLocations

Get Locations

View as Markdown
Retrieves physical locations across ShipBob's fulfillment network. An active location (`is_active=true`) is operational for fulfillment processes, including receiving inventory and processing returns. Access to locations varies: some are available to all merchants by default, while others require special approval. Use the `access_granted` parameter to determine if a location is available to the authenticated user, and `receiving_enabled` to confirm if the location accepts inventory.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

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
abbreviationstring or null
Abbreviation of the location. Combination of nearest Airport Code and the sequence number.
access_grantedboolean or null
Indicates whether or not the user is authorized to interact at all with the location
attributeslist of strings or null
Available attributes for the location
idinteger or null

Id of the location in ShipBob’s database

is_activeboolean or null
Indicates if the location is operationally active or inactive
is_receiving_enabledboolean or null
Indicates if the receiving is enabled for FC
is_shipping_enabledboolean or null
Indicates if the shipping is enabled for FC
namestring or null

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

regionobject or null
serviceslist of objects or null
Services provided by the location
timezonestring or null
Time zone of the location

Errors