> ## 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 merchants the caller may act for

> Returns the merchant records the caller can use: every installed merchant for staff, or just the caller's own store for a merchant token. Call it first to discover merchant ids and each store's settings. Read-only.



## OpenAPI

````yaml /api-reference/openapi/lite.json get /merchants/
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:
  /merchants/:
    get:
      summary: The merchants the caller may act for
      description: >-
        Returns the merchant records the caller can use: every installed
        merchant for staff, or just the caller's own store for a merchant token.
        Call it first to discover merchant ids and each store's settings.
        Read-only.
      operationId: listMerchants
      responses:
        '200':
          description: The merchants.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/LiteMerchant'
        '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'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    LiteMerchant:
      type: object
      properties:
        id:
          type: string
        display_name:
          type: string
        start_timestamp:
          type:
            - number
            - 'null'
          description: Install time, epoch seconds.
        base_currency:
          type: string
          description: Currency of the default market (ISO 4217).
        has_completed_onboarding:
          type: boolean
        auto_activate_all_collections:
          type: boolean
          description: New collections are activated for Depict sorting automatically.
        desktop_columns:
          type: integer
          description: Collection grid columns on desktop.
        mobile_columns:
          type: integer
          description: Collection grid columns on mobile.
        shopify_domain:
          type: string
          description: The shop's *.myshopify.com domain.
        shopify_app_installed:
          type: boolean
        has_run_at_least_one_ingestion:
          type:
            - boolean
            - 'null'
          description: The first full catalog import has finished.
        multi_store_group_id:
          type:
            - string
            - 'null'
          description: Multi-store group the merchant belongs to, if any.
        multi_store_activation_code:
          type:
            - string
            - 'null'
        variant_group_by_name:
          type:
            - string
            - 'null'
          description: >-
            Product option name used to group variants in the collection grid
            (e.g. Color); null = no grouping.
        shopify_is_multi_market:
          type: boolean
        uses_cloudflare_ingestion:
          type: boolean
        default_market_id:
          type:
            - string
            - 'null'
      required:
        - id
        - display_name
        - base_currency
        - desktop_columns
        - mobile_columns
        - shopify_domain
        - shopify_app_installed
        - has_run_at_least_one_ingestion
        - multi_store_group_id
        - multi_store_activation_code
        - variant_group_by_name
    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.

````