Location All Ep
POST/v1/location/all
Location All EP
Retrieves all location details from the system.
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.
active: bool | None = None
Whether the location is active.
store_id: str | None = None
Internal identifier of the site this location record is tied to, when it represents a site.
tcn: str | None = None
The location's TCN (terminal control number).
freight_region_name: str | None = None
Name of the freight region the location belongs to.
freight_region_id: str | None = None
Internal identifier of that freight region.
requires_card: bool | None = None
Whether a driver must hold a valid card for this location to be dispatched there.
requires_approval: bool | None = None
Whether orders to this location require approval.
cards: list[Card] | None = []
The card requirements configured at this location.
Show Child Attributes
id: str
Internal identifier of the card.
name: str
Name of the card.
activity: Activity
The activity the card governs. One of Loading or Unloading.
activity_threshold: int | None = None
Number of activities before re-certification is triggered, for activity-based cards.
certification_trigger: CertificationTrigger
What drives re-certification. One of Automatic - Activity Based, Manual - Date Based,
or Never Expires.
days_valid: int | None = None
How many days a certification stays valid, for date-based cards.
warning_threshold: int | None = None
How far ahead of expiry to start warning.
dispatch_impact: DispatchImpact
What an invalid card does to dispatch. One of Alert,
Alert Manual, Block Optimizer, Block Dispatch, or Informational (No Impact).
carding_instructions: str | None = ""
Free-text instructions shown to the driver for carding at this location.
dwells: list[Dwell] | None = []
Per-product-group dwell times at this location, in minutes.
Show Child Attributes
product_group: str | None = default
The product group this dwell applies to. default covers any group without its own entry.
set_dwell: int = 30
The configured dwell time in minutes.
dwell_override: int | None = None
A temporary dwell time that replaces set_dwell until override_expiry passes.
override_expiry: datetime | None = None
When dwell_override stops applying. Expired overrides are cleared automatically.
payroll_override: int | None = None
A dwell time used only for payroll, taking precedence over both values above.
geofence: list[Coordinate] | None = None
The polygon bounding the location, as an ordered list of latitude / longitude pairs.
supply_map: list[SourceMap] | None = []
List of source_system and source_id mappings. Used for the eBOL process.
Show SourceMap Attributes
source_system: str
System name.
source_id: str
ID in the source system.
notes: str | None = None
Free-text notes about the location.
layout_file: str | None = None
Filename of the uploaded location layout diagram, if one has been attached.
Responses
- 200
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": "2026-09-25T19:33:18.188Z",
"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": "2026-09-25T19:33:18.188Z",
"payroll_override": 0
}
],
"requires_card": true,
"requires_approval": true,
"geofence": [
{
"latitude": 0,
"longitude": 0
}
],
"supply_map": [
{
"source_system": "string",
"source_id": "string"
}
],
"tcn": "string",
"store_id": "string",
"notes": "string",
"rich_notes": "string",
"layout_file": "string",
"extra_data": {}
}
]