Wiki source code of Pedidos - Enviar um Pedido

Version 11.1 by WBS Tecnologia on 2021/05/18 17:53
Show last authors
1 (% class="jumbotron" %)
2 (((
3 (% class="container" %)
4 (((
5 = Inserir um Pedido na Plataforma =
6
7 Neste Método vamos descrever como Inserir um Pedido na Plataforma.
8 )))
9 )))
10
11 (% class="row" %)
12 (((
13 (% class="col-xs-12 col-sm-8" %)
14 (((
15 = Detalhes da Rota =
16
17 (% class="box infomessage" %)
18 (((
19 Rota:/BDIApi/Pedido/Salvar
20 )))
21
22 * Parâmetros:
23 * Requer Autenticação: **Sim **
24 * Método: **POST**
25 * Tipo de Retorno**:  Void | Pedido**
26 * Headers:
27 ** API_TOKEN: Token de Autenticação
28 * Corpo/Payload
29 ** JSON do Pedido
30
31 == Códigos de Status ==
32
33 * 404 = Sem resultados
34 * 500 = Erro Interno do Servidor
35 * 200 = OK
36 * 403 = Acesso Negado, Token de Autenticação Inválido?
37
38 = Detalhes da Ação =
39
40 Insere um Pedido na Plataforma
41
42 === (% style="font-size:26px" %)Headers(%%) ===
43
44 Abaixo segue os headers que devem ou podem ser passados para a ação:
45
46 |=Header|=Descrição / Validação|=Valor Padrão
47 |API_TOKEN|[Obrigatório] Token da Autenticação|
48
49 == (% style="font-size:29px" %)Corpo(%%) ==
50
51 Este é o Payload do corpo, este JSON representa o pedido a ser inserido na plataforma:
52
53 {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}}
54 {
55 "Cabecalho": {
56 "Codigo": 13555,
57 "CriadoEm": "2020-12-19T13:25",
58 "ValorDoFrete": 5.00,
59 "TipoDeFrete": 1,
60 "ValorTotal": 215.00,
61 "Situacao": 0,
62 "TipoDeConsumidor": 1,
63 "TipoDeImportacao": 0,
64 "Classificacao": "testes",
65 "Observacoes": "Teste de Observação",
66 "ValorDeDesconto": 0,
67 "TipoDeEnvio": 100
68 },
69 "Itens": [
70 {
71 "Quantidade": 10,
72 "ValorUnitario": 21.00,
73 "Desconto": 0,
74 "CodigoDeBarras": "9788522480432"
75 }
76 ],
77 "Faturas": [
78 {
79 "NumeroDeParcelas": 1,
80 "Valor": 215.00,
81 "AprovadoEm": "2020-12-19T13:35",
82 "NSU": "TESTE",
83 "Autorizacao": "0983aisadafs90",
84 "Resumo": "Teste de Fatura",
85 "NumeroDoCartao": "XXXXXXXXXXXX5423",
86 "FormaDePagamentoId": 17
87 }
88 ],
89 "EnderecoDeCobranca": {
90 "Nome": "Marcelo Junior",
91 "Apelido": "Marcelo Junior",
92 "Email": "teste@wbstecn.com.br",
93 "CnpjCpf": "12345678900",
94 "RgIE": "123456780",
95 "Tipo": 1,
96 "Bairro" : "Jd. Nova IP",
97 "CEP" : "13000056",
98 "Cidade" : "Minha Cidade",
99 "Complemento" : "",
100 "Destinatario" : "Marcelo Junior",
101 "LinhaDeEndereco" : "Rua dos Opalas",
102 "Pais" :"Brasil",
103 "TelefoneFixo" : "19998885664",
104 "UF" : "SP"
105 },
106 "EnderecoDeEntrega": {
107 "Nome": "Marcelo Junior",
108 "Apelido": "Marcelo Junior",
109 "Email": "teste@wbstecn.com.br",
110 "CnpjCpf": "12345678900",
111 "RgIE": "123456780",
112 "Tipo": 1,
113 "Bairro" : "Jd. Nova IP",
114 "CEP" : "13000056",
115 "Cidade" : "Minha Cidade",
116 "Complemento" : "",
117 "Destinatario" : "Marcelo Junior",
118 "LinhaDeEndereco" : "Rua dos Opalas",
119 "Pais" :"Brasil",
120 "TelefoneFixo" : "19998885664",
121 "UF" : "SP"
122 }
123 }
124 {{/code}}
125
126 == Campos Obrigatórios e Validações: ==
127
128 |**Nome**|**Descrição**
129 |EnderecoDeCobranca|O Pedido deve ter pelo menos o endereço de Cobrança.
130 |EnderecoDeCobranca.Complemento|Não deve conter mais de 80 caracteres.
131 |EnderecoDeCobranca.LinhaDeEntrega|Não deve conter mais de 100 caracteres.
132 |EnderecoDeCobranca.Nome|Não deve conter mais de 50 caracteres
133 |EnderecoDeCobranca.Apelido|Não deve conter mais de 50 caracteres
134 |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.
135 |Itens[*].ProdutoId|Deve ser informado, caso o código de barras não for informado.
136 |Itens[*].CodigoDeBarras|Deve ser informado, caso o Id do produto não for informado.
137 |Itens[*].ValorUnitario|Deve ser maior que 0
138 |Itens[*].Quantidade|Deve ser maior que 0
139 | |
140 |Cabecalho.Codigo|Não pode estar em branco
141 |Cabecalho.CriadoEm|Obrigatório informar
142 |Cabecalho.ValorDoFrete|Tem que ser 0 ou maior.
143 |Cabecalho.ValorTotal|Tem que ser 0 ou maior
144 |Cabecalho.TipoDeFrete|Tem que ser informado corretamente!
145 |Cabecalho.TipoDeEnvio|Tem que ser informado o ID recuperado pela API de Tipos de Envio.
146 |Cabecalho.TipoDeImportacao|
147
148 {{{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); 
149 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);
150 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).
151       }}}
152
153
154 )))
155
156
157 (% class="col-xs-12 col-sm-4" %)
158 (((
159 {{box title="**Índice**"}}
160 {{toc/}}
161 {{/box}}
162
163 {{box}}
164 **Exemplos**
165
166 * Exemplo de Payload: BAIXAR
167 * Exemplo de Resultado: BAIXAR
168 {{/box}}
169 )))
170 )))
WBS Tecnologia (C) 2024
1.2