MANUAL_DE_ESPECIFICACAO_DO_RMSSERVICES
Visão Geral do Programa
Este documento descreve o serviço corporativo em termos de envolvimento, fornecendo restrições técnicas e de negócio, bem como informações de requisitos e semânticas para uso deste serviço.
1. Campo de Aplicação
Governança de Serviços
2. Serviço
2.1 Descrição do Serviço
O RMSServices é uma camada de serviços que faz a comunicação de outras aplicações ao ERP e vem para substituir pequenos aplicativos de apoio que tem objetivos específicos e não oferecem evolução e nem mesmo flexibilidade na sua arquitetura.
2.2 Direito de Acesso
Toda requisição requer um Http Header chamado “x-rms-token’ que é utilizado para autenticar a requisição. Este token deve ser fornecido pela equipe RMS responsável pelo projeto.
2.3 Protocolo do Serviço
Interno e externo: REST API
2.4 Requisitos Não Funcionais
Autenticação e autorização com OAuth2.
2.5 URL do Serviço
http://<ip-do-servidor>:<porta>/RMSServices/api/<nome-do-metodo>
3. Capacidades
3.1 Descrição
# | Capacidade | Descrição |
1 | 3.1.1.1 Classificacao | GET - Retorna uma lista de classificação mercadológica.
GET/id – Retorna uma classificação específica. |
2 | 3.1.1.2 Cliente | POST – Recebe um objeto cliente para salvar na base. |
3 | 3.1.1.3 EstoquePreco | GET – Retorna um objeto estoquepreco referente ao código do produto e filial passados via querystring |
4 | 3.1.1.4 PedidoAux | POST – Recebe um objeto pedido para salvar no banco.
PUT – Recebe um objeto pedido para atualizar no banco. |
5 | 3.1.1.5 Produto | GET – Lista todos os produtos.
GET/id – Retorna um produto de acordo com o código RMS. |
3.1.2
3.2 Filtros padrões da API
Campo | Tipo | Descrição |
limit | int | Quantidade (máxima) de registros retornados. Por padrão serão sempre retornados 50 registros, sendo que através deste parâmetro o limite pode ser alterado para até 250 registros (de 1 a 250). |
START | INT | Número de registros que serão pulados na query. Este parâmetro pode ser utilizado em conjunto com limit. Por exemplo, se houver 300 registros no total, pode-se utilizar start=0&limit=100 para obter os primeiros 100 registros, para obter próximos 100 registros, usamos start=100&limit=100. |
3.2.1
3.3 Serviços
3.3.1 Classificacao
3.3.1.1 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/Classificacao
3.3.1.2 Parâmetros de Entrada
Não existem parâmetros de entrada nesta requisição
3.3.1.3 Parâmetros de Saída
Campo | Tipo | Descrição |
Id | Decimal |
|
Departamento | String |
|
Secao | String |
|
Grupo | String |
|
Subgrupo | String |
|
Categoria | String |
|
idExterno | Decimal |
|
idPai | Decimal |
|
Descricao | String |
|
3.3.1.4 Pré-Condição
O sistema a consumir este serviço deve ter permissão para utilizá-lo.
3.3.1.5 Pós-Condição
Não se aplica.
3.3.1.6 Sem Disponibilidade
Contate o Administrador.
3.3.1.7
3.3.1.8 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/Classificacao/<id>
3.3.1.9 Parâmetros de Entrada
Campo | Tipo | Descrição |
Id | string - Obrigatório |
|
3.3.1.10 Parâmetros de Saída
Campo | Tipo | Descrição |
Id | Decimal |
|
Departamento | String |
|
Secao | String |
|
Grupo | String |
|
Subgrupo | String |
|
Categoria | String |
|
idExterno | Decimal |
|
idPai | Decimal |
|
Descricao | String |
|
3.3.1.11 Pré-Condição
O sistema a consumir este serviço deve ter permissão para utilizá-lo.
3.3.1.12 Pós-Condição
Não se aplica.
3.3.1.13 Sem Disponibilidade
Contate o Administrador.
3.3.1.14 Exemplo de Requisição
3.3.2 Cliente
3.3.2.1 POST - http://<ip-do-servidor>:<porta>/RMSServices/api/Cliente
3.3.2.2 Parâmetros de Entrada
Campo | Tipo | Descrição |
cgcCpf | Int64 - Obrigatório |
|
razaosocial | String |
|
endereco | String |
|
bairro | String |
|
cidade | String |
|
estado | String |
|
cep | Int64 |
|
dataCadastro | DateTime |
|
datafatura | DateTime |
|
inscricaoEstadual | String |
|
filler | String |
|
3.3.2.3
3.3.2.4 Parâmetros de Saída
A API retornará um Response Code 200 se o cliente for inserido com sucesso.
3.3.2.5 Pré-Condição
O sistema a consumir este serviço deve ter permissão para utilizá-lo.
3.3.2.6 Pós-Condição
Não se aplica.
3.3.2.7 Sem Disponibilidade
Contate o Administrador.
3.3.3 EstoquePreco
3.3.3.1 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/Estoquepreco?id=<id>&filialid=<filialid>
3.3.3.2 Parâmetros de Entrada
Campo | Tipo | Descrição |
id | int - Obrigatório | Código RMS do produto |
filialid | int - Obrigatório | Código da Filial |
3.3.3.3
3.3.3.4 Parâmetros de Saída
Campo | Tipo | Descrição |
QuantidadeEstoque | Decimal |
|
Preco | Decimal |
|
PrecoPromocao | Decimal |
|
InicioPromocao | DateTime |
|
FimPromocao | DateTime |
|
produtoid | String |
|
filialid | int |
|
3.3.3.5 Pré-Condição
O sistema a consumir este serviço deve ter permissão para utilizá-lo.
3.3.3.6 Pós-Condição
Não se aplica.
3.3.3.7 Sem Disponibilidade
Contate o Administrador.
3.3.4 PedidoAux
3.3.4.1 POST - http://<ip-do-servidor>:<porta>/RMSServices/api/PedidoAux
3.3.4.2 Parâmetros de Entrada
Campo | Tipo | Descrição |
idPedido | Int64 - Obrigatório |
|
idPedidoLoja | Int64 - Obrigatório |
|
idClienteLoja | Int64 - Obrigatório |
|
valorTotal | Decimal - Obrigatório |
|
ValorMercadoria | Decimal - Obrigatório |
|
ValorDesconto | Decimal - Obrigatório |
|
ValorFrete | Decimal - Obrigatório |
|
Data | DateTIme - Obrigatório |
|
FormaEntrega | Int64 - Obrigatório |
|
DataEntrega | DateTime - Obrigatório |
|
observacaoPedido | String - Obrigatório |
|
EnderecoEntrega | String- Obrigatório |
|
NumeroEntrega | Int32 - Obrigatório |
|
ComplementoEntrega | String – Obrigatório |
|
BairroEntrega | String – Obrigatório |
|
CidadeEntrega | String - Obrigatório |
|
EstadoEntrega | String - Obrigatório |
|
CepEntrega | Int32 - Obrigatório |
|
PaisEntrega | String - Obrigatório |
|
FormaPagamento | Int64 - Obrigatório |
|
FilialOrigem | Int32 - Obrigatório |
|
FilialVenda | Int32 - Obrigatório |
|
CodigoVendedorRms | Int32 - Obrigatório |
|
CodigoAgenda | Int32 - Obrigatório |
|
AgendamentoEntrega | Int32 - Obrigatório |
|
FlagWeb | Int32 - Obrigatório |
|
DiasAgenda | Int32 - Obrigatório |
|
CifFob | Int32 - Obrigatório |
|
PercentualDesconto | Decimal - Obrigatório |
|
CgcCpf | Int64 - Obrigatório |
|
Rg | String - Obrigatório |
|
CondicaoPagamento | Int32 - Obrigatório |
|
RetiraEntrega | Int32 - Obrigatório |
|
formaPgtoDescricao | String - Obrigatório |
|
formaEntregaDescricao | String - Obrigatório |
|
NomeSistema | String - Obrigatório |
|
ConfirmacaoAutomatica | Int32 - Obrigatório |
|
HoraEntregaInicio | Int32 - Obrigatório |
|
HoraEntregaFim | Int32 - Obrigatório |
|
ObservacaoEntrega | String - Obrigatório |
|
Transportadora | Int32 - Obrigatório |
|
RazaoSocial | String - Obrigatório |
|
InscricaoEstadual | String - Obrigatório |
|
Ddd | Int32 - Obrigatório |
|
Telefone | Int64 - Obrigatório |
|
TipoPessoa | String - Obrigatório |
|
String - Obrigatório |
| |
GpsEntrega | String - Obrigatório |
|
GpsCobranca | String - Obrigatório |
|
statusIntegracao | Int64 - Obrigatório |
|
PercentualMargem | Decimal - Obrigatório |
|
Peso | Double - Obrigatório |
|
Volume | Double - Obrigatório |
|
Itens | List<ItemPedidoAux> - Obrigatório |
|
3.3.4.2.1 ItemPedidoAux
Campo | Tipo | Descrição |
idPedidoAux | Int64 - Obrigatório |
|
idPedidoLoja | Int64 - Obrigatório |
|
idItemPedidoloja | Int64 - Obrigatório |
|
idProdutoLoja | Int64 - Obrigatório |
|
idProdutoRms | Int32 - Obrigatório |
|
valorUnitario | Decimal - Obrigatório |
|
descontoUnitario | Decimal - Obrigatório |
|
valorTotal | Decimal - Obrigatório |
|
presente | Int32 - Obrigatório |
|
quantidade | Double - Obrigatório |
|
comentario | String - Obrigatório |
|
peso | Double - Obrigatório |
|
margem | Decimal - Obrigatório |
|
ean | Int64 - Obrigatório |
|
3.3.4.3 Parâmetros de Saída
Campo | Tipo | Descrição |
status | Boolean | Indicador de sucesso da operação
|
mensagem | String | Mensagem informativa sobre a operação. |
3.3.4.4 Pré-Condição
O sistema a consumir este serviço deve ter permissão para utilizá-lo.
3.3.4.5 Pós-Condição
O Pedido não será mostrado no RMS até que tenha uma atualização do mesmo via PUT informando que o status do pedido é igual a 2.
3.3.4.6 Sem Disponibilidade
Contate o Administrador.
3.3.4.7 PUT- http://<ip-do-servidor>:<porta>/RMSServices/api/PedidoAux
3.3.4.8 Parâmetros de Entrada
Campo | Tipo | Descrição |
idPedido | Int64 - Obrigatório |
|
idPedidoLoja | Int64 - Obrigatório |
|
idClienteLoja | Int64 - Obrigatório |
|
valorTotal | Decimal - Obrigatório |
|
ValorMercadoria | Decimal - Obrigatório |
|
ValorDesconto | Decimal - Obrigatório |
|
ValorFrete | Decimal - Obrigatório |
|
Data | DateTIme - Obrigatório |
|
FormaEntrega | Int64 - Obrigatório |
|
DataEntrega | DateTime - Obrigatório |
|
observacaoPedido | String - Obrigatório |
|
EnderecoEntrega | String - Obrigatório |
|
NumeroEntrega | Int32 - Obrigatório |
|
ComplementoEntrega | String - Obrigatório |
|
BairroEntrega | String - Obrigatório |
|
CidadeEntrega | String - Obrigatório |
|
EstadoEntrega | String - Obrigatório |
|
CepEntrega | Int32 - Obrigatório |
|
PaisEntrega | String - Obrigatório |
|
FormaPagamento | Int64 - Obrigatório |
|
FilialOrigem | Int32 - Obrigatório |
|
FilialVenda | Int32 - Obrigatório |
|
CodigoVendedorRms | Int32 - Obrigatório |
|
CodigoAgenda | Int32 - Obrigatório |
|
AgendamentoEntrega | Int32 - Obrigatório |
|
FlagWeb | Int32 - Obrigatório |
|
DiasAgenda | Int32 - Obrigatório |
|
CifFob | Int32 - Obrigatório |
|
PercentualDesconto | Decimal - Obrigatório |
|
CgcCpf | Int64 - Obrigatório |
|
Rg | String - Obrigatório |
|
CondicaoPagamento | Int32 - Obrigatório |
|
RetiraEntrega | Int32 - Obrigatório |
|
formaPgtoDescricao | String - Obrigatório |
|
formaEntregaDescricao | String - Obrigatório |
|
NomeSistema | String - Obrigatório |
|
ConfirmacaoAutomatica | Int32 - Obrigatório |
|
HoraEntregaInicio | Int32 - Obrigatório |
|
HoraEntregaFim | Int32 - Obrigatório |
|
ObservacaoEntrega | String - Obrigatório |
|
Transportadora | Int32 - Obrigatório |
|
RazaoSocial | String - Obrigatório |
|
InscricaoEstadual | String - Obrigatório |
|
Ddd | Int32 - Obrigatório |
|
Telefone | Int64 - Obrigatório |
|
TipoPessoa | String - Obrigatório |
|
String - Obrigatório |
| |
GpsEntrega | String - Obrigatório |
|
GpsCobranca | String - Obrigatório |
|
statusIntegracao | Int64 - Obrigatório |
|
PercentualMargem | Decimal - Obrigatório |
|
Peso | Double - Obrigatório |
|
Volume | Double - Obrigatório |
|
Itens | List<ItemPedidoAux> - Obrigatório |
|
3.3.4.9 itemPedidoAux
Campo | Tipo | Descrição |
idPedidoAux | Int64 - Obrigatório |
|
idPedidoLoja | Int64 - Obrigatório |
|
idItemPedidoloja | Int64 - Obrigatório |
|
idProdutoLoja | Int64 - Obrigatório |
|
idProdutoRms | Int32 - Obrigatório |
|
valorUnitario | Decimal - Obrigatório |
|
descontoUnitario | Decimal - Obrigatório |
|
valorTotal | Decimal - Obrigatório |
|
presente | Int32 - Obrigatório |
|
quantidade | Double - Obrigatório |
|
comentario | String - Obrigatório |
|
peso | Double - Obrigatório |
|
margem | Decimal - Obrigatório |
|
ean | Int64 - Obrigatório |
|
3.3.4.10 Parâmetros de Saída
Campo | Tipo | Descrição |
status | Boolean | Indicador de sucesso da operação. |
mensagem | String | Mensagem informativa sobre a operação. |
3.3.4.11 Pré-Condição
Não se aplica.
3.3.4.12 Pós-Condição
Não se aplica.
3.3.4.13 Sem Disponibilidade
Contate o Administrador.
3.3.4.14 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/Produto
3.3.4.15 Parâmetros de Entrada
Campo | Tipo | Descrição |
categoria_id | long | Retorna os produtos da categoria referente. |
3.3.4.16
3.3.4.17 Parâmetros de Saída
Campo | Tipo | Descrição |
Codigo | Int64 |
|
Digito | Int64 |
|
Ean | String |
|
Departamento | Int64 |
|
Secao | Int64 |
|
Grupo | Int64 |
|
SubGrupo | Int64 |
|
Categoria | Int64 |
|
Descricao | String |
|
DescricaoReduzida | String |
|
DescricaoComercial | String |
|
DescricaoWeb | String |
|
DataEntradaLinha | DateTime |
|
CodigoPai | Int64 |
|
Peso | decimal |
|
TipoProduto | Int64 |
|
EmbalagemVenda | String |
|
Gramatura | Decimal |
|
TipoGramatura | String |
|
Marca | String |
|
AlturaEmbalagemvenda | decimal |
|
LarguraEmbalagemVenda | decimal |
|
ComprimentoEmbalagemVenda | decimal |
|
CodigoCor | String |
|
Tamanho | String |
|
Cor | String |
|
idClassificacaoExterna | Decimal |
|
idExternoClassificacao | Decimal |
|
idVinculo | Decimal |
|
3.3.4.18 Pré-Condição
Não se aplica.
3.3.4.19 Pós-Condição
Não se aplica.
3.3.4.20 Sem Disponibilidade
Contate o Administrador.
3.3.4.21 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/Produto/<id>
3.3.4.22 Parâmetros de Entrada
Campo | Tipo | Descrição |
Id | Int - Obrigatório | Código RMS do produto |
3.3.4.23 Parâmetros de Saída
Campo | Tipo | Descrição |
Codigo | Int64 |
|
Digito | Int64 |
|
Ean | String |
|
Departamento | Int64 |
|
Secao | Int64 |
|
Grupo | Int64 |
|
SubGrupo | Int64 |
|
Categoria | Int64 |
|
Descricao | String |
|
DescricaoReduzida | String |
|
DescricaoComercial | String |
|
DescricaoWeb | String |
|
DataEntradaLinha | DateTime |
|
CodigoPai | Int64 |
|
Peso | decimal |
|
TipoProduto | Int64 |
|
EmbalagemVenda | String |
|
Gramatura | Decimal |
|
TipoGramatura | String |
|
Marca | String |
|
AlturaEmbalagemvenda | decimal |
|
LarguraEmbalagemVenda | decimal |
|
ComprimentoEmbalagemVenda | decimal |
|
CodigoCor | String |
|
Tamanho | String |
|
Cor | String |
|
idClassificacaoExterna | Decimal |
|
idExternoClassificacao | Decimal |
|
idVinculo | Decimal |
|
3.3.4.24 Pré-Condição
Não se aplica.
3.3.4.25 Pós-Condição
Não se aplica.
3.3.4.26 Sem Disponibilidade
Contate o Administrador.
Conteúdos Relacionados:
Links dos principais conceitos e processos.
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas