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

# List merchants (preview)

> Stores whose merchants have opted in to catalogue sharing.

<Warning>Preview: in development, not yet live.</Warning>


## OpenAPI

````yaml integrations/meta-ai/catalogue-api/openapi.json GET /merchants
openapi: 3.1.0
info:
  title: Vortex IQ Catalogue API (preview)
  version: 0.1.0
  description: >-
    **Preview: in development, not yet live.** Product search across BigCommerce
    and Adobe Commerce (including Magento Open Source) stores whose merchants
    have opted in to sharing their catalogue. Read-only. Prices are in each
    store's own currency and every product links to its page on the merchant's
    store, where the shopper buys.


    Only opted-in stores are ever searched. Hidden and disabled products are
    never returned, and nothing internal (cost price, stock counts, sales,
    customer or order data) is ever exposed.
  contact:
    name: Vortex IQ Support
    url: https://www.vortexiq.ai/contact-us
    email: support@vortexiq.ai
servers:
  - url: https://app.vortexiq.ai/api/v1/catalog
    description: Vortex IQ platform (planned)
security:
  - partnerAuth: []
paths:
  /merchants:
    get:
      summary: List merchants
      description: Stores whose merchants have opted in to catalogue sharing.
      operationId: listMerchants
      parameters:
        - name: platform
          in: query
          schema:
            type: string
            enum:
              - bigcommerce
              - adobe_commerce
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
        - name: cursor
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Opted-in merchants.
          content:
            application/json:
              schema:
                type: object
                required:
                  - merchants
                  - next_cursor
                properties:
                  merchants:
                    type: array
                    items:
                      $ref: '#/components/schemas/Merchant'
                  next_cursor:
                    type:
                      - string
                      - 'null'
        '401':
          description: Missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Rate limit reached. Retry after the number of seconds in
            `Retry-After`.
          headers:
            Retry-After:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Merchant:
      type: object
      required:
        - id
        - name
        - domain
        - platform
        - currency
      properties:
        id:
          type: string
          description: Stable merchant id.
          examples:
            - m_7f3c2a
        name:
          type: string
          examples:
            - Example Outdoor Co
        domain:
          type: string
          description: The store's public domain. Product links point here.
          examples:
            - www.example-outdoor.com
        platform:
          type: string
          enum:
            - bigcommerce
            - adobe_commerce
          description: Adobe Commerce includes Magento Open Source.
        currency:
          type: string
          examples:
            - GBP
    Error:
      type: object
      required:
        - error
        - error_description
      properties:
        error:
          type: string
          examples:
            - invalid_request
        error_description:
          type: string
  securitySchemes:
    partnerAuth:
      type: http
      scheme: bearer
      description: >-
        A bearer token issued to approved partners such as Meta, sent as
        `Authorization: Bearer <token>`. Partner credentials are issued during
        onboarding; shoppers never sign in.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.