Consultar um pedido em aberto

Requisição

O que o seu sistema envia para a API nesta chamada.

Respostas

O que a API devolve. O número diz como a chamada terminou: os que começam com 2 deram certo, com 4 indicam um problema no que foi enviado e com 5 um erro do nosso lado.

• 200Deu certoOKPedido em aberto

  Pedido em aberto

  Corpo application/json

  • datagrupo de camposobject

    Pedido em aberto

    Campos de data

    • idnúmero inteirointeger <int64>

      Id do pedido

    • idEmpresanúmero inteirointeger <int64>

      Empresa do pedido

    • datadata e horastring <date-time>pode vir vazio

      Data indicada no pedido

    • dataFaturamentoIndicadadata e horastring <date-time>pode vir vazio

      Data prevista para o faturamento

    • dataUltimaAlteracaodata e horastring <date-time>

      Quando o pedido foi alterado pela última vez. Igual a dataCriacao se nunca foi alterado

    • dataCriacaodata e horastring <date-time>

      Quando o pedido foi criado. É o mesmo momento do campo data do aviso do webhook (o texto pode diferir nas últimas casas da fração de segundo)

    • usuarioCriacaotextostringpode vir vazio

      Usuário que criou o pedido

    • usuarioUltimaAlteracaotextostringpode vir vazio

      Usuário que alterou o pedido por último

    • idFinalidadenúmero inteirointeger <int64>pode vir vazio

      Finalidade do pedido

    • indicadorPresencialcódigo (veja os valores)integer <int32>

      Como a venda foi feita

      5 valores possíveis

      Valor	Nome	Significado
      1	Presencial	Presencial
      2	Internet	Internet
      3	Teleatendimento	Teleatendimento
      5	PresencialForaDoEstabelecimento	Presencial, fora do estabelecimento
      9	OutrosNaoPresencial	Outros, não presencial

    • valorDescontonúmero decimalnumber <double>pode vir vazio

      Desconto do pedido, em valor (não em %)

    • valorFretenúmero decimalnumber <double>

      Valor do frete

    • dataEntregadata e horastring <date-time>pode vir vazio

      Data prevista de entrega. Datas que representam um dia são a meia-noite do grupo em UTC (com gmt_offset -3, o dia 26/10 vem como 2026-10-26T03:00:00Z)

    • modalidadeFretecódigo (veja os valores)integer <int32>

      Quem paga o frete

      6 valores possíveis

      Valor	Nome	Significado
      0	CIF	Por conta do remetente (CIF)
      1	FOB	Por conta do destinatário (FOB)
      2	PorContaTerceiros	Por conta de terceiros
      3	TransporteProprioPorContaRemetente	Transporte próprio, por conta do remetente
      4	TransporteProprioPorContaDestinatario	Transporte próprio, por conta do destinatário
      9	SemFrete	Sem frete

    • valorSeguronúmero decimalnumber <double>

      Valor do seguro

    • valorOutrasDespesasnúmero decimalnumber <double>

      Outras despesas acessórias

    • valorTotalIpinúmero decimalnumber <double>pode vir vazio

      Total de IPI

    • valorTotalIcmsStnúmero decimalnumber <double>pode vir vazio

      Total de ICMS por substituição tributária

    • valorTotalBrutoProdutonúmero decimalnumber <double>pode vir vazio

      Soma do valorTotal dos itens

    • valorTotalLiquidoProdutonúmero decimalnumber <double>pode vir vazio

      valorTotalBrutoProduto − valorDesconto + valorFrete + valorSeguro + valorOutrasDespesas + valorTotalIcmsSt + valorTotalIpi

    • valorTotalDeduzidoServiconúmero decimalnumber <double>pode vir vazio

      Total deduzido dos serviços (impostos retidos)

    • valorTotalBrutoServiconúmero decimalnumber <double>pode vir vazio

      Soma do valorTotal dos serviços

    • valorTotalLiquidoServiconúmero decimalnumber <double>pode vir vazio

      valorTotalBrutoServico − valorTotalDeduzidoServico

    • valorTotalBrutonúmero decimalnumber <double>pode vir vazio

      valorTotalBrutoProduto + valorTotalBrutoServico. Não inclui desconto, frete, seguro, outras despesas nem impostos

    • valorTotalLiquidonúmero decimalnumber <double>pode vir vazio

      valorTotalLiquidoProduto + valorTotalLiquidoServico

    • observacaotextostringpode vir vazio

      Observação do pedido

    • observacaoInternatextostringpode vir vazio

      Observação de uso interno da empresa

    • codigoIBGEServicoPrestadonúmero inteirointeger <int32>pode vir vazio

      Código IBGE do município onde o serviço é prestado

    • valorCotacaonúmero decimalnumber <double>pode vir vazio

      Cotação do dólar usada no pedido

    • idTabelaPreconúmero inteirointeger <int64>pode vir vazio

      Tabela de preço usada

    • dadosParceirogrupo de camposobject

      Cliente do pedido

      Campos de dadosParceiro

      • idParceironúmero inteirointeger <int64>pode vir vazio

        Id do cliente

      • nomeParceirotextostringpode vir vazio

        Nome ou razão social do cliente

      • cpfCnpjParceirotextostringpode vir vazio

        CPF ou CNPJ do cliente, só números

      • idEnderecoEntreganúmero inteirointeger <int64>pode vir vazio

        Endereço de entrega escolhido

    • itenslistaarray[object]pode vir vazio

      Produtos do pedido

      Campos de cada item de itens

      • idProdutonúmero inteirointeger <int64>

        Id do produto no sistema

      • idVariacaonúmero inteirointeger <int64>pode vir vazio

        Id da variação, quando o produto tem variações

      • quantidadenúmero decimalnumber <double>

        Quantidade vendida

      • valorUnitarionúmero decimalnumber <double>

        Preço unitário

      • valorIcmsStnúmero decimalnumber <double>pode vir vazio

        ICMS por substituição tributária do item

      • valorIpinúmero decimalnumber <double>pode vir vazio

        IPI do item

      • valorTotalnúmero decimalnumber <double>

        Total do item (quantidade × valorUnitario), antes do desconto do pedido

      • idDepositonúmero inteirointeger <int64>pode vir vazio

        Depósito de onde sai o produto

      • idVendedornúmero inteirointeger <int64>pode vir vazio

        Vendedor do item

      • percentualComissaonúmero decimalnumber <double>pode vir vazio

        Comissão do vendedor, em %. null quando o item não tem vendedor

      • valorDolarnúmero decimalnumber <double>pode vir vazio

        Preço em dólar, quando o item é cotado em dólar

      • descricaoAdicionaltextostringpode vir vazio

        Complemento da descrição do produto

      • informacaoAdicionaltextostringpode vir vazio

        Informação adicional do item

      • codigoLoteEspecificadotextostringpode vir vazio

        Lote escolhido, quando o produto controla lote

      • quantidadeReservadanúmero decimalnumber <double>

        Quantidade já reservada no estoque para este item

    • servicoItenslistaarray[object]pode vir vazio

      Serviços do pedido

      Campos de cada item de servicoItens

      • idServiconúmero inteirointeger <int64>

        Id do serviço

      • valorUnitarionúmero decimalnumber <double>

        Preço unitário

      • quantidadenúmero inteirointeger <int32>

        Quantidade

      • complementotextostringpode vir vazio

        Complemento da descrição

      • valorDeduzidoISSQNnúmero decimalnumber <double>pode vir vazio

        ISSQN retido

      • valorDeduzidoINSSnúmero decimalnumber <double>pode vir vazio

        INSS retido

      • valorDeduzidoIRnúmero decimalnumber <double>pode vir vazio

        IR retido

      • valorDeduzidoCSLLnúmero decimalnumber <double>pode vir vazio

        CSLL retida

      • valorDeduzidoPISnúmero decimalnumber <double>pode vir vazio

        PIS retido

      • valorDeduzidoCOFINSnúmero decimalnumber <double>pode vir vazio

        COFINS retida

      • valorTotalDeduzidonúmero decimalnumber <double>pode vir vazio

        Soma dos impostos retidos

      • idVendedornúmero inteirointeger <int64>pode vir vazio

        Vendedor do serviço

      • percentualComissaonúmero decimalnumber <double>pode vir vazio

        Comissão do vendedor, em %

      • valorTotalnúmero decimalnumber <double>

        Total do serviço, antes das deduções

    • formasPagamentolistaarray[object]pode vir vazio

      Formas de pagamento do pedido

      Campos de cada item de formasPagamento

      • idFormaPagamentonúmero inteirointeger <int64>

        Id da forma de pagamento

      • descricaoFormaPagamentotextostringpode vir vazio

        Nome da forma de pagamento

      • valornúmero decimalnumber <double>

        Valor pago nessa forma

      • datadata e horastring <date-time>

        Data de vencimento desse valor

      • observacaotextostringpode vir vazio

        Observação

      • creditoClienteverdadeiro ou falsoboolean

        Se o valor usa crédito que o cliente tem na empresa

    • dadosEstoquegrupo de camposobject

      Baixa de estoque. Só vem quando a empresa usa o controle de estoque; nas outras vem null

      Campos de dadosEstoque

      • statusEstoquecódigo (veja os valores)integer <int32>

        Situação da baixa de estoque

        12 valores possíveis

        Valor	Nome	Significado
        0	NaoIniciado	Não iniciado
        1	ProcessandoBaixa	Processando a baixa
        2	AprovadoBaixa	Baixa aprovada
        3	ReprovadoBaixa	Baixa reprovada (motivo em motivo)
        4	AprovadoBaixaRollback	Desfazer da baixa aprovado
        5	ReprovadoBaixaRollBack	Desfazer da baixa reprovado
        10	ProcessandoBaixaEstorno	Processando o estorno da baixa
        11	AprovadoBaixaEstorno	Estorno da baixa aprovado
        12	ReprovadoBaixaEstorno	Estorno da baixa reprovado
        13	AprovadoBaixaEstornoRollback	Desfazer do estorno aprovado
        14	ReprovadoBaixaEstornoRollback	Desfazer do estorno reprovado
        99	NaoUtiliza	Empresa não usa o controle de estoque

      • statusEstoqueDescricaotextostringpode vir vazio

        Nome da situação correspondente ao código, como NaoIniciado ou AprovadoBaixa. É um identificador, não um texto para exibir ao usuário

      • motivotextostringpode vir vazio

        Motivo, quando a baixa é reprovada

    • origemcódigo (veja os valores)integer <int32>

      Por onde o pedido entrou

      3 valores possíveis

      Valor	Nome	Significado
      1	PedidoVenda	Pedido de venda
      2	ForcaVendaAplicativo	Força de vendas (aplicativo)
      3	Consignado	Consignado

    • statusReservacódigo (veja os valores)integer <int32>

      Situação da reserva dos itens

      3 valores possíveis

      Valor	Nome	Significado
      0	Nenhum	Nenhum
      1	Processando	Processando
      2	Reprovado	Reprovado (motivo em statusReservaMotivo)

    • statusReservaMotivotextostringpode vir vazio

      Motivo, quando a reserva é reprovada

    • possuiReservaComSaldoverdadeiro ou falsoboolean

      Se há itens com quantidade reservada

• 400Dados inválidosBad RequestDados inválidos ou regra de negócio não atendida. A mensagem em errors diz o motivo.

  Dados inválidos ou regra de negócio não atendida. A mensagem em errors diz o motivo.

  Corpo application/json

  • errorslistaarray[object]pode vir vazio

    Lista de erros, com a mensagem de cada um

    Campos de cada item de errors

    • errorMessagetextostringpode vir vazio

      Mensagem do erro, em português

    • fieldtextostringpode vir vazio

      Campo que causou o erro, quando houver

    • valuetextostringpode vir vazio

      Valor recebido no campo, quando houver

  • sessionGuidtextostringpode vir vazio

    Identificador da requisição. Informe ao suporte quando pedir ajuda

• 401Não autorizadoUnauthorizedToken ausente, inválido, expirado ou enviado com o prefixo Bearer.

  Token ausente, inválido, expirado ou enviado com o prefixo Bearer.

  Corpo application/json

  • errorslistaarray[object]pode vir vazio

    Lista de erros, com a mensagem de cada um

    Campos de cada item de errors

    • errorMessagetextostringpode vir vazio

      Mensagem do erro, em português

    • fieldtextostringpode vir vazio

      Campo que causou o erro, quando houver

    • valuetextostringpode vir vazio

      Valor recebido no campo, quando houver

  • sessionGuidtextostringpode vir vazio

    Identificador da requisição. Informe ao suporte quando pedir ajuda

• 429Muitas chamadasToo Many RequestsLimite de requisições do grupo atingido (até 100 de uma vez; repõe 5 a cada 3 segundos, cerca de 100 por minuto). Espere os segundos do header Retry-After; a mensagem também diz quanto esperar.

  Limite de requisições do grupo atingido (até 100 de uma vez; repõe 5 a cada 3 segundos, cerca de 100 por minuto). Espere os segundos do header Retry-After; a mensagem também diz quanto esperar.

  Headers da resposta

  • Retry-Afterinteger

    Segundos a esperar antes de tentar de novo

  Corpo application/json

  • errorslistaarray[object]pode vir vazio

    Lista de erros, com a mensagem de cada um

    Campos de cada item de errors

    • errorMessagetextostringpode vir vazio

      Mensagem do erro, em português

    • fieldtextostringpode vir vazio

      Campo que causou o erro, quando houver

    • valuetextostringpode vir vazio

      Valor recebido no campo, quando houver

  • sessionGuidtextostringpode vir vazio

    Identificador da requisição. Informe ao suporte quando pedir ajuda

• 500Erro no servidorInternal Server ErrorErro inesperado do nosso lado. Tente de novo; se persistir, fale com o suporte.

  Erro inesperado do nosso lado. Tente de novo; se persistir, fale com o suporte.

  Corpo application/json

  • errorslistaarray[object]pode vir vazio

    Lista de erros, com a mensagem de cada um

    Campos de cada item de errors

    • errorMessagetextostringpode vir vazio

      Mensagem do erro, em português

    • fieldtextostringpode vir vazio

      Campo que causou o erro, quando houver

    • valuetextostringpode vir vazio

      Valor recebido no campo, quando houver

  • sessionGuidtextostringpode vir vazio

    Identificador da requisição. Informe ao suporte quando pedir ajuda