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

# Listar produtos



## OpenAPI

````yaml https://erp.olist.com/public-api/v3/swagger/swagger-mintlify.json get /produtos
openapi: 3.0.0
info:
  title: Olist ERP API v3
  description: >-
    Documentação completa: <a href="https://api-docs.erp.olist.com"
    target="_blank">https://api-docs.erp.olist.com</a>
  version: '3.1'
servers:
  - url: https://api.tiny.com.br/public-api/v3
security: []
paths:
  /produtos:
    get:
      tags:
        - Produtos
      summary: Listar produtos
      operationId: ListarProdutosAction
      parameters:
        - $ref: '#/components/parameters/nomeProduto'
        - $ref: '#/components/parameters/codigoProduto'
        - $ref: '#/components/parameters/gtin'
        - $ref: '#/components/parameters/situacao'
        - $ref: '#/components/parameters/dataCriacao'
        - $ref: '#/components/parameters/dataAlteracao'
        - $ref: '#/components/parameters/idListaPreco'
        - $ref: '#/components/parameters/get_produtos_limit'
        - $ref: '#/components/parameters/get_produtos_offset'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                properties:
                  itens:
                    type: array
                    items:
                      $ref: '#/components/schemas/ListagemProdutosResponseModel'
                  paginacao:
                    $ref: '#/components/schemas/PaginatedResultModel'
                type: object
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDTO'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
        '503':
          description: Service Unavailable
      security:
        - bearerAuth: []
components:
  parameters:
    nomeProduto:
      name: nome
      in: query
      description: Pesquisa por nome parcial ou completo do produto
      required: false
      schema:
        type: string
    codigoProduto:
      name: codigo
      in: query
      description: Pesquisa pelo código do produto
      required: false
      schema:
        type: string
    gtin:
      name: gtin
      in: query
      description: Pesquisa através do código GTIN do produto
      required: false
      schema:
        type: integer
    situacao:
      name: situacao
      in: query
      description: |-
        Pesquisa com base na situação informada
        - A - Ativo
        - I - Inativo
        - E - Excluido
      required: false
      schema:
        enum:
          - A
          - I
          - E
      x-enumDescriptions:
        - A - Ativo
        - I - Inativo
        - E - Excluido
    dataCriacao:
      name: dataCriacao
      in: query
      description: Pesquisa através da data de criação do produto
      required: false
      schema:
        type: string
        example: '2023-01-01 10:00:00'
    dataAlteracao:
      name: dataAlteracao
      in: query
      description: Pesquisa através da data de última alteração do produto
      required: false
      schema:
        type: string
        example: '2023-01-01 10:00:00'
    idListaPreco:
      name: idListaPreco
      in: query
      description: >-
        Filtra produtos que estão cadastrados na lista de preços informada.
        Quando informado, retorna apenas produtos que possuem preço definido
        nesta lista.
      required: false
      schema:
        type: integer
    get_produtos_limit:
      name: limit
      in: query
      description: Limite da paginação
      required: false
      schema:
        type: integer
        default: 100
    get_produtos_offset:
      name: offset
      in: query
      description: Offset da paginação
      required: false
      schema:
        type: integer
        default: 0
  schemas:
    ListagemProdutosResponseModel:
      title: ' '
      description: ' '
      type: object
      allOf:
        - properties:
            id:
              type: integer
            sku:
              type: string
            descricao:
              type: string
            tipo:
              description: |-

                - K - Kit
                - S - Simples
                - V - Com Variacoes
                - F - Fabricado
                - M - Materia Prima
              type: string
              enum:
                - K
                - S
                - V
                - F
                - M
              x-enumDescriptions:
                - K - Kit
                - S - Simples
                - V - Com Variacoes
                - F - Fabricado
                - M - Materia Prima
            situacao:
              description: |-

                - A - Ativo
                - I - Inativo
                - E - Excluido
              type: string
              enum:
                - A
                - I
                - E
              x-enumDescriptions:
                - A - Ativo
                - I - Inativo
                - E - Excluido
            dataCriacao:
              type: string
              nullable: true
            dataAlteracao:
              type: string
              nullable: true
            unidade:
              type: string
            gtin:
              type: string
            precos:
              $ref: '#/components/schemas/PrecoProdutoResponseModel'
            estoque:
              $ref: '#/components/schemas/EstoqueListagemResponseModel'
            tipoVariacao:
              description: |-

                - N - Normal
                - P - Pai
                - V - Variacao
              type: string
              enum:
                - 'N'
                - P
                - V
              nullable: true
              x-enumDescriptions:
                - N - Normal
                - P - Pai
                - V - Variacao
          type: object
    PaginatedResultModel:
      title: ' '
      description: ' '
      type: object
      allOf:
        - properties:
            limit:
              type: integer
            offset:
              type: integer
            total:
              type: integer
          type: object
    ErrorDTO:
      title: ' '
      description: ' '
      properties:
        mensagem:
          description: Mensagem de erro geral
          type: string
          example: Ocorreram erros de validação
        detalhes:
          description: Detalhes específicos do erro
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetailDTO'
          example:
            - campo: codigo
              mensagem: O campo código é obrigatório
          nullable: true
      type: object
    PrecoProdutoResponseModel:
      title: ' '
      description: ' '
      type: object
      allOf:
        - properties:
            preco:
              type: number
              format: float
              nullable: true
            precoPromocional:
              type: number
              format: float
              nullable: true
            precoCusto:
              type: number
              format: float
              nullable: true
            precoCustoMedio:
              type: number
              format: float
              nullable: true
          type: object
    EstoqueListagemResponseModel:
      title: ' '
      description: ' '
      type: object
      allOf:
        - properties:
            localizacao:
              type: string
              nullable: true
          type: object
    ErrorDetailDTO:
      title: ' '
      description: ' '
      properties:
        campo:
          description: Campo que gerou o erro
          type: string
          example: codigo
        mensagem:
          description: Mensagem de erro específica do campo
          type: string
          example: O campo código é obrigatório
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: Bearer

````