gicnet API

Guia de Integração  

Segurança da comunicação

Para salvaguardar a segurança do sistema de comunicações e da plataforma Gicnet API a Inventore, implementou várias medidas de segurança das quais destacamos: Sistema de autenticação da API. Apenas os nossos parceiros devidamente autorizados, terão acesso aos métodos da nossa API. Chamadas ao sistema não autorizadas serão ignoradas e descartadas. Comunicações protegidas por SSL: As comunicações eletrónicas estão protegidas por SSL. 

Webservice

A API GICnet é um webservice do tipo RESTFUL e admite no corpo dos pedidos um objecto JSON com a seguinte estrutura: {"Service":"nome do serviço","idCliente":"código do cliente","senha":"palavra passe cliente/API", parametros adicionais...} 

Endereço da API

https://inventore.net/ws/api/ws-api.php

Métodos disponíveis

 

1. Listagem de lojas

Nome do serviço: ListaLojas
Descrição: Método para listar as lojas (existentes no Gicnet)
PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"Lojas":[{"idloja":"1","descritivo":"XX - VASCO GAMA"},...]}}

Caso a execução tenha erros:

{"response”:"error", "payload": {"msgerror":"Não existem lojas"}}

PARÂMETRO


 

response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


 

Lojas

DESCRIÇÃO


Listagem de Lojas

TIPO


JSON array (3)

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


 

idloja

DESCRIÇÃO


Código de loja

TIPO


int(10)

descritivo

Designação da loja

String(80)

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

2. Dados Loja

Nome do serviço: LojaID
Descrição: Método para obter os dados de uma loja (existente no gicnet)
PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idloja

Código de Loja

int(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"descritivo":"XX - COLOMBO"}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror”:"Loja não encontrada"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


descritivo

DESCRIÇÃO


designação da loja

TIPO


String

 

Caso “response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

3. Listagem de Armazéns

Nome do serviço: ListaArmazens
Descrição: Método para listar os armazéns (existentes no gicnet)
PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:
Exemplos:
Caso a execução seja bem sucedida:

{"response":"ok", “payload": {"Armazens":[{"idarmazem":"1","descritivo":"VASCO GAMA","idloja":"1"},...]}}

Caso a execução tenha erros:
{"response":"error", "payload”: {"msgerror":"Não existem armazéns"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”
(2) payload:
Caso ”response”:”ok”:

PARÂMETRO


Armazens

DESCRIÇÃO


Listagem de armazéns

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


idarmazem

DESCRIÇÃO


Código de armazém

TIPO


int(10)

descritivo

Designação do armazém

String(80)

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

4. Dados Armazém

Nome do serviço: ArmazensID
Descrição: Método para obter os dados de um armazém (existente no gicnet)
PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idarmazem

Código de armazém

int(10)


PARÂMETROS DE SAÍDA
:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"descritivo":"VASCO GAMA", "idloja":"1"}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror”:"Armazém não encontrado"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


descritivo

DESCRIÇÃO


Designação do armazém

TIPO


String

 

Caso “response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

5. Listagem de Classes (Serviços)

Nome do serviço: ListaClassesServicos

Descrição: Método para listar as classes associadas a serviços (existentes no Gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"ClassesServicos":[{"idclasse":"120","descritivo":"ACADEMIA XX"},...]}}

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Não existem ClassesServicos"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


ClassesServicos

DESCRIÇÃO


Listagem de classes associadas a Serviços

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


idclasse

DESCRIÇÃO


Código da classe

TIPO


int(10)

descritivo

Designação da classe

String(80)

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

6. Dados Classe (Serviços)

Nome do serviço: ClassesServicosID

Descrição: Método para obter os dados de uma classe associada a serviços (existente no Gicnet)

 

PARÂMETROS DE ENTRADA

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idclasse

Código da classe

int(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"descritivo":"ACADEMIA XX"}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror”:"ClasseServico não encontrada"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


descritivo

DESCRIÇÃO


Designação da classe

TIPO


String

 

Caso “response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

7. Listagem de Classes (Produtos)

Nome do serviço: ListaClassesProdutos

Descrição: Método para listar as classes associadas a produtos (existentes no Gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"ClassesProdutos":[{"idclasse":"53","descritivo":"LOTEAL"},...]}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Não existem ClassesProdutos"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


ClassesProdutos

DESCRIÇÃO


Listagem de classes associadas a Produtos

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


idclasse

DESCRIÇÃO


Código da classe

TIPO


int(10)

descritivo

Designação da classe

String(80)

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

8. Dados Classe (Produtos)

Nome do serviço: ClassesProdutosID

Descrição: Método para obter os dados de uma classe associada a produtos (existente no Gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idclasse

Código da classe

int(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"descritivo":"LOTEAL"}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror”:"ClasseProduto não encontrada"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


descritivo

DESCRIÇÃO


Designação da classe

TIPO


String

 

Caso “response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

9. Listagem de Sub Classes

Nome do serviço: ListaSubClasses

Descrição: Método para listar sub classes (existentes no Gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"SubClasses":[{"idclasses":"15","descritivo":"Styling","idclasse":"12"},...]}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Não existem SubClasses"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


SubClasses

DESCRIÇÃO


Listagem de sub classes

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


idclasses

DESCRIÇÃO


Código da sub classe

TIPO


int(10)

descritivo

Designação da classe

String(80)

idclasse

Código da classe de nível superior

int(10)

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

10. Dados Sub Classe

Nome do serviço: SubClasseID

Descrição: Método para obter os dados de uma sub classe (existente no gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idclasses

Código da sub classe

int(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"descritivo":"TÉCNICO","idclasse":"13"}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror”:"SubClasse não encontrada"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


descritivo

DESCRIÇÃO


Designação da classe

TIPO


String

idclasse

Código da classe de nível superior

int(10)

 

Caso “response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

11. Listagem de Sub Classes pertencentes a uma Classe de Nível Superior

Nome do serviço: ListaSubClassesClasseSupID

Descrição: Método para obter os dados de sub classes associadas a uma classe de nível superior (existente no Gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idclasse

Código da classe de nível superior

int(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"SubClasses":[{"idclasses":"15","descritivo":"Styling"},...]}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror”:"SubClasses não encontradas para a classe superior"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


SubClasses

DESCRIÇÃO


Listagem de sub classes

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


idclasses

DESCRIÇÃO


Código sub classe

TIPO


int(10)

descritivo

Designação da classe

String(80)

 

Caso “response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

12. Listagem de Serviços/Loja

Nome do serviço: ListaServicosLoja

Descrição: Método para listar serviços por loja (existentes no Gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"ServicosLoja":[{"idservico":"5","descritivo":"BRUSHING ","idclasse":"140","idclasses":"187","idloja":"1","preco1":"10.9","taxaiva":"23"},...]}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Não existem Serviços"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


ServicosLoja

DESCRIÇÃO


Listagem de serviços por loja

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


idservico

DESCRIÇÃO


Código do serviço

TIPO


int(10)

descritivo

Designação do serviço

String(80)

idclasse

Código classe nível superior

int(10)

idclasses

Código subclasse

int(10)

idloja

Código loja

int(10)

preco1

Preço 1

Double

taxaiva

Taxa IVA

Double

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

13. Listagem de Lojas com um Serviço

Nome do serviço: ListaServicosLojaServicoID

Descrição: Método para listar lojas com um serviço específico (existentes no Gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idservico

Código Serviço

int(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"ServicosLojaServId":[{"descritivo":"BRUSHING ","idclasse":"140","idclasses":"187","idloja":"1","preco1":"10.9","taxaiva":"23"},...]}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Serviço não encontrado"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


ServicosLojaServId

DESCRIÇÃO


Listagem de lojas com serviço específico

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos: 

PARÂMETRO


descritivo

DESCRIÇÃO


Designação do serviço

TIPO


String(80)

idclasse

Código classe nível superior

int(10)

idclasses

Código subclasse

int(10)

idloja

Código loja

int(10)

preco1

Preço 1

Double

taxaiva

Taxa IVA

Double

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

14. Listagem de Produtos/Loja

Nome do serviço: ListaProdutosLoja

Descrição: Método para listar produtos por loja (existentes no Gicnet)

 

PARÂMETROS DE ENTRADA

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"ProdutosLoja":[{"idproduto":"41","descritivo":"LUO 5.3","idclasse":"57","idclasses":"69","idloja":"1","preco1":"0","preco2":"0","taxaiva":"23"},...]}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Não existem Produtos"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


ProdutosLoja

DESCRIÇÃO


Listagem de produtos por loja

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


idproduto

DESCRIÇÃO


Código produto

TIPO


int(10)

descritivo

Designação do serviço

String(80)

idclasse

Código classe nível superior

int(10)

idclasses

Código subclasse

int(10)

idloja

Código loja

int(10)

preco1

Preço 1

Double

preco2

Preço 2

Double

preco3

Preço 3

Double

taxaiva

Taxa IVA

Double

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

 15. Listagem de lojas com um Produto

Nome do serviço: ListaProdutosLojaProdutoID

Descrição: Método para listar lojas com um produto específico (existentes no Gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idproduto

Código Produto

int(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura: 

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"ProdutosLojaProdId":[{"descritivo":"LUO 5.3","idclasse":"57","idclasses":"69","idloja":"1","preco1":"0","preco2":"0","preco3":"0","taxaiva":"23"},...]}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Produto não encontrado"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


ProdutosLojaProdId

DESCRIÇÃO


Listagem de lojas com produto específico

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos: 

PARÂMETRO


descritivo

DESCRIÇÃO


Designação do serviço

TIPO


String(80)

idclasse

Código classe nível superior

int(10)

idclasses

Código subclasse

int(10)

idloja

Código loja

int(10)

preco1

Preço 1

Double

preco2

Preço 2

Double

preco2

Preço 3

Double

taxaiva

Taxa IVA

Double

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

16. Dados de um Produto / Loja

Nome do serviço: ProdutoIDLojaID

Descrição: Método para obter os dados de um produto / loja (existente no Gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idproduto

Código do produto

int(10)

idloja

Código da loja

int(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"descritivo":"LUO 5.3","idclasse":"57","idclasses":"69","preco1":"0","preco2":"0","preco3":"0","taxaiva":"23"}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror”:"Produto/Loja não encontrados"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


descritivo

DESCRIÇÃO


Designação do serviço

TIPO


String(80)

idclasse

Código classe nível superior

int(10)

idclasses

Código subclasse

int(10)

preco1

Preço 1

Double

preco2

Preço 2

Double

preco2

Preço 3

Double

taxaiva

Taxa IVA

Double

 

Caso “response”:”error”:

PARÂMETRO DESCRIÇÃO TIPO

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

17. Listagem de Stocks

Nome do serviço: ListaProdutosStock

Descrição: Método para listar stocks de produtos (existentes no gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"ProdutosLojaProdId":[{"idproduto":"6","idarmazem":"1","stock":"0"},...]}}

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Produto não encontrado"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


ProdutosStock

DESCRIÇÃO


Listagem de stocks de produtos

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


idproduto

DESCRIÇÃO


Código do produto

TIPO


int(10)

idarmazem

Código armazém

int(10)

stock

Stock

Double

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

18. Listagem de Stocks para um Armazém

Nome do serviço: ListaProdutosStockArmazemID

Descrição: Método para listar stocks para um armazém (existentes no Gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idarmazem

Código de armazém

int(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"ProdutosStockArmazemID":[{"idproduto":"6","stock":"0"},...]}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Não existem Stocks para este Armazém"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


ProdutosStockArmazemID

DESCRIÇÃO


Listagem de stocks para um armazém

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


idproduto

DESCRIÇÃO


Código do produto

TIPO


int(10)

stock

Stock

Double

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

19. Listagem de Stocks para um Produto

Nome do serviço: ListaProdutosStockProdutoID

Descrição: Método para listar stocks (por armazém) para um produto (existentes no Gicnet)

 

PARÂMETROS DE ENTRADA

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idproduto

Código do produto

int(10)

 

PARÂMETROS DE SAÍDA

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

 

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"ProdutosStockProdutoID":[{"idarmazem":"1","stock":"0"},...]}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Não existem Stocks para este Produto"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


ProdutosStockProdutoID

DESCRIÇÃO


Listagem de stocks para um produto

TIPO


JSON array (3)

 

(3) cada elemento da lista é do tipo JSON object e contém os seguintes campos:

PARÂMETRO


idarmazem

DESCRIÇÃO


Código de armazém

TIPO


int(10)

stock

Stock

Double

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

20. Dados de Stock Produto/Armazém

Nome do serviço: ProdutoIDArmazemID

Descrição: Método para obter dados de stock para um produto/armazém (existentes no gicnet)

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

idproduto

Código do produto

int(10)

idarmazem

Código do armazém

int(10)

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload":{"stock":"0"}}

 

Caso a execução tenha erros:

{"response":"error", "payload": {"msgerror":"Não existe este produto/armazém"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


stock

DESCRIÇÃO


Stock

TIPO


Double

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String

 

21. Criação de Encomendas no GICnet

Nome do serviço: GravaEncomendaInternet

Descrição: Método para criar uma encomenda no GICnet.

 

PARÂMETROS DE ENTRADA:

PARÂMETRO


idCliente

DESCRIÇÃO


Código de Cliente Gicnet

TIPO


String(9)

senha

Palavra passe da API

String(10)

nomeCliente

Nome do Cliente

String(80)

morada

Morada Facturação

String(80)

ncontribuinte

Nº Contribuinte

String(15)

email

E-mail

String(80)

cPostal

Código Postal Facturação

String(80)

localidade

Localidade Facturação

String(80)

nrencomendaext

Numero Encomenda Externa

String (20)

linhasEncomenda

Linhas da Encomenda

(*)

 

(*)Linhas Encomenda:

PARÂMETRO


idArtigo

DESCRIÇÃO


Código Artigo

TIPO


int(10)

idTipoArtigo

Tipo de Artigo (‘S’ - Serviço ou ‘P’ - Produto)

Char(1)

preco

Preço Artigo

Double

desconto

Desconto

Double

taxaiva

Taxa IVA

Double

qtd

Quantidade

Double

 

Exemplo:

{"Service":"GravaEncomendaInternet","idCliente":"0111111","senha":"xxxxx", "nomeCliente": "Cliente Teste", "morada":"Morada teste", "ncontribuinte":"123456789", "email":"Este endereço de email está protegido contra piratas. Necessita ativar o JavaScript para o visualizar.", "cPostal":"4100-100", "localidade": "Porto", "nrencomendaext":"1000002571", "linhasEncomenda": [{"idArtigo":"1", "idTipoArtigo":"P", "preco":"50", "desconto":"0", "taxaiva":"23", "qtd":"1"}]}

 

PARÂMETROS DE SAÍDA:

A resposta é um JSON Object com a seguinte estrutura:

Exemplos:

Caso a execução seja bem sucedida:

{"response":"ok", "payload": {"documento":"57}}

 

Caso a execução tenha erros:

{"response”:”error", "payload": {"msgerror":"Falta parametrizar a encomenda online no GICnet"}}

PARÂMETRO


response

DESCRIÇÃO


Código da resposta

TIPO


String (1)

payload

Conteúdo da resposta

JSON Object (2)

 

(1) Valores possíveis: “ok”, “error”

(2) payload:

Caso ”response”:”ok”:

PARÂMETRO


documento

DESCRIÇÃO


Numero da encomenda criada

TIPO


Double

 

Caso ”response”:”error”:

PARÂMETRO


msgerror

DESCRIÇÃO


Mensagem de erro

TIPO


String