From e1566dc8f47b6aba162f6dff6c0e2185ae787555 Mon Sep 17 00:00:00 2001 From: "Ronald A. Richardson" Date: Wed, 14 Oct 2026 15:23:49 +0800 Subject: [PATCH] docs(storefront): a store's and network's clock (timezone, utc_offset) on stores, food trucks and cart items --- .../Fleetbase Storefront API/Cart/.resources/object.yaml | 2 +- .../Food Trucks/.resources/object.yaml | 6 ++++-- .../Fleetbase Storefront API/Store/.resources/object.yaml | 8 ++++++++ .../Store/About Store.request.yaml | 3 ++- 4 files changed, 15 insertions(+), 4 deletions(-) diff --git a/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml index 6120288..5acd30f 100644 --- a/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml +++ b/postman/collections/Fleetbase Storefront API/Cart/.resources/object.yaml @@ -39,7 +39,7 @@ fields: description: "Number of unique cart line items." - name: items type: array of objects - description: "Cart line items." + description: "Cart line items. Each item's `store` gives the store it is bought from: `id`, `name`, `logo_url`, `backdrop_url`, `online`, `currency`, and its clock, `timezone` and `utc_offset` (minutes east of UTC), to show a booked item's `scheduled_at` in the store's time." - name: events type: array of objects description: "Cart event history." diff --git a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml index 5d255ed..8578f85 100644 --- a/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml +++ b/postman/collections/Fleetbase Storefront API/Food Trucks/.resources/object.yaml @@ -10,7 +10,9 @@ example: | "name": "Acme Market", "logo_url": "https://files.example.com/logo.png", "currency": "USD", - "options": { "map_marker": "store", "reviews_enabled": true } + "options": { "map_marker": "store", "reviews_enabled": true }, + "timezone": "Asia/Singapore", + "utc_offset": 480 }, "vehicle": { "id": "vehicle_6Tq1nP8", "plate_number": "GBB-1006", "online": true }, "service_area": { "id": "service_area_2Kd8mQ4", "name": "Singapore Central" }, @@ -56,7 +58,7 @@ fields: description: "Public identifier of the food truck." - name: store type: object - description: "The store the truck sells for: `id`, `name`, `logo_url`, `currency` and `options` (including `map_marker` and `reviews_enabled`)." + description: "The store the truck sells for: `id`, `name`, `logo_url`, `currency`, `options` (including `map_marker` and `reviews_enabled`), and its clock, `timezone` and `utc_offset` (minutes east of UTC), to read the truck's hours on." - name: network type: object description: "For a truck the network runs itself, the network: `id`, `name`, `logo_url`. Returned by Query Food Trucks only." diff --git a/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml b/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml index 780be7d..0c1c594 100644 --- a/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/.resources/object.yaml @@ -13,6 +13,8 @@ example: | "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, @@ -53,6 +55,12 @@ fields: - name: country type: string description: "Country code derived from the store currency." + - name: timezone + type: string + description: "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." + - name: utc_offset + type: integer + description: "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." - name: options type: object description: "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`)." diff --git a/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml b/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml index aaac125..84d4371 100644 --- a/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml +++ b/postman/collections/Fleetbase Storefront API/Store/About Store.request.yaml @@ -1,5 +1,6 @@ $kind: http-request -description: About Store +description: |- + 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. url: "{{base_url}}/{{api_prefix}}/{{namespace}}/about" method: GET scripts: