Pedidos - Enviar um Pedido
Version 13.1 by WBS Tecnologia on 2021/05/20 17:35
Inserir um Pedido na Plataforma
Neste Método vamos descrever como Inserir um Pedido na Plataforma.
Detalhes da Rota
- Parâmetros:
- Requer Autenticação: Sim
- Método: POST
- Tipo de Retorno: Void | Pedido
- Headers:
- API_TOKEN: Token de Autenticação
- Corpo/Payload
- JSON do Pedido
Códigos de Status
- 404 = Sem resultados
- 500 = Erro Interno do Servidor
- 200 = OK
- 403 = Acesso Negado, Token de Autenticação Inválido?
Detalhes da Ação
Insere um Pedido na Plataforma
Headers
Abaixo segue os headers que devem ou podem ser passados para a ação:
Header | Descrição / Validação | Valor Padrão |
---|---|---|
API_TOKEN | [Obrigatório] Token da Autenticação |
Corpo
Este é o Payload do corpo, este JSON representa o pedido a ser inserido na plataforma:
Exemplo do Payload
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
"Cabecalho": {
"Codigo": 13555,
"CriadoEm": "2020-12-19T13:25",
"ValorDoFrete": 5.00,
"TipoDeFrete": 1,
"ValorTotal": 215.00,
"Situacao": 0,
"TipoDeConsumidor": 1,
"TipoDeImportacao": 0,
"Classificacao": "testes",
"Observacoes": "Teste de Observação",
"ValorDeDesconto": 0,
"TipoDeEnvio": 100
},
"Itens": [
{
"Quantidade": 10,
"ValorUnitario": 21.00,
"Desconto": 0,
"CodigoDeBarras": "9788522480432"
}
],
"Faturas": [
{
"NumeroDeParcelas": 1,
"Valor": 215.00,
"AprovadoEm": "2020-12-19T13:35",
"NSU": "TESTE",
"Autorizacao": "0983aisadafs90",
"Resumo": "Teste de Fatura",
"NumeroDoCartao": "XXXXXXXXXXXX5423",
"FormaDePagamentoId": 17
}
],
"EnderecoDeCobranca": {
"Nome": "Marcelo Junior",
"Apelido": "Marcelo Junior",
"Email": "teste@wbstecn.com.br",
"CnpjCpf": "12345678900",
"RgIE": "123456780",
"Tipo": 1,
"Bairro" : "Jd. Nova IP",
"CEP" : "13000056",
"Cidade" : "Minha Cidade",
"Complemento" : "",
"Destinatario" : "Marcelo Junior",
"LinhaDeEndereco" : "Rua dos Opalas",
"Pais" :"Brasil",
"TelefoneFixo" : "19998885664",
"UF" : "SP"
},
"EnderecoDeEntrega": {
"Nome": "Marcelo Junior",
"Apelido": "Marcelo Junior",
"Email": "teste@wbstecn.com.br",
"CnpjCpf": "12345678900",
"RgIE": "123456780",
"Tipo": 1,
"Bairro" : "Jd. Nova IP",
"CEP" : "13000056",
"Cidade" : "Minha Cidade",
"Complemento" : "",
"Destinatario" : "Marcelo Junior",
"LinhaDeEndereco" : "Rua dos Opalas",
"Pais" :"Brasil",
"TelefoneFixo" : "19998885664",
"UF" : "SP"
}
}
"Cabecalho": {
"Codigo": 13555,
"CriadoEm": "2020-12-19T13:25",
"ValorDoFrete": 5.00,
"TipoDeFrete": 1,
"ValorTotal": 215.00,
"Situacao": 0,
"TipoDeConsumidor": 1,
"TipoDeImportacao": 0,
"Classificacao": "testes",
"Observacoes": "Teste de Observação",
"ValorDeDesconto": 0,
"TipoDeEnvio": 100
},
"Itens": [
{
"Quantidade": 10,
"ValorUnitario": 21.00,
"Desconto": 0,
"CodigoDeBarras": "9788522480432"
}
],
"Faturas": [
{
"NumeroDeParcelas": 1,
"Valor": 215.00,
"AprovadoEm": "2020-12-19T13:35",
"NSU": "TESTE",
"Autorizacao": "0983aisadafs90",
"Resumo": "Teste de Fatura",
"NumeroDoCartao": "XXXXXXXXXXXX5423",
"FormaDePagamentoId": 17
}
],
"EnderecoDeCobranca": {
"Nome": "Marcelo Junior",
"Apelido": "Marcelo Junior",
"Email": "teste@wbstecn.com.br",
"CnpjCpf": "12345678900",
"RgIE": "123456780",
"Tipo": 1,
"Bairro" : "Jd. Nova IP",
"CEP" : "13000056",
"Cidade" : "Minha Cidade",
"Complemento" : "",
"Destinatario" : "Marcelo Junior",
"LinhaDeEndereco" : "Rua dos Opalas",
"Pais" :"Brasil",
"TelefoneFixo" : "19998885664",
"UF" : "SP"
},
"EnderecoDeEntrega": {
"Nome": "Marcelo Junior",
"Apelido": "Marcelo Junior",
"Email": "teste@wbstecn.com.br",
"CnpjCpf": "12345678900",
"RgIE": "123456780",
"Tipo": 1,
"Bairro" : "Jd. Nova IP",
"CEP" : "13000056",
"Cidade" : "Minha Cidade",
"Complemento" : "",
"Destinatario" : "Marcelo Junior",
"LinhaDeEndereco" : "Rua dos Opalas",
"Pais" :"Brasil",
"TelefoneFixo" : "19998885664",
"UF" : "SP"
}
}
Campos Obrigatórios e Validações:
Nome | Descrição |
EnderecoDeCobranca | O Pedido deve ter pelo menos o endereço de Cobrança. |
EnderecoDeCobranca.Complemento | Não deve conter mais de 80 caracteres. |
EnderecoDeCobranca.LinhaDeEntrega | Não deve conter mais de 100 caracteres. |
EnderecoDeCobranca.Nome | Não deve conter mais de 50 caracteres |
EnderecoDeCobranca.Apelido | Não deve conter mais de 50 caracteres |
EnderecoDeCobranca.Tipo |
|
EnderecoDeEntegra | Se informado respeita as mesmas regras do Endereço de Cobrança, se não informado o Endereço de Cobrança será utilizado no lugar. |
Itens[*].ProdutoId | Deve ser informado, caso o código de barras não for informado. |
Itens[*].CodigoDeBarras | Deve ser informado, caso o Id do produto não for informado. |
Itens[*].ValorUnitario | Deve ser maior que 0 |
Itens[*].Quantidade | Deve ser maior que 0 |
Cabecalho.Codigo | Não pode estar em branco |
Cabecalho.CriadoEm | Obrigatório informar |
Cabecalho.ValorDoFrete | Tem que ser 0 ou maior. |
Cabecalho.ValorTotal | Tem que ser 0 ou maior |
Cabecalho.TipoDeFrete | Tem que ser informado corretamente! |
Cabecalho.TipoDeEnvio | Tem que ser informado o ID recuperado pela API de Tipos de Envio. |
Cabecalho.TipoDeImportacao | 0 - Importar e Reservar (Todos os pedidos serão importados, independentemente da confirmação de pagamento do cliente por parte do EC. Nessa situação, os produtos ficarão como Reservados para atender esse pedido, aguardando o EC mudar o status para 1); 1 - Importar e/ou Liberar (Serão importados apenas os pedidos que estão com pagamento do cliente confirmado por parte do EC. Nessa situação, os produtos ficarão com a situação de Liberados para atender o pedido); 2 - Cancelar (Após o pedido ter sido importado, ele será cancelado se o EC colocar a situação como 2, desde que não tenha sido emitida nota fiscal). |
Para mais campos | Consulte |
Índice
Exemplos
- Exemplo de Payload: BAIXAR
- Exemplo de Resultado: BAIXAR