Timestreams API
Read timestreams, timelines and time periods.
Timestreams let a store change its products, menus and prices based on the current time. For example, a food and beverage store can offer an extended pre-order menu before a match and a smaller menu once the match starts.
A timestream has timelines, and a timeline has time periods. A snapshot returns the time periods that are active at a given time. A product can belong to a timestream. Pass the timestreamId when you add that product to a basket.
| Property | Value |
|---|---|
| Base path | /timestreams |
| Authentication | x-api-key header |
| Pagination | page and pageSize. See Pagination and language. |
| OpenAPI document | timestreams.yaml |
Endpoints
GET
/timestreamsGet a list of timestreamsPOST/timestreamsSearch for timestreamsGET/timestreams/{timestreamId}Get a timestreamGET/timestreams/{timestreamId}/snapshotGet timeperiodsPOST/timestreams/{timestreamId}/snapshotSearch timeperiodsGET/timestreams/{timestreamId}/timelinesGet a list of timelinesPOST/timestreams/{timestreamId}/timelinesSearch for timelinesGET/timestreams/{timestreamId}/timelines/{timelineId}Get a specific timelineGET/timestreams/{timestreamId}/timelines/{timelineId}/periodsGet periods for a timelineGET/timestreams/{timestreamId}/timelines/{timelineId}/periods/{timeperiodId}Get a specific timeperiod