Aqui você vê as diferenças entre duas revisões dessa página.
api:ecommerce [2017/07/06 18:45] rmota [Pagamento] |
api:ecommerce [2021/05/25 19:40] (atual) rafael [Get] |
||
---|---|---|---|
Linha 235: | Linha 235: | ||
<tr> | <tr> | ||
<td>Path</td> | <td>Path</td> | ||
- | <td colspan="2">{url_base}/Datasnap/Rest/TProduto/all/{limite}/{pagina}</td> | + | <td colspan="2">{url_base}/Datasnap/Rest/TProduto/all/{ativo}/{limite}/{pagina}</td> |
</tr> | </tr> | ||
<tr> | <tr> | ||
Linha 248: | Linha 248: | ||
<td>Tipo</td> | <td>Tipo</td> | ||
<td>Descrição</td> | <td>Descrição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>{ativo}</td> | ||
+ | <td>SmallInt(0 ou 1)</td> | ||
+ | <td>Define se retorna produtos Ativos ou Inativos</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Linha 287: | Linha 292: | ||
<br>   }, | <br>   }, | ||
<br>   "ativo":true | <br>   "ativo":true | ||
+ | <br>   "pesavel":false | ||
<br>  }, | <br>  }, | ||
<br>  { | <br>  { | ||
Linha 304: | Linha 310: | ||
<br>   }, | <br>   }, | ||
<br>   "ativo":true | <br>   "ativo":true | ||
+ | <br>   "pesavel":false | ||
<br>  } | <br>  } | ||
<br> ]} | <br> ]} | ||
Linha 363: | Linha 370: | ||
<br>   }, | <br>   }, | ||
<br>   "ativo":true | <br>   "ativo":true | ||
+ | <br>   "pesavel":false | ||
+ | <br>  }} | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | | ||
+ | </html> | ||
+ | |||
+ | <html> | ||
+ | | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/Datasnap/Rest/TProduto/findByEan/{ean}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">GET</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Parâmetros do Path</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Nome</td> | ||
+ | <td>Tipo</td> | ||
+ | <td>Descrição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>{ean}</td> | ||
+ | <td>String(20)</td> | ||
+ | <td>Código de Barra do Produto</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Resposta</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">Objeto</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Exemplo</td> | ||
+ | <td colspan="2"> | ||
+ | <br> { | ||
+ | <br>  "result":{ | ||
+ | <br>   "id":9732186001, | ||
+ | <br>   "descricao":"COCO RALADO MAIS COCO UMID. SOCOCO 24X100GR", | ||
+ | <br>   "referencia":"COCO RALADO MAIS COCO UMID. SO", | ||
+ | <br>   "codigobarra":"0000001006506", | ||
+ | <br>   "estoque":15, | ||
+ | <br>   "preco":37.64, | ||
+ | <br>   "peso":0, | ||
+ | <br>   "unidade":"CX", | ||
+ | <br>   "decimais":0, | ||
+ | <br>   "categoria": | ||
+ | <br>   { | ||
+ | <br>     "id":3400, | ||
+ | <br>     "descricao":"MERCEARIA\/FARINACEO" | ||
+ | <br>   }, | ||
+ | <br>   "ativo":true | ||
+ | <br>   "pesavel":false | ||
<br>  }} | <br>  }} | ||
</td> | </td> | ||
Linha 429: | Linha 496: | ||
<br>   } | <br>   } | ||
<br>   "ativo":true | <br>   "ativo":true | ||
+ | <br>   "pesavel":false | ||
<br>  }, | <br>  }, | ||
<br>  { | <br>  { | ||
Linha 447: | Linha 515: | ||
<br>  } | <br>  } | ||
<br>   "ativo":true | <br>   "ativo":true | ||
+ | <br>   "pesavel":false | ||
<br> ]} | <br> ]} | ||
</td> | </td> | ||
Linha 508: | Linha 577: | ||
</tr> | </tr> | ||
</table> | </table> | ||
+ | </html> | ||
+ | |||
+ | * Recupera a imagem do produto na base64 | ||
+ | <html> | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/datasnap/rest/TProduto/foto/{id_produto}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">GET</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Parâmetros do Path</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Nome</td> | ||
+ | <td>Tipo</td> | ||
+ | <td>Descrição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>{id_produto}</td> | ||
+ | <td>Inteiro(20)</td> | ||
+ | <td>ID do produto</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Resposta</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">Objeto</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Exemplo</td> | ||
+ | <td colspan="2"> | ||
+ | <br> { | ||
+ | <br> "result": "\/9j\/4AAQSkZJRgABAQEAYABgAAD\/2w..." | ||
+ | <br> } | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </html> | ||
+ | |||
+ | ==== Delete ==== | ||
+ | |||
+ | * Exclui os produtos que sofreram alteração no período informado | ||
+ | |||
+ | <html> | ||
+ | | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/Datasnap/Rest/TProduto/lastupdated/{inicio}/{termino}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">DELETE</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Parâmetros do Path</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Nome</td> | ||
+ | <td>Tipo</td> | ||
+ | <td>Descrição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>{inicio}</td> | ||
+ | <td>String(20)</td> | ||
+ | <td>Data de início, 99.99.9999 99:99:9</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>{termino}</td> | ||
+ | <td>String(20)</td> | ||
+ | <td>Data de término, 99.99.9999 99:99:9</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | | ||
</html> | </html> | ||
Linha 593: | Linha 741: | ||
<td>Inteiro(20)</td> | <td>Inteiro(20)</td> | ||
<td>Id da promoção</td> | <td>Id da promoção</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Resposta</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">Objeto</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Exemplo</td> | ||
+ | <td colspan="2"> | ||
+ | <br> { | ||
+ | <br>  "result":{ | ||
+ | <br>   "id":23740000001, | ||
+ | <br>   "inicio":"06\/07\/2016", | ||
+ | <br>   "termino":null, | ||
+ | <br>   "preco":160, | ||
+ | <br>   "preco_normal":169 | ||
+ | <br>   "id_produto":123456789 | ||
+ | <br> } | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/Datasnap/Rest/TPromocao/produto/{idProduto}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">GET</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Parâmetros do Path</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Nome</td> | ||
+ | <td>Tipo</td> | ||
+ | <td>Descrição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>{idProduto}</td> | ||
+ | <td>Inteiro(20)</td> | ||
+ | <td>Id do Produto</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Linha 903: | Linha 1096: | ||
<td>Inteiro(20)</td> | <td>Inteiro(20)</td> | ||
<td>Id do cliente</td> | <td>Id do cliente</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Resposta</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">Objeto</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Exemplo</td> | ||
+ | <td colspan="2">{ | ||
+ | <br> "result":{ | ||
+ | <br>   "id":23763899001, | ||
+ | <br>   "nome":"Julius A. Swafford" | ||
+ | <br>   "documento":"56148825619" | ||
+ | <br>}} | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | | ||
+ | </html> | ||
+ | |||
+ | <html> | ||
+ | | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/Datasnap/Rest/TCliente/findByDoc/{doc}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">GET</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Parâmetros do Path</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Nome</td> | ||
+ | <td>Tipo</td> | ||
+ | <td>Descrição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>{doc}</td> | ||
+ | <td>String(30)</td> | ||
+ | <td>Documento do cliente</td> | ||
</tr> | </tr> | ||
<tr> | <tr> | ||
Linha 1762: | Linha 2000: | ||
<br>   "acrescimo":0, | <br>   "acrescimo":0, | ||
<br>   "situacao":"VENCIDO", | <br>   "situacao":"VENCIDO", | ||
+ | <br>   "frete":0, | ||
<br>   "status":2 | <br>   "status":2 | ||
<br>  }, | <br>  }, | ||
Linha 1778: | Linha 2017: | ||
<br>   "acrescimo":0, | <br>   "acrescimo":0, | ||
<br>   "situacao":"VENCIDO", | <br>   "situacao":"VENCIDO", | ||
+ | <br>   "frete":0, | ||
<br>   "status":2 | <br>   "status":2 | ||
<br>  } | <br>  } | ||
Linha 1831: | Linha 2071: | ||
<br>   "acrescimo":0, | <br>   "acrescimo":0, | ||
<br>   "situacao":"VENCIDO", | <br>   "situacao":"VENCIDO", | ||
+ | <br>   "frete":0, | ||
<br>   "status":2 | <br>   "status":2 | ||
<br>   "produtos":[{ | <br>   "produtos":[{ | ||
Linha 2026: | Linha 2267: | ||
<br>  "desconto": 0, | <br>  "desconto": 0, | ||
<br>  "atacado": 0 | <br>  "atacado": 0 | ||
+ | <br> } | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </html> | ||
+ | |||
+ | <html> | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/Datasnap/Rest/TPedido/frete/{idPedido}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">POST</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Parâmetros do Path</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Nome</td> | ||
+ | <td>Tipo</td> | ||
+ | <td>Descrição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>{idPedido}</td> | ||
+ | <td>Inteiro(20)</td> | ||
+ | <td>Id do pedido</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Corpo de Requisição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">Objeto</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>frete</td> | ||
+ | <td colspan="2">Decimal(18,2), Obrigatório, > 0</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Exemplo</td> | ||
+ | <td colspan="2"> | ||
+ | <br> { | ||
+ | <br>  "frete": 9.90 | ||
<br> } | <br> } | ||
</td> | </td> | ||
Linha 2035: | Linha 2321: | ||
<note important>Um pedido só pode ser alterado enquando o seu status for igual a 1</note> | <note important>Um pedido só pode ser alterado enquando o seu status for igual a 1</note> | ||
+ | |||
+ | <html> | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/Datasnap/Rest/TPedido/pedido/{idPedido}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">DELETE</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Parâmetros do Path</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Nome</td> | ||
+ | <td>Tipo</td> | ||
+ | <td>Descrição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>{idPedido}</td> | ||
+ | <td>Inteiro(20)</td> | ||
+ | <td>Id do pedido</td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </html> | ||
<html> | <html> | ||
Linha 2066: | Linha 2378: | ||
</table> | </table> | ||
</html> | </html> | ||
- | |||
==== Pagamento ==== | ==== Pagamento ==== | ||