Skip to main content

Store Upsert Many Ep

POST 
/v1/store/upsert_many

Create/Update Site Information

Creates or updates site information based on the provided data. This endpoint allows for the comprehensive management of site details, including address, contact information, market and sector association, and specific configurations.

Required Scopes (is.w)

Request​

id: str
Internal site identifier.

store_number: str
Number unique to the site.

name: str | None = None
Site name.

address: str | None = None
Site street address, e.g., 111 Example St.

city: str | None = None
Site city.

state: str | None = None
Site state (formatted as a two-letter abbreviation).

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 store hours.

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.

trailer_config: str | None = None
If applicable, trailer configuration associated with the site.

lat: float
Site latitude.

lon: float
Site longitude.

timezone: str | None = "America/Chicago"
Local site timezone.

status: str | None = "open"
Current site status.

Show Status

open
The site is open.

closed
The site is closed.

under construction
The site is under construction.

contact_name: str | None = None
Name of the site contact.

open_date: datetime | None = None
Date the site opened.

close_date: datetime | None = None
Date the site closed.

unavailable_hours: list[dict] | None = []
List containing unavailable hours with keys for day_of_week, start_hour, and end_hour.

counterparty_id: str | None = None
Identifier of the counterparty associated with the site.

counterparty_name: str | None = None
Name of the counterparty associated with the site.

supply_owner_id: str | None = None
Identifier of the supply owner associated with a site.

supply_owner_name: str | None = None
Name of the supply owner associated with a site.

freight_customer_id: str | None = None
Identifier of the freight customer associated with the site.

freight_customer_name: str | None = None
Name of the freight customer associated with the site.

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

monitoring_strategy: str
Sets how tank readings are integrated for the site.

Show Monitoring Strategies

Manual Tank Readings
Tank readings are manually entered. Will create forecasts and show flags.

No Readings (Call-In)
Store is a Call-In site. No readings will be shown or processed. Orders created manually.

Updated via Integration
Readings are sent in via an external integration.

Connect to Tank Monitor
Tank readings are connected to a tank monitor.

Connect to Tank Monitor (E-Sticking)
Tank readings are connected to a tank monitor and E-Sticking is enabled.

drop_workflow: str
The drop workflow of the store. Options are "Sticking" or "No Sticking".

Show Drop Workflows

Sticking
Drivers are required to stick the tank for drops.

No Sticking
Drivers are not required to stick the tank for drops. Volume will be entered manually.

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.

geofence: list[Coordinate] = None
List of latitude and longitude coordinates that define the geofence for the location. These can be generated using a tool like https://geojson.io and copying in the coordinate list. If a polygon geofence is not specified a radius based geofence will be used by default.

Details

Show Coordinate Attributes latitude: float
Latitude of the coordinate.

longitude: float
Longitude of the coordinate.

freight_region_name: str | None = None
Name of the freight region the site belongs to.

freight_region_id: str | None = None
Internal identifier of that freight region. Takes precedence over freight_region_name when both are sent.

in_network_terminals: list[str] | None = None
Names of the terminals treated as in-network for this site.

excluded_terminals: list[str] | None = None
Names of terminals explicitly excluded from supplying this site.

excluded_supply_zones: list[str] | None = None
Names of supply zones explicitly excluded from supplying this site.

delivery_window_default_name: str | None = None
Name of the delivery window default to apply to requests for this site.

delivery_window_default_id: str | None = None
Internal identifier of that delivery window default. Takes precedence over delivery_window_default_name when both are sent.

allow_by_product_request: bool | None = None
Whether delivery requests for this site may be submitted by product.

tank_wagon_capable: bool | None = None
Whether the site can be served by a tank wagon.

hide_tank_alerts: bool | None = None
When True, tank flags and runout times for this site are suppressed.

notes: str | None = None
Site notes.

internal_notes: str | None = None
Notes about the site kept for internal use, separate from notes.

estick_monitor_override: str | None = None
Overrides the monitor type reported by the tank-monitoring integration when reading e-stick levels for this site. Leave unset to use the type the integration reports.

attributes: dict[str, bool | float | str] = {}
Custom attributes applied to the site, keyed by attribute definition id. Attribute definitions are managed in the application; each definition fixes the value type of its entry (boolean, number, string, or presence-only exists).


Response​

status: str
"success" if no errors occurred, otherwise "fail".

completed: list
The records that were successfully completed.

errors: list
All records that encountered errors during processing.

Provides feedback on the operation’s outcome, detailing successful updates, completions, and any encountered errors.

Responses​

Successful Response

Loading...