Wiki source code of Pedido - Consultar Situação por Código
Last modified by WBS Tecnologia on 2021/01/14 17:53
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% class="jumbotron" %) | ||
2 | ((( | ||
3 | (% class="container" %) | ||
4 | ((( | ||
5 | = Consulta a Situação de um Pedido pelo Código da Loja = | ||
6 | ))) | ||
7 | ))) | ||
8 | |||
9 | (% class="row" %) | ||
10 | ((( | ||
11 | (% class="col-xs-12 col-sm-8" %) | ||
12 | ((( | ||
13 | = Detalhes da Rota = | ||
14 | |||
15 | (% class="box infomessage" %) | ||
16 | ((( | ||
17 | Rota: /BDIApi/Pedido/Situacao?codigo=XXXXXXX | ||
18 | ))) | ||
19 | |||
20 | * Parâmetros: | ||
21 | ** codigo = [Obrigatório] Código de Barras do Produto | ||
22 | * Requer Autenticação: **Sim ** | ||
23 | * Método: **GET** | ||
24 | * Tipo de Retorno**: Void | Pedido** | ||
25 | * Headers: | ||
26 | ** API_TOKEN: Token de Autenticação | ||
27 | |||
28 | == Códigos de Status == | ||
29 | |||
30 | * 404 = Sem resultados | ||
31 | * 500 = Erro Interno do Servidor | ||
32 | * 200 = OK | ||
33 | * 403 = Acesso Negado, Token de Autenticação Inválido? | ||
34 | |||
35 | = Detalhes da Ação = | ||
36 | |||
37 | Consulta a Situação do Pedido, que é uma versão bem resolvido do pedido apartir do código de pedido da Loja. | ||
38 | |||
39 | === (% style="font-size:26px" %)Headers(%%) === | ||
40 | |||
41 | Abaixo segue os headers que devem ou podem ser passados para a ação: | ||
42 | |||
43 | |=Header|=Descrição / Validação|=Valor Padrão | ||
44 | |API_TOKEN|[Obrigatório] Token da Autenticação| | ||
45 | |||
46 | == (% style="font-size:29px" %)Detalhes do Resultado(%%) == | ||
47 | |||
48 | Este é o Payload do resultado caso a ação tenha sucesso: | ||
49 | |||
50 | {{code language="json" layout="LINENUMBERS" title="Exemplo do Payload"}} | ||
51 | { | ||
52 | "AtualizadoEm": "2020-12-29T14:25:50.533", | ||
53 | "ValorTotal": 215.00, | ||
54 | "Situacao": 0, | ||
55 | "ChaveNFE": null, | ||
56 | "Rastreio": null | ||
57 | } | ||
58 | {{/code}} | ||
59 | ))) | ||
60 | |||
61 | |||
62 | (% class="col-xs-12 col-sm-4" %) | ||
63 | ((( | ||
64 | {{box title="**Índice**"}} | ||
65 | {{toc/}} | ||
66 | {{/box}} | ||
67 | |||
68 | {{box}} | ||
69 | **Exemplos** | ||
70 | |||
71 | * Exemplo de Payload: BAIXAR | ||
72 | * Exemplo de Resultado: BAIXAR | ||
73 | {{/box}} | ||
74 | ))) | ||
75 | ))) |