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

# Listar sucursales con su estado

> Sucursales del restaurante con su estado abierto/cerrado en vivo. `register_mode` indica cómo se gestiona la apertura: `manual` (caja del día) o `schedule` (horario semanal + excepciones).




## OpenAPI

````yaml /openapi.yaml get /locations
openapi: 3.1.0
info:
  title: FoodDelivery API
  version: '1.0'
  description: |
    API pública de FoodDelivery, v1.
    Lectura con cualquier llave; los endpoints de escritura requieren una
    llave con el permiso de escritura (se define al generarla en el panel).
    Las llaves sandbox (`fd_test_`) usan estos mismos endpoints en modo
    prueba: pedidos marcados PRUEBA, pago simulado y stock/local sin efecto
    real (ver la guía Sandbox).
    Montos en CLP sin decimales; fechas ISO 8601 en horario de Chile
    (America/Santiago).
servers:
  - url: https://app.fooddelivery.cl/api/v1
security:
  - apiKey: []
tags:
  - name: Pedidos
  - name: Menú
  - name: Inventario
  - name: Locales
paths:
  /locations:
    get:
      tags:
        - Locales
      summary: Listar sucursales con su estado
      description: >
        Sucursales del restaurante con su estado abierto/cerrado en vivo.
        `register_mode` indica cómo se gestiona la apertura: `manual` (caja del
        día) o `schedule` (horario semanal + excepciones).
      operationId: listLocations
      responses:
        '200':
          description: Sucursales y estado.
          content:
            application/json:
              schema:
                type: object
                properties:
                  register_mode:
                    type: string
                    enum:
                      - manual
                      - schedule
                  checked_at:
                    type: string
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LocationStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    LocationStatus:
      type: object
      properties:
        location_id:
          type: string
          format: uuid
        name:
          type: string
        address:
          type: string
          nullable: true
        is_active:
          type: boolean
          description: false = sucursal desactivada en el panel.
        open_now:
          type: boolean
        reason:
          type: string
          enum:
            - caja_abierta
            - caja_cerrada
            - dentro_del_horario
            - fuera_del_horario
            - sucursal_desactivada
        next_opening_at:
          type: string
          nullable: true
          description: Próxima apertura según horario (solo si está cerrada).
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - forbidden
                - not_found
                - location_closed
                - location_inactive
                - insufficient_stock
                - illegal_transition
                - managed_by_integrator
                - state_conflict
                - payment_unavailable
                - rate_limited
                - internal_error
            message:
              type: string
  responses:
    Unauthorized:
      description: API key ausente, inválida o revocada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: Límite de peticiones excedido; ver header `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >
        API key del restaurante, generada en el panel de administración
        (Integraciones → API pública): `fd_live_...` para producción o
        `fd_test_...` para sandbox (modo prueba sobre el mismo restaurante).

````