Aqui você vê as diferenças entre duas revisões dessa página.
api:mvs [2019/07/19 17:22] rfrancisco_iws.com.br [Salvar loja] |
api:mvs [2019/07/19 18:28] (atual) rfrancisco_iws.com.br [Logs Promoção] |
||
---|---|---|---|
Linha 986: | Linha 986: | ||
</tr> | </tr> | ||
</table> | </table> | ||
- | </html | + | </html> |
+ | |||
+ | ===== Promoções ===== | ||
+ | |||
+ | ==== Recuperar promoções ==== | ||
+ | |||
+ | * Recupera as promoções. | ||
+ | |||
+ | <html> | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/api/v1/promotions</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">GET</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Cabeçário da Requisição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Authorization</td> | ||
+ | <td colspan="2">Bearer {token usuário}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Resposta</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">JSON</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Exemplo</td> | ||
+ | <td> | ||
+ | <br> [ | ||
+ | <br>  { | ||
+ | <br>   "id": 1001, | ||
+ | <br>   "store_id": 1031, | ||
+ | <br>   "start_date": "2019-07-19", | ||
+ | <br>   "finish_date": "2019-07-19", | ||
+ | <br>   "barcode": "7892123456789", | ||
+ | <br>   "value": 21, | ||
+ | <br>   "type": "abs", | ||
+ | <br>   "qty_ticket": 12, | ||
+ | <br>   "qty_sales": 12 | ||
+ | <br>  } | ||
+ | <br> ] | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </html> | ||
+ | |||
+ | ==== Recuperar clientes da promoção ==== | ||
+ | |||
+ | * Recupera os clientes da promoção. | ||
+ | |||
+ | <html> | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/api/v1/promotions/{id}/customers</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">GET</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Cabeçário da Requisição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Authorization</td> | ||
+ | <td colspan="2">Bearer {token usuário}</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}</td> | ||
+ | <td>Inteiro(20)</td> | ||
+ | <td>Id da promoção</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Resposta</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">JSON</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Exemplo</td> | ||
+ | <td colspan="2"> | ||
+ | <br> [ | ||
+ | <br>  { | ||
+ | <br>   "id": 1001, | ||
+ | <br>   "name": "João Almeida Neves", | ||
+ | <br>   "document": "99999999999", | ||
+ | <br>   "phone_number": "99999999999", | ||
+ | <br>   "active": 1, | ||
+ | <br>   "address": "Rua Cel. Joaquim Francisco", | ||
+ | <br>   "district": "Varginha", | ||
+ | <br>   "number": 409, | ||
+ | <br>   "city": "Itajubá", | ||
+ | <br>   "state": "MG", | ||
+ | <br>   "activation_date": "2019-02-28", | ||
+ | <br>  } | ||
+ | <br> ] | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </html> | ||
+ | |||
+ | ==== Logs ==== | ||
+ | |||
+ | ==== Logs Promoção ==== | ||
+ | |||
+ | * Recupera os logs da promoção. | ||
+ | |||
+ | <html> | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/api/v1/mvs-export-logs/promotions</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">GET</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Cabeçário da Requisição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Authorization</td> | ||
+ | <td colspan="2">Bearer {token usuário}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Resposta</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">JSON</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Exemplo</td> | ||
+ | <td colspan="2"> | ||
+ | <br> [ | ||
+ | <br>  { | ||
+ | <br>   "id": 1001, | ||
+ | <br>   "store": "99999999999999", | ||
+ | <br>   "start_date": "2019-07-19", | ||
+ | <br>   "finish_date": "2019-07-22", | ||
+ | <br>   "barcode": "78900151544442", | ||
+ | <br>   "value": 33, | ||
+ | <br>   "type": "abs", | ||
+ | <br>   "qty_ticket": 21, | ||
+ | <br>   "qty_sales": 13 | ||
+ | <br>  } | ||
+ | <br> ] | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </html> | ||
+ | |||
+ | ==== Logs Mvs ==== | ||
+ | |||
+ | * Recupera os logs da MVs. | ||
+ | |||
+ | <html> | ||
+ | <table> | ||
+ | <tr> | ||
+ | <td>Path</td> | ||
+ | <td colspan="2">{url_base}/api/v1/mvs-export-logs/logs</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">GET</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Cabeçário da Requisição</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Authorization</td> | ||
+ | <td colspan="2">Bearer {token usuário}</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td colspan="3">Resposta</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Tipo</td> | ||
+ | <td colspan="2">JSON</td> | ||
+ | </tr> | ||
+ | <tr> | ||
+ | <td>Exemplo</td> | ||
+ | <td colspan="2"> | ||
+ | <br> [ | ||
+ | <br>  { | ||
+ | <br>   "id": 1001, | ||
+ | <br>   "url": "https:\\mvs.com.br/promotions", | ||
+ | <br>   "request_body": {"promotion_id": 21, "start_date": "2019-02-11"}, | ||
+ | <br>   "response_code": 200, | ||
+ | <br>   "authorization": Bearer 78s1dsfsedFDVDFBAdddf, | ||
+ | <br>   "created_at": "2019-07-19 13:52:34", | ||
+ | <br>   "updated_at": "2019-07-19 13:52:34" | ||
+ | <br>  } | ||
+ | <br> ] | ||
+ | </td> | ||
+ | </tr> | ||
+ | </table> | ||
+ | </html> |