Field reference
The nested shapes operations take and return, each written once and documented field by field. An operation page links a field to its shape; the OpenAPI document names them as components.
Planning facts
- GuideLinkA link with a purpose: the official page, tickets, a live status page, a timetable. Spots, places and areas carry up to 12. Each needs a url or a value.
- StatusNoticeA closure or works notice that goes out of date. Buyers stop seeing it after until; readiness and list_stale_notices flag it once it ran out.
- FeeOne fee or ticket as the source states it. The amount is information for buyers, never charged by Sceniq. Buyers see it with an as-of date; readiness flags rows past validUntil or unchecked for a year.
- ScheduleStructured opening hours. The free-text hours stay the fallback; the apps show today's hours in the spot's time zone. Readiness flags a schedule past validUntil.
- HoursBandOne band of opening hours: a date range, weekdays, and open and close times. The last matching band wins, so list the year-round band first and the exceptions after it.
- SpotPinA point that belongs to a spot besides its main pin: where visitors stand, enter, start walking or leave the car. Each gets its own map links and a place on the web map. At most 12 per spot.
- MapLinkAn extra map link drawn as a map pill on the spot (a Swisstopo view, a trailhead in Apple Maps). For official, ticket or status pages use links instead. At most 8 per spot.
- AccessRuleA rule for getting in: a reservation, a permit, a registration, a required guide. Used in arrival.rules and on areas; at most 20.
- RestrictionA rule on site with an optional place: no photos here, no drones, no stopping on this road. At most 20 per spot.
- SpotFeatureA part of the site with its own rules: a monastery's closing day, a ticketed skyway, a museum inside a park. At most 12 per spot.
- SpotEventA recurring or one-off event worth timing a visit for: a light show, a festival, a tide. The apps show the next listed date. At most 12 per spot.
- FoodNoteWhy a spot lists no food places.
- TripFactsThe planning stats bar on a spot: elevation, crowds and best season.
- SiteChangeThe day something at the spot changed (a bridge replaced, boats banned). Readiness flags photos captured before it.
- SourceRefResearch evidence for the creator's review. Never shown to buyers. Needs a url or a title; at most 40 per row.
Arrival
Guide settings
- AreaA park, reserve, island, region or city whose rules, fees, season, links and status apply to every spot that points at it (areaId). Stored once per guide, at most 50; set_area writes one.
- MapRegionThe map region the viewer opens on. set_guide_region replaces the whole object: fields left out are cleared.
- SocialLinkA social profile link: on the creator profile (set_profile_socials, at most 6) or on one sales page's about section (socialsOverride).
Place details
- PlaceConditionsConditions for a place, shown as chips on its card. Only true flags are stored; false and absent show nothing.
- ParkingInfoParking facts shown on a place's card.
- TransportInfoTransport details of a place (a ferry, a bus line, a cable car): its stops, the days it runs and how long the timetable is valid. list_stale_notices lists a timetable past timetableValidUntil.
- ActivityInfoDetails of a tour or activity (kind activity): where it meets, how long it takes, when it departs and who authorizes it.
Route facts
- RouteSeasonWhen a route can be walked. Buyers opening it outside its months see it as out of season, with the closure note.
- RouteVariantAn alternative to the main route: a detour, a shortcut, another start. At most 12 per route.
- RouteStageOne day or leg of a multi-day trek, in order. At most 40 per route.
- RouteSegmentA section of a route with its own access (free to Scout Lookout, a permit for the chains). At most 20 per route.
- FigureSourceWhere one of a route's numbers comes from. At most 20 per route.
- TransitNoteA transit note for one mode, shown under Transit on the route card. At most 20 per route; a row with an empty note is dropped.
- ExtraPropA free label and value row the creator adds to a route or a place card. At most 24; a row with both sides empty is dropped, a half-empty one refused.
- RouteTrackThe line of a route from the creator's GPX or KML file, drawn on the maps. 2 to 1,000 positions; simplify long recordings first.
Photo metadata
Chapters
- ChapterIntroThe structured front matter of an intro chapter (set_chapter_intro): a cover with kicker, title and byline, then up to 20 sections. Strings are trimmed and empty ones dropped; the whole object is at most 150,000 characters of JSON. Photos are storageIds the intro owns: a write that drops one deletes the file (for a live guide, at the next publish).
- IntroSectionOne section of a chapter's front matter. A prose section carries text, a numbered grid or a side photo; a chapters or collections section lists the guide's chapters or collections and carries only kicker, title, deck and items.
- IntroItemThe dressing of one row (chapters section) or card (collections section) of a chapter's front matter. An entry that sets nothing is dropped.
Sales page
- ListingConfigThe sales page, always sent whole (read get_sales_page and edit that). Every save checks the list caps, that each media id is a product- or listing-owned photo of this guide, and the banned phrase about updates. The publish checks (a hero photo and title, 2 to 6 bullets, content in every enabled section) run when the creator publishes in the studio.
- HeroSectionThe top of the sales page, always shown: the photo carousel, title, headline, kicker and bullets.
- ListingSlideOne photo of the hero carousel or the gallery, by media id. The photo's own credit shows with it.
- PitchSectionWhat's inside the guide, as boxes. Can be switched off.
- ReviewsSectionTestimonials on the sales page. Can be switched off.
- CustomReviewA testimonial the creator supplied (reviews source custom), quoted verbatim in every language. Only real quotes the creator gives you; never invent one.
- GallerySectionFull-screen photos with captions. Can be switched off; off in a new draft.
- AboutCreatorSectionThe creator's bio, social links and video. Bio and social links come from the creator profile unless this page overrides them. Can be switched off.
- IntroVideoA video referenced by provider and id, never by an embed code.
- BuyFormSectionThe buy section with the checkout, always shown.
- FaqSectionQuestions and answers below the buy form. Off in a new draft.
Objects
- SpotA spot as list_spots returns it.
- SpotDetailA spot with its photos, chapters and routes (get_spot).
- SpotWriteA spot after create_spot or update_spot, with the write's warnings.
- PropertyA custom property definition.
- GuideA guide: settings, region, areas, properties and price.
- GuideDetailA guide with its chapter and photo counts (get_guide).
- GuideSummaryOne row of list_guides.
- AreaWithSpotsAn area with the spots that point at it.
- ChapterA chapter or a collection with its members.
- RouteA route with its facts and its spot and place links.
- RouteWriteA route after create_route, with the write's warnings.
- PlaceA place: a stay, transport, a tour, food or parking.
- PlaceWriteA place after create_facility, with the write's warnings.
- PhotoA photo with its metadata and owner.
- PublishGateAn open publish gate.
- StaleFactA dated fact that ran out or needs a new check.
- ReadinessThe publish checklist of a guide.
- StaleNoticesThe stale facts of a guide.
- PublishStatusWhat buyers see and what a publish would do.
- PublishQueuedThe publish status after publish_changes.
- LinkReportEntryOne link with its last check.
- LinkReportEvery link buyers can open, with its health.
- ProfileThe creator's public profile.
- SalesPageThe default sales page and the photos it may use.
- WhoamiThe key, its creator, the limits and the endpoints.
- UploadedPhotoA photo after upload_media.
- UploadedBlobA stored file after an upload with target=blob.
- BatchUploadThe results of upload_media_batch.