Byte & Pieces

Showing 25 of 85 from the live probe.

• List membership post types

  List all available membership post types for the current shop. Use this to discover which post type names can be used when creating or filtering membership posts (e.g., text posts, image posts, video posts, etc.). Returns: - types: array of post type objects, each containing: - name (String — one of: "Text", "Image", "Video", "Audio", "Poll", "LiveStream", "VideoEmbed")

• List membership post tags

  List all membership post tags configured for the current shop. Use this to discover available membership post tag IDs and names, for example when filtering membership posts by tag or building tag-based navigation. Returns: - tags: array of tag objects, each containing: - Identity: id (UUID), name (String)

• List membership post series

  List all membership post series configured for the current shop. Use this to discover available series IDs and their titles — for example when grouping membership posts, linking posts to a series, or building series-based navigation. Returns: - series: array of series objects, each containing: - Identity: id (UUID String), title (String)

• List membership post access types

  List all available access filter options for membership posts in the current shop. Use this to discover valid access filter values when building post listings or selectors that filter posts by who can see them (all, members-only, or public). Returns: - accesses: array of access option objects, each containing: - key (String — human-readable label, e.g., "All posts", "Members only posts", "Public only posts") - value (String — filter value to pass in APIs; one of: "" (all), "MembersOnly", "P

• Update draft theme setting resource

  Set an image_picker theme setting of a draft theme by referencing a Google Cloud Storage object. This is for image_picker settings from the theme settings schema — for the shop logo or favicon use update-draft-theme-logo / update-draft-theme-favicon instead. Returns: - id (UUID): the draft theme ID, confirming the update was applied.

• Get draft theme page template layout

  Retrieve the full layout structure for a product or collection page template of a draft theme, including all section groups and their sections with settings. The layout is organized as section groups (header, footer, aside) each containing ordered sections. Each section has typed settings that define its configurable UI components. Returns: - sections_groups: array of section groups, each containing: - Identity: id (String), type (VALUES: header, footer, aside, static), modifiable (Boolean)

• Get draft theme custom page layout

  Retrieve the full layout structure for a custom page or policy page of a draft theme, including all section groups and their sections with settings. The layout is organized as section groups (header, footer, aside) each containing ordered sections. Each section has typed settings that define its configurable UI components. Returns: - sections_groups: array of section groups, each containing: - Identity: id (String), type (VALUES: header, footer, aside, static), modifiable (Boolean) - sectio

• List offers for product page template

  List the offers currently assigned to a product page template in the given draft theme. Archived draft assignments are excluded. Returns: - id (UUID): the product page template ID. - name (String): the template name. - offers (Array[Object]): assigned offers, each with id (UUID).

• Assign offers to product page template

  Replace the set of offers assigned to a product page template in the given draft theme. Missing offers are added, previously archived matches are restored, and any currently assigned offers not in the new set are archived. Returns: - assigned (Boolean): true on success, confirming the assignment was applied.

• List collections for collection page template

  List the collections bound to a collection page template in the given draft theme. Only bindings with draft status "New" or "NotChanged" are returned (archived bindings are excluded). Returns: - id (UUID): the collection page template ID. - name (String): the template's display name. - collections: array of bound collections, each containing: - id (UUID): the collection ID.

• Assign collections to collection page template

  Assign (upsert) the set of collections bound to a collection page template in the given draft theme. Replaces the current draft binding set: collections missing from the input are archived, previously archived collections present in the input are revived, and new collections are added. Returns: - assigned (Boolean): true on success.

• Get theme documentation

  Retrieve AI-oriented documentation file describing how to work with the theme behind a draft theme.

• Get theme feature

  Check whether a specific feature flag is enabled on the published theme. Use this to verify theme capabilities before performing theme-dependent operations. Returns: - Feature: name (String), enabled (Boolean)

• List draft theme section schemas

  List available section schemas for a draft theme filtered by layout group (header, aside, footer). Returns the sections that can be placed in the specified area of the theme layout. Returns per section: - Identity: section_type (String), name (nullable String) - Layout: max_blocks (nullable Integer) - Info: description (nullable String), group_name (nullable String), position (nullable Integer) - Presets: preset_names (array of String — available preset configurations)

• Get draft section schema

  Retrieve the section schema for a specific draft section. Use this to inspect a draft section's configuration constraints — its type, display name, block limits, available presets, and the writable setting keys. Returns: - Identity: section_type (String — e.g., "text-carousel") - Display: name (nullable String — human-readable label, e.g., "Scrolling text") - Constraints: max_blocks (nullable Integer — maximum number of blocks allowed) - Metadata: description (nullable String — what the section

• List navigation linkables

  Paginated picker of items a navigation/menu link can point to in the current shop. Use this to discover what can be linked from a navigation item: platform links (Home, Cart), custom URLs, memberships, pages, collections, and products. Returns: - linkables: array of ungrouped items (platform & custom links), each containing: - id (String), title (String), url (String), type (Platform/Custom) - groups: array of grouped, paginated buckets, each containing: - title (String — group label, e.g.

• Get linkable

  Retrieve a single linkable (navigation link target) by its type and ID in the current shop. Use this to resolve the canonical title/URL of a navigation target — e.g. to display the destination of an existing link. Returns: - id (String): the linkable's ID - title (String): display title/label of the linkable - url (String): resolved URL the linkable points to - type (String): one of Platform, Membership, Page, Collection, Product, Custom

• List membership tiers

  List all membership tiers configured for the current shop. Use this to discover available tier IDs and names, for example when setting a page's `access.type == "Membership"` or building memberships-related navigation/gating. Returns: - tiers: array of tier objects, each containing: - Identity: id (Integer), name (String)

• List draft section block schemas

  List block schemas available for a draft section. Use this to discover which block types can be added to a specific draft section. Returns: - block_schemas: array of block schema objects, each containing: - Identity: id (nullable UUID — null for theme blocks and for custom-liquid sections where block schemas are inline; such blocks are identified by block_type), name (String), block_type (String) - Constraints: limit (nullable Integer — max instances of this block)

• Update draft theme settings

  Update one or more theme setting values in a draft theme. Pass every setting you want to change in the same call. Returns: - id (UUID): the draft theme ID, confirming the updates were applied.

• Get draft theme settings

  Retrieve all theme settings for a draft theme, grouped into named sections with typed UI components. Returns the full settings schema with current values — NOT the theme library catalog. Each setting section contains an ordered array of UI components (inputs, selects, radios, headers, etc.) that define the theme customization interface. Returns: - settings: array of setting sections, each containing: - Identity: name (String), icon (String — e.g. "palette", "type", "layout") - values: order

• Get draft theme section preview

  Render an HTML preview of a single section for a draft theme. The preset is taken from the theme's selected preset, falling back to the section's first preset. Returns: - Preview: html (String — a full HTML document; the rendered section markup is inside the <body> tag)

• Get draft navigation

  Retrieve a draft navigation (menu) by its handle for a given draft theme, including the full hierarchical tree of links. Navigation handles are theme-specific — there are no fixed default handles. They appear as the values of link_list settings in the draft theme layout, header, and footer sections. Returns: - id (String — UUID): the shop navigation ID - system (Boolean): whether the navigation is system-managed (non-deletable) - hidden (Boolean): whether the navigation is hidden from display -

• Update draft theme logo

  Update the logo image of a draft theme by referencing a Google Cloud Storage object. Returns: - id (UUID): the draft theme ID, confirming the update was applied.

• Delete draft theme logo

  Remove the logo image from a draft theme. Returns: - id (UUID): the draft theme ID, confirming the logo was removed.