Store All Ep
POST/v1/store/all
Store and Tank Information Response
Provides detailed information about a store and its associated tanks, including market, sector, and detailed tank information such as product details, inventory, and strategy.
Response
store_number: str
The unique number for the site.
name: str | None = None
Store name.
market: str | None = None
Market name of the site’s market.
market_id: str | None = None
Market identifier of the site’s market.
sector: str | None = None
Sector name of the site’s sector.
sector_id: str | None = None
Sector identifier of the site’s sector.
tanks: list
List of tanks at the site, each containing:
Show Child Attributes
carrier_id: str | None = None
Carrier internal identifier if linked to the tank.
carrier: str | None = None
Carrier name.
product_id: str | None = None
Tank’s product identifier.
product: str
Tank’s product name.
description: str | None = None
Tank description.
product_last_transition: datetime | None = None
Date of the tank’s last product transition.
customer_product_id: str | None = None
Customer-facing product identifier.
customer_product: str | None = None
Customer-facing product name.
customer_product_last_transition: datetime | None = None
Date of the last customer-facing product transition.
island: str
Island or specific drop area at a store for a set of products.
load_tags: list[str] = []
Named load groups for order generation.
filter_tags: list[str] = []
Strings for grouping and filtering tanks in the UI.
tank_chart: str | None = None
Name of the tank chart file.
storage_max: float = 0
Maximum amount of product the tank can hold.
tank_size: float = 0
Tank volume size.
daily_demand: float = 0
Estimated daily demand used in forecasting.
inventory: float = 0
Current amount of product in the tank.
tank_id: int
Identifier for the tank.
fuel_bottom: float = 0
Pumpable minimum amount of product the tank should hold.
target_min: float = 0
Goal minimum level of product inside the tank.
target_max: float = 0
Goal maximum level of product inside the tank.
prior_day_lifted_volume: float = 0
Volume lifted from this tank yesterday.
prior_day_as_of: datetime | None = None
When the last calculation of lifted volume was made.
inventory_data_as_of: datetime | None = None
Date of the last inventory calculation.
gph_30: float = 0
Average gallons per hour calculated from the last 30 minutes of data.
gph_60: float = 0
Gallons sold every hour.
icon: str | None = None
Icon mapped to the product shown on the tank lid.
inventory_strategy: str = "Keep Full"
Strategy for tank supply. Either Keep Full or Keep Min.
minimum_load_size: int = 3000
Minimum size of a load that can be dropped at a tank.
maximum_load_size: int | None = None
Maximum size of a load that can be dropped at a tank.
manufacturer: str | None = None
Manufacturer of the tank.
dimensions: str | None = None
Tank dimensions.
tank_color: str | None = None
Color of the tank.
strapping_table: str | None = None
Identifier for the tank's sticking strapping table.
run_out_as_of: datetime | None = None
The date the run-out was last updated.
run_out_date: datetime
Calculated run-out date.
run_out_date_with_drops: datetime
Calculated run-out date considering scheduled drops.
forecast_disabled: bool = False
Indicates whether forecasting is disabled for this tank.
split_me: bool = False
Indicates if the tank is marked for splitting.
inventory_override: InventoryOverride | None = None
Overrides for inventory strategy settings.
Show Child Attributes
inventory_strategy: str = "Keep Full"
Strategy for scheduling tank supply. Supported strategies are “Keep Full”, “Keep Min”, and “Manual”.
target_min: float = 0
The goal minimum level of product inside the tank.
target_max: float = 0
The goal maximum level of product inside the tank.
minimum_load_size: int = 3000
The minimum size of a load that can be dropped at a tank.
maximum_load_size: int | None = None
The maximum size of a load that can be dropped at a tank.
load_tags: list[str] = []
Named load groups for order generation.
alerts: list = []
List of alerts associated with the tank.
Show Child Attributes
name: str | None = None
Alert name.
type: str = "unknown"
Alert type.
severity: str | None = None
Severity of the alert.
details: list[dict] = []
List of alert details, potentially including additional data about the alert.
roles: list[str] = []
Roles that are relevant to the alert.
alert_id: str | None = None
Internal identifier of the alert.
extra_data: dict = {}
Any additional data provided or managed by the client through integration endpoints.
inactive: bool = False
Indicates whether the tank is inactive.
measured_inventory: float = 0
Current measured inventory level of the tank.
measured_as_of: datetime
Date of the current measured inventory level of the tank.
levels: list = []
Cache of recent fuel levels.
Show Child Attributes
date: datetime
The date and time of the level measurement.
value: float
The measured level value.
type: str
Type of level measurement (e.g., "manual", "automatic").
tank_supply_default: TankSupply | None = None
Default supply option information for the tank.
Show Child Attributes
terminal: str | None = None
Name of the terminal associated with the default tank supply.
supply_zone: str | None = None
If the default supply is a supply zone, the name of the supply zone.
best_rack: bool | None = False
Indicates if the default supply is best rack.
components: list[dict] = []
List of components for the tank supply, potentially including details like product, supplier, and terminal.
tank_supply_override: TankSupplyOverride | None = None
Supply override details for the tank.
Show Child Attributes
effective_from: datetime
The start date of the supply override.
effective_to: datetime
The end date of the supply override.
terminal: str | None = None
If the override is terminal specific, the terminal that is the supply source for this tank.
supply_zone: str | None = None
If the override supply is a supply zone, the name of the supply zone.
best_rack: bool | None = False
Indicates if the override supply is best rack.
components: list[dict] = []
List of components for the tank supply override, potentially including details like product, supplier, and terminal.
manifold_id: str | None = None
Parent manifold identifier if the tank is part of a manifold.
ici: dict = {}
Inventory costing identifier unique to the tank.
extra_data: dict = {}
Additional data provided or managed through integration endpoints.
updated_on: datetime | None = None
Datetime the tank was last updated.
updated_by: str | None = None
User who last updated the tank.
compliance_hold: bool | None
Indicates whether the tank is under compliance hold.
lat: float
Site latitude.
lon: float
Site longitude.
address: str | None = None
Site street address, e.g., 111 Example St.
city: str | None = None
Site city.
state: str | None = None
Site state.
postal_code: str | None = None
Site postal code.
phone_number: str | None = None
Site phone number.
emails: list[str] | None = []
List of emails associated with the site.
hours: str | None = None
Description of the site’s open hours.
timezone: str = "US/Central"
Local site timezone.
status: str | None = "open"
Current site status.
drop_workflow: str ="Sticking"
The drop workflow of the store.
open_date: datetime | None = None
Site open date.
close_date: datetime | None = None
Site close date.
unavailable_hours: list = []
List of days and hours that the site is unavailable.
counterparty_id: str | None = None
Counterparty identifier associated with the site.
counterparty_name: str | None = None
Counterparty name associated with the site.
supply_owner_id: str | None = None
Supply owner identifier associated with the site.
supply_owner_name: str | None = None
Supply owner name associated with the site.
freight_customer_id: str | None = None
Freight customer identifier associated with the site.
freight_customer_name: str | None = None
Freight customer name associated with the site.
layout_file: str | None = None
Reference to site layout PDF.
layout_file_uploaded: datetime | None = None
Date the site layout file was uploaded.
auto_order_disabled: bool = False
Indicates if auto-ordering is disabled for the site.
updated_id: str
Unique identifier for concurrent update purposes.
trailer_config: str | None = None
Trailer configuration associated with the site.
monitoring_strategy: str = "Unmonitored"
Site monitoring strategy.
estick_monitor_override: str | None = None
Not applicable for integration.
notes: str | None = None
Site notes.
credit_hold: bool | None = None
Indicates if the site is on credit hold.
compliance_hold_date: datetime | None = None
The date that the compliance hold begins.
Responses
- 200
- 422
Successful Response
- application/json
- Example (from schema)
[
{
"_id": "5eb7cf5a86d9755df3a6c593",
"store_number": "string",
"name": "string",
"market": "string",
"market_id": "string",
"sector": "string",
"sector_id": "string",
"tanks": [
{
"carrier_id": "string",
"carrier": "string",
"product_id": "string",
"product": "string",
"description": "string",
"product_last_transition": "2025-12-17T21:49:50.592Z",
"customer_product_id": "string",
"customer_product": "string",
"customer_product_last_transition": "2025-12-17T21:49:50.592Z",
"island": "auto",
"load_tags": [
"string"
],
"filter_tags": [
"string"
],
"tank_chart": "string",
"storage_max": 0,
"tank_size": 0,
"daily_demand": 0,
"inventory": 0,
"tank_id": 0,
"requires_pump": false,
"fuel_bottom": 0,
"target_min": 0,
"target_max": 0,
"prior_day_lifted_volume": 0,
"prior_day_as_of": "2025-12-17T21:49:50.592Z",
"inventory_data_as_of": "2025-12-17T21:49:50.592Z",
"gph_30": 0,
"gph_60": 0,
"icon": "string",
"inventory_strategy": "Keep Full",
"minimum_load_size": 3000,
"maximum_load_size": 0,
"manufacturer": "string",
"dimensions": "string",
"tank_color": "string",
"strapping_table": "string",
"run_out_as_of": "2025-12-17T21:49:50.592Z",
"run_out_date": "2025-12-17T21:49:50.592Z",
"run_out_date_with_drops": "2025-12-17T21:49:50.592Z",
"forecast_disabled": false,
"split_me": false,
"inventory_override": {
"inventory_strategy": "Keep Full",
"target_min": 0,
"target_max": 0,
"minimum_load_size": 3000,
"maximum_load_size": 0,
"load_tags": [
"string"
]
},
"alerts": [
{
"name": "string",
"type": "unknown",
"severity": "string",
"details": [
{
"label": "string",
"value": "string",
"date": "2025-12-17T21:49:50.592Z"
}
],
"roles": [
"string"
],
"alert_id": "string",
"extra_data": {}
}
],
"inactive": false,
"measured_inventory": 0,
"measured_as_of": "2025-12-17T21:49:50.592Z",
"levels": [
{
"date": "2025-12-17T21:49:50.592Z",
"value": 0,
"type": "string"
}
],
"tank_supply_default": {
"terminal": "string",
"supply_zone": "string",
"generate_volume": false,
"components": [
{
"curve_id": "string",
"terminal": "string",
"supplier": "string",
"product": "string",
"price_type": "string"
}
]
},
"tank_supply_override": {
"effective_from": "2025-12-17T21:49:50.592Z",
"effective_to": "2025-12-17T21:49:50.592Z",
"terminal": "string",
"supply_zone": "string",
"best_rack": true,
"generate_volume": true,
"components": [
{
"curve_id": "string",
"terminal": "string",
"supplier": "string",
"product": "string",
"price_type": "string"
}
]
},
"manifold_id": "string",
"apportion_percentage": 0,
"ici": {},
"extra_data": {},
"updated_on": "2025-12-17T21:49:50.592Z",
"updated_by": "string",
"compliance_hold": true,
"water_reading_requirement": "none",
"demand_model_tank_profile": "string",
"delivery_match_config": {
"link_volume_threshold": 0,
"link_hour_threshold": 0,
"approve_volume_threshold": 0,
"approve_hour_threshold": 0,
"block_cross_store_matches": false,
"block_edit_volume_when_order_approved_in_dr_match": true,
"block_edit_time_when_order_approved_in_dr_match": true
},
"intraday_sales": 0,
"intraday_forecast": 0,
"sales_variance_percent_threshold": 0,
"sales_variance_absolute_threshold": 0,
"percent_filled": 0,
"current_volume": 0,
"model_target_min": 0,
"model_target_max": 0,
"estimated_inventory": 0,
"estimated_as_of": "2025-12-17T21:49:50.592Z"
}
],
"lat": 0,
"lon": 0,
"address": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"contact_name": "string",
"phone_number": "string",
"emails": [
"string"
],
"hours": "string",
"timezone": "US/Central",
"status": "open",
"drop_workflow": "Sticking",
"open_date": "2025-12-17T21:49:50.592Z",
"close_date": "2025-12-17T21:49:50.592Z",
"unavailable_hours": [
{
"day_of_week": "Sunday",
"start_hour": "2025-12-17T21:49:50.592Z",
"end_hour": "2025-12-17T21:49:50.592Z"
}
],
"counterparty_id": "string",
"counterparty_name": "string",
"in_network_terminals": [
{
"name": "string",
"location_id": "string"
}
],
"in_network_supply_zones": [
{
"name": "string",
"supply_zone_id": "string"
}
],
"supply_owner_id": "string",
"supply_owner_name": "string",
"freight_customer_id": "string",
"freight_customer_name": "string",
"freight_region_name": "string",
"freight_region_id": "string",
"layout_file": "string",
"layout_file_uploaded": "2025-12-17T21:49:50.592Z",
"auto_order_disabled": false,
"updated_id": "5eb7cf5a86d9755df3a6c593",
"trailer_config": "string",
"monitoring_strategy": "Unmonitored",
"estick_monitor_override": "string",
"notes": "string",
"updated_on": "2025-12-17T21:49:50.592Z",
"updated_by": "string",
"extra_data": {},
"credit_hold": true,
"compliance_hold_date": "2025-12-17T21:49:50.592Z",
"delivery_window_default_name": "string",
"delivery_window_default_id": "string",
"allow_by_product_request": false,
"geofence": [
{
"latitude": 0,
"longitude": 0
}
]
}
]
Validation Error
- application/json
- Example (from schema)
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}