Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
Expand Down Expand Up @@ -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."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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`)."
Expand Down
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Loading