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

# Listar premios

> Devuelve el catálogo de premios del comercio, paginado.

Cada premio trae un array `offers` con el precio en puntos según el nivel del cliente. El `productOfferId` de la oferta que corresponda es lo que después mandás a `POST /external/exchange/product`.

Si enviás el header `x-branch-id`, se excluyen los premios que están limitados a otras sucursales.

**Atención**: este endpoint devuelve `{ data, meta, links }` en la raíz, sin el envelope `{ success, status, message, data }`.



## OpenAPI

````yaml /api-reference/openapi.json get /external/products
openapi: 3.0.0
info:
  title: API de Tienda de Puntos
  description: >-
    API pública de Tienda de Puntos. Permite sumar puntos por compra, consultar
    clientes, validar canjes y consumir cupones desde tu POS, ERP o e-commerce.


    Todas las llamadas se autentican con el header `x-api-key`.
  version: 0.0.1
  contact: {}
servers:
  - url: https://api.tiendadepuntos.com
    description: Producción
  - url: https://apidev.tiendadepuntos.com
    description: Desarrollo
security:
  - ApiKeyAuth: []
tags: []
paths:
  /external/products:
    get:
      tags:
        - Premios
      summary: Listar premios
      description: >-
        Devuelve el catálogo de premios del comercio, paginado.


        Cada premio trae un array `offers` con el precio en puntos según el
        nivel del cliente. El `productOfferId` de la oferta que corresponda es
        lo que después mandás a `POST /external/exchange/product`.


        Si enviás el header `x-branch-id`, se excluyen los premios que están
        limitados a otras sucursales.


        **Atención**: este endpoint devuelve `{ data, meta, links }` en la raíz,
        sin el envelope `{ success, status, message, data }`.
      operationId: ExternalProductCatalogController_findAll
      parameters:
        - name: order
          required: false
          in: query
          description: Campo por el que ordenar.
          schema:
            type: string
            enum:
              - name
              - stock
              - createdAt
              - points
        - name: levelId
          required: false
          in: query
          description: >-
            Devuelve solo los premios que tengan una oferta para este nivel. Los
            IDs salen de `GET /external/levels`.
          schema:
            example: 3
            type: number
        - name: isEnabled
          required: false
          in: query
          description: >-
            Filtra por premios habilitados. Si vas a mostrar el catálogo a un
            cliente, usá `true`: los deshabilitados no son canjeables desde la
            API.
          schema:
            type: boolean
            example: true
        - name: x-branch-id
          in: header
          description: >-
            ID de la sucursal en la que se registra la operación. Si se omite,
            la operación queda asociada al comercio sin sucursal.
          required: false
          schema:
            type: integer
            example: 1972
        - name: page
          required: false
          in: query
          schema:
            type: integer
            minimum: 1
            default: 1
            example: 1
        - name: limit
          required: false
          in: query
          description: Cantidad de resultados por página. Máximo 200.
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 10
            example: 10
        - name: query
          required: false
          in: query
          description: Búsqueda parcial por nombre.
          schema:
            type: string
            example: café
        - name: direction
          required: false
          in: query
          description: Sentido del orden. Solo aplica si se envía `order`.
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
      responses:
        '200':
          description: Página de premios. Sin envelope.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ExternalProductOutputDto'
                  meta:
                    type: object
                    properties:
                      totalItems:
                        type: integer
                        example: 128
                      itemCount:
                        type: integer
                        example: 10
                      itemsPerPage:
                        type: integer
                        example: 10
                      totalPages:
                        type: integer
                        example: 13
                      currentPage:
                        type: integer
                        example: 1
                      from:
                        type: integer
                        example: 1
                      to:
                        type: integer
                        example: 10
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: external/products?page=1&limit=10
                      previous:
                        type: string
                        example: null
                        nullable: true
                      next:
                        type: string
                        nullable: true
                        example: external/products?page=2&limit=10
                      last:
                        type: string
                        example: external/products?page=13&limit=10
                      path:
                        type: string
                        example: external/products
                      firstPageUrl:
                        type: string
                        example: external/products?page=1&limit=10
                      lastPageUrl:
                        type: string
                        example: external/products?page=13&limit=10
        '400':
          description: El cuerpo o los parámetros no pasaron la validación.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 400
                  timestamp:
                    type: string
                    format: date-time
                    example: '2026-07-31T14:05:12.431Z'
                  path:
                    type: string
                    example: /external/tags/add
                  method:
                    type: string
                    example: POST
                  message:
                    type: string
                    example: Error de validación
                  errors:
                    type: array
                    nullable: true
                    items:
                      type: object
                  data:
                    type: object
                    nullable: true
        '404':
          description: >-
            Falta el header `x-api-key` (`Api Key is required`) o la API key no
            corresponde a ningún comercio (`Business not found`). También se usa
            cuando el recurso pedido no existe.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  timestamp:
                    type: string
                    format: date-time
                    example: '2026-07-31T14:05:12.431Z'
                  path:
                    type: string
                    example: /external/tags/add
                  method:
                    type: string
                    example: POST
                  message:
                    type: string
                    example: Api Key is required
                  errors:
                    type: array
                    nullable: true
                    items:
                      type: object
                  data:
                    type: object
                    nullable: true
      security:
        - ApiKeyAuth: []
components:
  schemas:
    ExternalProductOutputDto:
      type: object
      properties:
        id:
          type: number
          description: ID del premio.
          example: 771
        name:
          type: string
          description: Nombre del premio.
          example: Café gratis
        description:
          type: string
          description: Descripción larga.
          example: Un café de especialidad a elección.
          nullable: true
        shortDescription:
          type: string
          description: Descripción corta.
          example: Café a elección
          nullable: true
        image:
          type: string
          description: URL de la imagen principal.
          example: https://tdp-products.s3.amazonaws.com/771.png
          nullable: true
        isEnabled:
          type: boolean
          description: Si está deshabilitado, no se puede canjear desde la API.
          example: true
        stock:
          $ref: '#/components/schemas/ExternalProductStockOutputDto'
        offers:
          description: >-
            Precio en puntos según el nivel del cliente. El `productOfferId` que
            se usa para canjear se obtiene de acá.
          type: array
          items:
            $ref: '#/components/schemas/ExternalProductOfferOutputDto'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/ExternalProductCategoryOutputDto'
        maxPurchases:
          type: number
          description: Máximo de canjes por cliente. `null` si no hay tope.
          example: null
          nullable: true
        createdAt:
          format: date-time
          type: string
          example: '2026-02-14T12:30:00.000Z'
        updatedAt:
          format: date-time
          type: string
          example: '2026-06-01T09:15:00.000Z'
      required:
        - id
        - name
        - description
        - shortDescription
        - image
        - isEnabled
        - stock
        - offers
        - categories
        - createdAt
        - updatedAt
    ExternalProductStockOutputDto:
      type: object
      properties:
        controlled:
          type: boolean
          description: Indica si el comercio lleva control de stock sobre este premio.
          example: true
        available:
          type: number
          description: >-
            Unidades disponibles. Solo tiene sentido cuando `controlled` es
            `true`.
          example: 12
      required:
        - controlled
        - available
    ExternalProductOfferOutputDto:
      type: object
      properties:
        productOfferId:
          type: number
          description: >-
            ID de la oferta. Es el `productOfferId` que consume `POST
            /external/exchange/product`.
          example: 4412
        points:
          type: number
          description: Puntos que cuesta el premio para este nivel.
          example: 500
        levelId:
          type: number
          description: Nivel al que aplica el precio. `null` si aplica a todos.
          example: 3
          nullable: true
        levelName:
          type: string
          description: Nombre del nivel.
          example: Nivel 2
          nullable: true
      required:
        - productOfferId
        - points
        - levelId
        - levelName
    ExternalProductCategoryOutputDto:
      type: object
      properties:
        id:
          type: number
          example: 7
        name:
          type: string
          example: Cafetería
      required:
        - id
        - name
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key del comercio. Se genera desde el panel de Tienda de Puntos, en
        Configuración → Integraciones.

````