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

# List retailers with locations

> List all retailers with their locations and product counts



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/retailers
openapi: 3.1.0
info:
  title: Goods API
  version: 1.0.0
  description: >-
    API for Goods grocery operations - scanner app, admin dashboard, and
    customer features
  contact:
    name: Goods Team
    url: https://goods.app
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://dev.api.switchyard.run
    description: Development
  - url: https://api.switchyard.run
    description: Production
security: []
tags:
  - name: v1
    description: API v1 - unified domain-based endpoints
  - name: Scanner
    description: Scanner app endpoints for drivers and pickers
  - name: Sweeps
    description: Sweep management - retail store pickup operations
  - name: RFC Picks
    description: Ready-for-checkout picking operations
  - name: Inventory
    description: Inventory management and barcode lookup
  - name: Admin
    description: Admin dashboard endpoints
  - name: Orders
    description: Order management
  - name: Products
    description: Product catalog management
  - name: Notifications
    description: Push, email, SMS, and Slack notification management
paths:
  /v1/retailers:
    get:
      tags:
        - Retailers
      summary: List retailers with locations
      description: List all retailers with their locations and product counts
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 10000
            default: 100
            description: Max items to return
            example: 100
          required: false
          name: limit
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
            description: Items to skip
            example: 0
          required: false
          name: offset
          in: query
        - schema:
            type: string
            maxLength: 200
            description: Search query
            example: whole foods
          required: false
          name: search
          in: query
      responses:
        '200':
          description: List of retailers and locations
          content:
            application/json:
              schema:
                type: object
                properties:
                  retailers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        retailer_code:
                          type: string
                          nullable: true
                        display_name:
                          type: string
                        brand_logo_url:
                          type: string
                          nullable: true
                      required:
                        - id
                        - retailer_code
                        - display_name
                        - brand_logo_url
                      description: Retailer summary
                  locations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        retailer_id:
                          type: string
                          nullable: true
                          format: uuid
                        name:
                          type: string
                        store_number:
                          type: string
                          nullable: true
                        address_1:
                          type: string
                          nullable: true
                        address_2:
                          type: string
                          nullable: true
                        city:
                          type: string
                          nullable: true
                        province:
                          type: string
                          nullable: true
                        postal_code:
                          type: string
                          nullable: true
                        latitude:
                          type: number
                          nullable: true
                        longitude:
                          type: number
                          nullable: true
                        product_count:
                          type: number
                      required:
                        - id
                        - retailer_id
                        - name
                        - store_number
                        - address_1
                        - address_2
                        - city
                        - province
                        - postal_code
                        - latitude
                        - longitude
                      description: Location
                  total:
                    type: number
                required:
                  - retailers
                  - locations
                  - total
                description: List retailers response
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Error message
                required:
                  - error
                description: Error response

````