Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Bloco de código
languagejs
{
  "seqCanalVenda":1,
  "idPedidoCanalVenda": "123",
  "dtaHorPedidoCanalVenda": "2022-10-13T13:34:15",
  "nroEmpresa": 1
}


PARÂMETROS DO CORPO

Nome

seqCanalVenda Inteiro Obrigatório

Sequencial do Canal de Venda

idPedidoCanalVenda Texto Obrigatório

Identificação do Pedido de Venda

O IdPedidoCanalVenda possui um tamanho máximo de 60 caracteres

dtaHorPedidoCanalVenda DataHora

Data/Hora do Pedido de Venda
Formado esperado: "YYYY-MM-DDTHH:MM:SS"

nroEmpresa Inteiro Obrigatório

Número da Empresa

O valor máximo permitido para Empresa é de 999999

nroSegmento Inteiro

Número do Segmento

codGeralOper Inteiro

Código Geral da Operação

O tamanho máximo permitido para o Código Geral Operação é de  999

nroRepresentante Inteiro

Número do Representante

O tamanho máximo permitido para o Representante é de 99999

nroTabVenda Texto

Número da Tabela de Venda

O Número da Tabela de Venda possui um tamanho máximo de 3 caracteres

seqTransportador Inteiro

Sequencial do Transportador

tipoEntrega Texto

Tipo de Entrega

O valor da propriedade TipoEntrega aceita apenas os valores: 'E' (Entrega) e 'R' (Retira)

obsPedido Texto

Observação do Pedido

A ObsPedido possui um tamanho máximo de 240 caracteres

obsNotaFiscal Texto

Observação da Nota Fiscal

A ObsNotaFiscal possui um tamanho máximo de 500 caracteres

vlrTotFrete Numérico

Valor total do Frete

tipoRateioFretePedido Texto

Tipo de Rateio do Frete do Pedido

O valor da propriedade TipoRateioFretePedido aceita apenas os valores: 'V' (Valor), 'P' (Peso Bruto), 'O' (Volume), e 'T' (Conforme cálculo do frete do transportador no pedido de venda)

tipoFreteDocAuxiliar Texto

Tipo de Frete/Documento Auxiliar

O valor da propriedade TipoFreteDocAuxiliar aceita apenas os valores: 0 (Contratação do Frete por conta do Remetente (CIF)), 1 (Contratação do Frete por conta do Destinatário (FOB)), 2 (Contratação do Frete por conta de Terceiros), 3 (Transporte Próprio por conta do Remetente), 4 (Transporte Próprio por conta do Destinatário), e 9 (Sem Ocorrência de Transporte)

indIntermediador Texto

Identificador do Intermediador

O valor da propriedade IndIntermediador aceita apenas os valores: 'S' (Sim) e 'N' (Não)

Object clienteDto

Dados do cliente do pedido de venda

Expandir
titleClique para expandir

Object clienteDto Obrigatório

Dados do cliente do pedido de venda

Nome

cpfCnpj Texto Obrigatório

CPF/CNPJ do Cliente

O valor da propriedade CpfCnpj possui o tamanho máximo de 14 caracteres

inscEstadualRg texto Obrigatório

Inscrição Estadual

O valor da propriedade InscEstadualRg possui o tamanho máximo de 60 caracteres

nomeRazaoSocial Texto Obrigatório

Razão Social

O valor da propriedade NomeRazaoSocial possui o tamanho máximo de 100 caracteres

nomeFantasia Texto

Nome Fantasia

O valor da propriedade NomeFantasia possui o tamanho máximo de 30 caracteres

sexo Texto

Gênero

O valor da propriedade Sexo aceita apenas os valores: 'M' (Masculino), 'F' (Feminino), e 'O' (Outros)

cidade Texto

Nome da Cidade

O valor da propriedade Cidade possui o tamanho máximo de 30 caracteres

uf Texto

Estado

O valor da propriedade Uf possui o tamanho máximo de 2 caracteres

pais Texto

País

O valor da propriedade Pais possui o tamanho máximo de 25 caracteres

bairro Texto

Bairro

O valor da propriedade Bairro possui o tamanho máximo de 30 caracteres

logradouro Texto

Logradouro

O valor da propriedade Logradouro possui o tamanho máximo de 35 caracteres

nroLogradouro Texto

Número do Logradouro

O valor da propriedade NroLogradouro possui o tamanho máximo de 10 caracteres

complementoLogradouro Texto

Complemento do Logradouro

O valor da propriedade ComplementoLogradouro possui o tamanho máximo de 60 caracteres

cep Texto

Código Postal (CEP)

O valor da propriedade Cep possui o tamanho máximo de 12 caracteres

foneDdd1 Texto

Número do DDD

O valor da propriedade FoneDdd1 possui o tamanho máximo de 5 caracteres

foneNro1 Texto

Número do Telefone

O valor da propriedade FoneNro1 possui o tamanho máximo de 12 caracteres

dtaNascFund DataHora

Data de Nascimento/Fundação

email Texto

E-mail

O valor da propriedade Email possui o tamanho máximo de 50 caracteres

emailNfe Texto

E-mail para entrega de Nota Fiscal

O valor da propriedade EmailNfe possui o tamanho máximo de 50 caracteres

estadoCivil Texto

Estado Civil

O valor da propriedade EstadoCivil aceita apenas os valores: 'S' (Solteiro), 'C' (Casado), 'V' (Viúvo), 'Q' (Desquitado), 'D' (Divorciado), 'A' (Amasiado), 'P' (Separado), e 'O' (Outros)

inscMunicipal Texto

Inscrição Municipal

O valor da propriedade InscMunicipal possui o tamanho máximo de 15 caracteres

inscProdutor Texto

Inscrição de Produtor

O valor da propriedade InscProdutor possui o tamanho máximo de 15 caracteres

indContribIcms Texto

Identificador de Contribuição de ICMS

O valor da propriedade IndContribIcms aceita apenas os valores: 'S' (Sim) e 'N' (Não)

fisicaJuridica Texto

Pessoa Física/Jurídica

O valor da propriedade FisicaJuridica aceita apenas os valores: 'F' (Pessoa Física) e 'J' (Pessoa Jurídica)

Array de objeto itemDto

Coleção de dados dos itens do pedido de venda

Expandir
titleClique para expandir...

Array de objeto itemDto Obrigatório

Coleção de dados dos itens do pedido de venda

Nomes
codAcesso Texto

qtdPedida Numérico

Quantidade Pedida

qtdEmbalagem Numérico

Quantidade da Embalagem

vlrEmbTabPreco Numérico

Valor da Embalagem na Tabela de Preço

vlrEmbInformado Numérico

Valor da Embalagem Informado

vlrEmbTabPromoc Numérico

Valor da Embalagem na Tabela Promocional

vlrEmbDesconto Numérico

Valor de desconto da Embalagem

observacaoItem Inteiro

Observação do item

qtdVolume Numérico

Quantidade de Volume do Item

indSimilarEcommerce Inteiro

Identificação de Pedido Similar ao E-commerce

indKit Inteiro

Identificador de Kit

vlrTotComissao Numérico

Valor Total da Comissão

fatorMultiplicador Numérico

Fator multiplicador

seqItemCanalVenda Inteiro

Sequencial do Item no Canal de Venda

Array de objeto pagamentoDto

Coleção de dados dos pagamentos do pedido de venda

Expandir
titleClique para expandir...

Array de objeto pagamentoDto

Coleção de dados dos pagamentos do pedido de venda

Nomes

nroFormaPagto Inteiro

Número Forma de Pagamento

nroCondPagto Inteiro

Número Condição de Pagamento

valorPagto Numérico

Valor do Pagamento

nroGiftCard Numérico

Número do Gift Card

nroParcela Numérico

Número de Parcelas

cpfCnpjCartao Texto

CPF/CNPJ do Proprietário do Cartão

cnpjInstituicaoPagto Texto

CNPJ da Instituição de Pagamento

idCarteira Texto

Identificação da Carteira

tipoCarteira Texto

Tipo de carteira

idPagtoCanalVenda Texto

Identificação do Pagamento do canal de venda

Array de objeto nsuDto

Coleção de dados complementares de cartões do pedido de venda

Expandir
titleClique para expandir...

Array de objeto nsuDto

Coleção de dados complementares de cartões do pedido de venda

Nomes

nsu Texto Obrigatório

NSU é a sigla para Número Sequencial Único. É um número único gerado para identificar uma transação ou uma nota fiscal.

nroCartao Texto Obrigatório

Número do cartão utilizado no pagamento

codRede Texto

Código da rede utilizada no pagamento

codBandeira Texto

Código da bandeira utilizada no pagamento

codBin Texto

Código BIN é o Número de Identificação Bancária (na sigla em inglês) e corresponde aos 6 primeiros dígitos de um cartão de crédito. 

nroAutorizacao Texto

Um código que é gerado a partir de cinco ou seis números por um banco emissor, o código usado para validar um cartão de crédito e aprová-lo quando uma compra ou venda é feita


CABEÇALHOS


RESPOSTA


Dica

200

ok

...