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

# Listar promociones

> Promociones de la sucursal. Por defecto solo las vigentes (`active_only=true`); con `false` devuelve todas por prioridad.

**Permiso requerido:** `pricing`



## OpenAPI

````yaml /api-reference/openapi.json get /pricing/promotions
openapi: 3.0.3
info:
  title: FileXpress API Externa
  version: 1.0.0
  description: >-
    API para integrar sistemas de terceros con FileXpress: facturación, RRHH,
    contabilidad, inventario, proyectos, cuentas por cobrar y pagar, tesorería,
    precios y promociones y caja.
servers:
  - url: https://api.filexpress.app/api/external
    description: Producción
security:
  - ApiKey: []
tags:
  - name: General
  - name: Facturación · Ventas
  - name: Facturación · Compras
  - name: Facturación · Clientes
  - name: Facturación · Proveedores
  - name: Facturación · Productos
  - name: Catálogos
  - name: RRHH · Empleados
  - name: RRHH · Asistencia
  - name: RRHH · Permisos
  - name: RRHH · Planillas
  - name: Contabilidad
  - name: Inventario
  - name: Proyectos
  - name: Cuentas por cobrar
  - name: Cuentas por pagar
  - name: Tesorería
  - name: Precios y promociones
  - name: Caja
paths:
  /pricing/promotions:
    get:
      tags:
        - Precios y promociones
      summary: Listar promociones
      description: >-
        Promociones de la sucursal. Por defecto solo las vigentes
        (`active_only=true`); con `false` devuelve todas por prioridad.


        **Permiso requerido:** `pricing`
      parameters:
        - name: branch_id
          in: query
          required: true
          description: Sucursal (GET /branches). De otro negocio → 404.
          schema:
            type: string
            format: uuid
          example: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
        - name: active_only
          in: query
          required: false
          description: Solo promociones vigentes (por defecto true).
          schema:
            type: boolean
            default: true
      responses:
        '200':
          description: Éxito
          content:
            application/json:
              schema:
                type: object
                required:
                  - status
                  - data
                properties:
                  status:
                    type: boolean
                    example: true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Promotion'
              example:
                status: true
                data:
                  - id: 9d1c5a3e-4b7f-4e2a-9c1d-2f6b8a0e7c11
                    name: 2x1 en bebidas
                    description: Fin de semana
                    discount_type: percentage
                    discount_value: 10
                    combo_price: null
                    apply_on: unit_price
                    min_quantity: 1
                    start_date: '2026-10-01'
                    end_date: '2026-10-31'
                    is_active: true
                    priority: 10
                    conditions:
                      - type: category
                        id: 3b8e2f10-7c4d-4a9e-b1f2-5d6c7e8f9a01
        '401':
          $ref: '#/components/responses/E401'
        '403':
          $ref: '#/components/responses/E403'
        '404':
          description: No encontrado o de otro negocio
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                status: false
                message: Branch not found
        '429':
          $ref: '#/components/responses/E429'
components:
  schemas:
    Promotion:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
          nullable: true
        discount_type:
          type: string
          description: >-
            Tipo de descuento (`override_price`: `discount_value` es el nuevo
            precio).
          enum:
            - percentage
            - fixed
            - override_price
            - combo
        discount_value:
          type: number
          nullable: true
        combo_price:
          type: number
          nullable: true
        apply_on:
          type: string
          description: Base del descuento.
          enum:
            - unit_price
            - subtotal
        min_quantity:
          type: integer
          nullable: true
        start_date:
          type: string
          format: date
          nullable: true
        end_date:
          type: string
          format: date
          nullable: true
        is_active:
          type: boolean
        priority:
          type: integer
        conditions:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: Aplica a.
                enum:
                  - product
                  - category
                  - brand
              id:
                type: string
                format: uuid
            required:
              - type
              - id
      required:
        - id
        - name
        - discount_type
    Error:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Errores por campo (solo en validación).
      required:
        - status
        - message
  responses:
    E401:
      description: API Key ausente o inválida
      content:
        application/json:
          example:
            status: false
            message: Invalid API Key.
    E403:
      description: Integración sin el permiso requerido o desactivada
      content:
        application/json:
          example:
            status: false
            message: This integration does not have the 'hr.employees' permission.
            required_scope: hr.employees
    E429:
      description: Límite de peticiones excedido
      content:
        application/json:
          example:
            status: false
            message: Rate limit exceeded. Please try again later.
            rate_limit: 100
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key de la integración (Integraciones → Nueva Integración).

````

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