apiDocumentaçãoOperaçõesapiDocumentaçãoOperaçõesAdicionarPedidoaltera dadosInclusão do Pedido de Venda
| Operação | produtos/pedidovenda:AdicionarPedido |
|---|---|
| Serviço | PedidoVenda |
| Módulo | Produtos |
| Endpoint | /api/v1/produtos/pedidovenda/ |
adicionar pedido de venda
| Campo | Tipo | Descrição |
|---|---|---|
codProj | integer | Código do Projeto. Preenchimento Opcional. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "ListarProjetos" da API http://app.omie.com.br/api/v1/geral/projetos/ para obter essa informação. |
codVend | integer | Código do Vendedor. Preenchimento Opcional. Informação localizada no cabeçalho do Pedido de Venda. Utilize a tag "codigo" do método "ListarVendedores" da API http://app.omie.com.br/api/v1/geral/vendedores/ para obter essa informação. |
codigo_categoria obrigatório | string | Código da categoria. Preenchimento Obrigatório. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "ListarCategorias" da API http://app.omie.com.br/api/v1/geral/categorias/ para obter essa informação. |
codigo_cenario_impostos | integer | Código do Cenário de Impostos. Se não informado, será assumido o cenário padrão. |
codigo_cliente | integer | Código do cliente. Preenchimento Obrigatório. Utilize a tag "codigo_cliente_omie" do método "ListarClientes" da API http://app.omie.com.br/api/v1/geral/clientes/ para obter essa informação. |
codigo_cliente_integracao | string | Código de Integração do Cliente Preenchimento Opcional. Esse campo deve ser informado apenas se você incluiu o cliente via API e informou um código de integração para o cliente. Do contrário, informe sempre a tag "codigo_cliente". |
codigo_conta_corrente obrigatório | integer | Código da Conta Corrente. Preenchimento Obrigatório. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. Utilize a tag "codigo" do método "PesquisarContaCorrente" da API http://app.omie.com.br/api/v1/geral/contacorrente/ para obter essa informação. |
codigo_parcela | string | Código da parcela/Condição de pagamento. Preenchimento Obrigatório. Utilize a tag "nCodigo" do método "ListarFormasPagVendas" da API http://app.omie.com.br/api/v1/produtos/formaspagvendas/ para obter essa informação. O código "999" é o único que permite uma definição de forma de pagamento customizada. Caso você escolha essa opção, deve também informar a tag "qtde_parcelas" e a estrutura "lista_parcelas". Alguns dos valores disponíveis são: "000" - A Vista "A03" - Para 3 dias "A05" - Para 5 dias "A07" - Para 7 dias "A08" - Para 8 dias "A09" - Para 9 dias "A10" - Para 10 dias "A13" - Para 13 dias "A14" - Para 14 dias "A15" - Para 15 dias "A17" - Para 17 dias "A20" - Para 20 dias "A21" - Para 21 dias "A25" - Para 25 dias "A26" - Para 26 dias "A28" - Para 28 dias "A35" - Para 35 dias "A36" - Para 36 dias "A40" - Para 40 dias "A42" - Para 42 dias "A45" - Para 45 dias "A50" - Para 50 dias "A56" - Para 56 dias "A60" - Para 60 dias "A70" - Para 70 dias "A75" - Para 75 dias "A90" - Para 90 dias "A98" - Para 98 dias "B20" - Para 120 dias "001" - 1 Parcela (para 30 dias) "002" - 2 Parcelas "003" - 3 Parcelas "004" - 4 Parcelas "005" - 5 Parcelas "006" - 6 Parcelas "007" - 7 Parcelas "010" - 10 Parcelas "012" - 12 Parcelas "024" - 24 Parcelas "036" - 36 Parcelas "048" - 48 Parcelas "S01" - 30/60 "S02" - 45/60 "S03" - 21/28/35 "S04" - 21/28/35/42 "S05" - 28/35/42 "S06" - 28/35/42/49 "S07" - 30/45/60/75/90 "S08" - 25/56 "S09" - 30/45 "S10" - 28/56 "S11" - 10/30/60 "S12" - 15/30/60 "S13" - 28/35 "S14" - 7/14/21 "S15" - 10/30/60/90 "S16" - 60/90/120 "S17" - 45/60/90 "S18" - 30/60/90 "S19" - 14/21 "S20" - 7/14 "S21" - 14/21/28 "S22" - 45/75 "S23" - 30/45/60 "S24" - 3/20/40 "S25" - 30/60/90/120 "S26" - 21/28 "S27" - a Vista/15 "S28" - a Vista/30 "S29" - a Vista/30/60 "S30" - a Vista/30/60/90 "S31" - a Vista/30/60/90/120/150 "S41" - 28/42/56 "S32" - 15/45/75 "S33" - 14/28/42 "S34" - 14/21/28/35/42 "S35" - 30/42/54/66/78/90 "S36" - 14/21/28/35 "S37" - 28/42 "S38" - 30/45/60 "S39" - 35/42/49/56 "S40" - 28/42/56/70 "S42" - 30/40/50/60 "S43" - 30/50/70/90 "S44" - 14/28 "S45" - 45/60/75/90 "S46" - a Vista/30/60/90/120 "S47" - a vista/20/40/60 "S48" - 21/42 "S49" - 15/30/45 "S50" - 14/42 "S51" - 21/35 "S52" - 28/56/84 "S53" - 28/42/56/70/84 "S54" - a Vista/30/45 "S55" - 21/45 "S56" - a Vista/28 "S57" - a Vista/60/90 "S58" - 35/45/55 "S59" - 28/35/42/56 "S60" - 30/45/60/75 "S61" - 28/35/42/49/56 "S62" - 40/70/100 "S63" - 42/56 "S64" - a Vista/28/35 "S65" - 35/42 "S66" - 20/40 "S67" - a Vista/28/35/42 |
codigo_pedido_integracao obrigatório | string | Código de integração do pedido de venda. Preenchimento Obrigatório na inclusão/alteração. Preenchimento Opcional na Consulta/Pesquisa. Preencha esse campo com o código do pedido no aplicativo que você está integração com o Omie. A função dele é servir como uma mapa de relacionamento entre as aplicações. Ao realizar uma consulta/listagem de pedidos você conseguirá ver a relação entre o id do pedido gerado no Omie e o código de pedido existente em sua aplicação. |
consumidor_final | string | Nota Fiscal para Consumo Final. Preenchimento Obrigatório. Informar "S" ou "N". Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
contato | string | Contato. Preenchimento Opcional. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
dados_adicionais_nf | string | Dados adicionais para a Nota Fiscal. Preenchimento Opcional. Utilize o caracter pipe ( | ) como separador de linha. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
data_previsao | string | Data de Previsão de Faturamento. Preenchimento Obrigatório. Utilize o formato "dd/mm/aaaa". Esse campo indica a data da previsão do faturamento do pedido e deve ser informado com uma data igual ou superior a data corrente. |
enviar_email | string | Enviar e-mail com o boleto de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Preenchimento Opcional. Informar "S" ou "N". Default "N" Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. É permitido somente o preenchimento de uma das tags "enviar_pix" ou "enviar_email |
enviar_pix | string | Enviar e-mail com o PIX de cobrança gerado pelo faturamento (juntamente com o DANFE e o XML da NF-e). Preenchimento Opcional. Informar "S" ou "N". Default "N" Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. É permitido somente o preenchimento de uma das tags "enviar_pix" ou "enviar_email |
etapa | string | Etapa do pedido de venda. Preenchimento Obrigatório. Esse campo indica em que coluna o pedido de venda irá figurar no processo de faturamento do Omie. Utilize a tag "codigo" do método "ListarEtapasFaturamento" da API http://app.omie.com.br/api/v1/produtos/etapafat/ para obter essa informação. Os valores são fixos, mas as descrições (funções atribuídas a cada coluna pode mudar. A API irá indicar a descrição de cada coluna. Os valores disponíveis para esse campo podem ser: "10" - Primeira coluna "20" - Segunda coluna "30" - Terceira coluna "40" - Quarta coluna "50" - Faturar |
itens | lista de object | Array de Itens do pedido de Venda |
numero_contrato | string | Número do Contrato de Venda. Preenchimento Opcional. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
numero_pedido_cliente | string | Número do pedido do cliente. Preenchimento Opcional. Informação localizada na Aba "Informações Adicionais" do Pedido de Venda. |
origem_pedido | string | Origem do Pedido. Default: API - Importado via API. MLV - Mercado Livre |
utilizar_emails | string | Utilizar os seguintes endereços de e-mail. Preenchimento Obrigatório. Informar a lista de e-mail que receberão a Nota Fiscal. Utilize a virgula (,) como separador. Informação localizada na Aba "E-mail para o Cliente" do Pedido de Venda. |
{
"codigo_pedido_integracao": "123456",
"codigo_cliente": 45621546,
"codigo_cenario_impostos": 65468465,
"itens": [
{
"codigo_produto": 0,
"quantidade": 1,
"valor_unitario": 1,
"cfop": "",
"codigo_cenario_impostos_item": 0
}
]
}