Location All Ep

POST /v1/location/all

Location All EP

Retrieves all location details from the system.

Required Scopes (ia.r)

Response

id: str
The internal identifier for the location.

name: str
The unique name of the location.

short_name: str | None = None
The abbreviated name of the location.

market: str | None = None
The name of the market associated with the location.

market_id: int | None = None
The internal market identifier.

type: str | None = None
The type of location, which can be one of the following: Biodiesel Terminal, Ethanol Terminal, Terminal, Depot, Store, and Delivered.

lat: float | None = None
The latitude of the location.

lon: float | None = None
The longitude of the location.

address: str | None = None
The street address of the location, e.g., 111 Example St.

phone: str | None = None
The phone number for the location.

city: str | None = None
Location city, e.g., "New York".

state: str | None = None
The two-letter abbreviation for the state the location is in.

postal_code: str | None = None
The postal code the location is in.

source_id: int | None = None
If location received from integration, the identifier used within the source system.

source_system: str | None = None
If location received from integration, the name of the source system.

source_system_id: int | None = None
If received from integration, the system id within the source system,

timezone: str | None = None
The timezone of the location.

supply_zones: list[str] | None = []
If part of a supply zone, the supply zone name.

updated_on: datetime | None = None
The timestamp of the most recent update to the location data.

extra_data: dict | None = {}
Any additional data provided or managed by the client through integration endpoints.

Responses

Successful Response

application/json

Example (from schema)

[
  {
    "id": "string",
    "name": "string",
    "short_name": "string",
    "market": "string",
    "market_id": "string",
    "freight_region_name": "string",
    "freight_region_id": "string",
    "type": "string",
    "lat": 0,
    "lon": 0,
    "address": "string",
    "phone": "string",
    "city": "string",
    "state": "string",
    "active": true,
    "postal_code": "string",
    "source_id": "string",
    "source_system": "string",
    "source_system_id": "string",
    "timezone": "string",
    "supply_zones": [
      "string"
    ],
    "updated_on": "2025-12-17T21:49:50.576Z",
    "cards": [
      {
        "timezone_data": {},
        "id": "string",
        "name": "string",
        "activity": "Loading",
        "activity_threshold": 0,
        "certification_trigger": "Automatic - Activity Based",
        "days_valid": 0,
        "warning_threshold": 0,
        "dispatch_impact": "Alert",
        "carding_instructions": "string"
      }
    ],
    "dwells": [
      {
        "product_group": "string",
        "set_dwell": 30,
        "dwell_override": 0,
        "override_expiry": "2025-12-17T21:49:50.576Z",
        "payroll_override": 0
      }
    ],
    "requires_card": true,
    "geofence": [
      {
        "latitude": 0,
        "longitude": 0
      }
    ],
    "supply_map": [
      {
        "source_system": "string",
        "source_id": "string"
      }
    ],
    "tcn": "string",
    "extra_data": {}
  }
]

Location All Ep

/v1/location/all

Location All EP

Response​

Responses​

Response

Responses