> ## Documentation Index
> Fetch the complete documentation index at: https://docs.depict.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# The merchant's portal feature flags

> Returns which portal features are switched on for the merchant (e.g. search_synonyms) and when onboarding was last reset. Call it before using a gated surface. Never fails for an authorized caller: missing config means every flag off. Read-only.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /portal-features
openapi: 3.1.0
info:
  title: Search & Merchandising API
  version: 1.0.0
  description: >-
    REST API behind Depict: Search & Merchandising, the native Shopify app:
    onboarding, collections, boost & bury, dashboards, A/B testing and
    multi-store management. Endpoints are served under the /api/lite prefix and
    are authenticated with the Shopify session token that App Bridge issues to
    the embedded app.
servers:
  - url: /api/lite
security:
  - ShopifySessionToken: []
paths:
  /portal-features:
    get:
      summary: The merchant's portal feature flags
      description: >-
        Returns which portal features are switched on for the merchant (e.g.
        search_synonyms) and when onboarding was last reset. Call it before
        using a gated surface. Never fails for an authorized caller: missing
        config means every flag off. Read-only.
      operationId: portalFeatures
      parameters:
        - schema:
            type: string
            description: Lite merchant id, e.g. `shopify-<shop id>`.
          required: true
          description: Lite merchant id, e.g. `shopify-<shop id>`.
          name: merchant_id
          in: query
      responses:
        '200':
          description: The flags.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortalFeaturesResponse'
        '400':
          description: merchant_id is missing, or a query parameter is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '403':
          description: Authenticated, but this identity may not call the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '404':
          description: Merchant not found for this caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    PortalFeaturesResponse:
      type: object
      properties:
        features:
          type: object
          properties:
            metafields_ingestion:
              type: boolean
            onboarding_in_app:
              type: boolean
            new_in_date_source:
              type: boolean
            product_groupings_enabled:
              type: boolean
            search_templates_extended:
              type: boolean
            search_theming:
              type: boolean
            search_synonyms:
              type: boolean
            mcp:
              type: boolean
            mcp_write:
              type: boolean
            collection_version_ab_test:
              type: boolean
          description: Flags explicitly set for the merchant; an absent key means off.
        onboarding:
          type: object
          properties:
            reset_at:
              type:
                - string
                - 'null'
              description: >-
                When staff last reset onboarding; setup progress counts from
                here. Null = never.
          required:
            - reset_at
      required:
        - features
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
  securitySchemes:
    ShopifySessionToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Shopify App Bridge session token of the embedded Depict: Search &
        Merchandising app. The shop in the token determines the merchant;
        merchant_id parameters must belong to that shop.

````