# Guide

A guide: settings, region, areas, properties and price.

Group: Objects.

## Fields

- `productId` (string, required): The guide's id.
- `name` (string, required): The guide's title.
- `slug` (string, required): URL slug of the sales page.
- `headline` (string or null, required): One-line promise under the title on the sales page.
- `purchaseButtonText` (string or null, required): The buy button label, or null for the default.
- `status` (string, required): draft (not on sale), published (on sale) or archived. One of `draft`, `published`, `archived`.
- `visibleOnStore` (boolean, required): Whether the guide shows in the Sceniq store (set in the studio).
- `storeReviewStatus` (string or null, required): The store review's state, or null before a review. One of `pending`, `approved`, `rejected`.
- `storeReviewNote` (string or null, required): The store review team's note.
- `storeTags` (array of strings, required): Store tags from the fixed vocabulary.
- `country` (string or null, required): ISO 3166-1 alpha-2 code of the country the guide covers; null means worldwide.
- `reviewsShown` (boolean, required): Whether buyer reviews show on the store card.
- `buyerCountShown` (boolean, required): Whether the buyer count shows on the sales page (set in the studio).
- `pricing` (object, required): How the guide is sold.
  - `oneTimeEnabled` (boolean, required): Whether the guide sells for a one-time price.
  - `subscriptionIncluded` (boolean, required): Whether it is part of a subscription.
  - `currency` (string, required): The guide's currency.
- `originalLanguage` (string, required): The language the guide is written in (BCP 47).
- `createdAt` (number, required): When the row was created (Unix time in milliseconds).
- `updatedAt` (number, required): When the row last changed (Unix time in milliseconds).
- `publishedAt` (number or null, required): When the guide first went on sale (Unix time in milliseconds).
- `lastApiWriteAt` (number or null, required): When a key last changed the guide (Unix time in milliseconds).
- `region` (MapRegion or null, required): The map region the viewer opens on.
  Fields of MapRegion: https://developers.sceniq.earth/fields/map-region.md
- `areas` (array of Area, required): Parks, islands and regions spots can point at.
  Fields of Area: https://developers.sceniq.earth/fields/area.md
- `mapStyle` (object or null, required): The map's style, set in the studio.
  - `basemap` (string, optional): The base map style.
  - `pinStyle` (string, optional): The pin style.
  - `themeColor` (string, optional): The accent color.
- `propertySchemaVersion` (number or null, required): Bumped on every property change.
- `properties` (array of Property, required): Custom property definitions.
  Fields of Property: https://developers.sceniq.earth/fields/property.md
- `price` (object or null, required): The active one-time price, or null when none is set.
  - `amountMinor` (number, required): The price in minor units (2900 is 29.00).
  - `currency` (string, required): ISO 4217 code in lower case (usd, eur, chf).
- `spotCount` (number, required): Number of spots, archived ones included.
- `thumbnailUrl` (string or null, required): The 4:5 store thumbnail.
- `dashboardUrl` (string, required): The guide in the studio.
- `salesPageUrl` (string, required): The public sales page (live once published).

## Used by

- [create_guide](https://developers.sceniq.earth/reference/create_guide.md)
- [update_guide](https://developers.sceniq.earth/reference/update_guide.md)