Integração Web Services

Voltar

Introdução ao Web Services

 

Web Service é uma solução utilizada na integração de sistemas e na comunicação entre aplicações diferentes. Com esta tecnologia é possível que novas aplicações possam interagir com aquelas que já existem e que sistemas desenvolvidos em plataformas diferentes sejam compatíveis. Os Web Services são componentes que permitem às aplicações enviar e receber dados em formato XML (Extensible Markup Language). Cada aplicação pode ter a sua própria “linguagem”, que é traduzida para uma linguagem universal, o formato XML.

Para as empresas, os Web Services podem trazer agilidade para os processos e eficiência na comunicação entre cadeias de produção ou de logística. Toda e qualquer comunicação entre sistemas passa a ser dinâmica e principalmente segura, pois não há intervenção humana.

Utilizando a tecnologia Web Service, uma aplicação pode invocar outra para efetuar tarefas simples ou complexas mesmo que as duas aplicações estejam em diferentes sistemas e escritas em linguagens diferentes. Por outras palavras, os Web Services fazem com que os seus recursos estejam disponíveis para que qualquer aplicação cliente possa operar e extrair os recursos fornecidos pelo Web Service.

objetivo dos Web Services é a comunicação de aplicações através da Internet. Esta comunicação é realizada com intuito de facilitar a integração entre as aplicações de uma empresa, ou seja, a interoperabilidade entre as informações que trafegam entre dois pontos nas diferentes aplicações como, por exemplo, o comércio eletrônico com clientes e fornecedores. Outro objetivo é definir um workflow entre as aplicações e constituir uma alternativa aos ERP (Enterprise Resource Planning). Com um workflow é possível otimizar, controlar processos e tarefas de uma determinada organização.

 

 

Apresentação do manual

 

Este manual apresenta um padrão para a troca de informações entre a plataforma de e-commerce da e-Commerce Store® e o ERP de seu cliente. Baseado nas informações necessárias para a implementação de cada tipo de serviço / produto, o padrão define um conjunto de registros/campos compõem os Web Services de integração.

 

 

Fluxograma geral das informações

 

O fluxo de informações abaixo mostra uma visão geral de como será realizado a troca de informações entre as empresas:

webserv_01

Onde:

  1. Aplicação e-Commerce Store®: sistema e-commerce
  2. Soap message: comunicação entre os sistemas. SOAP (Simple Object Access Protocol) baseia-se numa chamada remota de um método e para tal necessita especificar o endereço do componente, o nome do método e os argumentos para esse método.
  3. WS e-Commerce Store: utilizado para a troca dos dados.
  4. Serviços: serviço do cliente que vai receber ou retornar dados.
  5. HTTP: utilizado para transportar de dados.

Aplicação Cliente: sistemas ERP ou serviço de integração.

 

 

Definições dos Web Services

 

Para os layouts abaixo definidos, aplicam-se as seguintes convenções:

 

  1. Para campos do tipo “Decimal”, o tamanho exibe a quantidade de caracteres que podem ser enviados como números inteiros, e a quantidade de caracteres que podem ser enviados como decimais:
    Por exemplo:            15,4 – significa 15 inteiros e 4 decimais;
  2. Os campos que possuem valores pré-definidos, apresentam esses valores na coluna “Descrição”;
  3. Os Web Services que recebem alguma informação normalmente retornam um valor “Boolean”, indicando se o registro foi recebido e processado com sucesso (retorna “True”) ou não (retorna “False”). Alguns deles podem retornar outros valores, como o Id do item cadastrado.

 

 

Integração do Produto

 

Para os layouts abaixo definidos, aplicam-se as seguintes convenções:

  1. Para campos do tipo “Decimal”, o tamanho exibe a quantidade de caracteres que podem ser enviados como números inteiros, e a quantidade de caracteres que podem ser enviados como decimais:
    Por exemplo:         15,4 – significa 15 inteiros e 4 decimais.
  2. Os campos que possuem valores pré-definidos, apresentam esses valores na coluna “Descrição”.
  3. Os Web Services que recebem alguma informação normalmente retornam um valor “Boolean”, indicando se o registro foi recebido e processado com sucesso (retorna “True”) ou não (retorna “False”). Alguns deles podem retornar outros valores, como o Id do item cadastrado.

Integração do Produto Cenário 1

Neste cenário temos os produtos e seus respectivos atributos. No exemplo abaixo, os três produtos são apresentados separadamente no resultado da busca.

 

webserv_02

 

Nesta situação não existe variações de produtos, ao informar o produto não deve ser informado o idPai e nem o idVinculo, conforme demostrado na tabela abaixo:

 

idRetornadoKUNomeidPaiidVinculo
1680Anel em Ouro Amarelo com Granada e Diamantesnullnull
2681Anel de Ouro com Granada e Diamantesnullnull
3685Anel Coração com Granada Verde e Diamantesnullnull

 

Na visualização de cada produto são apresentados os seus atributos:

 

webserv_03
O exemplo acima representa um produto com um único sku e vários atributos, ou seja vários tamanhos de aros diferentes para o mesmo produto.

Abaixo demostramos como deverá ser retornado o conteúdo das tabelas segundo o exemplo acima.

 

webserv_04

Integração do Produto Cenário 2

Neste cenário temos os produtos e suas variações.  No resultado da busca é apresentado apenas o produto principal (idPai = null), independente das suas variações e atributos.

 

webserv_05
Nesta situação existem variações de produtos. Ao informar o produto principal, o idPai deve ser null, assim como o idVinculo.

As variações dos produtos serão cadastradas referenciando o produto principal como sendo o idPai, conforme demostrado na tabela abaixo:

 

idRetornadoSKUNomeIdPaiidVinculo
1Lentes de Contato EXPRESSIONS COLORSnullnull
2122Lentes de Contato EXPRESSIONS COLORS - Azul1null
3123Lentes de Contato EXPRESSIONS COLORS - Cinza1null
424Lentes de Contato EXPRESSIONS COLORS - Verde1null
525Lentes de Contato EXPRESSIONS COLORS - Pure hazel1null

 

Na visualização do produto são apresentadas as suas variações de cores.

 

webserv_06
O exemplo acima é representado por um produto principal (idPai) que contém 4 variações de cores, cada cor possui um sku diferente.

Abaixo demostramos como deverá ser retornado o conteúdo das tabelas segundo o exemplo acima.

 

webserv_07

 

Integração do Produto Cenário 3

Neste cenário temos variações de produtos e grupo de produtos na visualização do produto.

No resultado da busca é apresentado apenas o produto principal (idPai = null), independente dos seus atributos.

 

webserv_08
Nesta situação existem variações de produtos. Ao informar o produto principal, o idPai deve ser null e o idVinculo deve ser informado.  As variações dos produtos serão cadastradas referenciando o produto principal como sendo o idPai e o grupo vinculado (idVinculo), conforme demonstrado na tabela abaixo:

 

idRetornadoSKUNomeidPaiidVinculo
1Tênis Converse All Star Star Player Ev Ox Rosanull55159
2122Tênis Converse All Star Star Player Ev Ox Rosa – Tamanho 33155159
3122Tênis Converse All Star Star Player Ev Ox Rosa – Cor Rosa155159

 

Na visualização do produto são apresentados os seus atributos de tamanho e outros produtos pertencentes ao mesmo grupo.

 

webserv_09
O exemplo acima é representado por um produto principal (idPai) que contem inúmeras variações de tamanhos, cada tamanho possui um sku diferente.

Abaixo demostramos como deverá ser retornado o conteudo das tabelas segundo o exemplo acima.

 

webserv_10

 

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
SKUCódigo interno do produtoString50X
CodigoProdutoVinculoRedirectCódigo para realizar direcionamento de URL. String100
Exemplo:redirecionamento URL site antigo para URL site novo
OBS.:Caso o cliente já tenha loja virtual é obrigatório o preenchimento deste campo
IdPaiId do produto que vincula os variantes, caso haja variantes.Long-
·                      Se IdPai for informado os dados do mesmo serão atualizados.
IdVinculoId do produto que vincula os diversos produtos variantesLong-
Exemplo: Produto A ; cor preta ; tamanho : 36 e 38
Produto B : cor branca ; tamanho 36 e 38
NomeNome do produtoString100X
PrecoCustoPreço de custoDecimal15.4X
PrecoDePreço normalDecimal15.4X
PrecoPorPreço promocional, caso haja. Se não houver, deve ser igual ao PrecoDeDecimal15.4X
PrazoEntregaPrazo de entrega em diasInt-
FreteGratis1 = SempreInt-X
2 = Nunca
3 = Neutro (produto que não possui uma regra fixa, ele varia de acordo com a regra geral do site – exemplo: valor mínimo do pedido).
TrocaGratisSe o produto possui troca grátis ou nãoBoolean-X
EstoqueFisicoQuantidade de estoque físico Int-X
PesoPeso produtoDouble-
AlturaAltura produtoDouble-
ComprimentoComprimento do produtoDouble-
LarguraLargura produtoDouble-
DataCriacaoData cadastro produtoDateTime-
DataAtualizacaoData alteração produtoDateTime-
GarantiaGarantia em meses de um determinado produto.Int-
FabricanteNomeNome do fabricanteString100
AutorCaso o produto seja livro ou algo do gênero.String100
EditoraCaso o produto seja livro ou algo do gênero.String100
ColecaoCaso o produto seja livro ou algo do gênero.String100
IsTelevendas Venda somente por telefone Boolean-

 

Integração dos Atributos do Produto

Através deste mesmo Web Service, podem ser enviados cada um dos atributos dos produtos cadastrados.

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
PedidoProdutoIdDeve receber sempre zero, utilizado para vincular o valor do atributo com o produto do pedido. ( não utilizar - campo interno )Int-
NomeNome do atributo, descrevendo a unidade (exemplo: “Tamanho – ml”)String2000X
ValorO valor do atributo, sem unidade de medida (exemplo:”100”, para 100 ml)String2000X
Tipo1 – SelecaoInt
2 – Filtro
3 – Comparacao
ExibirAtributoMarca se o atributo é exibido no siteBoolean-
VariacaoPrecoCaso haja variação no preço desse atributo, adicionar a diferença nesse campo.Decimal15.4

 

Integração das Informações do Produto

Através deste mesmo Web Service, podem ser enviadas as informações relevantes ao produto.

Obs.: Sempre deve-se enviar todas as informações e não somente as que deseja atualizar / inserir.

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TipoInformacaoProdIdO tipo da informação sendo cadastrada , identificada pelo código a seguirInt-X
1- Informações
2- Benefícios
3- Especificações
4- Dados Técnicos
5- Composição
6- Modo de Usar
7- Cuidados
8- Itens Inclusos
9- Dicas
10- Vídeo
11- Descrição
12- Valor Referente
13- PopUp Referente
TituloO título da informação.String200X
TextoO conteúdo da informação, que pode ser formatado em HTML. String8000X

 

Retorno: Boolean onde true = produto inserido com sucesso!

 

 

Atualização de Produto Preço

 

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncProdutoPreco.asmx) – Update

Neste Web Service devem ser enviadas as atualizações sobre o preço de cada produto.

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
SKUCódigo interno do produtoString50X
PrecoCustoPreço de custoDecimal15.4X
PrecoDePreço normalDecimal15.4X
PrecoPorPreço promocional, caso haja. Se não houver, deve ser igual ao PrecoDeDecimal15.4X

 

Retorno: Boolean onde true =  preço produto atualizado com sucesso!

 

 

Atualização de Produto Estoque

 

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncProdutoEstoque.asmx) –  Update

 

Neste Web Service devem ser enviadas as atualizações sobre o saldo disponível de cada produto no estoque.

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
SKUCódigo interno do produtoString50X
SaldoDisponivelSaldo disponível do produto em estoqueInt-X


Retorno:
Boolean onde true =  saldo disponível atualizado com sucesso!

 

 

Cadastro de Imagens De Produtos

 

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncProdutoImagem.asmx)  –  Insert

 

Neste Web Service são cadastradas as imagens dos produtos. Elas devem ser enviadas na maior resolução possível, para serem redimensionadas e exibidas no site. As imagens devem ser convertidas em uma string de base 64bits para serem enviadas ao serviço.

 

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
SKUSKU do produto que a imagem se refereString60X
imagemBase64Imagem convertida em texto 64 bitsString-X
imagemFormatoFormato que a imagem estava antes de convertida (exemplo: jpeg, bmp, gif, png)String-X
isPrincipalSe é a imagem principal do produtoBoolean-X

 

Retorno: Boolean onde true = foto cadastrada com sucesso!

 

Exclusão de Imagens de Produtos

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncProdutoImagem.asmx) – SyncClear

Apaga todas as fotos cadastradas para um produto.

 

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
SKUSKU do produto variante cadastradoString50X

 

Retorno: Boolean onde true = foto excluída com sucesso!

 

 

Atualização de Estoque

 

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncEstoque.asmx) – Update

Neste Web Service devem ser enviadas as atualizações sobre o estoque de cada produto. Apenas as informações fornecidas são atualizadas, as demais são mantidas como estão no sistema.

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
SKUSKU do produto variante cadastrado.Long-X
SaldoDisponivelSe o produto está disponível para venda Int-

 

Retorno: Boolean onde true = estoque sincronizado com sucesso!

 

 

Pedidos Realizados No Site

 

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncPedidoVenda.asmx) – GetItemsToSync

Este Web Service disponibiliza uma lista com os pedidos realizados no site e que ainda não foram integrados ao ERP. Sendo a estrutura dividida em três partes:

Parâmetro:

 

CampoSignificadoTipoTamanhoObrigatório
TokenChave de acesso ao web.serviceString-X

 

Retorno: lista com 20 itens, onde temos:

  1. Informações do pedido;
    • Informações do cliente;
      • Informações de newsletter;
    • Lista dos produtos;
      • Lista de informações dos produtos;
      • Lista de serviços dos produtos;
    • Lista de informações de pagamento;
    • Informações de assinatura;

 

1.      - Informações do pedido    
CampoDescriçãoTipoTamanhoObrigatório
PedidoIdNúmero do pedidoLong-X
UsuarioIdId do usuário que realizou o pedidoLong-X
DataPedidoData que foi realizado o pedidoDateTime-X
NomeDestinoNome do destinatárioString100X
EnderecoEndereço de entregaString200X
NumeroNúmero do endereço de entregaString20X
ComplementoDescrição do complemento de entregaString100X
BairroDescrição do BairroString50X
CidadeDescrição da CidadeString50X
EstadoDescrição da UFString2X
CepCep de entrega pedidoString10X
RGRg do compradorString50
ParcelasNumero de parcelas Boleto ou CartãoInt
ValorFreteValor do frete total para o ClienteDecimal15.4X
ValorFreteEmpresaValor do frete total para a EmpresaDecimal15.4
TransportadoraFreteId da TransportadoraInt-X
ValorPedidoValor total do pedidoDecimal15.4X
IpEndereço IP do computador que efetuou o pedido.String-
PrazoEnvioPrazo de envio do pedidoInt-
LinhaDigitalBoletoLinha digitavel do boletoString-
CodigoDeBarrasBoletoCodigo de Barras do BoletoString-
NumeroCupomDescontoNúmero do cupom vale presente, caso tenha sido usadoString50
ValorCupomDescontoValor do cupom vale presente, caso exista.Decimal15.4
Status do Pedido, conforme código abaixo
1. Pago
2. Aguardando Liberação
3. Cartão Temporariamente Negado
4. Cartão Negado
5. Fraude
6. Suspeito de Fraude
7. Boleto Expirado
8. Cancelado
Status9. Enviadoint-
10. Liberado
11. Faturado - Nota fiscal emitida
13. Documentos Para Compra (Analise de Risco)
14. Pedido Aprovado Analise
15. Recebido (Produto encomendado chega ao estoque)
16. Separado (Produto exite em estoque)
17. Encomendado (Produto não exite em estoque)
18. Entregue
Continuação do Status19. Aguardando Troca de Pagamento (Aguardando Alteração de Forma de Pagamento)
20. Pedido Conferido
SubtotalValor do pedido sem juros ou freteDecimal15.4
ValorJurosSe a compra foi feita com juros, apresenta o valor dos jurosDecimal15.4
ValorParcelasValor de cada parcela, se a compra foi parceladaDecimal15.4
ValorServicosValor dos serviços dos itens do pedido.Decimal15.4
ParceiroIdId do parceiro pelo qual feito a compra.Int
TabelaPrecoIdId da tabela de preço ao qual o preço se refere.Int
PedidoIdMarketplacePedidoId do MarketPlaceString
CanalMarketplaceCanal Market Place do PedidoString
MarketplaceCanalPedidoIdPedidoId do Canal MarketPlaceString
RetiradaLojaIdEm casos de pedidos feitos com opção de retirada na loja esse campo virá preenchido com o Id da retirada na lojaint
DataPagamentoData de Pagamento do PedidoDateTime
DataCancelamentoData de cancelamento do pedidoDateTime

 

 

1.1    Informações do cliente         
CampoDescriçãoTipoTamanhoObrigatório
UsuarioIdId do usuário que realizou o pedido.Int-X
EcommerceIdIdentifica em qual site o cliente está cadastrado, se houver apenas um é 1Int-X
TipoPessoaId1 - FísicaInt-X
2 – Jurídica
OrigemContatoId1 - GoogleInt-
2 - Bing
3 - Jornal
4 - Patrocínio Esportivo
5 - Recomendação de alguém
6 - Revista
7 - Site na Internet
8 - Televisão
9 – Outro
EnderecoResidencialIdId do endereço residencialInt-
EnderecoEntregaIdId do endereço de entrega selecionadoInt-
TipoSexoId1 - MasculinoInt-
2 – Feminino
FormaPagamentoId1-BoletoInt-
2-PayPal
3-Visa
4-MasterCard
5-American Express
6-Diners
7-Aura
8-Hipercard
9-Google Checkout
10-ELO
11-Deposito Bancario
12-Moip
13-Créditos VP
14-Discover
15-Mercado Pago
16-Promocao
17-FastCash – Deposito
18-FastCash – Transferencia
19-FastCash – Financiamento
99-Pagamento Marketplace Extra
TipoPreferenciaUsuarioIdCorresponde à ordenação padrão utilizada no site como preferência do usuário:Int-
0 – Indefinido
1 - Marcas
2 - Preços
3 - Mais Vendidos
NomeNome do usuárioString100X
CPFCPF do usuárioString20
EmailEmail usuárioString100X
RGRG usuárioString12
OrgaoEmissorOrgão emissorString-
NomeMaeNome da mãeString-
TelefoneResidencialNúmero do telefone residencialString20
TelefoneCelularNúmero do telefone celularString20
TelefoneComercialNúmero do telefone comercialString20
DataNascimentoData de nascimento obrigatório para pagamento de pedido com cartão de crédito.DateTime-
RazaoSocialRazão social do usuário, campo obrigatório para pedidos de pessoa Jurídica.String100
CNPJCNPJ do usuário, campo obrigatório para pedidos de pessoa Jurídica.String20
InscricaoEstadualInscrição Estadual usuário.String20
ResponsavelNome da pessoa resposável pela pessoa jurídicaString100
DataCriacaoData de cadastro usuárioDateTime-X
DataAtualizacaoData de alteração usuário sistemaDateTime-
EnderecoEndereço usuárioString200
NumeroNúmero endereço usuárioString20
ComplementoComplemento endereço usuárioString100
BairroBairro usuárioString50
CidadeCidade usuárioString50
EstadoEstado usuárioString2
CEPCEP usuárioString10
ParceiroIDId do parceiro pelo qual feito a compra.Int-

 

 

1.1.1               Informações de newsletter ( não mapeado na classe )     
CampoDescriçãoTipoTamanhoObrigatório
IntegracaoNewsletterIdNúmero de referência do cadastro de newsletterInt-
UsuarioIdId do usuário que realizou o pedidoInt-
NomeNome do usuárioString100
EmailEmail usuárioString100
DataCadastroData de cadastro do usuário na newsletterDatetime-
StatusStatus do cadastro.Boolean-
Sexo1 - MasculinoString100
2 – Feminino
DoubleOptInValidoxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxBoolean-
DataAceitacaoOptInData que o usuário aceitou o envio de newsletterDatetime-
IPAceitacaoOptInIp da máquina no usuário quando aceitou o envio de newsletterString100

 

 

1.1    Lista de produtos     
CampoDescriçãoTipoTamanhoObrigatório
PedidoIdId do pedidoLong-X
ProdutoVarianteIdId do produtolong-X
ComboSe o produto fizer parte de um combo de produtoslong-
SKUSKU do ProdutoString50X
NomeNome do ProdutoString100X
DescricaoDescrição do produto String100
PesoUnitarioPeso de cada unidade do produtoDouble-
PesoTotalPeso do produtoDouble-
PrecoUnitarioPreço de cada unidade do produtoDecimal15.4
Preco_VendaPreço do produtoDecimal15.4
PrecoRateadoRateio do frete com o desconto-
ValorJurosValor de juros do item, caso existaDecimal15.4
DataCriacaoData de criação do pedidoDatetime-
DataAtualizacaoData da última atualização nesse item do pedidoDatetime-
ProdutoQuantidadeQuantidade itens compradosInt-X
UrlImagemCaminho da imagem do produtoString-
TipoSe é um produto principal (Pai) ou um dos variantes ( Filho)String-
PedidoProdutoIdId do Produto neste pedidoLong-
BrindeInforma se o produto é brindeBoolean-X

 

 

1.1.1               Lista de atributos dos produtos    
CampoDescriçãoTipoTamanhoObrigatório
NomeNome do atributoString2000X
ValorValor selecionado do atributoString2000X

 

 

1.1.1               Lista de serviços do produto    
CampoDescriçãoTipoTamanhoObrigatório
ServicoIdId do serviçoInt-
DescricaoDecrição do serviço vinculadoString1000
DescricaoPrecoDecrição do preço do serviço vinculadoDecimal15.4
IdPrecoId do preçoInt-
NomeNome do serviço vinculadoString1000
PrecoServicoPreço do serviço vinculadoDecimal15.4
PrecoServicoTotalPreço total do serviço vinculado (quantidade * total)Decimal15.4
PedidoProdutoIdId do produtoInt-
PedidoProdutoAconteceServicoIdId do serviço vinculado ao produtoInt-
QuantidadeQuantidade de serviços compradosInt-
TempoTempo do serviço vinculado ao produtoString-
ValidadorValidador do serviço vinculadoString-
ContratoGarantiaAceito do contrato do serviçoString-

 

 

1.1    Lista de informações de pagamento    
CampoDescriçãoTipoTamanhoObrigatório
NSUNSU do PagamentoString-
NumeroAutorizacaoPagamentoNumero de Autorização do pagamentoString-
DataAutorizacaoPagamentoData de Autorização do PagamentoDateTime-
DataUltimoStatusData do Ultimo status de PagamentoDateTime-
AdquirenteAdquirente do PagamentoDecimal15.4

 

 

1.1    Informações de assinatura    
CampoDescriçãoTipoTamanhoObrigatório
PedidoIdId do pedidoInt-
AssinaturaIdId da assinaturaInt-
GrupoAssinaturaIdId do grupo da assinaturaInt-
GrupoAssinaturaNomeNome do grupo da assianturaString50
TipoPeriodoTipo do período da assinatura (semanal, quinzenal ou mensal)String25
TempoPeriodoTempo do período da assinatura Int-
PercentualDescontoPercentual de desconto recebido pelo usuárioDecimal15.4

 

 

 

Confirmação de Pedidos

 

A confirmação de pedidos pode ser feito através de duas formas de WebServices, o primeiro se refere a sincronização por pedido e o segundo por lista de pedidos.

Por Pedido

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncPedidoVenda.asmx) – Complete

Através deste Web Service, ocorre a confirmação da sincronização dos pedidos. Isso fará com que esse pedido não seja disponibilizado novamente no Web Service “Pedidos realizados no site”.

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos webservicesString-X
PedidoIdId do pedido sincronizadoLong-X

 

Retorno: Boolean onde true = pedido sincronizado com sucesso!

Por Lista de Pedidos

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncPedidoVenda.asmx) – CompleteBatch

Esse WebService tem a mesma funcionalidade que o Metodo ‘Complete’ A diferença é que enquanto o método ‘Complete’ recebe apenas um PedidoId, esse Método recebe uma lista de pedidosId

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos webservicesString-X
pedidoIdArrayLista de Ids dos pedidos sincronizadosLong[]-X

 

Retorno: Boolean onde true = pedido sincronizado com sucesso!

 

 

Atualização de Status de Pedido

 

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncPedidoStatus.asmx) – UpdateStatus

Através deste Web Service, devem ser enviados as alterações nos status dos pedidos. Esses status serão atualizados no site e exibidos aos clientes.

Parâmetros:

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
PedidoIdNúmero do pedidoLong-X
ProdutoVarianteIdNúmero do produto variante Long-
QuantidadeQuantidade do itemInt-
SituacaoPedidoIdCódigo da situação do pedido:Int-X
1 -Pago
2 -Aguardando Liberação
3 -Cartão Temporariamente Negado
4 -Cartão Negado
5 -Fraude
6 -Suspeito de Fraude
7 -Boleto Expirado
8 -Cancelado
9 -Enviado
10 -Liberado
11 -Faturado - Nota fiscal emitida
RastreamentoCódigo de rastreamento do pedidoString50X
DataEventoData baixa pedido financeiroDateTime-
NumeroNotaFiscal Número nota fiscalString60
ChaveAcessoNFEChave de acesso a notal fiscal eletrônicaString50
UrlNFEUrl da nota fiscal eletrônicaString100
SerieNFESérie da notal fiscal eletrônicaString100
UrlRastreamentoLink de rastreamento do pedidoString300

 

Sendo que:

  1. Se estes itens não forem enviados o rastreamento será marcado para todo o Pedido.
  2. Se produtoVarianteId for enviado, o rastreamento será marcado para um dos produtos do item.
  3. Se produtoVarianteId e Quantidade forem enviados, o rastreamento será marcado para a quantidade de produtos do item.

Retorno: Boolean onde true = status alterado com sucesso!

 

4.8.1 Atualização de Status do Pedido Delete Rastreamento

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncPedidoStatus.asmx) – DeleteRastreamento

Através Deste Web Service, podem ser deletados os códigos de rastreamento do pedido para nova inserção ou correção. Esses status serão   atualizados no site e exibidos aos clientes.

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
PedidoIdNúmero do pedidoLongX

 

Atualização de Status do Pedido Select Status

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncPedidoStatus.asmx) – SelectStatus

Este Deste Web Service retornar uma lista de status de um determinado pedido, informado como parâmetro.

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
PedidoIdNúmero do pedidoLongX

 

Retorno: Lista de Status do pedido!

Atualização de Status do Pedido Select Status All

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncPedidoStatus.asmx) – SelectStatusAll

Este WebService retorna os 20 últimos pedidos com seus status. Necessita do Complete.

 Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X

 

Retorno: Lista de 20 pedidos e seus respectivos status!

 

Atualização de Status do Pedido Complete

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncPedidoStatus.asmx) – Complete

Este Deste Web marca uma determinada lista de status de pedido como integrada

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
PedidoIdNúmero do pedidoLongX

 

Retorno: Boolean onde true = sucesso!

 

 

Usuário Cadastrado no Site

 

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncUsuario.asmx) – GetItems

Este Web Service disponibiliza uma lista com os usuários cadastrados no site que ainda não foram integrados ao ERP.

Parâmetros:

 

CampoSignificadoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X

 

Retorno: Lista com 20 Itens

 

CampoSignificadoTipoTamanhoObrigatório
UsuarioIdId do usuário no sistemaLong-X
EcommerceIdIdentifica em qual site o cliente esta cadastrado, se houver apenas um é 1Int-
TipoPessoaId1 – FísicaInt-X
2 – Jurídica
OrigemContatoId
EnderecoResidencialIdCódigo endereço residencialLong-
EnderecoEntregaIdCódigo endereço de entrega.Long-
TipoSexoId1 – MasculinoInt-
2 – Feminino
FormaPagamentoIdForma de pagamento preferencial do usuário:Int-X
1-Boleto
2-PayPal
3-Visa
4-MasterCard
5-American Express
6-Diners
7-Aura
8-Hipercard
9-Google Checkout
10-ELO
11-Deposito Bancario
12-Moip
13-Créditos VP
14-Discover
15-Mercado Pago
16-Promocao
17-FastCash – Deposito
18-FastCash – Transferencia
19-FastCash – Financiamento
99-Pagamento Marketplace Extra
TipoPreferenciaUsuarioIdCorresponde à ordenação padrão utilizada no site como preferência do usuário:Int-
0 - Indefinido
1 – Marcas
2 – Preços
3 – Mais Vendidos
NomeNome do usuárioString100X
CPFCPF do usuárioString50
EmailEmail usuárioString100X
RGRG usuárioString12
OrgaoEmissorOrgão emissorString-
NomeMaeNome da mãeString100
TelefoneResidencialNúmero do telefone residencialString20
TelefoneCelularNúmero do telefone celularString20
TelefoneComercialNúmero do telefone comercialString20
DataNascimentoData de nascimento DateTime-
RazaoSocialRazão social do usuário, campo obrigatório para pedidos de pessoa Jurídica.String100
CNPJCNPJ do usuário, campo obrigatório para pedidos de pessoa Jurídica.String20
InscricaoEstadualInscrição Estadual usuário.String20
ResponsavelNome da pessoa resposável pela pessoa jurídicaString100
DataCriacaoData de cadastro usuárioDateTime-X
DataAtualizacaoData de alteração usuário sistemaDateTime-
EnderecoEndereço usuárioString200
NumeroNúmero endereço usuárioString20X
ComplementoComplemento endereço usuárioString100X
BairroBairro usuárioString50X
CidadeCidade usuárioString50X
EstadoEstado usuárioString2X
CEPCEP usuárioString10X
ParceiroIDId do parceiro por onde o cliente fez a compraInt

 

Informações de Newsletter

 

1.9.1 Informações de newsletter     
CampoDescriçãoTipoTamanhoObrigatório
IntegracaoNewsletterIdNúmero de referência do cadastro de newsletterInt-
UsuarioIdId do usuário que realizou o pedidoInt-
NomeNome do usuárioString100
EmailEmail usuárioString100
DataCadastroData de cadastro do usuário na newsletterDatetime-
StatusStatus do cadastro.Boolean-
Sexo1 - MasculinoString100
2 – Feminino
DoubleOptInValidoxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxBoolean-
DataAceitacaoOptInData que o usuário aceitou o envio de newsletterDatetime-
IPAceitacaoOptInIp da maquina no usuário quando aceitou o envio de newsletterString100

 

Usuário Cadastrado no Site

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncUsuario.asmx) – Select

Este Web Service busca e exibe as informações de um usuário específico, localizado por id.

Parâmetro:

 

CampoSignificadoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
UsuarioIdId do usuário no sistemaLong-X

 

Retorno: Uma lista com os dados deste usuário.

 

CampoSignificadoTipoTamanhoObrigatório
UsuarioIdId do usuário no sistemaLong-X
EcommerceIdIdentifica em qual site o cliente esta cadastrado, se houver apenas um é 1Int-
TipoPessoaId1 – FísicaInt-X
2 – Jurídica
OrigemContatoId
EnderecoResidencialIdCódigo endereço residencialLong-
EnderecoEntregaIdCódigo endereço de entrega.Long-
TipoSexoId1 – MasculinoInt-
2 – Feminino
FormaPagamentoIdForma de pagamento preferencial do usuário:Int-X
1-Boleto
2-PayPal
3-Visa
4-MasterCard
5-American Express
6-Diners
7-Aura
8-Hipercard
9-Google Checkout
11-Deposito Bancário
13-ELO
TipoPreferenciaUsuarioIdCorresponde à ordenação padrão utilizada no site como preferência do usuário:Int-
0 - Indefinido
1 – Marcas
2 – Preços
3 – Mais Vendidos
NomeNome do usuárioString100X
CPFCPF do usuárioString50
EmailEmail usuárioString100X
RGRG usuárioString12
OrgaoEmissorOrgão emissorString-
NomeMaeNome da mãeString100
TelefoneResidencialNúmero do telefone residencialString20
TelefoneCelularNúmero do telefone celularString20
TelefoneComercialNúmero do telefone comercialString20
DataNascimentoData de nascimento DateTime-
RazaoSocialRazão social do usuário, campo obrigatório para pedidos de pessoa Jurídica.String100
CNPJCNPJ do usuário, campo obrigatório para pedidos de pessoa Jurídica.String20
InscricaoEstadualInscrição Estadual usuário.String20
ResponsavelNome da pessoa resposável pela pessoa jurídicaString100
DataCriacaoData de cadastro usuárioDateTime-X
DataAtualizacaoData de alteração usuário sistemaDateTime-
EnderecoEndereço usuárioString200
NumeroNúmero endereço usuárioString20X
ComplementoComplemento endereço usuárioString100X
BairroBairro usuárioString50X
CidadeCidade usuárioString50X
EstadoEstado usuárioString2X
CEPCEP usuárioString10X
ParceiroIDId do parceiro por onde o cliente fez a compraInt

 

Informações de newsletter

 

1.9.2.1 Informações de newsletter    
CampoDescriçãoTipoTamanhoObrigatório
IntegracaoNewsletterIdNúmero de referência do cadastro de newsletterInt-
UsuarioIdId do usuário que realizou o pedidoInt-
NomeNome do usuárioString100
EmailEmail usuárioString100
DataCadastroData de cadastro do usuário na newsletterDatetime-
StatusStatus do cadastro.Boolean-
Sexo1 - MasculinoString100
2 – Feminino
DoubleOptInValidoxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxBoolean-
DataAceitacaoOptInData que o usuário aceitou o envio de newsletterDatetime-
IPAceitacaoOptInIp da máquina no usuário quando aceitou o envio de newsletterString100

 

Confirmação de Usuários Sincronizados

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncUsuario.asmx) – Complete

Através deste Web Service, a confirmação da sincronização dos usuários. Isso fará com que esse usuário não seja disponibilizado novamente no Web Service “Usuários cadastrados no site”, até que ele faça uma alteração no seu cadastro.

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
UsuarioIdId do usuário no sistemaLong-X

 

Retorno: Boolean onde true = sincronizado com sucesso!

 

 

Endereço do Usuário Cadastrado no Site

 

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncUsuarioEndereco.asmx) – GetItems

Este Web Service disponibiliza uma lista de endereços dos usuários cadastrados no site e que ainda não foram integrados ao ERP.

Parâmetro:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X

 

Retorno: Lista com 20 itens

 

CampoSignificadoTipoTamanhoObrigatório
UsuarioIdCódigo usuário sistemaLong-X
CPFCPF do usuário, caso pessoa fisicaString-
CNPJCNPJ da empresa, caso pessoa juridicaString-
EnderecoIdCódigo endereçoLong-X
EnderecoEndereço usuárioString500X
NumeroNúmero endereço usuárioString50X
ComplementoComplemento endereço usuárioString100
BairroBairro di endereçoString100X
CidadeCidade do endereçoString100X
EstadoEstado do endereçoString100X
CEPCEP do endereçoString50X
TelefoneResidencialNúmero do telefone residencialString20
TelefoneCelularNúmero do telefone celularString20
TelefoneComercialNúmero do telefone comercialString20

 

Confirmação de Endereço dos Usuários Sincronizados

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncUsuarioEndereco.asmx) – Complete

Através deste Web Service, ocorre a confirmação da sincronização dos endereços dos usuários. Esse processo fará com que esse endereço não seja disponibilizado novamente no Web Service “Endereço do usuário cadastrado no site”, até que ele faça uma alteração no seu cadastro.

  Parâmetro:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
EnderecoIdCódigo do endereço sincronizadoLong-X

 

Retorno: Boolean onde true = sincronizado com sucesso!

 

 

Inclui Produto Categoria

 

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncProdutoCategoria.asmx) – Insert

 

Através deste Web Service inclui-se um produto em uma categoria.

Parâmetro:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesstring-X
SKUCódigo do produtoint-X
CategoriaClienteIdCódigo da categoria do clienteint-X

 

Retorno:  ProdutoCategoriaId = Código de relacionamento entre Produto e Categoria.

Deletar Produto Categoria

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncProdutoCategoria.asmx) – Delete

Através deste Web Service deleta-se um produto de uma categoria, todos os produtos de uma categoria ou todas as categorias de um produto, dependendo dos parâmetros informados.

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesstring-X
CategoriaClienteIdCódigo da categoria do clienteint-X
SKUCódigo do produtoint-X

 

Retorno: Bolean true = excluído com sucesso!

Listar Produto Categoria

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncProdutoCategoria.asmx) – GetItems

 

Web Service que retorna os produtos relacionados a uma categoria, as categorias relacionados a um produto ou verifica se um produto pertence a uma categoria, dependendo dos parâmetros informados. Caso nenhum parâmetro seja informado retorna todos os relacionamentos categoria x produto.

Parâmetros:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesstring-X
CategoriaClienteIdCódigo da categoria do cliente, caso não seja informado retorna todas as categorias do produtoint-
SKUCódigo do produto, caso não seja informado retorna todos os itens da categoriaint-

 

Retorno: Uma lista com os dados de relacionamento entre produto e categoria do cliente.

 

CampoDescriçãoTipoTamanhoObrigatório
CategoriaClienteIdCódigo da categoria do clienteint-
SKUCódigo do produtoint-

 

 

 

Incluir Categoria

 

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncCategoria.asmx) – Insert

 

Através deste Web Service cria-se uma nova categoria.

Parâmetro:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-X
NomeNome da categoriaString100X
CategoriaClientePaiIdCódigo da categoria do cliente a qual está subordinadaint-
CategoriaClienteIdSe CategoriaClienteId for informado os dados do mesmo serão atualizados.Int-

 

Retorno: Boolean: true caso a categoria seja adicionada com sucesso.

Excluir Categoria

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncCategoria.asmx) – Delete

 

Através deste Web Service apaga-se uma categoria.

Parâmetro:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesstring-X
CategoriaClienteIdCódigo da Categoria do clienteint-X

 

Retorno: Boolean onde true = excluído com sucesso!

Listar Todas as Categorias

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncCategoria.asmx) – GetItems

Web Server que retorna uma lista com todas as categorias cadastradas.

Parâmetro:

 

CampoDescriçãoTipoTamanhoObrigatório
TokenChave de acesso aos web.servicesString-

 

Retorno: Lista de Categorias

 

CampoDescriçãoTipoTamanhoObrigatório
NomeNome da categoriaString100X
CategoriaClientePaiIdCódigo da categoria do cliente a qual está subordinadaint-
CategoriaClienteIdCódigo da categoria do clienteInt-X

 

Seleciona Categoria

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncCategoria.asmx) – Select

 

Web Server utilizado somente para retorno.

Parâmetro:

 

CampoDescriçãoTipoTamanhoObrigatório
Tokenstring-
CategoriaClienteIdCódigo da categoria do clienteint-X

 

Retorno: Dados da categoria com Id fornecido

 

CampoDescriçãoTipoTamanhoObrigatório
NomeNome da categoriaString100X
CategoriaClientePaiIdCódigo da categoria do cliente a qual está subordinadaint-
CategoriaClienteIdCódigo da categoria do clienteint-X

 

Seleciona Categoria por Codigo Interno

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncCategoria.asmx) – GetCategoriaIdByCodigoCategoriaInterno

 

Web Server utilizado somente para retorno. Retorna uma lista de categorias vinculadas à categoria interna informada em parâmetro.

Parâmetro:

 

CampoDescriçãoTipoTamanhoObrigatório
Tokenstring-
categoriaInternoIdCódigo interno da categoriaint-X

 

Retorno: Dados da categoria com Id fornecido

 

CampoDescriçãoTipoTamanhoObrigatório
CategoriaIdCódigo da categoria.int-
CategoriaClienteIdCódigo da categoria do clienteint-X

 

Seleciona Lista Categoria por Código Interno

(http://integracao.desenv.ecommercestore.com.br/modelo008/SyncCategoria.asmx) – GetListaCategoriaIdByCodigoInterno

 

Web Server utilizado somente para retorno. Retorna uma lista de categorias vinculadas à lista de códigos de categorias internos do cliente.

Parâmetro:

 

CampoDescriçãoTipoTamanhoObrigatório
Tokenstring-
categoriaInternoIdLista de Códigos de categoria do clienteList-X

 

Retorno: Dados da categoria com Id fornecido

 

CampoDescriçãoTipoTamanhoObrigatório
CategoriaIdCódigo da categoria int-
CategoriaClienteIdCódigo da categoria do clienteint-X