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

# Listar produtos



## OpenAPI

````yaml GET /product
openapi: 3.0.0
info:
  title: payera-api
  description: Documentação de endpoints e entidades da payera
  version: '1.0'
  contact: {}
servers:
  - url: https://api.rivoopay.com
security:
  - ApiKeyAuth: []
paths:
  /product:
    get:
      tags:
        - Product
      summary: Get all products of a company
      operationId: ProductController_getAllByCompany
      parameters:
        - name: name
          required: false
          in: query
          description: Filter by product name (partial match, case-insensitive)
          schema:
            example: Bola
            type: string
        - name: description
          required: false
          in: query
          description: Filter by product description (partial match)
          schema:
            example: muito bom
            type: string
        - name: price
          required: false
          in: query
          description: Filter by product price in cents (centavos)
          schema:
            example: 1990
            type: number
        - name: needShipping
          required: false
          in: query
          description: Filter by shipping requirement
          schema:
            example: false
            type: boolean
        - name: sku
          required: false
          in: query
          description: Filter by Stock Keeping Unit
          schema:
            example: SKU-ABCD-123
            type: string
        - name: categories
          required: false
          in: query
          description: Filter by product categories
          schema:
            example:
              - Eletronicos e Tecnologia
            type: array
            items:
              type: string
              enum:
                - Jogos
                - Eletrônicos
                - Roupas
                - Acessórios
                - Casa e Decoração
                - Esportes
                - Brinquedos
                - UGC
                - Cursos
                - Serviços
                - Livros
                - E-books
                - Música
                - Filmes e Séries
                - Alimentos e Bebidas
                - SaaS
                - Outros
        - name: id
          required: false
          in: query
          description: Filter by product ID
          schema:
            format: uuid
            example: 0e02a425-32b4-493d-8db6-1a033457b5ee
            type: string
        - name: status
          required: false
          in: query
          description: Filter by product status
          schema:
            example: ACTIVE
            type: string
            enum:
              - ACTIVE
              - INACTIVE
        - name: companyId
          required: false
          in: query
          description: Filter by company ID
          schema:
            format: uuid
            example: f96a489c-8a4d-4c7b-a1f6-347acbd832df
            type: string
      responses:
        '200':
          description: All products of a company in App
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProductDTO'
components:
  schemas:
    ProductDTO:
      type: object
      properties:
        id:
          type: string
          description: Product identifier
          example: prod_01F4Z8Z5Y6X7W8V9U0T1S2R3Q4
          maxLength: 255
        name:
          type: string
          description: Product name
          example: Produto Bola
          maxLength: 255
        description:
          type: string
          description: Product description
          example: Produto muito bom para uso diário
        price:
          type: number
          description: Product price in cents (centavos)
          example: 1990
          minimum: 0
        needShipping:
          type: boolean
          description: Indicates if the product requires shipping
          example: false
          default: false
        sku:
          type: string
          description: Stock Keeping Unit - unique identifier for inventory management
          example: SKU-ABCD-123
          nullable: true
        imageUrl:
          type: string
          description: URL of the product image
          example: https://example.com/image.png
          format: uri
          nullable: true
        categories:
          type: array
          description: Product categories
          example:
            - Eletronicos e Tecnologia
            - Celulares e Smartphones
          items:
            type: string
            enum:
              - Jogos
              - Eletrônicos
              - Roupas
              - Acessórios
              - Casa e Decoração
              - Esportes
              - Brinquedos
              - UGC
              - Cursos
              - Serviços
              - Livros
              - E-books
              - Música
              - Filmes e Séries
              - Alimentos e Bebidas
              - SaaS
              - Outros
        companyId:
          type: string
          description: Company ID that owns this product
          example: f96a489c-8a4d-4c7b-a1f6-347acbd832df
          format: uuid
        status:
          type: string
          description: Product status
          example: ACTIVE
          enum:
            - ACTIVE
            - INACTIVE
          default: ACTIVE
        marketplaceStatus:
          type: string
          description: Marketplace status
          example: INACTIVE
          enum:
            - APPROVED
            - ANALYSIS
            - DECLINED
            - INACTIVE
          default: INACTIVE
        type:
          type: string
          enum:
            - ONE_TIME
            - RECURRING
        frequency:
          type: string
          enum:
            - WEEKLY
            - MONTHLY
            - SEMIANNUAL
            - ANNUAL
          description: Obrigatório quando type=RECURRING
        dayDue:
          type: number
          description: Prazo de pagamento em dias após a geração (1-7)
          minimum: 1
          maximum: 7
        dayGenerateCharge:
          type: number
          description: Dia de geração da cobr (1-28)
          minimum: 1
          maximum: 28
      required:
        - id
        - name
        - description
        - price
        - needShipping
        - companyId
        - status
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````