Documentação de software

Ferramentas do usuário

Ferramentas do site

Você está aqui: IWS » api » Lista de Operações
Visitou: • Lista de Operações
api:mvs

Diferenças

Aqui você vê as diferenças entre duas revisões dessa página.

Link para esta página de comparações

api:mvs [2019/07/19 17:11]
rfrancisco_iws.com.br [Recuperar Loja] 		api:mvs [2019/07/19 18:28] (atual)
rfrancisco_iws.com.br [Logs Promoção]
Linha 870: Linha 870:
           <​br>&​emsp;&​emsp;"​updated_at":​ "​2019-07-19 13:​52:​34"​           <​br>&​emsp;&​emsp;"​updated_at":​ "​2019-07-19 13:​52:​34"​
           <​br>&​emsp;​}           <​br>&​emsp;​}
 +        </td>
 +    </tr>
 +    </​table>​
 +</​html>​
 +
 +==== Salvar loja ====
 +
 +  * Registra ou atualiza a loja do usuário.
 +
 +<​html>​
 +<​table>​
 +      <tr>
 +        <​td>​Path</​td>​
 +        <td colspan="​2">​{url_base}/​api/​v1/​stores/​{id}</​td>​
 +      </tr>
 +      <tr>
 +        <​td>​Tipo</​td>​
 +        <td colspan="​2">​POST</​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 loja. *Zero para uma nova loja</​td>​
 +      </tr>
 +      <tr>
 +        <td colspan="​3">​Corpo de Requisição</​td>​
 +      </tr>
 +      <tr colspan="​2">​
 +        <​td>​Tipo</​td>​
 +        <td colspan="​2">​JSON(application/​json)</​td>​
 +      </tr>
 +      <tr colspan="​2">​
 +        <​td>​name</​td>​
 +        <td colspan="​2">​String(50),​ Obrigatório</​td>​
 +      </tr>
 +      <tr colspan="​2">​
 +        <​td>​document</​td>​
 +        <td colspan="​2">​String(20),​ Obrigatório</​td>​
 +      </tr>
 +      <tr colspan="​2">​
 +        <​td>​Exemplo</​td>​
 +        <td colspan="​2">​
 +          <​br>&​emsp;​{
 +          <​br>&​emsp;&​emsp;"​name":​ "Loja 01"
 +          <​br>&​emsp;&​emsp;"​document":​ "​99999999999999",​
 +          <​br>&​emsp;​}
 +        </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>&​emsp;​{
 +          <​br>&​emsp;&​emsp;"​id":​ 4001
 +          <​br>&​emsp;​}
 +        </td>
 +    </tr>
 +    </​table>​
 +</​html>​
 +
 +==== Excluir loja ====
 +
 +  * Exclui um loja do usuário.
 +
 +<​html>​
 +<​table>​
 +      <tr>
 +        <​td>​Path</​td>​
 +        <td colspan="​2">​{url_base}/​api/​v1/​stores/​{id}</​td>​
 +      </tr>
 +      <tr>
 +        <​td>​Tipo</​td>​
 +        <td colspan="​2">​DELETE</​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 loja</​td>​
 +      </tr>
 +    </​table>​
 +</​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>&​emsp;​[
 +          <​br>&​emsp;&​emsp;​{
 +          <​br>&​emsp;&​emsp;&​emsp;"​id":​ 1001,
 +          <​br>&​emsp;&​emsp;&​emsp;"​store_id":​ 1031,
 +          <​br>&​emsp;&​emsp;&​emsp;"​start_date":​ "​2019-07-19",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​finish_date":​ "​2019-07-19",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​barcode":​ "​7892123456789",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​value":​ 21,
 +          <​br>&​emsp;&​emsp;&​emsp;"​type":​ "​abs",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​qty_ticket":​ 12,
 +          <​br>&​emsp;&​emsp;&​emsp;"​qty_sales":​ 12
 +          <​br>&​emsp;&​emsp;​}
 +          <​br>&​emsp;​]
 +        </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>&​emsp;​[
 +          <​br>&​emsp;&​emsp;​{
 +          <​br>&​emsp;&​emsp;&​emsp;"​id":​ 1001,
 +          <​br>&​emsp;&​emsp;&​emsp;"​name":​ "João Almeida Neves",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​document":​ "​99999999999",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​phone_number":​ "​99999999999",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​active":​ 1,
 +          <​br>&​emsp;&​emsp;&​emsp;"​address":​ "Rua Cel. Joaquim Francisco",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​district":​ "​Varginha",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​number":​ 409,
 +          <​br>&​emsp;&​emsp;&​emsp;"​city":​ "​Itajubá",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​state":​ "​MG",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​activation_date":​ "​2019-02-28",​
 +          <​br>&​emsp;&​emsp;​}
 +          <​br>&​emsp;​]
 +        </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>&​emsp;​[
 +          <​br>&​emsp;&​emsp;​{
 +          <​br>&​emsp;&​emsp;&​emsp;"​id":​ 1001,
 +          <​br>&​emsp;&​emsp;&​emsp;"​store":​ "​99999999999999",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​start_date":​ "​2019-07-19",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​finish_date":​ "​2019-07-22",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​barcode":​ "​78900151544442",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​value":​ 33,
 +          <​br>&​emsp;&​emsp;&​emsp;"​type":​ "​abs",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​qty_ticket":​ 21,
 +          <​br>&​emsp;&​emsp;&​emsp;"​qty_sales":​ 13
 +          <​br>&​emsp;&​emsp;​}
 +          <​br>&​emsp;​]
 +        </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>&​emsp;​[
 +          <​br>&​emsp;&​emsp;​{
 +          <​br>&​emsp;&​emsp;&​emsp;"​id":​ 1001,
 +          <​br>&​emsp;&​emsp;&​emsp;"​url":​ "​https:​\\mvs.com.br/​promotions",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​request_body":​ {"​promotion_id":​ 21, "​start_date":​ "​2019-02-11"​},​
 +          <​br>&​emsp;&​emsp;&​emsp;"​response_code":​ 200,
 +          <​br>&​emsp;&​emsp;&​emsp;"​authorization":​ Bearer 78s1dsfsedFDVDFBAdddf,​
 +          <​br>&​emsp;&​emsp;&​emsp;"​created_at":​ "​2019-07-19 13:​52:​34",​
 +          <​br>&​emsp;&​emsp;&​emsp;"​updated_at":​ "​2019-07-19 13:​52:​34"​
 +          <​br>&​emsp;&​emsp;​}
 +          <​br>&​emsp;​]
         </td>         </td>
     </tr>     </tr>
     </​table>​     </​table>​
 </​html>​ </​html>​
api/mvs.1563556271.txt.gz · Última modificação: 2019/07/19 17:11 por rfrancisco_iws.com.br

Ferramentas da página

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki