1. Objetivo
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.
2. Campo de Aplicação
Governança de Serviços.
3. Serviço
3.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.
3.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.
3.3 Protocolo do Serviço
Interno e externo: REST API
3.4 URL do Serviço
http://<ip-do-servidor>:<porta>/RMSServices/api/<nome-do-metodo>
4. Capacidades
4.1 Descrição
# | Capacidade | Descrição |
|---|
1 | | GET - GetAllClassificacao – Retorna uma lista de classificações mercadológicas do de-para usando vários filtros. GET - GetListaClassificacao – Retorna uma lista de classificações mercadológicas reduzida (não traz a relação de-para). POST - PostClassificacao – Insere uma associação de classificação mercadológica no de-para. PUT - PutClassificacao – Altera uma associação de classificação mercadológica do de-para. DELETE - DeleteClassificacao – Apaga uma associação de classificação mercadológica do de-para. | 2 | | GET - GetEstoquePreco – Retorna um objeto estoquepreco referente ao código do produto e filial passados via querystring. | 3 | PedidoAux | GET/id - GetPedido – Retorna um pedido. GET - GetAllPedido– Retorna uma lista de pedidos reduzidos. POST - PostPedido – Recebe um objeto pedido para salvar no banco. PUT - PutPedido – Recebe um objeto pedido para atualizar no banco. | 4 | | GET - GetProduto – Lista todos os produtos. GET/id - GetProduto – Retorna um produto de acordo com o código RMS. |
4.2 Filtros padrões da API
Campo | Tipo | Descrição |
|---|
limit | int | Quantidade (máxima) de registros retornados. Através deste parâmetro o limite pode ser alterado para o número de registros desejados. | 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. |
4.3 Serviços
4.3.1 Classificação
4.3.1.1 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/Classificacao/GetAllClassificacao 4.3.1.2 Parâmetros de Entrada | Campo | Tipo | Descrição |
|---|
| in_crs_id | Number – Opcional | Id da classificação de ligação | | in_idclassificacao | Number – Opcional | Id da classificação | | in_idexterno | Number – Opcional | Id externo | | in_idpai | Number – Opcional | Id da classificação pai (se existir) | | in_descricao | string – Opcional | Nome da classificação | | in_Departamento | Number(3) – Opcional | Código do departamento | | in_Secao | Number(3) – Opcional | Código da seção | | in_Grupo | Number(3) – Opcional | Código do grupo | | in_SubGrupo | Number(3) – Opcional | Código do subgrupo | | in_Categoria | Number(3) – Opcional | Código da categoria |
4.3.1.3 Parâmetros de Saída Campo | Tipo | Descrição |
|---|
| Crs_Id | Number | Id da classificação de ligação | IDClassificacao | Number | Id da classificação | Departamento | Number | Código do departamento | Secao | Number | Código da seção | Grupo | Number | Código do grupo | Subgrupo | Number | Código do subgrupo | Categoria | Number | Código da categoria | IDExterno | Number | Id externo | | Situacao | Number | Situação: 0 - inativo, 1 - ativo | IDPai | Number | Id da classificação pai (se existir) | Descricao | Varchar2(255) | Nome da classificação |
4.3.1.4 Pré-Condição
O sistema a consumir este serviço deve ter permissão para utilizá-lo. 4.3.1.5 Pós-Condição Não se aplica. 4.3.1.6 Sem Disponibilidade
Contate o Administrador.
4.3.1.7 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/Classificacao/GetListaClassificacao 4.3.1.8 Parâmetros de Entrada Não se aplica. 4.3.1.9 Parâmetros de Saída Campo | Tipo | Descrição |
|---|
IdClassificacao | Number | Id da classificação | Descricao | Varchar2(255) | Nome da classificação |
4.3.1.10 Pré-Condição O sistema a consumir este serviço deve ter permissão para utilizá-lo. 4.3.1.11 Pós-Condição
Não se aplica. 4.3.1.12 Sem Disponibilidade
Contate o Administrador.
4.3.1.13 POST - http://<ip-do-servidor>:<porta>/RMSServices/api/Classificacao/PostClassificacao 4.3.1.14 Parâmetros de Entrada Campo | Tipo | Descrição |
|---|
| Crs_Id | Number – Opcional | Id da classificação de ligação (não usado na inclusão) | | IDClassificacao | Number – Obrigatório | Id da classificação | | Departamento | Number(3) – Obrigatório | Código do departamento | | Secao | Number(3) – Obrigatório | Código da seção | | Grupo | Number(3) – Obrigatório | Código do grupo | | Subgrupo | Number(3) – Obrigatório | Código do subgrupo | | Categoria | Number(3) – Obrigatório | Código da categoria | | IDExterno | Number – Opcional | Id externo (não usado na inclusão) | | Situacao | Number(1) – Opcional | Situação: 0 - inativo, 1 - ativo (não usado na inclusão) | | IDPai | Number – Opcional | Id da classificação pai (se existir) (não usado na inclusão) | | Descricao | Varchar2(255) – Opcional | Nome da classificação (não usado na inclusão) |
4.3.1.15 Parâmetros de Saída Não se aplica. 4.3.1.16 Pré-Condição O sistema a consumir este serviço deve ter permissão para utilizá-lo. A classificação mercadológica já deve estar cadastrada. 4.3.1.17 Pós-Condição
Não se aplica. 4.3.1.18 Sem Disponibilidade
Contate o Administrador.
4.3.1.19 PUT - http://<ip-do-servidor>:<porta>/RMSServices/api/Classificacao/PutClassificacao 4.3.1.20 Parâmetros de Entrada Campo | Tipo | Descrição |
|---|
| Crs_Id | Number – Obrigatório | Id da classificação de ligação | | IDClassificacao | Number – Opcional | Id da classificação (não usado na atualização) | | Departamento | Number(3) – Obrigatório | Código do departamento | | Secao | Number(3) – Obrigatório | Código da seção | | Grupo | Number(3) – Obrigatório | Código do grupo | | Subgrupo | Number(3) – Obrigatório | Código do subgrupo | | Categoria | Number(3) – Obrigatório | Código da categoria | | IDExterno | Number – Obrigatório | Id externo (não usado na inclusão) | | Situacao | Number(1) – Opcional | Situação: 0 - inativo, 1 - ativo (não usado na atualização) | | IDPai | Number – Opcional | Id da classificação pai (se existir) (não usado na atualização) | | Descricao | Varchar2(255) – Opcional | Nome da classificação (não usado na atualização) |
4.3.1.21 Parâmetros de Saída Não se aplica. 4.3.1.22 Pré-Condição O sistema a consumir este serviço deve ter permissão para utilizá-lo. O de-para da classificação mercadológica já deve estar cadastrado. 4.3.1.23 Pós-Condição
Não se aplica. 4.3.1.24 Sem Disponibilidade
Contate o Administrador.
4.3.1.25 DELETE- http://<ip-do-servidor>:<porta>/RMSServices/api/Classificacao/DeleteClassificacao/<id> 4.3.1.26 Parâmetros de Entrada Campo | Tipo | Descrição |
|---|
| in_crs_id | Number | Id da classificação de ligação |
4.3.1.27 Parâmetros de Saída Não se aplica. 4.3.1.28 Pré-Condição O sistema a consumir este serviço deve ter permissão para utilizá-lo. O de-para da classificação mercadológica já deve estar cadastrado.
4.3.1.29 Pós-Condição
Não se aplica. 4.3.1.30 Sem Disponibilidade
Contate o Administrador.
4.3.2 EstoquePreco
4.3.2.1 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/Estoquepreco/GetEstoquePreco/<id>?filialOrigem=<filialOrigem>&filialVenda=<filialVenda> 4.3.2.2 Parâmetros de Entrada Campo | Tipo | Descrição |
|---|
id | Number(8) - Obrigatório | Código RMS do produto com dígito | filialOrigem | Number(8) - Obrigatório | Código da Filial de origem com dígito | | filialVenda | Number(8) - Obrigatório | Código da Filial de venda com dígito |
4.3.2.3 Parâmetros de Saída Campo | Tipo | Descrição |
|---|
QuantidadeEstoque | Decimal | Quantidade disponível para venda | Preco | Decimal | Preço unitário | PrecoPromocao | Decimal | Preço de promoção (0,00 se não existir) | InicioPromocao | DateTime | Data de início (se existir) - yyyy-MM-ddTHH:mm:ss | FimPromocao | DateTime | Data final (se existir) - yyyy-MM-ddTHH:mm:ss | IDproduto | String | Id do produto | IDfilial | int | Id da filial |
4.3.2.4 Pré-Condição
O sistema a consumir este serviço deve ter permissão para utilizá-lo.
4.3.2.5 Pós-Condição
Não se aplica. 4.3.2.6 Sem Disponibilidade
Contate o Administrador.
4.3.3 PedidoAux
4.3.3.1 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/PedidoAux/GetPedido?codigoPedido=<CodigoPedido>&codigoPedidoLoja=<CodigoPedidoLoja>
4.3.3.2 Parâmetros de Entrada Campo | Tipo | Descrição |
|---|
| codigoPedido | Number – Opcional | Código do pedido aux | | codigoPedidoLoja | Number – Opcional | Código do pedido na loja |
4.3.3.3 Parâmetros de Saída
Campo | Tipo | Descrição |
|---|
IDPedido | Number | Id do pedidoAux | IDPedidoLoja | Number(8) | Id do pedido na loja | IDClienteLoja | Number | Id do cliente na loja | ValorTotal | Decimal | Valor total = valor total + frete - desconto | ValorMercadoria | Decimal | Valor do pedido sem frete -> valor do pedido sem frete e sem desconto | ValorDesconto | Decimal | Valor de desconto. | ValorFrete | Decimal | Valor do frete | Data | DateTime | Data de realização do pedido - yyyy-MM-ddTHH:mm:ss | FormaEntrega | Number | Id da forma de entrega | DataEntrega | DateTime | Data de entrega - yyyy-MM-ddTHH:mm:ss | ObservacaoPedido | Varchar2(60) | Observações do pedido | EnderecoEntrega | Varchar2(40) | Endereço de entrega | NumeroEntrega | Number(10) | Número de entrega | ComplementoEntrega | Varchar2(20) | Complemento do endereço de entrega | BairroEntrega | Varchar2(20) | Bairro de entrega | | IDCidadeEntrega | Number(8) | Código IBGE da cidade de entrega | CidadeEntrega | Varchar2(20) | Cidade de entrega | EstadoEntrega | Varchar2(2) | UF | CepEntrega | Number(9) | Cep | PaisEntrega | Varchar2(3) | País (BRA) | FormaPagamento | Number | Id da forma de pagamento | FilialOrigem | Number(8) | Id da filial de origem | FilialVenda | Number(8) | Id da filial de venda | CodigoVendedorRms | Number(8) | Id do vendedor padrão | CodigoAgenda | Number | id da agenda do lojista | AgendamentoEntrega | Number | Id do agendamento de retirada da logística | FlagWeb | Number(1) | Pedido feito pela Web (sempre 1 para pedidos web) | DiasAgenda | Number(2) | Quantidade de dias definido pela agenda | CifFob | Number(1) | 1 – CIF; 2 – FOB | PercentualDesconto | Decimal | Percentual do desconto | CgcCpf | Number(17) | CPF/CNPJ do cliente | Rg | Varchar2(20) | RG do cliente | CondicaoPagamento | Number(3) | Condição de pagamento | RetiraEntrega | Number(1) | 0 - Retira; 1 - Entrega | FormaPgtoDescricao | Varchar2(40) | Descrição da forma de pagamento | FormaEntregaDescricao | Varchar2(40) | Descrição da forma de entrega | NomeSistema | Varchar2(30) | Nome do sistema | ConfirmacaoAutomatica | Number(1) | 0 - Status suspenso; 1 - Status cadastrado (não mais utilizado, sempre será cadastrado) | HoraEntregaInicio | Number(6) | Horário de entrega inicial | HoraEntregaFim | Number(6) | Horário de entrega final | ObservacaoEntrega | Varchar2(1000) | Observação da entrega | Transportadora | Number(8) | Id da transportadora | RazaoSocial | Varchar2(40) | Nome do cliente | InscricaoEstadual | Varchar2(25) | Inscrição estadual | Ddd | Number(4) | DDD do telefone do cliente | Telefone | Number(10) | Telefone do cliente | TipoPessoa | Varchar2(1) | F - Física; J - Jurídica | Email | Varchar2(100) | E-mail do cliente | GpsEntrega | Varchar2(40) | Código GPS do endereço de entrega | GpsCobranca | Varchar2(40) | Código GPS do endereço de cobrança | StatusIntegracao | Number(1) | 0 – Em processo de integração; 1 - Integrado com sucesso; 2 – Aguardando liberação. Gerado automaticamente pela aplicação | PercentualMargem | Decimal | Percentual da margem de lucro | Peso | Decimal | Peso total dos produtos | Volume | Double | Volume total dos produtos | Itens | List<ItemPedidoAux> | Lista de produtos do pedido |
4.3.3.3.1 ItemPedidoAux Campo | Tipo | Descrição |
|---|
IDPedidoAux | Number – Obrigatório | Id do pedido aux | IDPedidoLoja | Number – Obrigatório | Id do pedido na loja | IDItemPedidoloja | Number – Obrigatório | Id do item no pedido da loja | IDProdutoLoja | Number – Obrigatório | Id do produto na loja | IDProdutoRms | Number(8) – Obrigatório | Id do produto no RMS com o dígito | ValorUnitario | Decimal – Obrigatório | Valor unitário | DescontoUnitario | Decimal – Obrigatório | Desconto do produto (individual) | ValorTotal | Decimal – Obrigatório | Valor total dos itens -> ((vlUntario-vlDescontoUnitario)*Quantidade) | Presente | Number(1) – Obrigatório | Embalar item para presente 0 – Não; 1 – Sim | Quantidade | Number(10,3) – Obrigatório | Quantidade de itens solicitado pelo cliente | Comentario | Varchar2(100) – Opcional | Comentários | Peso | Numver(9,3) – Obrigatório | Peso do item | Margem | Decimal – Obrigatório | Percentual da margem de lucro do item | Ean | Number(14) – Obrigatório | EAN do produto |
4.3.3.4 Pré-Condição
O sistema a consumir este serviço deve ter permissão para utilizá-lo. 4.3.3.5 Pós-Condição
Não se aplica. 4.3.3.6 Sem Disponibilidade
Contate o Administrador.
4.3.3.7 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/PedidoAux/GetAllPedido
4.3.3.8 Parâmetros de Entrada Não se aplica. 4.3.3.9 Parâmetros de Saída Campo | Tipo | Descrição |
|---|
| IdPedidoAux | Number | Id do pedidoAux | | IdPedidoRMS | Number(7) | Id do pedido no RMS | | IdPedidoLoja | Number(8) | Id do pedido na loja | | Data | DateTime | Data de realização do pedido - yyyy-MM-ddTHH:mm:ss | | Status | Number(1) | 0 – Pronto para integração; 1 - Integrado com sucesso; 2 – Aguardando liberação. Gerado automaticamente pela aplicação |
4.3.3.10 Pré-Condição
O sistema a consumir este serviço deve ter permissão para utilizá-lo. 4.3.3.11 Pós-Condição
Não se aplica. 4.3.3.12 Sem Disponibilidade
Contate o Administrador. 4.3.3.13 POST - http://<ip-do-servidor>:<porta>/RMSServices/api/PedidoAux/PostPedido
4.3.3.14 Parâmetros de Entrada
Campo | Tipo | Descrição |
|---|
IDPedido | Number – Automático | Id do pedidoAux. Gerado automaticamente pela aplicação | IDPedidoLoja | Number(8) – Obrigatório | Id do pedido na loja | IDClienteLoja | Number – Obrigatório | Id do cliente na loja | ValorTotal | Decimal – Obrigatório | Valor total = valor total + frete - desconto | ValorMercadoria | Decimal – Obrigatório | Valor do pedido sem frete -> valor do pedido sem frete e sem desconto | ValorDesconto | Decimal – Obrigatório | Valor de desconto. Caso exista, o valor deverá ser positivo | ValorFrete | Decimal – Obrigatório | Valor do frete | Data | DateTime – Obrigatório | Data de realização do pedido - yyyy-MM-ddTHH:mm:ss | FormaEntrega | Number – Obrigatório | Id da forma de entrega | DataEntrega | DateTime – Obrigatório | Data de entrega - yyyy-MM-ddTHH:mm:ss | ObservacaoPedido | Varchar2(60) – Opcional | Observações do pedido. Caso vazia, será 'loja eletronica' | EnderecoEntrega | Varchar2(40) – Obrigatório | Endereço de entrega | NumeroEntrega | Number(10) – Obrigatório | Número de entrega | ComplementoEntrega | Varchar2(20) – Obrigatório | Complemento do endereço de entrega | BairroEntrega | Varchar2(20) – Obrigatório | Bairro de entrega | | IDCidadeEntrega | Number(8) – Obrigatório | Código IBGE da cidade de entrega | CidadeEntrega | Varchar2(20) – Obrigatório | Cidade de entrega | EstadoEntrega | Varchar2(2) – Obrigatório | UF | CepEntrega | Number(9) – Obrigatório | Cep | PaisEntrega | Varchar2(3) – Obrigatório | País (BRA) | FormaPagamento | Number – Obrigatório | Id da forma de pagamento | FilialOrigem | Number(8) – Obrigatório | Id da filial de origem | FilialVenda | Number(8) – Obrigatório | Id da filial de venda | CodigoVendedorRms | Number(8) – Obrigatório | Id do vendedor padrão | CodigoAgenda | Number – Obrigatório | ID da de agenda do lojista | AgendamentoEntrega | Number – Obrigatório | Id do agendamento de retirada da logística | FlagWeb | Number(1) – Obrigatório | Pedido feito pela Web | DiasAgenda | Number(2) – Obrigatório | Quantidade de dias definido pela agenda | CifFob | Number(1) – Obrigatório | 1 – CIF; 2 – FOB | PercentualDesconto | Decimal – Obrigatório | Percentual do desconto | CgcCpf | Number(17) – Obrigatório | CPF/CNPJ do cliente | Rg | Varchar2(20) – Obrigatório | RG do cliente | CondicaoPagamento | Number(3) – Obrigatório | Condição de pagamento | RetiraEntrega | Number(1) – Obrigatório | 0 - Retira; 1 - Entrega | FormaPgtoDescricao | Varchar2(40) – Obrigatório | Descrição da forma de pagamento | FormaEntregaDescricao | Varchar2(40) – Obrigatório | Descrição da forma de entrega | NomeSistema | Varchar2(30) – Obrigatório | Nome do sistema | ConfirmacaoAutomatica | Number(1) – Obrigatório | 0 - Status suspenso; 1 - Status cadastrado | HoraEntregaInicio | Number(6) – Obrigatório | Horário de entrega inicial | HoraEntregaFim | Number(6) – Obrigatório | Horário de entrega final | ObservacaoEntrega | Varchar2(1000) – Obrigatório | Observação da entrega | Transportadora | Number(8) – Obrigatório | Id da transportadora | RazaoSocial | Varchar2(40) – Obrigatório | Nome do cliente | InscricaoEstadual | Varchar2(25) – Obrigatório | Inscrição estadual | Ddd | Number(4) – Obrigatório | DDD do telefone do cliente | Telefone | Number(10) – Obrigatório | Telefone do cliente | TipoPessoa | Varchar2(1) – Obrigatório | F - Física; J - Jurídica | Email | Varchar2(100) – Obrigatório | E-mail do cliente | GpsEntrega | Varchar2(40) – Opcional | Código GPS do endereço de entrega | GpsCobranca | Varchar2(40) – Opcional | Código GPS do endereço de cobrança | StatusIntegracao | Number(1) – Automático | 0 – Pronto para integração; 1 - Integrado com sucesso; 2 – Aguardando liberação. Gerado automaticamente pela aplicação | PercentualMargem | Decimal – Obrigatório | Percentual da margem de lucro | Peso | Decimal – Obrigatório | Peso total dos produtos | Volume | Double – Obrigatório | Volume total dos produtos | Itens | List<ItemPedidoAux> – Obrigatório | Lista de produtos do pedido |
4.3.3.14.1 ItemPedidoAux Campo | Tipo | Descrição |
|---|
IDPedidoAux | Number – Obrigatório | Id do pedido aux | IDPedidoLoja | Number – Obrigatório | Id do pedido na loja | IDItemPedidoloja | Number – Obrigatório | Id do item no pedido da loja | IDProdutoLoja | Number – Obrigatório | Id do produto na loja | IDProdutoRms | Number(8) – Obrigatório | Id do produto no RMS com o dígito | ValorUnitario | Decimal – Obrigatório | Valor unitário | DescontoUnitario | Decimal – Obrigatório | Desconto do produto (individual) | ValorTotal | Decimal – Obrigatório | Valor total dos itens -> ((vlUntario-vlDescontoUnitario)*Quantidade) | Presente | Number(1) – Obrigatório | Embalar item para presente 0 – Não; 1 – Sim | Quantidade | Number(10,3) – Obrigatório | Quantidade de itens solicitado pelo cliente | Comentario | Varchar2(100) – Opcional | Comentários | Peso | Numver(9,3) – Obrigatório | Peso do item | Margem | Decimal – Obrigatório | Percentual da margem de lucro do item | Ean | Number(14) – Obrigatório | EAN do produto |
4.3.3.15 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. |
4.3.3.16 Pré-Condição
O sistema a consumir este serviço deve ter permissão para utilizá-lo. 4.3.3.17 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. 4.3.3.18 Sem Disponibilidade
Contate o Administrador.
4.3.3.19 PUT- http://<ip-do-servidor>:<porta>/RMSServices/api/PedidoAux/PutPedido
4.3.3.20 Parâmetros de Entrada
Campo | Tipo | Descrição |
|---|
idPedido | Number – Automático | Id do pedidoAux. Gerado automaticamente pela aplicação | idPedidoLoja | Number(8) – Obrigatório | Id do pedido na loja | idClienteLoja | Number – Obrigatório | Id do cliente na loja | valorTotal | Decimal – Obrigatório | Valor total = valor total + frete - desconto | ValorMercadoria | Decimal – Obrigatório | Valor do pedido sem frete -> valor do pedido sem frete e sem desconto | ValorDesconto | Decimal – Obrigatório | Valor de desconto. Caso exista, o valor deverá ser positivo | ValorFrete | Decimal – Obrigatório | Valor do frete | Data | DateTime – Obrigatório | Data de realização do pedido - yyyy-MM-ddTHH:mm:ss | FormaEntrega | Number – Obrigatório | Id da forma de entrega | DataEntrega | DateTime – Obrigatório | Data de entrega - yyyy-MM-ddTHH:mm:ss | observacaoPedido | Varchar2(60) – Opcional | Observações do pedido. Caso vazia, será 'loja eletronica' | EnderecoEntrega | Varchar2(40) – Obrigatório | Endereço de entrega | NumeroEntrega | Varchar2(10) – Obrigatório | Número de entrega | ComplementoEntrega | Varchar2(20) – Obrigatório | Complemento do endereço de entrega | BairroEntrega | Varchar2(20) – Obrigatório | Bairro de entrega | | IDCidadeEntrega | Number(8) – Obrigatório | Código IBGE da cidade de entrega | CidadeEntrega | Varchar2(20) – Obrigatório | Cidade de entrega | EstadoEntrega | Varchar2(2) – Obrigatório | UF | CepEntrega | Number(9) – Obrigatório | Cep | PaisEntrega | Varchar2(3) – Obrigatório | País (BRA) | FormaPagamento | Number – Obrigatório | Id da forma de pagamento | FilialOrigem | Number(8) – Obrigatório | Id da filial de origem | FilialVenda | Number(8) – Obrigatório | Id da filial de venda | CodigoVendedorRms | Number(8) – Obrigatório | Id do vendedor padrão | CodigoAgenda | Number – Obrigatório | Id da de agenda do lojista | AgendamentoEntrega | Number – Obrigatório | Id do agendamento de retirada da logística | FlagWeb | Number(1) – Obrigatório | Pedido feito pela Web | DiasAgenda | Number(2) – Obrigatório | Quantidade de dias definido pela agenda | CifFob | Number(1) – Obrigatório | 1 – CIF; 2 – FOB | PercentualDesconto | Decimal – Obrigatório | Percentual do desconto | CgcCpf | Number(17) – Obrigatório | CPF/CNPJ do cliente | Rg | Varchar2(20) – Obrigatório | RG do cliente | CondicaoPagamento | Number(3) – Obrigatório | Condição de pagamento | RetiraEntrega | Number(1) – Obrigatório | 0 - Retira; 1 - Entrega | formaPgtoDescricao | Varchar2(40) – Obrigatório | Descrição da forma de pagamento | formaEntregaDescricao | Varchar2(40) – Obrigatório | Descrição da forma de entrega | NomeSistema | Varchar2(30) – Obrigatório | Nome do sistema | ConfirmacaoAutomatica | Number(1) – Obrigatório | 0 - Status suspenso; 1 - Status cadastrado | HoraEntregaInicio | Number(6) – Obrigatório | Horário de entrega inicial | HoraEntregaFim | Number(6) – Obrigatório | Horário de entrega final | ObservacaoEntrega | Varchar2(1000) – Obrigatório | Observação da entrega | Transportadora | Number(8) – Obrigatório | Id da transportadora | RazaoSocial | Varchar2(40) – Obrigatório | Nome do cliente | InscricaoEstadual | Varchar2(25) – Obrigatório | Inscrição estadual | Ddd | Number(4) – Obrigatório | DDD do telefone do cliente | Telefone | Number(10) – Obrigatório | Telefone do cliente | TipoPessoa | Varchar2(1) – Obrigatório | F - Física; J - Jurídica | Email | Varchar2(100) – Obrigatório | E-mail do cliente | GpsEntrega | Varchar2(40) – Opcional | Código GPS do endereço de entrega | GpsCobranca | Varchar2(40) – Opcional | Código GPS do endereço de cobrança | statusIntegracao | Number(1) – Automático | 0 – Pronto para integração; 1 - Integrado com sucesso; 2 – Aguardando liberação. Gerado automaticamente pela aplicação | PercentualMargem | Decimal – Obrigatório | Percentual da margem de lucro | Peso | Decimal – Obrigatório | Peso total dos produtos | Volume | Double – Obrigatório | Volume total dos produtos | Itens | List<ItemPedidoAux> – Obrigatório | Lista de produtos do pedido |
4.3.3.21 itemPedidoAux Campo | Tipo | Descrição |
|---|
idPedidoAux | Number – Obrigatório | Id do pedido aux | idPedidoLoja | Number – Obrigatório | Id do pedido na loja | idItemPedidoloja | Number – Obrigatório | Id do item no pedido da loja | idProdutoLoja | Number – Obrigatório | Id do produto na loja | idProdutoRms | Number(8) – Obrigatório | Id do produto no RMS com o dígito | valorUnitario | Decimal – Obrigatório | Valor unitário | descontoUnitario | Decimal – Obrigatório | Desconto do produto (individual) | valorTotal | Decimal – Obrigatório | Valor total dos itens -> ((vlUntario-vlDescontoUnitario)*Quantidade) | presente | Number(1) – Obrigatório | Embalar item para presente 0 – Não; 1 – Sim | quantidade | Number(10,3) – Obrigatório | Quantidade de itens solicitado pelo cliente | comentario | Varchar2(100) – Opcional | Comentários | peso | Numver(9,3) – Obrigatório | Peso do item | margem | Decimal – Obrigatório | Percentual da margem de lucro do item | ean | Number(14) – Obrigatório | EAN do produto |
4.3.3.22 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. 4.3.3.23 Pré-Condição
Não se aplica. 4.3.3.24 Pós-Condição
Não se aplica. 4.3.3.25 Sem Disponibilidade
Contate o Administrador.
4.3.3.26 DELETE-http://<ip-do-servidor>:<porta>/RMSServices/api/PedidoAux/DeletePedido 4.3.3.27 Parâmetros de Entrada Campo | Tipo | Descrição |
|---|
idPedido | Number – Obrigatório | Id do pedidoAux. | idPedidoLoja | Number(8) – Obrigatório | Id do pedido na loja | idClienteLoja | Number – Opcional | Id do cliente na loja | valorTotal | Decimal – Opcional | Valor total = valor total + frete - desconto | ValorMercadoria | Decimal – Opcional | Valor do pedido sem frete -> valor do pedido sem frete e sem desconto | ValorDesconto | Decimal – Opcional | Valor de desconto | ValorFrete | Decimal – Opcional | Valor do frete | Data | DateTime – Opcional | Data de realização do pedido - yyyy-MM-ddTHH:mm:ss | FormaEntrega | Number – Opcional | Id da forma de entrega | DataEntrega | DateTime – Opcional | Data de entrega - yyyy-MM-ddTHH:mm:ss | observacaoPedido | Varchar2(60) – Opcional | Observações do pedido. Caso vazia, será 'loja eletronica' | EnderecoEntrega | Varchar2(40) – Opcional | Endereço de entrega | NumeroEntrega | Varchar2(10) – Opcional | Número de entrega | ComplementoEntrega | Varchar2(20) – Opcional | Complemento do endereço de entrega | BairroEntrega | Varchar2(20) – Opcional | Bairro de entrega | | IDCidadeEntrega | Number(8) – Opcional | Código IBGE da cidade de entrega | CidadeEntrega | Varchar2(20) – Opcional | Cidade de entrega | EstadoEntrega | Varchar2(2) – Opcional | UF | CepEntrega | Number(9) – Opcional | Cep | PaisEntrega | Varchar2(3) – Opcional | País (BRA) | FormaPagamento | Number – Opcional | Id da forma de pagamento | FilialOrigem | Number(8) – Opcional | Id da filial de origem | FilialVenda | Number(8) – Opcional | Id da filial de venda | CodigoVendedorRms | Number(8) – Opcional | Id do vendedor padrão | CodigoAgenda | Number – Opcional | Id da de agenda do lojista | AgendamentoEntrega | Number – Opcional | Id do agendamento de retirada da logística | FlagWeb | Number(1) – Opcional | Pedido feito pela Web | DiasAgenda | Number(2) – Opcional | Quantidade de dias definido pela agenda | CifFob | Number(1) – Opcional | 1 – CIF; 2 – FOB | PercentualDesconto | Decimal – Opcional | Percentual do desconto | CgcCpf | Number(17) – Opcional | CPF/CNPJ do cliente | Rg | Varchar2(20) – Opcional | RG do cliente | CondicaoPagamento | Number(3) – Opcional | Condição de pagamento | RetiraEntrega | Number(1) – Opcional | 0 - Retira; 1 - Entrega | formaPgtoDescricao | Varchar2(40) – Opcional | Descrição da forma de pagamento | formaEntregaDescricao | Varchar2(40) – Opcional | Descrição da forma de entrega | NomeSistema | Varchar2(30) – Opcional | Nome do sistema | ConfirmacaoAutomatica | Number(1) – Opcional | 0 - Status suspenso; 1 - Status cadastrado | HoraEntregaInicio | Number(6) – Opcional | Horário de entrega inicial | HoraEntregaFim | Number(6) – Opcional | Horário de entrega final | ObservacaoEntrega | Varchar2(1000) – Opcional | Observação da entrega | Transportadora | Number(8) – Opcional | Id da transportadora | RazaoSocial | Varchar2(40) – Opcional | Nome do cliente | InscricaoEstadual | Varchar2(25) – Opcional | Inscrição estadual | Ddd | Number(4) – Opcional | DDD do telefone do cliente | Telefone | Number(10) – Opcional | Telefone do cliente | TipoPessoa | Varchar2(1) – Opcional | F - Física; J - Jurídica | Email | Varchar2(100) – Opcional | E-mail do cliente | GpsEntrega | Varchar2(40) – Opcional | Código GPS do endereço de entrega | GpsCobranca | Varchar2(40) – Opcional | Código GPS do endereço de cobrança | statusIntegracao | Number(1) – Opcional | 0 – Pronto para integração; 1 - Integrado com sucesso; 2 – Aguardando liberação. Gerado automaticamente pela aplicação | PercentualMargem | Decimal – Opcional | Percentual da margem de lucro | Peso | Decimal – Opcional | Peso total dos produtos | Volume | Double – Opcional | Volume total dos produtos | Itens | List<ItemPedidoAux> – Opcional | Lista de produtos do pedido |
4.3.3.27.1 itemPedidoAux Campo | Tipo | Descrição |
|---|
idPedidoAux | Number – Obrigatório | Id do pedido aux | idPedidoLoja | Number – Obrigatório | Id do pedido na loja | idItemPedidoloja | Number – Obrigatório | Id do item no pedido da loja | idProdutoLoja | Number – Obrigatório | Id do produto na loja | idProdutoRms | Number(8) – Obrigatório | Id do produto no RMS com o dígito | valorUnitario | Decimal – Obrigatório | Valor unitário | descontoUnitario | Decimal – Obrigatório | Desconto do produto (individual) | valorTotal | Decimal – Obrigatório | Valor total dos itens -> ((vlUntario-vlDescontoUnitario)*Quantidade) | presente | Number(1) – Obrigatório | Embalar item para presente 0 – Não; 1 – Sim | quantidade | Number(10,3) – Obrigatório | Quantidade de itens solicitado pelo cliente | comentario | Varchar2(100) – Opcional | Comentários | peso | Numver(9,3) – Obrigatório | Peso do item | margem | Decimal – Obrigatório | Percentual da margem de lucro do item | ean | Number(14) – Obrigatório | EAN do produto |
4.3.3.28 Parâmetros de Saída Não se aplica. 4.3.3.29 Pré-Condição O sistema a consumir este serviço deve ter permissão para utilizá-lo. O de-para da classificação mercadológica já deve estar cadastrado. 4.3.3.30 Pós-Condição
Não se aplica. 4.3.3.31 Sem Disponibilidade
Contate o Administrador.
4.3.4 Produto
4.3.4.1 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/Produto/GetProduto
4.3.4.2 Parâmetros de Entrada
Campo | Tipo | Descrição |
|---|
categoria_id | long | Retorna os produtos da classificação referente. | codigo | Number | Código do produto. Não é mais utilizado. |
4.3.4.3 Parâmetros de Saída
Campo | Tipo | Descrição |
|---|
Codigo | Number(7) | Id do produto (sem o dígito) | Digito | Number(1) | Dígito | Ean | Varchar2(13) | Ean | Departamento | Number(3) | Código do departamento | Secao | Number(3) | Código da seção | Grupo | Number(3) | Código do grupo | SubGrupo | Number(3) | Código do subgrupo | Categoria | Number(3) | Código da categoria | Descricao | Varchar2(40) | Nome | DescricaoReduzida | Varchar2(22) | Nome reduzido | DescricaoComercial | Varchar2(30) | Nome comercial | DescricaoWeb | String | Nome para a loja web | DataEntradaLinha | DateTime | Data que o produto entrou em linha - yyyy-MM-ddTHH:mm:ss | CodigoPai | Number(8) | Id do produto pai | Peso | decimal | Peso | TipoProduto | Number(2) | Tipo do produto | EmbalagemVenda | Varchar2(2) | Tipo de embalagem de venda | Gramatura | Decimal | Gramatura de venda | TipoGramatura | Varchar2(2) | Tipo de medida do produto | Marca | Varchar2(20) | Marca | AlturaEmbalagemvenda | decimal | Altura do produto | LarguraEmbalagemVenda | decimal | Largura do produto | ComprimentoEmbalagemVenda | decimal | Comprimento do produto | CodigoCor | Varchar2(3) | Id da Cor | Tamanho | Varchar2(4) | Tamanho do produto | Cor | Varchar2(3) | Nome da cor | idClassificacaoExterna | Number | Id da classificação externa | idExternoClassificacao | Number | Id da classificação na loja web | idVinculo | Number | Vínculo inicial do produto (“Avô”, se houver) | PaisClassificacao | Varchar2 | Não utilizado |
4.3.4.4 Pré-Condição
Não se aplica.
4.3.4.5 Pós-Condição
Não se aplica.
4.3.4.6 Sem Disponibilidade
Contate o Administrador.
4.3.4.7 GET - http://<ip-do-servidor>:<porta>/RMSServices/api/Produto/GetProduto/<id> 4.3.4.8 Parâmetros de Entrada Campo | Tipo | Descrição |
|---|
Id | Number(8)- Obrigatório | Código RMS do produto com dígito |
4.3.4.9 Parâmetros de Saída Campo | Tipo | Descrição |
|---|
Codigo | Number(7) | Id do produto (sem o dígito) | Digito | Number(1) | Dígito | Ean | Varchar2(13) | Ean | Departamento | Number(3) | Código do departamento | Secao | Number(3) | Código da seção | Grupo | Number(3) | Código do grupo | SubGrupo | Number(3) | Código do subgrupo | Categoria | Number(3) | Código da categoria | Descricao | Varchar2(40) | Nome | DescricaoReduzida | Varchar2(22) | Nome reduzido | DescricaoComercial | Varchar2(30) | Nome comercial | DescricaoWeb | String | Nome para a loja web | DataEntradaLinha | DateTime | Data que o produto entrou em linha - yyyy-MM-ddTHH:mm:ss | CodigoPai | Number(8) | Id do produto pai | Peso | decimal | Peso | TipoProduto | Number(2) | Tipo do produto | EmbalagemVenda | Varchar2(2) | Tipo de embalagem de venda | Gramatura | Decimal | Gramatura de venda | TipoGramatura | Varchar2(2) | Tipo de medida do produto | Marca | Varchar2(20) | Marca | AlturaEmbalagemvenda | decimal | Altura do produto | LarguraEmbalagemVenda | decimal | Largura do produto | ComprimentoEmbalagemVenda | decimal | Comprimento do produto | CodigoCor | Varchar2(3) | Id da Cor | Tamanho | Varchar2(4) | Tamanho do produto | Cor | Varchar2(3) | Nome da cor | idClassificacaoExterna | Number | Id da classificação externa | idExternoClassificacao | Number | Id da classificação na loja web | idVinculo | Number | Vínculo inicial do produto (“Avô”, se houver) | PaisClassificacao | Varchar2 | Não utilizado |
4.3.4.10 Pré-Condição
Não se aplica.
4.3.4.11 Pós-Condição
Não se aplica.
4.3.4.12 Sem Disponibilidade
Contate o Administrador.
| 
