listar pedidos
usado para listar pedidos presentes. Os parâmetros obrigatórios são
- Offset
- limit
- status_id
- token
query Parameters
limitinteger · style: form · explode: truepor exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1offsetinteger · style: form · explode: truepor exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1cliente_idinteger · style: form · explode: truemostra o id do cliente
um número usado para a identificação do cliente
Example: 1vendedor_idinteger · style: form · explode: truemostra id do vendedor
um número usado para a identificação de um vendedor
Example: 1situacaostring · style: form · explode: truemostra situação do pedido
- AI: Aprovado Integral
- AP: Aprovado Parcial
- EA: Em andamento
- RE: Reprovado
- FI: Faturado Integral
- FP: Faturado parcial
- BM: Baixa manual
- CA: Cancelado
Example: AIperiodo_lancamento_iniciostring · style: form · explode: truemostra periodo de inicio do lançamento
o formato é de ano, mês, dia
Example: 2025-03-21periodo_lancamento_finalstring · style: form · explode: truemostra periodo final do lançamento
o formato é de ano, mês, dia
Example: 2025-03-21periodo_faturamento_iniciostring · style: form · explode: truemostra perido inicial do faturamento
o formato é de ano, mês, dia
Example: 2025-03-21periodo_faturamento_finalstring · style: form · explode: truemostra periodo final do faturamento
o formato é de ano, mês, dia
Example: 2025-03-21idinteger · style: form · explode: truemostra o id
Um número usado para identificação
Example: 1tokenstring · style: form · explode: trueO seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX
Responses
A solicitação foi bem-sucedida
dataobject · required
criar pedidos
usado para criar novos pedidos. Os parâmetros obrigatórios são
- token
Também é obrigatório enviar o json no body da requisição se tiver em dúvida sobre o que algo no json indica olhe na discrição do parâmetro correspondente
query Parameters
tokenstring · style: form · explode: trueO seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXidentificacao_internastring · style: form · explode: trueum código usado para identificação interna.
Example: 701861XXXXZcodigo_externointeger · style: form · explode: truecódigo usado para identificação externa
Example: 0situacaostring · style: form · explode: truemostra situação do pedido
- AI: Aprovado Integral
- AP: Aprovado Parcial
- EA: Em andamento
- RE: Reprovado
- FI: Faturado Integral
- FP: Faturado parcial
- BM: Baixa manual
- CA: Cancelado
Example: AIcanceladoboolean · style: form · explode: truemostra se o pedido foi cancelado ou não
contatostring · style: form · explode: trueusado para mostrar o contato atribuído ao pedido
fretestring · style: form · explode: truemostra se o pedido irá precisar de frete ou não
tabelastring · style: form · explode: true.
destacarboolean · style: form · explode: truemostra se está destacado ou não
para true a resposta será S e para false N
Example: truesituacao_separacaostring · style: form · explode: true.
tipo_pedido_idinteger · style: form · explode: truemostra o id do pedido.
Example: 0filial_idinteger · style: form · explode: trueid usado para mostrar qual filial o pedido está atribuído
Example: 1vendedor_idinteger · style: form · explode: truemostra id do vendedor
um número usado para a identificação de um vendedor
Example: 1transportadora_idinteger · style: form · explode: truemostra o id da transportadora atribuída.
Example: 1forma_pagamento_idinteger · style: form · explode: truemostra o id da forma de pagamento selecionada
Example: 1setor_idinteger · style: form · explode: truemostra o id do setor atribuído
Example: 0valor_total_servicointeger · style: form · explode: truemostra o valor total atribuído ao serviço
Example: 0valor_descontos_servicointeger · style: form · explode: truevalor dos descontos atribuidos ao serviço
Example: 1valor_total_produtointeger · style: form · explode: truevalor total atribuído ao produto
Example: 0valor_descontos_produtointeger · style: form · explode: truevalor dos descontos atribuídos a um produto
Example: 0valor_freteinteger · style: form · explode: truevalor do frete atribuído
Example: 0valor_outra_despesasinteger · style: form · explode: truevalor atribuído a outras despesas
Example: 0valor_total_geralinteger · style: form · explode: truemostra o valor total do pedido atribuído
Example: 1peso_brutointeger · style: form · explode: truemostra o peso bruto do pedido atribuído
Example: 1peso_liquidointeger · style: form · explode: truemostra o peso líquido do produto atribuído
Example: 1quantidade_volumesinteger · style: form · explode: truequantidade de volumes atribuídos
Example: 1valor_total_pisinteger · style: form · explode: truemostra o valor total do imposto atribuído
Example: 1valor_total_cofinsinteger · style: form · explode: truemostra o valor total do imposto atribuído
Example: 1valor_total_fcpinteger · style: form · explode: truemostra o valor total do FCP atribuído
Example: 1valor_total_icms_recolhidointeger · style: form · explode: truemostra o valor total do imposto atribuído
Example: 1valor_base_icms_subinteger · style: form · explode: truemostra o valor do imposto atribuído
Example: 1valor_total_icms_subinteger · style: form · explode: truemostra o valor total do imposto atribuído
Example: 1valor_base_fcpinteger · style: form · explode: truemostra o valor base do fcp atribuído
Example: 1tributosboolean · style: form · explode: truemostra se os tributos se aplicam ou não
logradourostring · style: form · explode: trueRua atribuída ao endereço da request
(00) 00000-0000
Example: Rua carneiro Leãocepstring · style: form · explode: truecep do endereço atribuído a request
Example: 00000-000numerointeger · style: form · explode: truenúmero atribuído ao endereço da request
Example: 1bairrostring · style: form · explode: truebairro atribuído ao endereço da request
Example: zona 07cidadestring · style: form · explode: truecidade atribuída ao endereço da request
Example: maringaestadostring · style: form · explode: trueestado do endereço atribuído a request
Example: PRcomplementostring · style: form · explode: truecomplemento do endereço atribuído a request
Example: ap 502codigo_ibge_cidadeinteger · style: form · explode: truecódigo do ibge associado ao endereço da request
Example: 0codigo_ibge_paisnumber · style: form · explode: truecódigo ibge do país do endereço atribuído
Example: 240nomestring · style: form · explode: truenome completo atribuido a request sendo enviada
apelidostring · style: form · explode: trueapelido atribuído ao nome
cpf_cnpjstring · style: form · explode: truemostra cpf ou o cnpj
o documento pode ser tanto o cpf ou cnpj
Example: 377.775.400-50rgstring · style: form · explode: truerg atrbuído a request
existe a opção de ser isento
Example: 0000000-0sexostring · style: form · explode: truesexo atribuído a pessoa associada a request
Example: Fdata_nascimentostring · style: form · explode: truedata de nascimento da pessoa atribuída a request
a sequência é ano,mês,dia
Example: 1990-12-30estado_civilstring · style: form · explode: trueestado civil da pessoa atribuída a request
Example: casado(a)nome_paistring · style: form · explode: truenome do pai da pessoa atribuída a request
nome_maestring · style: form · explode: truenome da mãe da pessoa atribuída a request
suframastring · style: form · explode: truecódigo para zona franca de Manaus
Example: 000000000telefone_comercialstring · style: form · explode: truetelefone comercial atribuído a request
Example: 00 00000-0000telefone_residencialstring · style: form · explode: truetelefone residencial atribuído a request
a formatação é hora - minuto - segundo
Example: 00 00000-0000telefone_celularstring · style: form · explode: truetelefone celular atribuído a request
Example: 00 00000-0000emailstring · style: form · explode: trueemail atribuído a request
Example: exemplo@gmail.comemail_fiscalstring · style: form · explode: trueemail fiscal atribuído a request
Example: exemplo@gmail.comrede_grupo_idinteger · style: form · explode: trueExample: 1observacoesstring · style: form · explode: trueobservações que serão atribuídas a request
Example: exemplo@gmail.comdata_cadastrostring · style: form · explode: truemostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20hora_cadastrostring · style: form · explode: trueMostra a hora em que o cadastro foi feito
a formatação é hora - minuto - segundo
Example: 08:30:00data_pedidostring · style: form · explode: truemostra a data em que o pedido foi feito
a formatação é ano - mês - dia
Example: 2026-04-02hora_pedidostring · style: form · explode: truemostra a hora em que o pedido foi feito
a formatação é hora - minuto - segundo
Example: 08:30:00data_aprovacaostring · style: form · explode: truemostra a data em que foi aprovado
a formatação é ano - mês - dia
Example: 2025-01-29hora_aprovacaostring · style: form · explode: truemostra a hora em que foi aprovado
a formatação é hora - minuto - segundo
Example: 08:30:00data_previsao_entregastring · style: form · explode: truemostra a data de previsão da entrega
a formatação é ano - mês - dia
Example: 2025-01-29data_prazo_faturamentostring · style: form · explode: truemostra a data do prazo do faturamento
a formatação é ano - mês - dia
Example: 2025-01-29data_ultima_atualizacaostring · style: form · explode: truemostra a data em que a ultima atualização foi feita
a formatação é ano - mês - dia hora - minuto - segundo
Example: 2025-10-04 10:35:10data_ultima_atualizacao_integracaostring · style: form · explode: truemostra a ultima data de uma atualização da integração
a formatação é ano - mês - dia hora - minuto - segundo
Example: 2025-12-29 17:29:15observacoes2string · style: form · explode: truemostra observações
sequenciainteger · style: form · explode: trueExample: 1produto_idinteger · style: form · explode: truemostra o id do produto
um número usado para a identificaçãod de um produto
Example: 1referencia_produto_idinteger · style: form · explode: truemostra o id da referencia do produto
Example: 1quantidadeinteger · style: form · explode: truemostra a quantidade
Example: 1descontointeger · style: form · explode: truemostra o desconto aplicado
Example: 0valor_unitariointeger · style: form · explode: truemostra o valor unitario
Example: 1valor_total_liquidointeger · style: form · explode: truemostra o valor total liquido
Example: 1quantidade_separadainteger · style: form · explode: truemostra a quantidade separada
Example: 1pesointeger · style: form · explode: truemostra o peso
Example: 1tabela_idinteger · style: form · explode: truemostra o id da tabela
Example: 1unidadestring · style: form · explode: truevalor_preco_tabelainteger · style: form · explode: truemostra o preço que consta na tabela
Example: 1valor_unitario_origeminteger · style: form · explode: truemostra o valor uniário que consta na origem
Example: 1valor_custo_mediointeger · style: form · explode: truemostra o valor do custo médio
Example: 1valor_ultimo_custointeger · style: form · explode: truemostra o valor do ultimo custo
Example: 1fator_valorinteger · style: form · explode: trueExample: 1fator_quantidadeinteger · style: form · explode: trueExample: 1valor_total_minimointeger · style: form · explode: truemostra o valor total minimo
Example: 1tabela_preco_idinteger · style: form · explode: truemostra o id da tabela de preços em que está presente
um número usado para identificação de uma tabela de preços
Example: 1valor_icmsinteger · style: form · explode: truemostra o valor do ICMS atribuído
Example: 1valor_base_icmsinteger · style: form · explode: truemostra o valor base do ICMS atribuído
Example: 1aliquota_difalinteger · style: form · explode: trueExample: 1aliquota_valor_ipiinteger · style: form · explode: trueExample: 1aliquota_substituicaointeger · style: form · explode: trueExample: 1aliquota_icms_subtracaointeger · style: form · explode: trueExample: 1aliquota_cofinsinteger · style: form · explode: truealiquota_pisinteger · style: form · explode: truealiquota_fcpinteger · style: form · explode: trueregra_icmsinteger · style: form · explode: trueregra_ipiinteger · style: form · explode: trueregra_cofinsinteger · style: form · explode: trueregra_fcpinteger · style: form · explode: truealiquota_icmsinteger · style: form · explode: trueincidencia_icmsinteger · style: form · explode: trueincidencia_icmsstinteger · style: form · explode: trueincidencia_pisinteger · style: form · explode: trueincidencia_cofinsinteger · style: form · explode: trueincidencia_icms_subtracaointeger · style: form · explode: truemargem_icmsstinteger · style: form · explode: truepauta_icmsstinteger · style: form · explode: trueparcelainteger · style: form · explode: truevalorinteger · style: form · explode: truevencimentointeger · style: form · explode: truetipo_recebimento_idinteger · style: form · explode: true
Responses
A requisição foi bem sucedida e um novo recurso foi criado como resultado
dataobject · required