---
title: "Consulta em lote - Solicitar."
url: "https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050/paths/api-v1-CatalogoProduto-ConsultaEmLote-Solicitar/post"
---

> Full API specification: https://devcenter.stone.com.br/apis/stone-tax/versions/206fd1c1-6382-4ada-8612-c67fdc65e050.md

# Consulta em lote - Solicitar.

`POST` `/api/v1/CatalogoProduto/ConsultaEmLote/Solicitar`

Solicita o processamento assíncrono da consulta de tributação de uma lista de produtos em lote. 🔄 **PROCESSAMENTO**: A consulta é processada de forma assíncrona. Utilize o identificador retornado para acompanhar o andamento através do endpoint de consulta. 📋 **FILTROS**: Cada item da lista pode ser identificado por **EAN**, **descrição similar** ou **hash**. Todos os filtros são processados individualmente e o resultado de cada um fica disponível na consulta do lote. 🔔 **CALLBACK**: Informe uma URL de callback para receber uma notificação automática assim que o processamento for concluído. O payload enviado seguirá o mesmo contrato do endpoint de consulta. ⚠️ **ATENÇÃO**: Só é permitida uma consulta em lote em andamento por emissor. Aguarde a conclusão antes de solicitar uma nova.

## Header parameters

- `DocumentoEmissor` (string, required) - Documento do emissor.

## Request body

Content types: `application/json-patch+json`, `application/json`, `text/json`, `application/*+json`

## Responses

- `200` - OK
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `500` - Internal Server Error

## OpenAPI definition

```yaml
openapi: 3.0.4
info:
  title: Stone Tax API
  version: 1.0.0
servers:
  - url: https://stone-tax-sdx.stone.com.br
    description: Ambiente de Desenvolvimento
  - url: https://stone-tax.stone.com.br
    description: Ambiente de Produção
paths:
  /api/v1/CatalogoProduto/ConsultaEmLote/Solicitar:
    post:
      tags:
        - CatalogoProduto
      summary: Consulta em lote - Solicitar.
      description: >-
        Solicita o processamento assíncrono da consulta de tributação de uma
        lista de produtos em lote.
                    
        🔄 **PROCESSAMENTO**: A consulta é processada de forma assíncrona.
        Utilize o identificador retornado para acompanhar o andamento através do
        endpoint de consulta.
                    
        📋 **FILTROS**: Cada item da lista pode ser identificado por **EAN**,
        **descrição similar** ou **hash**. Todos os filtros são processados
        individualmente e o resultado de cada um fica disponível na consulta do
        lote.
                    
        🔔 **CALLBACK**: Informe uma URL de callback para receber uma
        notificação automática assim que o processamento for concluído. O
        payload enviado seguirá o mesmo contrato do endpoint de consulta.
                    
        ⚠️ **ATENÇÃO**: Só é permitida uma consulta em lote em andamento por
        emissor. Aguarde a conclusão antes de solicitar uma nova.
      parameters:
        - name: DocumentoEmissor
          in: header
          description: Documento do emissor.
          required: true
          schema:
            type: string
      requestBody:
        description: Dados da solicitação de consulta em lote.
        content:
          application/json-patch+json:
            schema:
              $ref: "#/components/schemas/SolicitarConsultaEmLoteInputModel"
          application/json:
            schema:
              $ref: "#/components/schemas/SolicitarConsultaEmLoteInputModel"
          text/json:
            schema:
              $ref: "#/components/schemas/SolicitarConsultaEmLoteInputModel"
          application/*+json:
            schema:
              $ref: "#/components/schemas/SolicitarConsultaEmLoteInputModel"
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                type: string
                format: uuid
            application/json:
              schema:
                type: string
                format: uuid
            text/json:
              schema:
                type: string
                format: uuid
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
        "500":
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ResponseErrorResult"
      security:
        - BearerAuth: []
security:
  - BearerAuth: []
components:
  schemas:
    SolicitarConsultaEmLoteInputModel:
      required:
        - filtros
      type: object
      properties:
        filtros:
          minItems: 1
          type: array
          items:
            $ref: "#/components/schemas/ConsultaLoteFiltroInputModel"
          description: Lista de filtros dos produtos a serem consultados.
        perfilTributario:
          $ref: "#/components/schemas/ConsultaLotePerfilTributarioInputModel"
        urlCallback:
          type: string
          description: URL de callback para notificação após a conclusão do processamento.
          nullable: true
      additionalProperties: false
      description: Dados para solicitação de consulta de tributação de produtos em
        lote de forma assíncrona.
    ResponseErrorResult:
      type: object
      properties:
        status:
          type: integer
          format: int32
        titulo:
          type: string
          nullable: true
        erros:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          nullable: true
      additionalProperties: false
    ConsultaLoteFiltroInputModel:
      required:
        - filtro
      type: object
      properties:
        tipoFiltro:
          $ref: "#/components/schemas/TipoFiltroConsultaProdutoModelEnum"
        filtro:
          maxLength: 255
          minLength: 1
          type: string
          description: Dado de filtragem para consulta do produto (EAN ou descrição
            similar).
      additionalProperties: false
      description: Filtro individual para consulta de tributação de produto em lote.
    ConsultaLotePerfilTributarioInputModel:
      type: object
      properties:
        codigoMunicipioDestino:
          type: string
          description: Código do município do destino. (Necessário somente se o
            destinatário for de outro município)
          nullable: true
        finalidade:
          $ref: "#/components/schemas/FinalidadeConsultaTributacaoModelEnum"
        situacaoEspecialDestinatario:
          $ref: "#/components/schemas/SituacaoEspecialDestinatarioConsultaTributacaoModel\
            Enum"
        origemProduto:
          $ref: "#/components/schemas/OrigemProdutoConsultaTributacaoModelEnum"
        produtoFabricacaoPropria:
          type: boolean
          description: "Indica se o produto consultado é de fabricação própria. (Default:
            false)"
          nullable: true
        destinatarioSimplesNacional:
          type: boolean
          description: "Indica se o destinatário é optante pelo Simples Nacional.
            (Default: false)"
          nullable: true
        destinatarioSubstitutoTributario:
          type: boolean
          description: "Indica se o destinatário é substituto tributário. (Default: false)"
          nullable: true
        mercadoriaProduzidaZFM:
          type: boolean
          description: "Indica se a mercadoria é produzida na Zona Franca de Manaus.
            (Default: false)"
          nullable: true
      additionalProperties: false
      description: >-
        Perfil tributário opcional para a consulta de tributação em lote.

        Se não informado, serão utilizados os valores padrão (venda para
        consumidor final presencial).
    TipoFiltroConsultaProdutoModelEnum:
      enum:
        - Ean
        - DescricaoSimilar
        - Hash
      type: string
      description: Tipo de filtro do catálogo de produto.
    FinalidadeConsultaTributacaoModelEnum:
      enum:
        - VendaConsumidorFinalNaoContribuinte
        - VendaConsumidorFinalContribuinte
        - VendaParaRevenda
        - Bonificacao
        - Transferencia
      type: string
      description: Finalidade da operação fiscal.
    SituacaoEspecialDestinatarioConsultaTributacaoModelEnum:
      enum:
        - Industrial
        - Distribuidor
        - Atacadista
        - ProdutorRural
        - ArmazemGeral
        - OrgaoPublico
      type: string
      description: Situação especial do destinatário da operação fiscal.
    OrigemProdutoConsultaTributacaoModelEnum:
      enum:
        - Nacional
        - EstrangeiraImportacaoDireta
        - EstrangeiraAdquiridaMercadoInterno
        - NacionalConteudoImportacaoSuperior40A70
        - NacionalPPB
        - NacionalConteudoImportacaoInferior40
        - EstrangeiraImportacaoDiretaSemSimilar
        - EstrangeiraAdquiridaMercadoInternoSemSimilar
        - NacionalConteudoImportacaoSuperior70
      type: string
      description: Origem do produto para consulta.
  securitySchemes:
    BearerAuth:
      type: http
      description: Autenticação via token JWT. Obtenha o token através do endpoint
        /Autenticacao/ObterToken usando Basic Auth. O token expira em 1 hora.
      scheme: bearer
      bearerFormat: JWT
```
