> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer-stage.shipbob.dev/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer-stage.shipbob.dev/_mcp/server. # Get Locations GET https://sandbox-api.shipbob.com/2026-01/location 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. Reference: https://developer-stage.shipbob.dev/2026-01/api/locations/get-locations ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: api-2026-01 version: 1.0.0 paths: /2026-01/location: get: operationId: get-locations summary: Get Locations description: >- 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. tags: - subpackage_locations parameters: - name: IncludeInactive in: query description: | Whether the inactive locations should be included or not required: false schema: $ref: >- #/components/schemas/Locations.Get.1.0.Location.IncludeInactive.Boolean - name: ReceivingEnabled in: query description: | Return all the receiving enabled locations required: false schema: $ref: >- #/components/schemas/Locations.Get.1.0.Location.ReceivingEnabled.Boolean - name: AccessGranted in: query description: | Return all the access granted locations required: false schema: $ref: >- #/components/schemas/Locations.Get.1.0.Location.AccessGranted.Boolean - name: Authorization in: header description: Authentication using Personal Access Token (PAT) token required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Locations.Get.1.0.Location.OK.OneOfArray' '401': description: Authorization missing or invalid content: application/json: schema: description: Any type '403': description: The provided credentials are not authorized to access this resource content: application/json: schema: description: Any type servers: - url: https://sandbox-api.shipbob.com description: https://sandbox-api.shipbob.com components: schemas: Locations.Get.1.0.Location.IncludeInactive.Boolean: type: boolean description: Whether the inactive locations should be included or not title: Locations.Get.1.0.Location.IncludeInactive.Boolean Locations.Get.1.0.Location.ReceivingEnabled.Boolean: type: boolean description: Return all the receiving enabled locations title: Locations.Get.1.0.Location.ReceivingEnabled.Boolean Locations.Get.1.0.Location.AccessGranted.Boolean: type: boolean description: Return all the access granted locations title: Locations.Get.1.0.Location.AccessGranted.Boolean Locations.FulfillmentCenterRegionViewModel: type: object properties: id: type: integer description: Unique Id for the location region name: type: string description: Name of the region the location is in. title: Locations.FulfillmentCenterRegionViewModel Locations.AddressViewModel: type: object properties: address1: type: string description: First part of the address of the location for this service address2: type: string description: Second part of the address of the location for this service city: type: string description: City of the location country: type: string description: Country of the location email: type: string description: Email of the location for this service name: type: string description: Name to use in the address of the location for this service phone_number: type: string description: Phone Number of the location for this service state: type: string description: State of the location zip_code: type: string description: Zip code of the location description: >- The service-specific address of the location. Each object contains address type, address1, address2, city, state, country, zip code, phone number, and email title: Locations.AddressViewModel Locations.ServiceTypeEnum: type: string enum: - Receiving - Returns title: Locations.ServiceTypeEnum Locations.ServiceViewModel: type: object properties: address: $ref: '#/components/schemas/Locations.AddressViewModel' enabled: type: boolean description: >- Indicates if the user is authorized to access this service at the location service_type: $ref: '#/components/schemas/Locations.ServiceTypeEnum' title: Locations.ServiceViewModel Locations.LocationViewModel: type: object properties: abbreviation: type: string description: >- Abbreviation of the location. Combination of nearest Airport Code and the sequence number. access_granted: type: boolean description: >- Indicates whether or not the user is authorized to interact at all with the location attributes: type: array items: type: string description: Available attributes for the location id: type: integer description: Id of the location in ShipBob’s database is_active: type: boolean description: Indicates if the location is operationally active or inactive is_receiving_enabled: type: boolean description: Indicates if the receiving is enabled for FC is_shipping_enabled: type: boolean description: Indicates if the shipping is enabled for FC name: type: string description: "Name of the location. Follows the naming convention City (State Code)\r\nfor domestic FCs and City (Country Code) for international FCs" region: $ref: '#/components/schemas/Locations.FulfillmentCenterRegionViewModel' services: type: array items: $ref: '#/components/schemas/Locations.ServiceViewModel' description: Services provided by the location timezone: type: string description: Time zone of the location title: Locations.LocationViewModel Locations.Get.1.0.Location.OK.OneOfArray: type: array items: $ref: '#/components/schemas/Locations.LocationViewModel' title: Locations.Get.1.0.Location.OK.OneOfArray securitySchemes: PAT: type: http scheme: bearer description: Authentication using Personal Access Token (PAT) token OAuth2: type: http scheme: bearer description: OAuth2 authentication using JWT tokens ``` ## Examples **Response** ```json [ { "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" } ] ``` **SDK Code** ```python default import requests url = "https://sandbox-api.shipbob.com/2026-01/location" querystring = {"IncludeInactive":"true","ReceivingEnabled":"true","AccessGranted":"true"} headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript default const url = 'https://sandbox-api.shipbob.com/2026-01/location?IncludeInactive=true&ReceivingEnabled=true&AccessGranted=true'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go default package main import ( "fmt" "net/http" "io" ) func main() { url := "https://sandbox-api.shipbob.com/2026-01/location?IncludeInactive=true&ReceivingEnabled=true&AccessGranted=true" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby default require 'uri' require 'net/http' url = URI("https://sandbox-api.shipbob.com/2026-01/location?IncludeInactive=true&ReceivingEnabled=true&AccessGranted=true") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java default import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://sandbox-api.shipbob.com/2026-01/location?IncludeInactive=true&ReceivingEnabled=true&AccessGranted=true") .header("Authorization", "Bearer ") .asString(); ``` ```php default request('GET', 'https://sandbox-api.shipbob.com/2026-01/location?IncludeInactive=true&ReceivingEnabled=true&AccessGranted=true', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp default using RestSharp; var client = new RestClient("https://sandbox-api.shipbob.com/2026-01/location?IncludeInactive=true&ReceivingEnabled=true&AccessGranted=true"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift default import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox-api.shipbob.com/2026-01/location?IncludeInactive=true&ReceivingEnabled=true&AccessGranted=true")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```