Wiki source code of Pedidos - Enviar um Pedido
Version 10.1 by WBS Tecnologia on 2021/01/14 17:11
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 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 | "Classificacao": "testes", | ||
| 64 | "Observacoes": "Teste de Observação", | ||
| 65 | "ValorDeDesconto": 0, | ||
| 66 | "TipoDeEnvio": 100 | ||
| 67 | }, | ||
| 68 | "Itens": [ | ||
| 69 | { | ||
| 70 | "Quantidade": 10, | ||
| 71 | "ValorUnitario": 21.00, | ||
| 72 | "Desconto": 0, | ||
| 73 | "CodigoDeBarras": "9788522480432" | ||
| 74 | } | ||
| 75 | ], | ||
| 76 | "Faturas": [ | ||
| 77 | { | ||
| 78 | "NumeroDeParcelas": 1, | ||
| 79 | "Valor": 215.00, | ||
| 80 | "AprovadoEm": "2020-12-19T13:35", | ||
| 81 | "NSU": "TESTE", | ||
| 82 | "Autorizacao": "0983aisadafs90", | ||
| 83 | "Resumo": "Teste de Fatura", | ||
| 84 | "NumeroDoCartao": "XXXXXXXXXXXX5423", | ||
| 85 | "FormaDePagamentoId": 17 | ||
| 86 | } | ||
| 87 | ], | ||
| 88 | "EnderecoDeCobranca": { | ||
| 89 | "Nome": "Marcelo Junior", | ||
| 90 | "Apelido": "Marcelo Junior", | ||
| 91 | "Email": "teste@wbstecn.com.br", | ||
| 92 | "CnpjCpf": "12345678900", | ||
| 93 | "RgIE": "123456780", | ||
| 94 | "Tipo": 1, | ||
| 95 | "Bairro" : "Jd. Nova IP", | ||
| 96 | "CEP" : "13000056", | ||
| 97 | "Cidade" : "Minha Cidade", | ||
| 98 | "Complemento" : "", | ||
| 99 | "Destinatario" : "Marcelo Junior", | ||
| 100 | "LinhaDeEndereco" : "Rua dos Opalas", | ||
| 101 | "Pais" :"Brasil", | ||
| 102 | "TelefoneFixo" : "19998885664", | ||
| 103 | "UF" : "SP" | ||
| 104 | }, | ||
| 105 | "EnderecoDeEntrega": { | ||
| 106 | "Nome": "Marcelo Junior", | ||
| 107 | "Apelido": "Marcelo Junior", | ||
| 108 | "Email": "teste@wbstecn.com.br", | ||
| 109 | "CnpjCpf": "12345678900", | ||
| 110 | "RgIE": "123456780", | ||
| 111 | "Tipo": 1, | ||
| 112 | "Bairro" : "Jd. Nova IP", | ||
| 113 | "CEP" : "13000056", | ||
| 114 | "Cidade" : "Minha Cidade", | ||
| 115 | "Complemento" : "", | ||
| 116 | "Destinatario" : "Marcelo Junior", | ||
| 117 | "LinhaDeEndereco" : "Rua dos Opalas", | ||
| 118 | "Pais" :"Brasil", | ||
| 119 | "TelefoneFixo" : "19998885664", | ||
| 120 | "UF" : "SP" | ||
| 121 | } | ||
| 122 | } | ||
| 123 | {{/code}} | ||
| 124 | |||
| 125 | == Campos Obrigatórios e Validações: == | ||
| 126 | |||
| 127 | |**Nome**|**Descrição** | ||
| 128 | |EnderecoDeCobranca|O Pedido deve ter pelo menos o endereço de Cobrança. | ||
| 129 | |EnderecoDeCobranca.Complemento|Não deve conter mais de 80 caracteres. | ||
| 130 | |EnderecoDeCobranca.LinhaDeEntrega|Não deve conter mais de 100 caracteres. | ||
| 131 | |EnderecoDeCobranca.Nome|Não deve conter mais de 50 caracteres | ||
| 132 | |EnderecoDeCobranca.Apelido|Não deve conter mais de 50 caracteres | ||
| 133 | |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. | ||
| 134 | |Itens[*].ProdutoId|Deve ser informado, caso o código de barras não for informado. | ||
| 135 | |Itens[*].CodigoDeBarras|Deve ser informado, caso o Id do produto não for informado. | ||
| 136 | |Itens[*].ValorUnitario|Deve ser maior que 0 | ||
| 137 | |Itens[*].Quantidade|Deve ser maior que 0 | ||
| 138 | | | | ||
| 139 | |Cabecalho.Codigo|Não pode estar em branco | ||
| 140 | |Cabecalho.CriadoEm|Obrigatório informar | ||
| 141 | |Cabecalho.ValorDoFrete|Tem que ser 0 ou maior. | ||
| 142 | |Cabecalho.ValorTotal|Tem que ser 0 ou maior | ||
| 143 | |Cabecalho.TipoDeFrete|Tem que ser informado corretamente! | ||
| 144 | |Cabecalho.TipoDeEnvio|Tem que ser informado o ID recuperado pela API de Tipos de Envio. | ||
| 145 | | | | ||
| 146 | |||
| 147 | |||
| 148 | ))) | ||
| 149 | |||
| 150 | |||
| 151 | (% class="col-xs-12 col-sm-4" %) | ||
| 152 | ((( | ||
| 153 | {{box title="**Índice**"}} | ||
| 154 | {{toc/}} | ||
| 155 | {{/box}} | ||
| 156 | |||
| 157 | {{box}} | ||
| 158 | **Exemplos** | ||
| 159 | |||
| 160 | * Exemplo de Payload: BAIXAR | ||
| 161 | * Exemplo de Resultado: BAIXAR | ||
| 162 | {{/box}} | ||
| 163 | ))) | ||
| 164 | ))) |