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

# Merchants List

> Fetch a paginated list of merchants with their lifetime success rates (checkout, checkoutDetails, productDetails, productSearch), coverage status, and checkout latency. Rates are computed over real traffic only; a rate is null (N/A) when there are no attempts yet.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/henry-sdk/openapi.documented.yml get /merchants
openapi: 3.1.0
info:
  title: Henry Labs API
  version: 1.5.0
  description: Playground for Henry Labs API endpoints
  contact:
    name: Henry Labs API Support
    email: support@henrylabs.ai
servers:
  - url: https://api.henrylabs.ai/v1
    description: Production server
security:
  - ApiKeyAuth: []
tags:
  - name: Product
    description: Product search, details, and data enrichment
  - name: Cart
    description: Universal user shopping cart management
  - name: Orders
    description: Order management post purchase
  - name: Merchants
    description: Merchant information and status
paths:
  /merchants:
    get:
      tags:
        - Merchants
      summary: Merchants List
      description: >-
        Fetch a paginated list of merchants with their lifetime success rates
        (checkout, checkoutDetails, productDetails, productSearch), coverage
        status, and checkout latency. Rates are computed over real traffic only;
        a rate is null (N/A) when there are no attempts yet.
      operationId: merchantsList
      parameters:
        - in: query
          name: cursor
          schema:
            description: >-
              Opaque cursor returned from the previous response; pass back to
              fetch the next page.
            example: '100'
            type: string
          description: >-
            Opaque cursor returned from the previous response; pass back to
            fetch the next page.
        - in: query
          name: limit
          schema:
            default: 20
            description: Limit the number of results
            example: 20
            type: number
            minimum: 1
            maximum: 100
          description: Limit the number of results
        - in: query
          name: host
          schema:
            description: Filter merchants by host
            example: nike.com
            type: string
            minLength: 1
          description: Filter merchants by host
        - in: query
          name: name
          schema:
            description: Filter merchants by name (partial match)
            example: nike
            type: string
            minLength: 1
          description: Filter merchants by name (partial match)
        - in: query
          name: coverageStatus
          schema:
            description: >-
              Filter merchants by coverage status (supported, testing, or
              unsupported).
            example: supported
            type: string
            enum:
              - supported
              - testing
              - unsupported
          description: >-
            Filter merchants by coverage status (supported, testing, or
            unsupported).
        - in: query
          name: categories
          schema:
            minItems: 1
            type: array
            items:
              type: string
              enum:
                - automotive
                - baby_and_kids
                - ecommerce
                - electronics_and_gadgets
                - fashion_and_accessories
                - finance
                - food
                - health_and_beauty
                - home_and_living
                - lifestyle_and_entertainment
                - other
                - sports_and_outdoor
                - travel
                - education
      responses:
        '200':
          description: Merchants fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/merchantsListResponse'
        '400':
          description: Bad request - Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  status:
                    type: string
                  message:
                    type: string
                required:
                  - success
                  - status
                  - message
                additionalProperties: false
        '401':
          description: Unauthorized - Invalid API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  status:
                    type: string
                  message:
                    type: string
                required:
                  - success
                  - status
                  - message
                additionalProperties: false
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import HenrySDK from '@henrylabs/sdk';

            const client = new HenrySDK({
              apiKey: process.env['HENRY_SDK_API_KEY'], // This is the default and can be omitted
            });

            const merchants = await client.merchants.list();

            console.log(merchants.data);
components:
  schemas:
    merchantsListResponse:
      type: object
      properties:
        success:
          type: boolean
        status:
          type: string
        message:
          type: string
        data:
          type: array
          items:
            $ref: '#/components/schemas/merchantData'
        pagination:
          $ref: '#/components/schemas/merchantsPagination'
      required:
        - success
        - status
        - message
        - data
        - pagination
      additionalProperties: false
    merchantData:
      type: object
      properties:
        host:
          type: string
        name:
          type: string
        description:
          type: string
        website:
          type: object
          properties:
            urls:
              type: array
              items:
                type: object
                properties:
                  value:
                    type: string
                  type:
                    type: string
                    enum:
                      - landing
                      - checkout
                required:
                  - value
                additionalProperties: false
          required:
            - urls
          additionalProperties: false
        logo:
          type: object
          properties:
            urls:
              type: array
              items:
                type: object
                properties:
                  value:
                    type: string
                required:
                  - value
                additionalProperties: false
          required:
            - urls
          additionalProperties: false
        categories:
          type: array
          items:
            type: string
            enum:
              - automotive
              - baby_and_kids
              - ecommerce
              - electronics_and_gadgets
              - fashion_and_accessories
              - finance
              - food
              - health_and_beauty
              - home_and_living
              - lifestyle_and_entertainment
              - other
              - sports_and_outdoor
              - travel
              - education
        coverageStatus:
          type: string
          enum:
            - supported
            - testing
            - unsupported
        rates:
          $ref: '#/components/schemas/merchantRates'
        latencyMs:
          $ref: '#/components/schemas/merchantLatency'
      required:
        - host
        - name
        - description
        - website
        - logo
        - categories
        - coverageStatus
        - rates
        - latencyMs
      additionalProperties: false
    merchantsPagination:
      type: object
      properties:
        nextCursor:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - nextCursor
      additionalProperties: false
    merchantRates:
      type: object
      properties:
        checkout:
          $ref: '#/components/schemas/merchantRate'
        checkoutDetails:
          $ref: '#/components/schemas/merchantRate'
        productDetails:
          $ref: '#/components/schemas/merchantRate'
        productSearch:
          $ref: '#/components/schemas/merchantRate'
      required:
        - checkout
        - checkoutDetails
        - productDetails
        - productSearch
      additionalProperties: false
    merchantLatency:
      type: object
      properties:
        checkout:
          $ref: '#/components/schemas/merchantLatencyEntry'
        checkoutDetails:
          $ref: '#/components/schemas/merchantLatencyEntry'
        productDetails:
          $ref: '#/components/schemas/merchantLatencyEntry'
        productSearch:
          $ref: '#/components/schemas/merchantLatencyEntry'
      required:
        - checkout
        - checkoutDetails
        - productDetails
        - productSearch
      additionalProperties: false
    merchantRate:
      type: object
      properties:
        rate:
          anyOf:
            - type: number
            - type: 'null'
      required:
        - rate
      additionalProperties: false
    merchantLatencyEntry:
      anyOf:
        - type: object
          properties:
            p50:
              type: number
            p95:
              type: number
          required:
            - p50
            - p95
          additionalProperties: false
        - type: 'null'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````