Store

With a network key, only active member stores are visible: suspended and pending (not yet approved) members are hidden from every storefront endpoint, and their products can't be quoted or checked out. Store endpoints describe the active storefront or network being browsed. Use them to retrieve store profile data, locations, payment gateways, tags, search results, and network store listings.

The Store object

A store describes a storefront business, including branding, contact information, operating options, locations, media, and network membership.

Attributes

idstringoptional

Public identifier of the store.

namestringoptional

Store name.

descriptionstringoptional

Store description.

websitestringoptional

Store website URL.

emailstringoptional

Store email address.

phonestringoptional

Store phone number.

tagsarray of stringsoptional

Store tags.

currencycurrencyoptional

Store currency code.

countrystringoptional

Country code derived from the store currency.

timezonestringoptional

The store's IANA timezone (its company's when the store has none set). Store hours, booking slots and booked times are wall-clock times in this zone.

utc_offsetintegeroptional

The store's current offset from UTC in minutes, east positive (480 for UTC+08:00, -240 for UTC-04:00). Read store hours and booked times on the store's clock with it (store time = UTC + utc_offset) rather than the device's timezone; it changes when the store's zone changes daylight saving time.

optionsobjectoptional

Public store options, such as pickup_enabled, cod_enabled, tips_enabled, multi_cart_enabled, reviews_enabled and map_marker (how the store is shown on maps: store, warehouse or factory icon, or logo).

logo_urlstringoptional

Store logo URL.

backdrop_urlstringoptional

Store backdrop image URL.

ratingnumberoptional

Store rating.

onlinebooleanoptional

Whether the store is online.

alertablebooleanoptional

Whether the store can receive order alerts.

is_networkbooleanoptional

Whether the resource is a storefront network.

is_storebooleanoptional

Whether the resource is a store.

created_attimestampoptional

Time the store was created.

updated_attimestampoptional

Time the store was last updated.

The Store object

{
  "id": "store_3Xb9kL2",
  "name": "Acme Market",
  "description": "Local grocery and delivery.",
  "website": "https://example.com",
  "email": "orders@example.com",
  "phone": "+15555550100",
  "tags": [
    "grocery"
  ],
  "currency": "USD",
  "country": "US",
  "timezone": "America/New_York",
  "utc_offset": -240,
  "options": {},
  "logo_url": "https://files.example.com/logo.png",
  "backdrop_url": null,
  "rating": 4.8,
  "online": true,
  "alertable": true,
  "is_network": false,
  "is_store": true,
  "slug": "acme-market",
  "created_at": "2026-05-07T09:30:00Z",
  "updated_at": "2026-05-07T09:30:00Z"
}

GET/v1/search

Search Store

Search Storefront

Query parameters

querystringoptional

Query value for this store request.

limitstringoptional

Limit value for this store request.

offsetstringoptional

Offset value for this store request.

GET/v1/search

curl https://api.fleetbase.io/v1/search?query=&limit=&offset= \
  -H "Authorization: Bearer flb_live_…"

GET/v1/about

About Store

The store the storefront key belongs to (with a network key, the network), as a Store object. It includes the store's clock: timezone and utc_offset, its current offset from UTC in minutes. Store hours (from its locations), product hours and booked times are wall-clock times in that zone, so read them on the store's clock (UTC + utc_offset) rather than the device's.

GET/v1/about

curl https://api.fleetbase.io/v1/about \
  -H "Authorization: Bearer flb_live_…"

GET/v1/lookup

Lookup Store

GET/v1/lookup

curl https://api.fleetbase.io/v1/lookup \
  -H "Authorization: Bearer flb_live_…"

GET/v1/locations

List Locations

GET/v1/locations

curl https://api.fleetbase.io/v1/locations \
  -H "Authorization: Bearer flb_live_…"

GET/v1/locations

Retrieve Location

GET/v1/locations

curl https://api.fleetbase.io/v1/locations \
  -H "Authorization: Bearer flb_live_…"

GET/v1/stores

List Network Stores

Lists active member stores for the authenticated Network. This endpoint requires a network key; a store key is rejected. Results are network-scoped and can be searched, filtered, distance-ranked, and paginated.

Query parameters

querystringoptional

Search member store names and other searchable store fields.

taggedstringoptional

Comma-separated store tags; a store matching any supplied tag is returned.

categorystringoptional

Network category public ID assigned to a member store.

without_categorybooleanoptional

When true, return only member stores without a network category assignment.

idsstringoptional

Comma-separated store public IDs to include.

excludestringoptional

Comma-separated store public IDs to exclude.

onlinebooleanoptional

Filter by the store online state.

sortstringoptional

Sort mode: highest_rated, lowest_rated, newest, oldest, popular, trending, or nearest.

location[latitude]numberoptional

Customer latitude used by nearest sorting and distance filtering. A missing or invalid location (or 0,0) is ignored, and then nearest and maximum_distance have no effect.

location[longitude]numberoptional

Customer longitude used by nearest sorting and distance filtering.

maximum_distancenumberoptional

Maximum distance from location in meters. Applies only with a valid location; each store then also has distance (meters).

limitintegeroptional

Maximum number of stores to return.

offsetintegeroptional

Number of matching stores to skip.

GET/v1/stores

curl https://api.fleetbase.io/v1/stores?query=&tagged=&category=&without_category=&ids=&exclude=&online=true&sort=&location%5Blatitude%5D=&location%5Blongitude%5D=&maximum_distance=&limit=&offset= \
  -H "Authorization: Bearer flb_live_…"

GET/v1/tags

List Tags

Returns unique storefront tags for the authenticated context. Network keys aggregate tags across active member stores, while store keys return tags from the current store only.

GET/v1/tags

curl https://api.fleetbase.io/v1/tags \
  -H "Authorization: Bearer flb_live_…"

GET/v1/gateways

Payment gateways for the current store

Query parameters

limitstringoptional

Limit value for this store request.

offsetstringoptional

Offset value for this store request.

GET/v1/gateways

curl https://api.fleetbase.io/v1/gateways?limit=&offset= \
  -H "Authorization: Bearer flb_live_…"

GET/v1/gateways/{id}

Specific payment gateway given the id

GET/v1/gateways/{id}

curl https://api.fleetbase.io/v1/gateways/{id} \
  -H "Authorization: Bearer flb_live_…"