Shipper Facilities

The facilities endpoint allows users to retrieve a list of facilities that match a given name, location, and search radius. The response includes detailed information about each facility, such as contact information, geographic coordinates, and operating hours.

Authentication

Include the following headers in your requests:

• Access-Token: The access token obtained from the "Create Access Token" endpoint.

• x-api-key: The API key provided by GenLogs. This header must be included in the request.

Permissions

Make sure that your api user is created with a role that has external-api-shipper-facilities permission

Endpoint

• URL: https://api.genlogs.io/facilities

• Method: GET

Query Parameters

• name (string, Required (Only optional when city and state is provided)): The name of the facility to search for.

• city(string, Required (Only optional when name is provided)): The location "city" around which to search for facilities. For example, "Boston" or "Atlanta"

• state(string, Required (Only optional when name is provided)): The location "state" around which to search for facilities. For example, "Massachusetts" or "Georgia"

• radius (integer, Optional [Default: 20]): The radius (in miles) within which to search around the specified location.

• lot_size_category (string, Optional): The size of lot category, if you want to use different ones remember to use | between them, for example Small | Medium

  • List of lot size category

    Small
    Medium
    Large
    X-Large

Response

• 200 OK: Successfully retrieved the list of facilities matching the search criteria.

• 400 Bad Request: If required parameters are missing or invalid.

• 401 Unauthorized: If the Access-Token or x-api-key is missing or invalid.

• 500 Internal Server Error: If an error occurs on the server while processing the request.

Response Body

• facilities (array of Facility objects): List of up to 1,000 facilities matching the search criteria ordered by relative load volume.

  • contact_phone (nullable string): Phone number of the facility's contact person.

  • contact_url (nullable string): URL for the facility's contact page or website.

  • facility_name (string): Name of the facility.

  • formatted_address (string): Full address of the facility.

  • id (string): Unique identifier for the facility.

  • lat (number): Latitude of the facility's location.

  • lon (number): Longitude of the facility's location.

  • operating_hours (nullable string): Operating hours of the facility.

  • place_category (string): Category or type of place (e.g., warehouse, distribution center).

Request Example:

curl -X GET 'https://api.genlogs.io/facilities?name=coca+cola&city=&state=&radius=50' \
-H 'Access-Token: {access_token}' \
-H 'x-api-key: {your_api_key}' \
-i

Get facilities based on name, location, and radius

get

Query parameters

namestringRequired

The name of the facility

Example: Example Facility

citystringRequired

The city of the facility

Example: New York

statestringRequired

The state of the facility

Example: NY

radiusintegerOptional

The radius to search around the location

Example: 50

Header parameters

acceptstringRequired

application/json

Example: application/json

Access-TokenstringRequired

Access Token for authentication

Example: [Token]

x-api-keystringRequired

X api key for authentication

Example: [x-api-key]

Responses

200

List of facilities

application/json

get

HTTPcURLJavaScriptPython

GET /facilities HTTP/1.1
Host: api.genlogs.io
accept: application/json
Access-Token: [Token]
x-api-key: [x-api-key]
Accept: */*

200

List of facilities

{
  "facilities": [
    {
      "contact_phone": "text",
      "contact_url": "text",
      "facility_name": "text",
      "formatted_address": "text",
      "id": "text",
      "lat": 1,
      "lon": 1,
      "operating_hours": "text",
      "place_category": "text"
    }
  ]
}