Introdução

A ferramenta de webservice da Moovin dispõe de uma plataforma POST para integração com sistemas externos independente da linguagem de programação utilizada.

Os dados da requisição via POST poderão ser enviados em formato JSON ou XML. O formato de retorno será igual ao formato enviado, ou poderá ser definido apenas acrescentando ao final da URL o tipo de formato:

Endereço de web service

O endereço do webservice é constituído da seguinte URL, substitua a sualoja pelo nome da loja e nomeDoMetodo pelo nome do método utilizado no web service.

http://sualoja.integration.moovin.com.br/webservice/nomeDoMetodo

Definição do tipo de retorno

O tipo de retorno é definido no endpoint da URL de endereço, os tipos possíveis são json e xml. Exemplos usando os tipos possíveis de retorno:

Retorno usando JSON: http://sualoja.integration.moovin.com.br/webservice/nomeDoMetodo/json
Retorno usando XML: http://sualoja.integration.moovin.com.br/webservice/nomeDoMetodo/xml

Consultando informações

O webservice dispõe de diversos métodos para consulta de informações. Todos os métodos de resgate de informações suportam o envio de filtros de busca. Na descrição dos métodos abaixo, será listado o nome e os filtros que cada um suporta.

Estrutura de filtros

A estrutura de filtros de cada método varia de acordo com o tipo de dados enviado para a requisição, os tipos possíveis são json e xml, segue exemplos de como aplicar o filtro em cada um dos tipos:

Filtro usando JSON:

{
   filtro1: "valor",
   filtro2: "valor"
}

Filtro usando XML:

<filtros>
   <filtro1>valor</filtro1>
   <filtro2>valor</filtro2>
</filtros>

Enviando informações

O webservice dispõe de métodos para o envio de informações de cadastros. Como retorno, virá um código de erro e uma mensagem. Em caso de sucesso, o código de erro é 0 (zero) e a mensagem “sucesso”. No final deste manual, encontra-se uma tabela com os possíveis retornas e seus respectivos códigos, mensagem e descrição.

Estrutura de retornos

A estrutura de retorno varia de acordo com o tipo definido para o retorno, segue exemplos de como os retornos são de acordo com o tipo:

Retorno usando JSON:

{
   error: "codigo",
   message: "Mensagem de retorno"
}

Retorno usando XML:

Descrição dos métodos

Para utilizar todos os métodos do webservice é necessário preencher dois parâmetros no POST da requisição, o primeiro é o token e o segundo é o data, o token é uma string com o token do cliente, já o data é um JSON ou XML contendo o filtro ou dados da requisição, filtros são usados em métodos gets e dados são usados em métodos save ou update.

Cada método é separado em três tópicos: método, descrição e filtro ou dados (dependendo do tipo de método get, save ou update). Alguns métodos ainda possuem exemplos de dados para fazer uma requisição em JSON e XML.

Métodos GET

Get Características

Método

O nome do método utilizado na consulta é getCaracteristicas.

Descrição

Este método retorna uma listagem com as características cadastradas.

Filtros

Os filtros são organizados em uma tabela contendo o nome, tipo e descrição de cada filtro.

Nome	Tipo	Descrição
limite	Integer(10)	Defini a quantidade de registros a retornar.
codigo	Integer(11)	Busca pelo código da característica que contém.
nome	String(50)	Busca pelo nome da característica que contém.

Retorno

Os retornos são organizados em uma tabela contendo grupo do campo, nome, tipo, e descrição de cada campo.

Grupo	Nome	Tipo	Descrição
raiz	caracteristicas		Campo principal da estrutura. Todas as características da consulta são retornados dentro dele.
caracteristicas	caracteristica		Contém os dados referentes a uma característica.
caracteristica	codigo	Integer(11)	Identificador da característica na plataforma.
caracteristica	nome	String(50)	Nome da característica.
caracteristica	filtro	Integer(1)	Defini se a característica irá ser utilizada como filtro para o cliente na loja. Retorna: - 1 “Sim” - 0 “Não”
caracteristica	multi	Integer(1)	Defini se é permitido ser relacionado mais de uma opção ao produto. Retorna: - 1 “Sim” - 0 “Não”
caracteristica	genero	Integer(1)	Gênero da característica. Retorna: - 0 “Unissex” - 1 “Masculino” - 2 “Feminino”
caracteristica	faixa_etaria	Integer(1)	Faixa etária da característica. Retorna: - 1 “Adulto” - 2 “Infantil’
caracteristica	exibe_descricao	Integer(1)	Defini se a característica será exibida na descrição do produto. Retorna: - 1 “Sim” - 0 “Não”
caracteristica	obrigatorio	Integer(1)	Defini se o campo deve ser preenchido pelo operador ao relacionar com o produto. Retorna: - 1 “Sim” - 0 “Não”
caracteristica	slug	String(55)	Identificador amigável da característica.
caracteristica	categorias	Array	Conjunto de categorias da característica.
categorias	categoria		Categoria relacionada ao conjunto de categorias.
categoria	cod_categoria	Integer(11)	Código da categoria.
categoria	nome	String(100)	Nome da categoria.
caracteristica	atributos	Array	Conjunto de atributos da característica.
atributos	atributo		Atributo relacionado ao conjunto de Atributos.
atributo	cod_atributo	Integer(11)	Código do atributo.
atributo	nome	String(50)	Nome do atributo.

Exemplo de retorno XML:

XML - Get Caracteristicas

Get Produtos

Método

O nome do método utilizado na consulta é getProdutos.

Descrição

Este método retorna uma listagem com os dados dos produtos.

Filtros

Os filtros são organizados em uma tabela contendo o nome, tipo e descrição de cada filtro.

Nome	Tipo	Descrição
limite	Integer(10)	Definir a quantidade de registros a retornar por página.
pagina	Integer(10)	Definir qual página deverá ser retornada.
gênero	Integer(1)	Gênero do produto: 0 - Unissex 1 - Masculino 2 - Feminino
nome	String(100)	Código para identificação da variação de cor do produto.
marca	String(100)	Faz uma busca nos produtos que são de uma marca específica.
data_cadastro	String(10)	Busca por produtos cadastrados em uma data específica. Formato: YYYY-MM-DD
codigo	String(40)	Busca por produtos contendo este código
produto_codigo_exato	String(40)	Busca por um produto com código específico.
id	Integer(11)	Busca por um produto com Id específico.

GE didos

Método

O nome do método utilizado na consulta é getPedidos.

Descrição

Este método retorna uma listagem com os pedidos cadastrados.

Filtros

Os filtros são organizados em uma tabela contendo o nome, tipo e descrição de cada filtro.

Nome	Tipo	Descrição
codigo	String(20)	Busca por um código específico de um pedido
data	String(19)	Busca pela data exata de criação dos pedidos (Y-m-d h:m:s): ‘2015-12-20’, ‘2016-02-13 00:00:00’.
data_de	String(19)	Busca pedidos cadastrados apartir desta data, incluindo a data de filtro (Y-m-d h:m:s).
data_ate	String(19)	Busca pedidos cadastrados até esta data, incluindo a data de filtro (Y-m-d h:m:s)..
cpf_cnpj	String(20)	Busca pelo CPF ou CNPJ do cliente do pedido.
produto_codigo	String(40)	Busca pedidos pelo código dos produtos que ele contém.
produto_codigo_cor	String(40)	Busca pedidos pelo código de cor dos produtos que ele contém.
produto_codigo_tamanho	String(40)	Busca pedidos pelo código de tamanho dos produtos que ele contém.
codigo_vendedor	Integer(11)	Busca pelo código do revendedor ou usuário que realizou a venda. Normalmente definido pelo televendas.
num_transacao	String(250)	Busca pedidos pelo número da transação. Pode ser usado mais de um número de transação separado por vírgula.
codigo_status_pedido	Integer(11)	Busca pedidos pelo código do status atual do pedido. Os códigos podem ser buscados do recurso getStatusPedidos.
limite	Integer(6)	Limita a busca para um número positivo igual ou menor a 300000.
data_ultima_atualizacao_de	String(19)	Busca pedidos alterados a partir desta data, incluindo a data de filtro (Y-m-d h:m:s).
data_ultima_atualizacao_ate	String(19)	Busca pedidos alterados até esta data, incluindo a data de filtro (Y-m-d h:m:s).

Observações:

Não são retornados pedidos inativos (deletados pela plataforma).
Não são retornados pedidos com status “Em compra”.

Retorno

Os retornos são organizados em uma tabela contendo grupo do campo, nome, tipo, e descrição de cada campo.

Grupo	Nome	Tipo	Descrição
raiz	pedidos		Campo principal da estrutura. Todos pedidos da consulta são retornados dentro dele.
pedidos	pedido		As informações dos pedidos são retornadas dentro deste campo. Cada campo de pedido é referente a um pedido diferente cadastrado na plataforma.
pedido	codigo_pedido	Integer(20)	Número do pedido na plataforma
pedido	data	Datetime	Data e hora da criação do pedido. exemplo: 2015-09-11 17:38:45
pedido	codigo_forma_pagamento	Integer(11)	Identificador da forma de pagamento na plataforma.
pedido	nome_forma_pagamento	Varchar(50)	Descrição formatada da forma de pagamento.
pedido	loja_venda	Varchar(50)	Nome da loja de venda do pedido.
pedido	nome_loja_pagamento	Varchar(50)	Nome formatado da loja de pagamento na plataforma.
pedido	codigo_status_pedido	Integer(11)	Identificador do status atual de pedido.
pedido	descricao_loja_status_pedido	Varchar(150)	Descrição formatada do status de pedido que é exibida na plataforma.
pedido	descricao_cliente_status_pedido	Varchar(200)	Descrição formatada que é exibida para os clientes do Ecommerce.
pedido	status_transacao	Varchar(50)	Descrição do Status de pagamento exibida na plataforma.
pedido	parcelas	Integer(11)	Número de parcelas do pedido.
pedido	valor_parcial	Decimal(9,2)	Valor parcial do pedido.
pedido	valor_total	Decimal(9,2)	Valor total do pedido com a soma de frete e encargos.
pedido	valor_frete	Decimal(9,2)	Valor total de frete do pedido.
pedido	valor_presente	Decimal(9,2)	Valor adicional de embalagem para presente.
pedido	valor_taxa_gateway	Decimal(9,2)	Valores adicionais de taxas cobrados pelo gateway.
pedido	forma_pagamento_sistema_pagamento	Varchar(150)
pedido	desconto_bonus	Decimal(9,2)	Valor total de descontos de bônus do pedido.
pedido	desconto_pontos	Decimal(9,2)	Valor total de descontos do sistema de prontos.
pedido	desconto_vlr_compra	Decimal(9,2)	Valor total de outros tipos de desconto. Exemplos: Etiquetas, Boleto, etc.
pedido	desconto_num_pedidos	Decimal(9,2)	Valor total de descontos por número x de compras feitas.
pedido	desconto_cupom	Decimal(9,2)	Valor total de descontos de cupons.
pedido	clearsale_score	Varchar(10)	Score de retorna de análise de risco da Clearsale.
pedido	codigo_cupom_desconto	Varchar(50)	Código identificador de um cupom de desconto vinculado a compra.
pedido	desconto_total	Decimal(9,2)	Soma total dos descontos do pedido.
pedido	cliente_ip	Varchar(30)	Endereço de ip do cliente no momento da compra.
pedido	separado_por_usuario	Varchar(50)	Usuário responsável pela separação do pedido (caso exista).
pedido	data_separado	Varchar(20)	Data e hora da separação. exemplo: 2015-09-11 17:38:45
pedido	navegador	Varchar(25)	Nome do navegador do cliente no momento da compra.
pedido	navegador_versao	Varchar(10)	Versão do navegador do cliente no momento da compra.
pedido	sistema_operacional	Varchar(15)	Sistema operacional do cliente no momento da compra.
pedido	mobile	Tinyint(1)	Define se o acesso foi através de um dispositivo Mobile. “0” - Não “1” - Sim
pedido	meio_ambiente	tinyint(4)	Flag de relação com os pedidos e preservação do meio ambiente.
pedido	pagamento_venc_boleto	Date	Data de vencimento do boleto.
pedido	importado	Tinyint(1)	Status de importação do pedido com o ERP ou outros sistemas.
pedido	campanha_id	Integer(11)	Identificador da campanha relacionada ao pedido.
pedido	campanha_ident	Varchar(50)	Identificador da campanha relacionada ao pedido.
pedido	pagamento_identificador	Varchar(200)	Identificador do pagamento. Obs: Caso o pedido seja de marketplace o valor será seu identificador no mesmo.
pedido	codigo_revendedor	Varchar(25)	Código do revendedor do pedido. Exemplo: Origem do televendas.
pedido	itens	Array	Contém todos os itens do pedido.
itens	item		Cada item se refere a um produto do pedido.
item	codigo	Varchar(35)	Código produto no momento em que o pedido foi efetuado.
item	produto_codigo	Varchar(40)	Código principal do produto cadastrado na plataforma.
item	produto_codigo_cor	Varchar(35)	Código do primeiro nível de variação do produto. Exemplo: Variação de cor.
item	produto_codigo_tamanho	Varchar(35)	Código do segundo nível de variação do produto. Exemplo: Variação de tamanho.
item	qtd	Integer(11)	Quantidade de venda do produto no pedido.
item	cor	Varchar(50)	Nome da cor do produto.
item	tamanho	Varchar(20)	Nome do tamanho do produto.
item	nome_loja	Varchar(200)	Nome da loja de estoque do item.
item	cod_loja	Varchar(30)	Código da loja de estoque do item.
item	valor	Decimal(9,2)	Valor do Item no momento da compra.
item	valor_pago	Decimal(9,2)	Valor final pago pelo item.
item	prazo_entrega_extra	Integer(3)	Dias extra para entrega do produto.
item	nfe_ncm	Varchar(20)	Número do NCM do produto.
item	nfe_origem	Integer(1)	Origem do produto: “0” - Nacional “1” - Importação direta “2” - Importação indireta
item	peso	Varchar(10)	Peso do produto em gramas.
item	presente	Tinyint(1)	Define se o item é um presente: “0” - Não “1” - Sim
item	pre_venda	Integer(1)	Define se o item é de pré-venda: “0” - Não “1” - Sim
item	personalizacao (desenvolvimento)	Varchar(250)	Contém os dados da personalização do item de pedido.
item	data_envio_pre_venda	Date	Data de envio da pré-venda.
item	descricao	Text	Descrição do item no pedido.
pedido	cliente		Contém os dados do cliente do pedido.
cliente	codigo	Integer(11)	Identificador do cliente na plataforma.
cliente	nome	Varchar(100)	Nome do cliente na plataforma.
cliente	telefone_residencial	Varchar(15)	Telefone da residência do cliente.
cliente	telefone_celular	Varchar(15)	Telefone celular do cliente.
cliente	telefone_comercial	Varchar(15)	Telefone comercial do cliente.
cliente	cpf_cnpj	Varchar(20)	Número do CPF ou CNPJ do cliente.
cliente	email	Varchar(120)	Endereço de correio eletrônico do cliente (Email).
cliente	data_nasc	Data	Data de nascimento do cliente. Ex: 1992-12-28
pedido	dados_entrega		Contém todas as informações de entrega do pedido
dados_entrega	nome	Varchar(100)	Nome do destinatário.
dados_entrega	rg	Varchar(20)	Número do RG do destinatário.
dados_entrega	endereco	Varchar(150)	Endereço do destinatário.
dados_entrega	número	Varchar(10)	Número do endereço do destinatário.
dados_entrega	complemento	Varchar(130)	Complementos de entrega.
dados_entrega	bairro	Varchar(30)	Bairro de entrega.
dados_entrega	cep	Varchar(10)	Número do CEP de entrega.
dados_entrega	cidade	Varchar(10)	Cidade de entrega.
dados_entrega	estado	Varchar(2)	Sigla do estado de entrega.
dados_entrega	email	Varchar(120)	Endereço do correio eletrônico do destinatário.
dados_entrega	instruções	Varchar(100)	Instruções extra para a entrega do pedido.
dados_entrega	cotacao	Varchar(100)	Número da cotação retornada pelo Sistema de Fretes
dados_entrega	cotacao_opcao_entrega	Varchar(100)	Opção da transportadora relacionada à cotação
dados_entrega	codigo_servico	Varchar(100)	Código de serviço da transportadora
pedido	dados_transporte		Contém os dados referentes ao transporte do pedido.
dados_transporte	modalidade	Varchar(50)	Descrição da modalidade de envio.
dados_transporte	codigo_rastreio	Varchar(60)	Código de rastreamento do pedido.
dados_transporte	valor_transporte	Decimal(9,2)	Valor total do transporte.
dados_transporte	prazo_entrega	Integer(3)	Prazo de entrega para o pedido.
dados_transporte	codigo_transportadora	Integer(11)	Identificador da modalidade de envio.
dados_transporte	tipo	Integer(1)	Tipo de entrega do pedido: “0” - Normal “1” - Expresso “2” - Loja “3” - Econômico “4” - Pague ao receber
dados_transporte	data_postagem	Date	Data da postagem do pedido.
dados_transporte	data_entrega	Date	Data da entrega do pedido.
pedido	dados_transacao		Dados da transação do pedido. Obs: Os dados dentro deste campo só será retornados se houver ao menos uma transação para o pedido. Um pedido pode conter diversas transações.
dados_transacao	transacao
transacao	data	Date
transacao	cod_forma_pagamento	Integer(11)	Identificador da forma de pagamento
transacao	forma_pagamento	Varchar(50)	Nome da forma de pagamento.
transacao	parcelas	Integer(2)	Número de parcelas da transação.
transacao	gateway	Varchar(50)	Nome do gateway da transação.
transacao	valor_total	Decimal(9,2)	Valor total da transação.
transacao	vencimento_boleto	Date	Data de vencimento do boleto.
transacao	mensagem_retorno	Varchar(200)	Mensagem de retorno do gateway.
transacao	codigo_retorno	Varchar(20)	Código de retorno do gateway.
transacao	num_autorizacao	Varchar(200)	Número da autorização do pagamento.
transacao	num_transacao	Varchar(250)	Número da transação.
transacao	adquirente	Varchar(20)	Identificador da adquirente.
transacao	num_comp_venda	Varchar(200)	Número do comprobante de venda do pedido.
transacao	data_pagamento	Date	data de pagamento da transação.

Exemplo XML - GetPedido

Métodos SAVE

Save Autor

Método

O nome do método utilizado na consulta é saveAutor.

Descrição

Salva novos autores na plataforma

Dados

Os dados enviados para salvar são organizados em uma tabela contendo o nome, tipo e descrição do campo, os campos obrigatórios possuem um (*) no final do nome demarcando que são obrigatórios. Segue tabela descrevendo os dados de envio:

Nome	Tipo	Descrição
codigo	Integer(11)	Identificador principal do autor. Esse código deve ser único
nome	String(200)	Nome do autor
grupo_nome	String(35)	Nome do grupo pertencente a cada autor
status	Integer(1)	Status relacionado ao autor. - 1 para Ativo - 0 para Inativo
email	String(200)	E-mail do autor
descricao	String(250)	Descrição do autor
nota	String(250)	Descrição resumida do autor
facebook	String(250)	Url da Fampage do Facebook
twitter	String(250)	URL da conta do Twitter do Autor
instagram	String(250)	URL da conta do Instagram do Autor
snapchat	String(250)	URL da conta do snapchat do Autor
periscope	String(250)	URL da conta do periscope do Autor
youtube	String(250)	URL da conta do youtube do Autor
google_plus	String(250)	URL da conta do Google Plus do Autor
blog	String(250)	URL do blog do Autor
website	String(250)	URL do website o Autor
curriculo_lattes	String(250)	URL da conta do Currículo Lattes do Autor
link	String(250)	Link do Autor
title	String(250)	Titulo referente à exibição do autor no Google
keywords	String(250)	Palavras chaves para indexação do autor no Google
description	String(250)	Descrição do autor para indexação do autor no Google
titulo	String(250)	Titulo personalizado do autor para visualização no site
descrição	String(250)	Descrição personalizado do autor para visualização no site

Exemplo XML - saveAutor

Save Produtos Autor

Método

O nome do método utilizado na consulta é saveProdutosAutor.

Descrição

Vincula produtos aos autores já cadastrados

Dados

Os dados enviados para salvar são organizados em uma tabela contendo o nome, tipo e descrição do campo, os campos obrigatórios possuem um (*) no final do nome demarcando que são obrigatórios. Segue tabela descrevendo os dados de envio:

Nome	Tipo	Descrição
	Integer(11)	Identificador principal do autor.
	Integer(1)	Li