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:

Code Block

language	js
theme	Midnight

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

Filtro usando XML:

Code Block

language	actionscript3
theme	Midnight

<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:

Code Block

theme	Midnight
linenumbers	true

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

Retorno usando XML:

Code Block

theme	Midnight
linenumbers	true

<response>
   <error>codigo</error>
   <message>Mensagem de retorno</message>
</response>

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

Expand

title	Get Características

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:

Code Block

title	XML - Get Caracteristicas

<caracteristicas>

   <caracteristica>

       <codigo>27</codigo>

       <nome>Material</nome>

       <filtro>1</filtro>

       <mult>1</mult>

       <genero>2</genero>

       <faixa_etaria>0</faixa_etaria>

       <exibe_descricao>0</exibe_descricao>

       <obrigatorio>0</obrigatorio>

       <slug>material2</slug>

       <categorias>

           <cod_categoria>100033</cod_categoria>

           <nome>Meias</nome>

       </categorias>

       <atributos>

           <atributo>

               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>





















       <slug>material2</slug>





















       <categorias>





















           <cod_categoria>100033</cod_categoria>





















           <nome>Meias</nome>





















       </categorias>





















       <atributos>





















           <atributo>





















               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>

       <mult>1</mult>

       <genero>2</genero>

       <faixa_etaria>0</faixa_etaria>

       <exibe_descricao>0</exibe_descricao>

       <obrigatorio>0</obrigatorio>

       <slug>material2</slug>

       <categorias>

           <cod_categoria>100033</cod_categoria>

           <nome>Meias</nome>

       </categorias>

       <atributos>

           <atributo>

               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>





















       <slug>material2</slug>





















       <categorias>





















           <cod_categoria>100033</cod_categoria>





















           <nome>Meias</nome>





















       </categorias>





















       <atributos>





















           <atributo>





















               <cod_atributo>160</cod_atributo>





















               <nome>Algodão</nome>





















           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>





















       <slug>material2</slug>





















       <categorias>





















           <cod_categoria>100033</cod_categoria>





















           <nome>Meias</nome>





















       </categorias>





















       <atributos>





















           <atributo>





















               <cod_atributo>160</cod_atributo>





















               <nome>Algodão</nome>





















           </atributo>





















       </atributos>





















   </caracteristica>





















</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>





















       <slug>material2</slug>





















       <categorias>





















           <cod_categoria>100033</cod_categoria>





















           <nome>Meias</nome>





















       </categorias>





















       <atributos>





















           <atributo>





















               <cod_atributo>160</cod_atributo>





















               <nome>Algodão</nome>





















           </atributo>





















       </atributos>





















   </caracteristica>





















</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>

       <obrigatorio>0</obrigatorio>

       <slug>material2</slug>

       <categorias>

           <cod_categoria>100033</cod_categoria>

           <nome>Meias</nome>

       </categorias>

       <atributos>

           <atributo>

               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>

       <genero>2</genero>

       <faixa_etaria>0</faixa_etaria>

       <exibe_descricao>0</exibe_descricao>

       <obrigatorio>0</obrigatorio>

       <slug>material2</slug>

       <categorias>

           <cod_categoria>100033</cod_categoria>

           <nome>Meias</nome>

       </categorias>

       <atributos>

           <atributo>

               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>

       <codigo>27</codigo>

       <nome>Material</nome>

       <filtro>1</filtro>

       <mult>1</mult>

       <genero>2</genero>

       <faixa_etaria>0</faixa_etaria>

       <exibe_descricao>0</exibe_descricao>

       <obrigatorio>0</obrigatorio>

       <slug>material2</slug>

       <categorias>

           <cod_categoria>100033</cod_categoria>

           <nome>Meias</nome>

       </categorias>

       <atributos>

           <atributo>

               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>





















       <slug>material2</slug>





















       <categorias>





















           <cod_categoria>100033</cod_categoria>





















           <nome>Meias</nome>





















       </categorias>





















       <atributos>





















           <atributo>





















               <cod_atributo>160</cod_atributo>





















               <nome>Algodão</nome>





















           </atributo>





















       </atributos>





















   </caracteristica>





















</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>





















       <slug>material2</slug>





















       <categorias>





















           <cod_categoria>100033</cod_categoria>





















           <nome>Meias</nome>

       </categorias>

       <atributos>

           <atributo>

               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>

       <slug>material2</slug>

       <categorias>

           <cod_categoria>100033</cod_categoria>

           <nome>Meias</nome>

       </categorias>

       <atributos>

           <atributo>

               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>

       <genero>2</genero>

       <faixa_etaria>0</faixa_etaria>

       <exibe_descricao>0</exibe_descricao>

       <obrigatorio>0</obrigatorio>

       <slug>material2</slug>

       <categorias>

           <cod_categoria>100033</cod_categoria>

           <nome>Meias</nome>

       </categorias>

       <atributos>

           <atributo>

               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>





















       <slug>material2</slug>





















       <categorias>





















           <cod_categoria>100033</cod_categoria>





















           <nome>Meias</nome>





















       </categorias>





















       <atributos>





















           <atributo>





















               <cod_atributo>160</cod_atributo>





















               <nome>Algodão</nome>





















           </atributo>





















       </atributos>





















   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>





















       <slug>material2</slug>





















       <categorias>





















           <cod_categoria>100033</cod_categoria>





















           <nome>Meias</nome>





















       </categorias>





















       <atributos>





















           <atributo>





















               <cod_atributo>160</cod_atributo>





















               <nome>Algodão</nome>





















           </atributo>





















       </atributos>





















   </caracteristica>





















</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>





















       <slug>material2</slug>





















       <categorias>





















           <cod_categoria>100033</cod_categoria>





















           <nome>Meias</nome>

       </categorias>

       <atributos>

           <atributo>

               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>





















   <caracteristica>





















       <codigo>27</codigo>





















       <nome>Material</nome>





















       <filtro>1</filtro>





















       <mult>1</mult>





















       <genero>2</genero>





















       <faixa_etaria>0</faixa_etaria>





















       <exibe_descricao>0</exibe_descricao>





















       <obrigatorio>0</obrigatorio>





















       <slug>material2</slug>





















       <categorias>





















           <cod_categoria>100033</cod_categoria>





















           <nome>Meias</nome>





















       </categorias>





















       <atributos>





















           <atributo>





















               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Code Block

title	XML - Get Caracteristicas

<caracteristicas>

   <caracteristica>

       <codigo>27</codigo>

       <nome>Material</nome>

       <filtro>1</filtro>

       <mult>1</mult>

       <genero>2</genero>

       <faixa_etaria>0</faixa_etaria>

       <exibe_descricao>0</exibe_descricao>

       <obrigatorio>0</obrigatorio>

       <slug>material2</slug>

       <categorias>

           <cod_categoria>100033</cod_categoria>

           <nome>Meias</nome>

       </categorias>

       <atributos>

           <atributo>

               <cod_atributo>160</cod_atributo>

               <nome>Algodão</nome>

           </atributo>

       </atributos>

   </caracteristica>

</caracteristicas>

Expand

title	Get Produtos

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.

Expand

title	Get Pedidos

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.

Code Block

theme	Midnight
linenumbers	true

<filtros>
 <codigo>26955</codigo>
</filtros>

Code Block

theme	Midnight
title	Exemplo XML - GetPedido
linenumbers	true
collapse	true

<pedidos>
	<pedido>
		<codigo_pedido>4084550</codigo_pedido>
		<data>2018-06-13 07:43:23</data>
		<codigo_forma_pagamento>1</codigo_forma_pagamento>
		<nome_forma_pagamento>Boleto ItaÃº</nome_forma_pagamento>
		<loja_venda />
		<nome_loja_pagamento>E-commerce</nome_loja_pagamento>
		<codigo_status_pedido>4</codigo_status_pedido>
		<descricao_loja_status_pedido>Aprovado</descricao_loja_status_pedido>
		<descricao_cliente_status_pedido>Pagamento Aprovado</descricao_cliente_status_pedido>
		<status_transacao>Cancelado</status_transacao>
		<paramento_efetuado />
		<parcelas>1</parcelas>
		<valor_parcial>350.00</valor_parcial>
		<valor_total>350.00</valor_total>
		<valor_frete>0.00</valor_frete>
		<valor_presente>0.00</valor_presente>
		<valor_taxa_gateway />
		<forma_pagamento_sistema_pagamento />
		<desconto_bonus>0.00</desconto_bonus>
		<desconto_pontos>0.00</desconto_pontos>
		<desconto_vlr_compra>0.00</desconto_vlr_compra>
		<desconto_num_pedidos>0.00</desconto_num_pedidos>
		<desconto_cupom>0.00</desconto_cupom>
		<clearsale_score />
		<codigo_cupom_desconto />
		<desconto_total>0.00</desconto_total>
		<cliente_ip>172.18.0.1</cliente_ip>
		<qtd_itens>2</qtd_itens>
		<separado_por_usuario />
		<data_separado>0000-00-00 00:00:00</data_separado>
		<navegador>Chrome</navegador>
		<navegador_versao>67.0.3396</navegador_versao>
		<sistema_operacional>Linux</sistema_operacional>
		<mobile>0</mobile>
		<meio_ambiente>0</meio_ambiente>
		<pagamento_venc_boleto>2018-06-15</pagamento_venc_boleto>
		<importado>0</importado>
		<campanha_id>1</campanha_id>
		<campanha_ident />
		<codigo_revendedor />
		<dados_transporte>
			<entrega>
				<modalidade>[Intelipost] Motoboy DF</modalidade>
				<codigo_rastreio />
				<valor_transporte>0.00</valor_transporte>
				<prazo_entrega>8</prazo_entrega>
				<codigo_transportadora>479</codigo_transportadora>
				<tipo>EconÃ´mico</tipo>
				<data_postagem>0000-00-00 00:00:00</data_postagem>
				<data_entrega>0000-00-00</data_entrega>
				 <cotacao>605959212</cotacao>
                <cotacao_opcao_entrega>88</cotacao_opcao_entrega>
                <codigo_servico>88</codigo_servico>
				<itens>
					<item />
				</itens>
			</entrega>
			<entrega>
				<modalidade>[Intelipost] Impresso leve</modalidade>
				<codigo_rastreio />
				<valor_transporte>0.00</valor_transporte>
				<prazo_entrega>12</prazo_entrega>
				<codigo_transportadora>496</codigo_transportadora>
				<tipo>Normal</tipo>
				<data_postagem>0000-00-00 00:00:00</data_postagem>
				<data_entrega>0000-00-00</data_entrega>
 	            <cotacao>6059592214</cotacao>
                <cotacao_opcao_entrega>77</cotacao_opcao_entrega>
                <codigo_servico>77</codigo_servico>
				<itens>
					<item>
						<codigo>155_0_0_U</codigo>
						<produto_codigo>155</produto_codigo>
						<produto_codigo_cor>155_0_0_U</produto_codigo_cor>
						<produto_codigo_tamanho>155_0_0_U</produto_codigo_tamanho>
						<qtd>1</qtd>
						<cor />
						<tamanho />
						<nome_loja>E-commerce</nome_loja>
						<cod_loja>01</cod_loja>
						<valor>150.00</valor>
						<valor_pago>150.00</valor_pago>
						<prazo_entrega_extra>0</prazo_entrega_extra>
						<nfe_ncm />
						<nfe_origem>0</nfe_origem>
						<peso>530</peso>
						<presente>0</presente>
						<pre_venda>1</pre_venda>
						<data_envio_pre_venda>2018-06-18</data_envio_pre_venda>
						<descricao>Ref: 155 | Terceira Etapa da Reforma do CÃ³digo de Processo Civil - estudos em homenagem ao Ministro JosÃ© Augusto Delgado.</descricao>
					</item>
				</itens>
			</entrega>
			<entrega>
				<modalidade>[Intelipost] Impresso leve</modalidade>
				<codigo_rastreio />
				<valor_transporte>0.00</valor_transporte>
				<prazo_entrega>12</prazo_entrega>
				<codigo_transportadora>496</codigo_transportadora>
				<tipo>Normal</tipo>
				<data_postagem>0000-00-00 00:00:00</data_postagem>
				<data_entrega>0000-00-00</data_entrega>
 	            <cotacao>6059532334</cotacao>
                <cotacao_opcao_entrega>99</cotacao_opcao_entrega>
                <codigo_servico>99</codigo_servico>
				<itens>
					<item>
						<codigo>10_0_0_U</codigo>
						<produto_codigo>10</produto_codigo>
						<produto_codigo_cor>10_0_0_U</produto_codigo_cor>
						<produto_codigo_tamanho>10_0_0_U</produto_codigo_tamanho>
						<qtd>1</qtd>
						<cor />
						<tamanho />
						<nome_loja>E-commerce</nome_loja>
						<cod_loja>01</cod_loja>
						<valor>200.00</valor>
						<valor_pago>200.00</valor_pago>
						<prazo_entrega_extra>0</prazo_entrega_extra>
						<nfe_ncm />
						<nfe_origem>0</nfe_origem>
						<peso>180</peso>
						<presente>0</presente>
						<pre_venda>1</pre_venda>
						<data_envio_pre_venda>2018-06-22</data_envio_pre_venda>
						<descricao>Ref: 10 | ColeÃ§Ã£o Temas de Processo Civil Vol. 5 - Amicus Curiae</descricao>
					</item>
				</itens>
			</entrega>
		</dados_transporte>
		<cliente>
			<codigo>470721</codigo>
			<nome>Teste Moovin</nome>
			<telefone_residencial>(51) 34430561</telefone_residencial>
			<telefone_celular>(55) 996504399</telefone_celular>
			<telefone_comercial />
			<cpf_cnpj>38972645010</cpf_cnpj>
			<email>teste@moovin.com.br</email>
			<data_nasc>1994-07-07</data_nasc>
		</cliente>
		<dados_entrega>
			<nome>Roberta Santana Honda</nome>
			<rg />
			<endereco>Quadra SQS 406 Bloco U</endereco>
			<numero>208</numero>
			<complemento>apto.</complemento>
			<instrucoes />
			<bairro>Asa Sul</bairro>
			<cep>70255210</cep>
			<cidade>BrasÃlia</cidade>
			<estado>DF</estado>
			<email>rohond@gmail.com</email>
			<telefone_residencial>(61) 999736336</telefone_residencial>
			<telefone_celular />
			<telefone_comercial />
		</dados_entrega>
		<dados_transacao>
			<transacao>
				<data>0000-00-00</data>
				<cod_forma_pagamento>5</cod_forma_pagamento>
				<forma_pagamento>Visa</forma_pagamento>
				<parcelas>1</parcelas>
				<gateway>pagseguronovo</gateway>
				<valor_total>469.90</valor_total>
				<vencimento_boleto>0000-00-00</vencimento_boleto>
				<mensagem_retorno>Verifique a chave enviada no campo "chaveCliente". Caso nÃ£o possua esta chave, entre em contato com o suporte. O formato da chave Ã© XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX.</mensagem_retorno>
				<codigo_retorno>14</codigo_retorno>
				<num_autorizacao />
				<num_transacao>10142776877BV1KJ6A6B</num_transacao>
				<ident>a2ed68df-4266-11e8-aee2-026a2b32652a</ident>
				<adquirente>cielo</adquirente>
				<num_comp_venda>999770</num_comp_venda>
				<data_pagamento>2018-04-17 14:42:01</data_pagamento>
			</transacao>
			<transacao>
				<data>0000-00-00</data>
				<cod_forma_pagamento>1</cod_forma_pagamento>
				<forma_pagamento>Boleto ItaÃº</forma_pagamento>
				<parcelas>1</parcelas>
				<gateway>pagseguronovo</gateway>
				<valor_total>350.00</valor_total>
				<vencimento_boleto>0000-00-00</vencimento_boleto>
				<mensagem_retorno>Verifique a chave enviada no campo "chaveCliente". Caso nÃ£o possua esta chave, entre em contato com o suporte. O formato da chave Ã© XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX.</mensagem_retorno>
				<codigo_retorno>14</codigo_retorno>
				<num_autorizacao />
				<num_transacao />
				<ident />
				<adquirente />
				<num_comp_venda />
				<data_pagamento>2018-06-13 07:43:26</data_pagamento>
			</transacao>
		</dados_transacao>
	</pedido>
</pedidos>

Code Block

theme	Midnight
title	Exemplo XML - GetPedido
linenumbers	true
collapse	true

{
  "pedidos": [
    {
      "codigo_pedido": "4084550",
      "data": "2018-06-13 07:43:23",
      "codigo_forma_pagamento": "1",
      "nome_forma_pagamento": "Boleto ItaÃº",
      "loja_venda": "",
      "nome_loja_pagamento": "E-commerce",
      "codigo_status_pedido": "4",
      "descricao_loja_status_pedido": "Aprovado",
      "descricao_cliente_status_pedido": "Pagamento Aprovado",
      "status_transacao": "Cancelado",
      "paramento_efetuado": "",
      "parcelas": "1",
      "valor_parcial": "350.00",
      "valor_total": "350.00",
      "valor_frete": "0.00",
      "valor_presente": "0.00",
      "valor_taxa_gateway": "",
      "forma_pagamento_sistema_pagamento": "",
      "desconto_bonus": "0.00",
      "desconto_pontos": "0.00",
      "desconto_vlr_compra": "0.00",
      "desconto_num_pedidos": "0.00",
      "desconto_cupom": "0.00",
      "clearsale_score": "",
      "codigo_cupom_desconto": "",
      "desconto_total": "0.00",
      "cliente_ip": "172.18.0.1",
      "qtd_itens": "2",
      "separado_por_usuario": "",
      "data_separado": "0000-00-00 00:00:00",
      "navegador": "Chrome",
      "navegador_versao": "67.0.3396",
      "sistema_operacional": "Linux",
      "mobile": "0",
      "meio_ambiente": "0",
      "pagamento_venc_boleto": "2018-06-15",
      "importado": "0",
      "campanha_id": "1",
      "campanha_ident": "",
      "codigo_revendedor": "",
      "dados_transporte": {
        "entrega": [
          {
            "modalidade": "[Intelipost] Motoboy DF",
            "codigo_rastreio": "",
            "valor_transporte": "0.00",
            "prazo_entrega": "8",
            "codigo_transportadora": "479",
            "tipo": "EconÃ´mico",
            "data_postagem": "0000-00-00 00:00:00",
            "data_entrega": "0000-00-00",
			"cotacao": "6059592214",
            "cotacao_opcao_entrega": "77",
            "codigo_servico": "77",
              
            "itens": {
              "item": []
            }
          },
          {
            "modalidade": "[Intelipost] Impresso leve",
            "codigo_rastreio": "",
            "valor_transporte": "0.00",
            "prazo_entrega": "12",
            "codigo_transportadora": "496",
            "tipo": "Normal",
            "data_postagem": "0000-00-00 00:00:00",
            "data_entrega": "0000-00-00",
			"cotacao": "21212123131",
            "cotacao_opcao_entrega": "99",
            "codigo_servico": "99",
            "itens": {
              "item": [
                {
                  "codigo": "155_0_0_U",
                  "produto_codigo": "155",
                  "produto_codigo_cor": "155_0_0_U",
                  "produto_codigo_tamanho": "155_0_0_U",
                  "qtd": "1",
                  "cor": "",
                  "tamanho": "",
                  "nome_loja": "E-commerce",
                  "cod_loja": "01",
                  "valor": "150.00",
                  "valor_pago": "150.00",
                  "prazo_entrega_extra": "0",
                  "nfe_ncm": "",
                  "nfe_origem": "0",
                  "peso": "530",
                  "presente": "0",
                  "pre_venda": "1",
                  "data_envio_pre_venda": "2018-06-18",
                  "descricao": "Ref: 155 | Terceira Etapa da Reforma do CÃ³digo de Processo Civil - estudos em homenagem ao Ministro JosÃ© Augusto Delgado."
                }
              ]
            }
          },
          {
            "modalidade": "[Intelipost] Impresso leve",
            "codigo_rastreio": "",
            "valor_transporte": "0.00",
            "prazo_entrega": "12",
            "codigo_transportadora": "496",
            "tipo": "Normal",
            "data_postagem": "0000-00-00 00:00:00",
            "data_entrega": "0000-00-00",
			"cotacao": "53535",
            "cotacao_opcao_entrega": "88",
            "codigo_servico": "88",
            "itens": {
              "item": [
                {
                  "codigo": "10_0_0_U",
                  "produto_codigo": "10",
                  "produto_codigo_cor": "10_0_0_U",
                  "produto_codigo_tamanho": "10_0_0_U",
                  "qtd": "1",
                  "cor": "",
                  "tamanho": "",
                  "nome_loja": "E-commerce",
                  "cod_loja": "01",
                  "valor": "200.00",
                  "valor_pago": "200.00",
                  "prazo_entrega_extra": "0",
                  "nfe_ncm": "",
                  "nfe_origem": "0",
                  "peso": "180",
                  "presente": "0",
                  "pre_venda": "1",
                  "data_envio_pre_venda": "2018-06-22",
                  "descricao": "Ref: 10 | ColeÃ§Ã£o Temas de Processo Civil Vol. 5 - Amicus Curiae"
                }
              ]
            }
          }
        ]
      },
      "cliente": {
        "codigo": "470721",
        "nome": "Teste Moovin",
        "telefone_residencial": "(51) 34430561",
        "telefone_celular": "(55) 996504399",
        "telefone_comercial": "",
        "cpf_cnpj": "38972645010",
        "email": "teste@moovin.com.br",
        "data_nasc": "1994-07-07"
      },
      "dados_entrega": {
        "nome": "Roberta Santana Honda",
        "rg": "",
        "endereco": "Quadra SQS 406 Bloco U",
        "numero": "208",
        "complemento": "apto.",
        "instrucoes": "",
        "bairro": "Asa Sul",
        "cep": "70255210",
        "cidade": "BrasÃlia",
        "estado": "DF",
        "email": "rohond@gmail.com",
        "telefone_residencial": "(61) 999736336",
        "telefone_celular": "",
        "telefone_comercial": ""
      },
      "dados_transacao": {
        "transacao": [
          {
            "data": "0000-00-00",
            "cod_forma_pagamento": "5",
            "forma_pagamento": "Visa",
            "parcelas": "1",
            "gateway": "pagseguronovo",
            "valor_total": "469.90",
            "vencimento_boleto": "0000-00-00",
            "mensagem_retorno": "Verifique a chave enviada no campo \"chaveCliente\". Caso nÃ£o possua esta chave, entre em contato com o suporte. O formato da chave Ã© XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX.",
            "codigo_retorno": "14",
            "num_autorizacao": "",
            "num_transacao": "10142776877BV1KJ6A6B",
            "ident": "a2ed68df-4266-11e8-aee2-026a2b32652a",
            "adquirente": "cielo",
            "num_comp_venda": "999770",
            "data_pagamento": "2018-04-17 14:42:01"
          },
          {
            "data": "0000-00-00",
            "cod_forma_pagamento": "1",
            "forma_pagamento": "Boleto ItaÃº",
            "parcelas": "1",
            "gateway": "pagseguronovo",
            "valor_total": "350.00",
            "vencimento_boleto": "0000-00-00",
            "mensagem_retorno": "Verifique a chave enviada no campo \"chaveCliente\". Caso nÃ£o possua esta chave, entre em contato com o suporte. O formato da chave Ã© XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX.",
            "codigo_retorno": "14",
            "num_autorizacao": "",
            "num_transacao": "",
            "ident": "",
            "adquirente": "",
            "num_comp_venda": "",
            "data_pagamento": "2018-06-13 07:43:26"
          }
        ]
      }
    }
  ]
}

Métodos SAVE

Expand

title	Save Autor

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

Code Block

theme	Midnight
title	Exemplo XML - saveAutor
linenumbers	true
collapse	true

<data>
	<autores>
		<autor>
			<codigo>1036</codigo>
			<nome>Teste Moovin</nome>
			<grupos>
				<grupo_nome>Coordenador</grupo_nome>
				<grupo_nome>Membros do conselho</grupo_nome>
			</grupos>
			<status>1</status>
			<email>teste@moovin.com.br</email>
			<descricao>Professora de Direito Tributário. Mestranda em Direito Público pela PUC Minas. Procuradora da Fazenda Nacional.
            </descricao>
			<nota>Teste Moovin testando.</nota>
			<redes_sociais>
				<facebook>fb.com</facebook>
				<twitter></twitter>
				<instagram></instagram>
				<snapchat></snapchat>
				<periscope></periscope>
				<youtube></youtube>
				<google_plus></google_plus>
				<blog></blog>
				<website></website>
				<curriculo_lattes></curriculo_lattes>
			</redes_sociais>
			<seo>
				<link></link>
			</seo>
			<meta>
				<title>Teste Moovin - Editora Juspodivm</title>
				<keywords>teste, moovin</keywords>
				<description>Encontre {QTD_LIVROS_AUTOR} livros do autor Teste Moovin. Com os melhores Preços e Ofertas Exclusivas. ✓ Frete Grátis  ✓ Em até 10x sem 
				</description>
			</meta>
			<corpo_pagina>
				<titulo>Autor: Teste Moovin</titulo>
				<descricao></descricao>
			</corpo_pagina>
		</autor>
	</autores>
</data>

Expand

title	Save Produtos Autor

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
codigo	Integer(11)	Identificador principal do autor.
limpar_produtos	Integer(1)	Limpar os produtos já relacionados ao autor - 1 para Sim - 0 para Não
referencia	String(35)	Referência dos produtos para ser vinculado ao autor
status	Integer(1)	Status relacionado ao autor. - 1 para Ativo - 0 para Inativo

Code Block

theme	Midnight
title	Exemplo XML - saveProdutosAutor
linenumbers	true
collapse	true

<data>
	<produtos_autores>
		<produtos_autor>
			<codigo>1036</codigo>
			<limpar_produtos>1</limpar_produtos>
			<produtos>
				<produto>76_0_0_U</produto>
			</produtos>
		</produtos_autor>
	</produtos_autores>
</data>

Expand

title	Save Produtos

Save Produtos

Método

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

Descrição

Salva os produtos enviados. Caso um produto já exista, o webservice irá atualizar as informações se o nos dados estiver o campo atualiza com o valor 1.

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
atualiza	Integer(1)	0 - Para não atualizar o produto se for encontrado. 1 - Para atualizar se o produto for encontrado.
produto_codigo (*)	String(40)	Código de identificação do produto. Esse código deve ser único
produto_codigo_cor (*)	String(35)	Código para identificação da variação de cor do produto. Esse código deve ser único
produto_codigo_tam (*)	String(35)	Código para identificação da variação de tamanho do produto. Esse código deve ser único
titulo (*)	String(200)	Título (nome) do produto.
titulo_completo	String(250)	Título completo (nome detalhado) do produto.
preco_custo	Float (12,2)	Valor de custo do produto.
preco_antigo	Float (12,2)	Valor antigo (de) do produto.
preco_atual (*)	Float(12,2)	Valor atual (por) do produto. Este valor será apresentado ao cliente para venda.
preco_antigo_atacado	Float(12,2)	Preço antigo(de) do produto para a modalidade atacado
preco_atual_atacado	Float(12,2)	Preço atual(por) do produto para a modalidade atacado
preco_antigo_tamanho	Float(12,2)	Preço antigo do tamanho. Caso enviar essa tag, não enviar as tags preco_antigo e preco_atual
preco_atual_tamanho	Float(12,2)	Preço atual do tamanho. Caso enviar essa tag, não enviar as tags preco_antigo e preco_atual
faixa_etaria	String (35)	Faixa etária do produto: – ambos – adulto – infantil
cor (*)	String (50)	Nome da cor do produto
tamanho (*)	String (20)	Tamanho do produto (PP,M,G,32...)
variacao (*)	String (12)	Variação do produto. Possíveis valores: - cor - tamanho - cortamanho - none
referencia	String (35)	Referencia do fabricante.
marca	String(100)	Nome da marca
descricao	String	Descrição do produto em texto ou HTML.
caracteristicas_tecnicas	String	Descrição técnica produto em texto ou HTML.
peso (*)	Float(8,2)	Float de até 10 posições. Utilizar o peso em gramas.
medidas	String(14)	Medidas do produto no formato: Altura x Largura x Comprimento. Exemplo: 12x13x14
lancamento	Integer(1)	Define se produto é lançamento. - 0 para Não - 1 para Sim
destaque	Integer(1)	Define se produto deve esta em destaque. - 0 para Não - 1 para Sim
genero (*)	String(1)	- 1 para Masculino - 2 para Feminino - 0 para Ambos
status (*)	Integer	Status relacionado ao produto. - 1 para Ativo - 0 para Inativo
status_cor (*)	Integer	Status relacionado à cor especificada para o produto, sem alterar o status do produto base. - 1 para Ativo - 0 para Inativo
data_cadastro	String(25)	Data e hora de cadastro do produto no formato 9999-99-99 99:99:99
data_lancamento	String(25)	Data e hora de lançamento do produto no formato 9999-99-99 99:99:99
qtd (*)	Integer(11)	Quantidade em estoque do produto no momento do cadastro
cod_loja (*)	String(12)	Código da loja que possui o estoque. Caso a loja não possua um código definido utilizar 01 (seguir sequencia caso a loja possua mais de uma loja de estoque)
garantia	String(200)	Texto de garantia do produto.
garantia_tempo	Integer(11)	Tempo em dias de garantia do produto.
estoque_minino	Integer(11)	Quantidade mínima do estoque.
categorias (*)	Objeto	Objeto que contém o array categoria.
limpar_categorias	Integer	Está tag não é obrigatória no envio, quando enviada faz todas as relações de categorias antigas cadastradas no produto serem apagadas. Deve ser enviado junto a tag ‘atualiza’. - 1 para Sim - 0 para Não
categoria (*)	Array	Conjunto que conterá as categorias.
categoria_pai (*)	Array	Conjunto de categoria_pai.
nome (*)	String(100)	Nome da categoria pai.
codigo (*)	Integer(11)	Código da categoria pai.
caracteristicas¹	Array	Conjunto de características da categoria pai.
renovar_caracteristicas	Integer(1)	Defini se será renovada ou não as caracteristicas enviadas. Valores: - 0 “Não” - 1 “Sim”
caracteristica	Array	Característica relacionada ao conjunto de Características.
nome	String(50)	Nome da característica.
atributos	Array	Conjunto de atributos da característica.
atributo	Array	Atributo relacionado ao conjunto de atributos.
codigo²	Integer(11)	Código do atributo. Pode ser consultado no método getCaracteristicas.
nome²	String(50)	Nome do atributo.
categorias_filho (*)	Array	Conjunto de categoria_filho.
categoria_filho (*)	Array	Categoria filho.
nome (*)	String(100)	Nome da categoria filho.
codigo (*)	Integer(11)	Código da categoria filho.
caracteristicas¹	Array	Conjunto de características da categoria pai.
renovar_caracteristicas	Integer(1)	Defini se será renovada ou não as caracteristicas enviadas. Valores: - 0 “Não” - 1 “Sim”
caracteristica	Array	Característica relacionada ao conjunto de Características.
nome	String(50)	Nome da característica.
atributos	Array	Conjunto de atributos da característica.
atributo	Array	Atributo relacionado ao conjunto de atributos.
codigo²	Integer(11)	Código do atributo. Pode ser consultado no método getCaracteristicas.
nome²	String(50)	Nome do atributo.
categorias_neto (*)	Array	Conjunto de categoria_neto.
categoria_neto (*)	Array	Categoria neto.
nome (*)	String(100)	Nome da categoria neto.
codigo (*)	Integer(11)	Código da categoria neto.
caracteristicas¹	Array	Conjunto de características da categoria pai.
renovar_caracteristicas	Integer(1)	Defini se será renovada ou não as caracteristicas enviadas. Valores: - 0 “Não” - 1 “Sim”
caracteristica	Array	Característica relacionada ao conjunto de Características.
nome	String(50)	Nome da característica.
multiplo	Integer(1)	Define se a característica permite múltipla seleção. Valores: Sim Não
filtravel	Integer(1)	Define se a característica poderá ser usada como filtro. Valores: Sim Não
obrigatorio	Integer(1)	Define se a característica é de uso obrigatório. Valores: Sim Não
tipo	String	Define se a característica é de produto ou estoque ou ambos. Valores: Estoque Produto Ambos
Exibe descricao	Integer(1)	Define se a característica será exibida na descrição do produto. Valores: Sim Não
Genero	Integer(1)	Define o gênero da característica. Valores: M para Masculino F para Feminino 0 Ambos
Faixa etaria	Integer(1)	Define a faixa etária da característica. Valores: Infantil Adulto Ambas
atributos	Array	Conjunto de atributos da característica.
atributo	Array	Atributo relacionado ao conjunto de atributos.
codigo²	Integer(11)	Código do atributo. Pode ser consultado no método getCaracteristicas.
nome²	String(50)	Nome do atributo.
posicao	Integer	Posição da Imagem, comparada com as outras do mesmo produto.
generico	Integer(1)	Informa se a imagem deve ser utilizada em todas as variações. - 0 para Não - 1 para Sim
imagem_variacao	Integer(1)	Informa se a imagem pertence apenas a esta variação. - 0 para Não - 1 para Sim
principal	Integer(1)	Informa se esta é a imagem principal do produto. - 0 para Não - 1 para Sim
overwrite	Integer(1)	Informa se, caso já exista uma imagem com este mesmo nome para este produto, ela seja sobrescrita. - 0 para Não - 1 para Sim
link	String	Formato de link que será utilizado para acessar o produto na loja. Devem ser enviados apenas letras, maiúsculas ou minúsculas, sem acentos, números e o caractere especial “-” Caso esse campo não seja informado, seu produto receberá um link padrão, que seu título - nome da cor.
meta_title	String	Meta tag de título relacionada ao produto.
meta_keywords	String	Meta tag de palavras -chave relacionadas ao produto. Elas devem ser enviadas separadas por vírgula.
ean13	String(13)	EAN do produto estoque.
descricao_cor	String	Descrição da variação de cor em texto ou HTML.
nfe_origem	Integer(1)	Define a origem do NCM do produto. - 0 para “Nacional”. - 1 para “Importação direta”. - 2 para “Importação indireta”.
nfe_ncm	String	Número do NCM do produto.
Imagens	Object	Tag referente a imagens de produtos.
limpar_imagens	Integer(1)	Define se deve remover as imagens atuais. 0 - “Não” 1 - “Sim”
Imagem	Array of Objects	Lista de imagens pertencentes a um produto. sub-tag de imagens.
Imagem(*)	String	Url completa da imagem. sub-tag de imagem.
imagem_base64(*)	String	Caso a url da imagem não for preenchida, é utilizado esse campo para realizar o upload de uma imagem codificada em base_64. sub-tag de imagem(*).
posicao(*)	Integer	Posição usada para definir a ordem de visualizações das imagens no produto. sub-tag de imagem(*).
generico(*)	Integer	Define se a imagem é genérica de um produto ou relacionada a uma variação específica. - 0 “Não” - 1 “Sim” Obs: Caso passado o valor “1” então a imagem será relacionada a variação específica do produto. sub-tag de imagem(*).
principal	Integer	Define se a imagem é a principal do produto. - 0 “Não” - 1 “Sim” sub-tag de imagem(*).

Observações

¹ O array caracteristicas deve ser colocado no nível da categoria correspondente. Exemplo: Um televisor de 50 polegadas tela LCD, da categoria principal Televisores e categoria filho Tela LCD deve conter as caracteristicas respectivas a categoria filho Tela LCD.

² Deve ser enviado o nome do atributo OU o código do atributo. Um dos dois é obrigatório o envio.

Code Block

theme	Midnight
title	Exemplo XML - saveProduto
linenumbers	true
collapse	true

<produtos>
	<produto>
		<atualiza>1</atualiza>
		<produto_codigo>123</produto_codigo>
		<produto_codigo_cor>1234</produto_codigo_cor>
		<produto_codigo_tam>1234</produto_codigo_tam>
		<titulo>Produto Teste</titulo>
		<preco_custo />
		<meta_title />
		<meta_keywords />
		<meta_description />
		<preco_antigo>150.00</preco_antigo>
		<preco_atual>100.00</preco_atual>
		<nfe_origem>1</nfe_origem>
		<ean13/>
		<nfe_ncm />
		<tamanho />
		<variacao>none</variacao>
		<referencia>12345</referencia>
		<marca>Sem Marca</marca>
		<descricao />
		<caracteristicas_tecnicas />
		<peso>1000</peso>
		<medidas />
		<destaque>1</destaque>
		<lancamento>0</lancamento>
		<genero>0</genero>
		<status />
		<qtd>10</qtd>
		<cod_loja>01</cod_loja>
		<categorias>
			<limpar_categorias>1</limpar_categorias>
			<categoria>
				<categoria_pai>
					<nome>Automotivo</nome>
					<codigo>1111</codigo>
					<categorias_filho>
						<categoria_filho>
							<nome>Carros</nome>
							<codigo>2222</codigo>
							<categorias_neto>
								<categoria_neto>
									<nome>Esporte</nome>
									<codigo>33333-111</codigo>
									<caracteristicas>
										<caracteristica>
											<nome>caracteristica</nome>
											<codigo>15</codigo>
											<tipo>estoque</tipo>
											<multiplo>sim</multiplo>
											<filtravel>sim</filtravel>
											<exibe_descricao>sim</exibe_descricao>
											<obrigatorio>sim</obrigatorio>
											<atributos>
												<atributo>
													<nomeatributo 1
                                                        
													</nome>
													<codigo>10</codigo>
												</atributo>
												<atributo>
													<nome>atributo 2</nome>
													<codigo>20</codigo>
												</atributo>
											</atributos>
										</caracteristica>
									</caracteristicas>
								</categoria_neto>
							</categorias_neto>
						</categoria_filho>
					</categorias_filho>
				</categoria_pai>
			</categoria>
		</categorias>
		<imagens>
			<imagem>
				<limpar_imagens>0</limpar_imagens>
				<imagem />
				<imagem_base64 />
				<posicao />
				<generico />
				<principal />
				<imagem_variacao />
			</imagem>
		</imagens>
	</produto>
</produtos>

Code Block

theme	Midnight
title	Exemplo Json - saveProduto
linenumbers	true
collapse	true

{
  "produto": [
    {
      "atualiza": 1,
      "produto_codigo": "",
      "produto_codigo_cor": "",
      "produto_codigo_tam": "",
      "titulo": "",
      "preco_custo": 99.9,
      "preco_antigo": 99.9,
      "preco_atual": 99.9,
      "preco_custo_atacado": 99.9,
      "preco_antigo_atacado": 99.9,
      "preco_atual_atacado": 99.9,
	  "preco_antigo_tamanho": 60.9,
      "preco_atual_tamanho": 50.9,
      "faixa_etaria": 0,
      "cor": "",
      "tamanho": "",
      "variacao": "",
      "referencia": "",
      "marca": "",
      "descricao": "",
      "ean13": "",
      "nfe_origem": "1",
      "nfe_ncm": "",
      "caracteristicas_tecnicas": "",
      "peso": 99.9,
      "medidas": "10x30x20",
      "destaque": 0,
      "lancamento": 0,
      "genero": "",
      "status": 1,
      "data_cadastro": "",
      "qtd": 99,
      "cod_loja": "",
      "categorias": {
        "limpar_categorias": 1,
        "categoria": [
          {
            "categoria_pai": {
              "nome": "Automotivo",
              "codigo": "1111",
              "categorias_filho": {
                "categoria_filho": {
                  "nome": "Carros",
                  "codigo": "2222",
                  "categorias_neto": {
                    "categoria_neto": {
                      "nome": "Esporte",
                      "codigo": "33333-111",
                      "caracteristicas": {
                        "caracteristica": {
                          "nome": "caracteristica",
                          "codigo": "10101",
                          "tipo": "Estoque",
                          "multiplo": "Sim",
                          "filtravel": "Sim",
                          "exibe_descricao": "Sim",
                          "obrigatorio": "Sim"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          {
            "categoria_pai": {
              "nome": "Automotivo",
              "codigo": "1111",
              "categorias_filho": {
                "categoria_filho": {
                  "nome": "Carros",
                  "codigo": "2222",
                  "categorias_neto": {
                    "categoria_neto": {
                      "nome": "Passeio",
                      "codigo": "33333-222"
                    }
                  }
                }
              }
            }
          }
        ]
      },
      "imagens": {
		"limpar_imagens":0,
        "imagem": [
          {
            "imagem": "",
            "imagem_base64": "",
            "posicao": "0",
            "generico": "0",
            "principal": "0"
          }
        ]
      }
    }
  ]
}

Expand

title	Save Estoque

Save Estoque

Método

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

Descrição

Salva ou atualiza os dados de estoque.

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
produto_codigo_tamanho (*)	String(35)	Código para identificação da variação de tamanho do produto. Esse código deve ser único.
qtd (*)	Integer(11)	Quantidade do produto em estoque.
cod_loja (*)	String(12)	Código da loja referente ao estoque. Caso tenha mais de uma loja de distribuição, é indispensável a utilização deste campo, pois caso contrário colocará na primeira loja encontrada na base de dados, causando divergência.
acao	Integer(1)	Define a ação a ser realizada na quantidade de estoque. Recebe os seguintes valores: “1” - Atualiza a quantidade de estoque pelo valor enviado absoluto; “2” - Atualiza a quantidade de estoque somando o valor enviado junto com o atual; “3” - Atualiza a quantidade de estoque diminuindo o valor enviado junto com o atual;

Code Block

theme	Midnight
title	ExemploXML - saveEstoque
linenumbers	true
collapse	true

<estoques>
  <estoque>
     <produto_codigo_tamanho>720162</produto_codigo_tamanho>
     <qtd>10</qtd>
     <cod_loja>1</cod_loja>
     <acao>1</acao>
  </estoque>
</estoques>

Code Block

theme	Midnight
title	Exemplo Json - saveEstoque
linenumbers	true
collapse	true

{
  "estoque":[
     {
        "produto_codigo_tamanho":"720162",
        "qtd":"10",
        "cod_loja":1,
        "acao":1,
     }
  ]
}

Expand

title	Save Características

Save Caracteristicas

Método

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

Descrição

Salva ou atualiza as características.

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
nome (*)	String(50)	Nome da característica
codigo (*)
multiplo	Integer(1)	Define se a característica permite múltipla seleção Sim Não
filtravel	Integer(1)	Define se a característica poderá ser usada como filtro Sim Não
obrigatorio	Integer(1)	Define se a característica é de uso obrigatório Sim Não
Tipo	Integer(1)	Define se a característica é de produto ou estoque ou ambos. Valores: Estoque Produto Ambos
Exibe descricao	Integer(1)	Define se a característica será exibida na descrição do produto. Valores: Sim Não
Faixa etaria	String	Define a faixa etária da característica. Valores: infantil adulto ambas
categorias (*)	Array	Conjunto com as categorias que se relacionam com a característica. A característica poderá se relacionar somente com categorias de último nível
categoria (*)	String(100)	Nome da categoria
atributos	Array	Atributos que se relacionam com a característica
atributo (*)	Array	Conjunto de opções da característica
nome (*)	String(100)	Nome do atributo
codigo (*)	Integer(11)	codigo do atributo

Code Block

theme	Midnight
title	Exemplo Json - saveCaracteristicas
linenumbers	true
collapse	true

<caracteristicas>
	<caracteristica>
		<nome></nome>
		<codigo></codigo>
		<multiplo></multiplo>
		<tipo></tipo>
		<exibe_descricao></exibe_descricao>
		<filtravel></filtravel>
		<obrigatorio></obrigatorio>
		<genero></genero>
		<faixa_etaria></faixa_etaria>
		<categorias>
			<categoria></categoria>
			<categoria></categoria>
		</categorias>
		<atributos>
			<atributo>
				<nome></nome>
				<codigo></codigo>
			</atributo>
			<atributo>
				<nome></nome>
				<codigo></codigo>
			</atributo>
		</atributos>
	</caracteristica>
</caracteristicas>

Code Block

theme	Midnight
title	Exemplo Json - saveCaracteristicas
linenumbers	true
collapse	true

{
  "caracteristica":[
     {
        "nome" : ””,
        "multiplo" : 0,
        "filtravel" : "",
        "obrigatorio" : "",
        "genero" : "",
        "categorias" {
              categoria: [
                    “Categoria1”, 
                    “Categoria2”,
              ]
        }
        "atributos" {
              atributo: [
                    “atributo 1”, 
                    “atributo 2”,
              ]
        }
     }
  ]
}

Expand

title	Save Características Produto

Save Características Produto

Método

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

Descrição

Vincula as caracteristicas com um produto.

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
produto_codigo (*)	String(40)	Código de identificação do produto. Esse código deve ser único
categorias (*)	Objeto	Objeto que contém o array categoria.
categoria (*)	Array	Conjunto que conterá as categorias.
categoria_pai (*)	Array	Conjunto de categoria_pai.
nome (*)	String(100)	Nome da categoria pai.
caracteristicas(*)¹	Array	Conjunto de características da categoria pai.
caracteristica	Array	Característica relacionada ao conjunto de Características.
nome	String(50)	Nome da característica.
atributos	Array	Conjunto de atributos da característica.
atributo	Array	Atributo relacionado ao conjunto de atributos.
codigo²	Integer(11)	Código do atributo. Pode ser consultado no método getCaracteristicas.
categorias_filho (*)	Array	Conjunto de categoria_filho.
categoria_filho (*)	Array	Categoria filho.
nome (*)	String(100)	Nome da categoria filho.
caracteristicas (*)¹	Array	Conjunto de características da categoria pai.
caracteristica	Array	Característica relacionada ao conjunto de Características.
nome	String(50)	Nome da característica.
atributos	Array	Conjunto de atributos da característica.
atributo	Array	Atributo relacionado ao conjunto de atributos.
codigo²	Integer(11)	Código do atributo. Pode ser consultado no método getCaracteristicas.
categorias_neto (*)	Array	Conjunto de categoria_neto.
categoria_neto (*)	Array	Categoria neto.
nome (*)	String(100)	Nome da categoria neto.
caracteristicas (*)¹	Array	Conjunto de características da categoria pai.
caracteristica	Array	Característica relacionada ao conjunto de Características.
nome	String(50)	Nome da característica.
atributos	Array	Conjunto de atributos da característica.
atributo	Array	Atributo relacionado ao conjunto de atributos.
codigo²	Integer(11)	Código do atributo. Pode ser consultado no método getCaracteristicas.

Observações

¹ O array caracteristicas deve ser colocado no nível da categoria correspondente. Exemplo: Um televisor de 50 polegadas tela LCD, da categoria principal Televisores e categoria filho Tela LCD deve conter as caracteristicas respectivas a categoria filho Tela LCD.

² Deve ser enviado o nome do atributo OU o código do atributo. Um dos dois é obrigatório o envio.

Code Block

theme	Midnight
title	Exemplo XML - saveCaracteristicasProduto
linenumbers	true
collapse	true

<produtos>
	<produto>
		<produto_codigo>000001001</produto_codigo>
		<categorias>
			<categoria>
				<categoria_pai>
					<nome>Escrita</nome>
					<caracteristicas>
						<caracteristica>
							<atributos>
								<atributo>
									<codigo>18</codigo>
								</atributo>
								<atributo>
									<codigo>19</codigo>
								</atributo>
							</atributos>
						</caracteristica>
					</caracteristicas>
				</categoria_pai>
			</categoria>
			<categoria>
				<categoria_pai>
					<nome>Parte de baixo</nome>
					<caracteristicas>
						<caracteristica>
							<atributos>
								<atributo>
									<codigo>22</codigo>
								</atributo>
								<atributo>
									<codigo>17</codigo>
								</atributo>
							</atributos>
						</caracteristica>
					</caracteristicas>
				</categoria_pai>
			</categoria>
			<categoria>
				<categoria_pai>
					<nome>Acessórios</nome>
					<caracteristicas>
						<caracteristica>
							<atributos>
								<atributo>
									<codigo>21</codigo>
								</atributo>
							</atributos>
						</caracteristica>
					</caracteristicas>
				</categoria_pai>
			</categoria>
		</categorias>
	</produto>
</produtos>

Expand

title	Save Nfe

Save Nfe

Método

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

Descrição

Salva ou atualiza a nota fiscal de um pedido e altera o status do pedido para faturado.

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
pedido	Integer(11)	Código do pedido.
serie	Integer	Número de série da chave da nota fiscal.
numero	String	Número da nota fiscal.
chave	String(44)	Chave de 44 dígitos de acesso para a nota fiscal.
link	String	Link para consulta da nota fiscal. Caso seja inserido o valor '[DEFAULT]', será inserido o link para o Portal da Nota Fiscal: http://www.nfe.fazenda.gov.br/portal/consulta.aspx?tipoConsulta=completa&tipoConteudo=XbSeqxE8pl8=
data	String	Data de emissão da nota, no seguinte formato: Y-m-d. Exemplos: 2016-02-13.
status_pedido	Integer(11)	Código do status de pedido que será atualizado após cadastrar a nota-fiscal do pedido. O Código deve ser o mesmo do campo codigo do método getStatusPedidos. Só deverá ser encaminhado o status do pedido para Faturado quando todas as entregas forem faturadas
codigo_entrega	Integer(11)	Código referente a cada entrega do pedido

Observações

Caso seja passado o campo status_pedido com um valor diferente de zero, o pedido será atualizado para o status correspondente cadastrado na plataforma. Se não for enviado o código, será alterado apenas o status da entrega e não do pedido. Quando todas as entregas tiverem suas respectivas notas, pode-se enviar o status desejado.

Code Block

theme	Midnight
title	Exemplo XML - saveNfe
linenumbers	true
collapse	true

<data>
	<nfe>
		<pedido>123</pedido>
		<numero>000012345</numero>
		<serie>1</serie>
		<chave>12480650672006884639473616149668943284951233</chave>
		<link>[DEFAULT]</link>
		<data>2016-03-25</data>
		<status_pedido>2</status_pedido>
        <codigo_entrega>12452121</codigo_entrega>
	</nfe>
</data>

Code Block

theme	Midnight
title	Exemplo Json - saveNfe
linenumbers	true
collapse	true

{
  "nfe": [
    {
      "pedido": 123,
      "numero": "000012345",
      "serie": 1,
      "chave": "12480650672006884639473616149668943284951233",
      "link": "[DEFAULT]",
      "data": "2016-03-25",
      "status_pedido": 2
    }
  ]
}

Expand

title	Save Clientes

Save Clientes

Método

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

Descrição

Salva os clientes enviados. Caso um cliente já exista, o webservice irá atualizar as informações se o nos dados estiver o campo atualiza com o valor 1.

Code Block

theme	Midnight
title	Exemplo Json - saveNfe
linenumbers	true
collapse	true

{
  "clientes": {
    "cliente": [
      {
        "atualiza": 1,
        "tipo_pessoa": "fisica",
        "nome": "Teste Moovin",
        "cpf_cnpj": "12345678910",
        "contato": "",
        "rg": "",
        "sexo": "M",
        "data_nascimento": "01/12/1970",
        "contribuinte": "0",
        "inscricao_estadual": "",
        "inscricao_estadual_isento": "",
        "cep": "92703670",
        "endereco": "Rua Salgado Filho",
        "numero": "468",
        "complemento": "",
        "instrucoes": "",
        "bairro": "São João",
        "cidade": "Porto Alegre",
        "pais": "BRA",
        "estado": "SP",
        "telefone_residencial": "(11) 981123822",
        "telefone_celular": "",
        "telefone_comercial": "",
        "status": "1",
        "bloqueado": "0",
        "email": "teste@moovin.com.br",
        "email_secundario": "",
        "slug": "",
        "sms": "1",
        "newsletter": "1",
        "cadastro_estendido": {
          "Campo1": "valor",
          "Campo2": [
            "valor1",
            "valor2"
          ],
          "Campo3": "valor3"
        }
      }
    ]
  }
}

Métodos UPDATE

Expand

title	Update Pedido

Update Pedido

Método

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

Descrição

Atualiza os dados dos pedidos (1 ou mais pedidos).

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_pedido (*)	Integer(11)	Código do pedido.
codigo_rastreio	String(60)	Código de rastreio do pedido.
data_postagem	Datetime	Data da postagem da transportadora.
data_entrega	Date	Data de entrega da transportadora.
codigo_modalidade_envio	Integer(11)	Código da modalidade de envio da transportadora.
uf_transporte	String(2)	UF do transporte.
data_pagamento	Date	Data de pagamento.
codigo_status_pedido	Integer(11)	Status do pedido. Só deverá enviar o status do pedido quando todas as entregas tiverem sido despachadas ou entregues
status_transacao	String(30)	Status da transação.
codigo_entrega	Integer(11)	Código referente a cada entrega do pedido
codigo_status_entrega	Integer(11)	Código referente ao status de acordo com a tabela status de entregas

Status de Entregas

Codigo	Nome
1	Pendente
2	Transporte
3	Transporte atrasado
4	Transporte problema
5	Entregue
6	Entregue atrasado
7	Entregue problema
8	Aguardando retirada
9	Saiu para entrega

Code Block

theme	Midnight
title	Exemplo XML - updatePedido
linenumbers	true
collapse	true

<pedidos>
   <pedido>
       <codigo_pedido> 107 </codigo_pedido>
       <codigo_rastreio> DU827432251BR </codigo_rastreio>
       <data_postagem> 2016-11-21 13:00:00 </data_postagem>
       <data_entrega> 2016-11-21 </data_entrega>
       <codigo_modalidade_envio> 32 </codigo_modalidade_envio>
       <uf_transporte> RS </uf_transporte>
       <data_pagamento> 2016-11-21 </data_pagamento>
       <codigo_status_pedido>4</codigo_status_pedido>
       <status_transacao> aprovado </status_transacao>
       <codigo_entrega>12452121</codigo_entrega>
       <codigo_status_entrega>2</codigo_status_entrega>  
   </pedido>
</pedidos>

Code Block

theme	Midnight
title	Exemplo Json - updatePedido
linenumbers	true
collapse	true

{
   "pedido": [
    {
       "codigo_pedido": "107",
       "codigo_rastreio": "DU827432251BR",
       "data_postagem": "2016-11-21 13:00:00",
       "data_entrega": "2016-11-21",
       "codigo_modalidade_envio": 32,
       "uf_transporte": "RS",
       "data_pagamento": "2016-11-21",
       "codigo_status_pedido": 4 ,
       "status_transacao": "aprovado"
       "codigo_entrega": 122345,
       "codigo_status_entrega": 2
    }
  ]
}

Expand

title	Update Precos

Update Precos

Método

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

Descrição

Atualiza os preços de produtos.

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
produto_codigo	String(40)	Código de identificação do produto. Esse código deve ser único.
produto_codigo_cor	Integer(35)	Codigo de identificação da variação de cor do produto. Esse código deve ser único.
produto_codigo_tamanho	Integer(35)	Código de identificação da variação de tamanho do produto. Esse código deve ser único.
preco_de	Float(12,2)	Valor que será apresentado como preço antigo do produto. Se não for recebido, o valor não será alterado.
preco_por	Float(12,2)	Valor que será apresentado como preço atual do produto. Se não for recebido ou for recebido com as constantes valor_atual ou [vlr_atual], o valor não será alterado.
manter_desconto	Integer(1)	Não altera os descontos já aplicados no produto na Moovin. Valores: 1 - Não alterar o desconto; 0 - Alterar o desconto.

Observações

Para utilizar a versão atualizada deste método é preciso solicitar para o help desk da Moovin ativá-lo no admin.

O quadro de parâmetros não mostra mas o código identificador da variação de cor ou o código da variação de tamanho é obrigatório, o funcionamento do método varia de acordo com o código recebido.

Se o código da variação de cor for enviado, o preço será atualizado se o produto usa o preço na variação de cor.

Se o código da variação de tamanho for enviado, o preço será atualizado se o produto usa preço por variação de tamanho.

O código do produto é recebido somente para especificar melhor o filtro, em caso de existirem variações de cor com o mesmo código.

Code Block

theme	Midnight
title	Exemplo XML - updatePrecos
linenumbers	true
collapse	true

<data>
   <produto>
    <produto_codigo>12345</produto_codigo>
     <produto_codigo_cor>12345-123</produto_codigo_cor>
     <produto_codigo_tamanho>12345-123-00</produto_codigo_tamanho>
     <preco_de>199.99</preco_de>
     <preco_por>159.99</preco_por>
  </produto>
</data>

Code Block

theme	Midnight
title	Exemplo Json - updatePrecos
linenumbers	true
collapse	true

{
   "produto": [
    {
       "produto_codigo": "12345",
       "produto_codigo_cor": "12345-123",
       "produto_codigo_tamanho": "12345-123-00",
       "preco_de": 199.99,
       "preco_por": 159.99
    }
  ]
}

Tabela de retornos

O webservice retorna na requisição duas informações o código e a mensagem, para facilitar a compreensão, nós disponibilizamos uma tabela contendo o código, mensagem e descrição:

Código	Mensagem	Descrição
0	Sucesso	Operação foi realizada com sucesso
1	Dados não enviados ou em formato desconhecido	Os dados não foram enviados em um formato compatível. Verifique se os dados estão em XML ou JSON
2	Método inexistente	O método requisitado não existe, verifique a documentação para ver os métodos válidos
3	Nenhum resultado encontrado para a busca	Ocorre quando não é encontrado nenhum resultado na consulta
4	Token não enviado ou incorreto	Verifique se o token foi enviado corretamente e se o mesmo está correto.
5	Não foi possível identificar a requisição	A requisição não veio por POST nem por SOAP.
6	Ocorreu um erro interno ao carregar o webservice	Entre em contato conosco informando esse erro
7	Verifique se os dados foram enviados corretamente	Faltam dados ou foram enviados em formato incorreto
8	Data não enviada ou em formato incorreto	Verifique a data enviada se está no formato conforme descreve a documentação
9	Verifique se os dados dos produtos foram enviados corretamente	Consulte esta documentação para maiores informações de como enviar os dados dos produtos

Version	Old Version 29	New Version Current
Changes made by	Suporte	Suporte
Saved on	17 Mar, 2020	17 Mar, 2020

Page Comparison

Versions Compared

Key

Introdução

Endereço de web service

Definição do tipo de retorno

Consultando informações

Estrutura de filtros

Enviando informações

Estrutura de retornos

Descrição dos métodos

Métodos GET

Get Características

Método

Descrição

Filtros

Retorno

Get Produtos

Método

Descrição

Filtros

GE didos

Método

Descrição

Filtros

Retorno

Métodos SAVE

Save Autor

Método

Descrição

Dados

Save Produtos Autor

Método

Descrição

Dados

Save Produtos

Método

Descrição

Dados

Observações

Save Estoque

Método

Descrição

Dados

Save Caracteristicas

Método

Descrição

Dados

Save Características Produto

Método

Descrição

Dados

Observações

Save Nfe

Método

Descrição

Dados

Observações

Save Clientes

Método

Descrição

Métodos UPDATE

Update Pedido

Método

Descrição

Dados

Status de Entregas

Update Precos

Método

Descrição

Dados

Observações

Tabela de retornos