copia_Documentação WebService 2020

07 Jan, 2022

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/json
Retorno usando XML: http://sualoja.integration.moovin.com.br/webservice/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.

Limite de requisições

O limite de requisição para o webservice deve ser até 60 registros enviados por minuto. Não podendo enviar diversos skus na mesma requisição. Adequar-se para enviar um SKU por requisição.

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.

Exemplo de requisição via Postman

Todos os métodos deverão ser enviados via POST.
Os parâmetros Token e Data devem estar localizados no Body.
O campo Data servirá para conter o filtro caso for um método GET ou como envio caso for um método de Update ou Save.
Caso for GET, é obrigatório enviar pelo menos um filtro. Exemplo na imagem abaixo.
Caso não fixar o formato de retorno (XML ou JSON), coletaremos a formatação do envio e retornaremos no mesmo formato.

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:

<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

Get Reservas Estoque

Método

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

Descrição

Este método retorna uma listagem com a quantidade de estoque de cada SKU a ser reservado

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)	Define quantos resultados serão exibidos na consulta. Caso seja informado um número maior que 100, ele retornará 30.
pagina	Integer(10)	Define de qual resultado ele começará a exibir resultados.
sku	String(100)	Caso seja informado, retornará apenas as informações de estoque daquele produto. Caso queira consultar mais skus, insira diversos skus nesta tag separado por vírgula
id_reserva	Integer(10)	Identificador da reserva
data_reserva_de	String(100)	Busca a partir desta data. (Y-m-d h:m:s): ‘2015-12-20’, ‘2016-02-13 00:00:00’.
data_reserva_ate	String(100)	Busca a até desta data. (Y-m-d h:m:s): ‘2015-12-20’, ‘2016-02-13 00:00:00’.
data_liberacao_de	String(100)	Busca a partir desta data. (Y-m-d h:m:s): ‘2015-12-20’, ‘2016-02-13 00:00:00’.
data_liberacao_ate	String(100)	Busca a até desta data. (Y-m-d h:m:s): ‘2015-12-20’, ‘2016-02-13 00:00:00’.

Exemplo de XML - getReservasEstoque

<reservas>
    <reserva>
          <id>123</id
          <codigo_pedido>1000</codigo_pedido> 
          <codigo_produto>12212</codigo_produto>
          <status>Criado</status>
          <qtd>1</qtd>
          <loja>01</loja>
   </reserva>
   <reserva>
         <id>124</id>
         <codigo_pedido>1000</codigo_pedido> 
         <codigo_produto>122121</codigo_produto>
         <status>Liberado</status>
         <qtd>1</qtd>
         <loja>02</loja>
   </reserva>
<reservas>

Get Quantidade Estoque

Método

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

Descrição

Este método retorna uma listagem com a quantidade de estoque de cada SKU

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)	Define quantos resultados serão exibidos na consulta. Caso seja informado um número maior que 100, ele retornará 30.
pagina	Integer(10)	Define de qual resultado ele começará a exibir resultados.
produto_codigo_tamanho	String(100)	Caso seja informado, retornará apenas as informações de estoque daquele produto.
data_modificacao_de	String(19)	Busca a partir desta data. (Y-m-d h:m:s): `2015-12-20`, `2016-02-13 00:00:00`
data_modificacao_ate	String(19)	Busca até essa data. (Y-m-d h:m:s): `2015-12-20`, `2016-02-13 00:00:00`

Exemplo de retorno XML:

Exemplo de XML

<?xml version="1.0" encoding="UTF-8" ?>
<estoques>
    <estoque>
        <produto_codigo_tamanho>1000028401889</produto_codigo_tamanho>
        <qtd>4</qtd>
        <cod_loja>loja-1</cod_loja>
    </estoque>
    <estoque>
        <produto_codigo_tamanho>1000028401889</produto_codigo_tamanho>
        <qtd>10</qtd>
        <cod_loja>02</cod_loja>
    </estoque>
</estoques>

Exemplo de Json - getQuantidadeEstoque

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

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 retornar com os pedidos.
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.
kit	integer	0 - Não retorna produtos Kit 1 - Retorna Produtos Kit

Get Preco

Método

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

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	Descrição
produto_codigo	Código do produto.
produto_codigo_cor	Código da variação do produto.
data_modificacao_de	Busca por alterações feitas entre estas datas Formato: YYYY-MM-DD
data_modificacao_ate
pagina	Qual página retornar no resultado da busca.
limite	Quantos itens deverão retornar em cada página da busca.

Retorno

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

Grupo	Nome	Descrição
	precos	Contém dados de preços de diversos produtos
	produto_codigo_cor	Código da Cor
	preco_de	Preço antigo do produto
	preco_por	Preço atual do produto
	desconto_por_qtd	Contém dados de desconto por quantidade
	qtd_de	Quantidade inicial
	qtd_ate	Quantidade final
	desconto	Desconto a ser aplicado no range de quantidade inicial e final caso escolhida

Exemplo de retorno Json:

Get Preco

{
    "precos": [
        {
            "produto_codigo_cor": "MTSFIAC",
            "preco_de": "0.00",
            "preco_por": "1.29",
            "desconto_por_qtd": [
                {
                    "qtd_de": "50",
                    "qtd_ate": "375",
                    "desconto": "0.00"
                },
                {
                    "qtd_de": "376",
                    "qtd_ate": "0",
                    "desconto": "16.00"
                },
                {
                    "qtd_de": "50",
                    "qtd_ate": "375",
                    "desconto": "0.00"
                },
                {
                    "qtd_de": "376",
                    "qtd_ate": "0",
                    "desconto": "16.00"
                }
            ]
        }
    ]
}

Get Imagens

Método

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

Descrição

Este método retorna uma listagem com as imagens 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)	Define a quantidade de registros a retornar.
pagina	Integer(10)	Define de qual resultado ele começará a exibir resultados.
status	Integer(10)	Status do produto: 0 - Inativo 1 - Ativo 2 - Ativo invisível
codigo	String(40)	Busca pelo código do produto.
nome	String(200)	Busca pelo nome do produto.
data_cadastro	String(19)	Busca pela data exata de cadastro dos clientes (Y-m-d h:m:s): ‘2015-12-20’, ‘2016-02-13 00:00:00’.
data_cadastro_de	String(19)	Busca a partir desta data. (Y-m-d h:m:s): ‘2015-12-20’, ‘2016-02-13 00:00:00’.
data_cadastro_ate	String(19)	Busca até essa data. (Y-m-d h:m:s): ‘2015-12-20’, ‘2016-02-13 00:00:00’.
produto_codigo_cor	String(35)	Busca pelo código da variação de cor do produto associado à cor da imagem.

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	produtos		Campo principal da estrutura. Todos produtos da consulta são retornados dentro dele.
produtos	produto		Contém os dados referentes a um produto.
produto	codigo	String(40)	Identificador do produto na plataforma.
produto	pos	integer(11)	Ordem de exibição das imagens do produto no site.
produto	imagem	String(200)	Nome da imagem do produto com formato.
produto	imagem_url	String(300)	Url completa da imagem do produto.

Exemplo de retorno XML:

<produtos>
   <produto>
       <codigo>0010010086</codigo>
       <pos>1</pos>
       <imagem>
       smartphone-microsoft-lumia-435-0f630c27b4479e38c17de.jpg
       </imagem>
       <imagem_url>
       http://cloudfront.net/smartphone-microsoft-lumia-435-0f630c27b4479e38c17de.jpg
       </imagem_url>
   </produto>
</produtos>

Get Clientes

Método

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

Descrição

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

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)	Define a quantidade de registros a retornar.
pagina	integer(10)	Filtra a página exibida conforme o limite de produtos que é retornado
tipo_pessoa	Integer(1)	Busca por clientes do tipo pessoa física ou jurídica: 0 - Pessoa física 1 - Pessoa jurídica
nome	String(100)	Busca por clientes com um nome específico.
cpf_cnpj	String(20)	Busca por clientes com um CPF caso pessoa física, ou CNPJ caso pessoa jurídica.
cep	String(10)	Busca por clientes de um determinado CEP.
cidade	String(50)	Busca por clientes de uma determinada cidade.
estado	String(2)	Busca por clientes de um determinado estado: Exemplo: RS, SP, SC ...
email	String(120)	Busca por clientes com um determinado e-mail.
data_cadastro	String(19)	Busca pela data exata de cadastro dos clientes (Y-m-d h:m:s): ‘2015-12-20’, ‘2016-02-13 00:00:00’.
codigo	Integer(11)	Busca por clientes com um determinado código.
autorizo_newsletter	Integer(11)	Busca por clientes que autorizam newsletters.
autorizo_sms	Integer(11)	Busca por clientes que autorizam sms.

Observações

O filtro de data de cadastro não é maior nem menor, é exatamente. Para buscar clientes de um dia, ‘2016-01-13’ ou de um mês, ‘2016-01’.

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	clientes		Campo principal da estrutura. Todos clientes da consulta são retornados dentro dele.
clientes	cliente		Contém os dados referentes a um cliente.
cliente	codigo_cliente	Integer(11)	Identificador do cliente na plataforma.
cliente	status	Tinyint(1)	Status do cliente na plataforma: “0” - Desativado “1” - Ativado
cliente	data_cadastro	Datetime	Data de cadastro do cliente na plataforma.
cliente	tipo_pessoa	Tinyint(1)	Tipo de cliente: “0” - Pessoa Física “1” - Pessoa Jurídica
cliente	nome	Varchar(100)	Nome do cliente.
cliente	inscricao_estadual	Varchar(25)	Número da inscrição estadual.
cliente	inscricao_estadual_isento	Tinyint(1)	Isenção de inscrição estadual: “0” - Não “1” - Sim
cliente	nome_fantasia	Varchar(120)	Nome fantasia do cliente/empresa.
cliente	estado_civil	Varchar(3)	Estado cívil do cliente: “n/a” - Não definido “1” - Solteiro “2” - Casado “3” - Separado “4” - Divorciado “5” - Outros
cliente	data_nasc	Date	Data de nascimento do cliente.
cliente	sexo	Varchar(10)	Gênero do cliente: “n/a” - Não definido “M” - Masculino “F” - Feminino
cliente	cpf_cnpj	Varchar(20)	Número do CPF ou CNPJ do cliente.
cliente	rg	Varchar(20)	Número do RG do cliente.
cliente	contribuinte	Varchar(10)	Define de o cliente é contribuinte: “n/a” - Não definido “N” - Não “S” - Sim
cliente	contato	Varchar(120)	Nome de contato do cliente.
cliente	endereco	Varchar(150)	Endereço de origem do cliente.
cliente	numero	Varchar(10)	Número de endereço de origem do cliente.
cliente	complemento	Varchar(130)	Complemento do endereço de origem do cliente.
cliente	bairro	Varchar(30)	Bairro de origem do cliente.
cliente	instrucoes	Varchar(100)	Instruções do endereço de origem do cliente.
cliente	cep	Varchar(50)	Código do CEP de origem do cliente.
cliente	cidade	Varchar(50)	Cidade de origem do cliente.
cliente	estado	Varchar(100)	Estado de origem do cliente.
cliente	email	Varchar(120)	Endereço de Email principal.
cliente	email_secundario	Varchar(120)	Endereço de Email secundário.
cliente	telefone_res	Varchar(15)	Telefone residencial.
cliente	telefone_cel	Varchar(15)	Telefone celular.
cliente	telefone_com	Varchar(15)	Telefone comercial.
cliente	pais	Varchar(3)	Sigla do pais do cliente.
cliente	grupo	Varchar(70)	Grupo do cliente.
cliente	autorizo_newsletter	Tinyint(1)	Autoriza receber Newsletter: “0” - Não “1” - Sim
cliente	autorizo_sms	Tinyint(1)	Autoriza receber Sms: “0” - Não “1” - Sim
cliente	campos_estendidos	Array	Contém todos os campos estendidos do cliente
cliente	campo_estendido		Cada campo estendido
campo_estendido	nome_campo	Varchar(100)	Título do campo estendido
campo_estendido	opcao	Varchar(100)	Opção escolhida no campo estendido

Exemplo de retorno XML:

<clientes>
   <cliente>
       <codigo_cliente>1</codigo_cliente>
       <status>1</status>
       <data_cadastro>2015-08-28 11:08:32</data_cadastro>
       <tipo_pessoa>0</tipo_pessoa>
       <nome>João da Silva</nome>
       <inscricao_estadual />
       <inscricao_estadual_isento>0</inscricao_estadual_isento>
       <nome_fantasia />
       <estado_civil>n/a</estado_civil>
       <data_nasc>1993-04-13</data_nasc>
       <sexo>M</sexo>
	   <autorizo_newsletter>1</autorizo_newsletter>
	   <autorizo_sms>1</autorizo_sms>	
       <cpf_cnpj>12364557897</cpf_cnpj>
       <rg>11.113.116-9</rg>
       <contribuinte>N</contribuinte>
       <contato />
       <endereco>Rua</endereco>
       <numero>123</numero>
       <complemento>Casa</complemento>
       <bairro>Centro</bairro>
       <instrucoes>Instrução</instrucoes>
       <cep>84600000</cep>
       <cidade>União da Vitória</cidade>
       <estado>PR</estado>
       <email>exemplo@mail.com</email>
       <email_secundario></email_secundario>
       <telefone_res>(51) 123456748</telefone_res>
       <telefone_cel>(42) 88000000</telefone_cel>
       <telefone_com />
       <pais />
	   <grupo>Varejo</grupo>
	   <campos_estendidos>
       		<campo_estendido>
		       <nome_campo>teste1</nome_campo>
       		   <opcao>12345</opcao>
       		</campo_estendido>
       </campos_estendidos>
   </cliente>
</clientes>

Get Pedidos

Método

O nome do método utilizado na consulta é getPedidos

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_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 100.
pagina	Integer(10)	paginaInteger(10)Filtra a página exibida conforme o limite de produtos que é retornado
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).
ordem_data_criacao	String(19)	O valor pode ser DESC (Decrescente) ou ASC (Crescente)
ordem_data_atualizacao	String(19)	O valor pode ser DESC (Decrescente) ou ASC (Crescente)
pedido_troca	Integer(11)	Define se o pedido obteve uma troca ou não. “0” - Não “1” - Sim
Importado	integer(1)	Define se o pedido foi importado pelo ERP ou não. "0" - Não "1" - Sim

Observações:

Não são retornados pedidos inativos (deletados pela plataforma).
Não são retornados pedidos com status “Em compra”.
Não é retornado o filtro de NF gerando uma otimização na consulta com o parâmetro getPedidosV2

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	data_ultima_atualizacao	Datetime	Data e hora da atualização do pedido. exemplo: 2015-09-11 17:38:45
pedido	numero_pedido_troca	Integer(11)	Número do pedido que obteve a troca
pedido	taxa_marketplace	Decimal(9.2)	Taxa cobrada pelo pedido de marketplace
pedido	taxa_frete_marketplace	Decimal(9.2)	TAxa de frete cobrada pelo marketplace
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_acrescimo	Decimal(9,2)	Valor de Acréscimo
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 cobrado no 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	url_boleto	Varchar(250)	Url 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	vendedor_nome	Varchar(60)	Identificador do nome do revendedor.
pedido	vendedor_codigo	Integer	Identificador do código do revendedor.
pedido	vendedor_nome	Varchar()	Identificador do nome do revendedor.
pedido	vendedor_codigo		Identificador do código do revendedor.
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	id_marketplace_item	Varchar(35)	Código enviado pelo Marketplace Mercado Libre e Colombo
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(50)	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.
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 (Valor original cotado na transportadora).
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.
	adquirente	Varchar(20)	Identificador da adquirente.
transacao	num_comp_venda	Varchar(200)	Número do comprovante de venda do pedido.
transacao	data_pagamento	Date	data de pagamento da transação.
transacao	identificador_conta	Varchar(200)	Identificador da conta. Utilizado no momento para coletar o identificador da conta no Mercado Livre.
transacao	nome_conta	Varchar(200)	Nome da conta. Utilizado no momento para coletar o nome da conta no Mercado Livre.

<filtros>
 <codigo>29355</codigo>
</filtros>

Exemplo JSON - GetPedidoV2

{
    "pedidos": [
        {
            "codigo_pedido": "39077",
            "data": "2019-12-23 13:53:30",
            "data_ultima_atualizacao": "2019-12-23 13:53:31",
            "codigo_forma_pagamento": "33",
            "nome_forma_pagamento": "Pagamento Netshoes - Netshoes",
            "loja_venda": "",
            "nome_loja_pagamento": "E-commerce",
            "codigo_status_pedido": "2",
            "descricao_loja_status_pedido": "Pendente",
            "descricao_cliente_status_pedido": "Pendente",
            "status_transacao": "Pendente",
            "pagamento_efetuado": "N",
            "parcelas": "1",
			"valor_acrescimo": "10.00",
            "valor_parcial": "99.89",
            "valor_total": "113.89",
            "valor_frete": "14.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": "",
            "qtd_itens": "1",
            "separado_por_usuario": "",
            "data_separado": "0000-00-00 00:00:00",
            "navegador": "",
            "navegador_versao": "",
            "sistema_operacional": "",
            "mobile": "0",
            "meio_ambiente": "0",
            "pagamento_venc_boleto": "0000-00-00",
            "importado": "0",
            "campanha_id": "58",
            "campanha_ident": "marketplace.netshoes",
            "pagamento_identificador": "36488046",
            "codigo_revendedor": "",
			"pedido_troca" "N",
			"numero_pedido_troca": "",
			"taxa_marketplace": "0.00",
			"taxa_frete_marketplace": "0.00",
            "itens": {
                "item": [
                    {
                        "codigo": "10.3318.37",
                        "produto_codigo": "6365667302",
                        "produto_codigo_cor": "6365667302427",
                        "produto_codigo_tamanho": "10.3318.37",
                        "qtd": "1",
                        "cor": "Napa Rosa",
                        "tamanho": "37",
                        "nome_loja": "E-commerce",
                        "cod_loja": "1",
                        "valor": "99.89",
                        "valor_pago": "99.89",
                        "prazo_entrega_extra": "0",
                        "nfe_ncm": "",
                        "nfe_origem": "0",
                        "peso": "1000",
                        "presente": "N",
                        "pre_venda": "N",
                        "personalizacao": "",
                        "data_envio_pre_venda": "0000-00-00",
                        "descricao": "Ref: 5667302 | Tam.: 37 | TÊNIS MOLECA FEMININO | Cor: NAPA ROSA",
                        "id_marketplace_item": ""
                    }
                ]
            },
            "cliente": {
                "codigo": "40897",
                "nome": "Teste Moovin LTDA",
                "telefone_residencial": "(77)777777777",
                "telefone_celular": "(77)777777777",
                "telefone_comercial": "",
                "cpf_cnpj": "012345678910",
                "email": "3089d11903282cda1ce06cfaa76ecb0c@netshoes.com.br",
                "data_nasc": "2019-12-23"
            },
            "dados_entrega": {
                "nome": "Teste de Destinatario",
                "rg": "",
                "endereco": "Avenida Inacio Berwian",
                "numero": "700",
                "complemento": "123456",
                "instrucoes": "Morada do Sol",
                "bairro": "Morada do Sol",
                "cep": "95775000",
                "cidade": "TUPANDI",
                "estado": "RS",
                "email": "3089d11903282cda1ce06cfaa76ecb0c@netshoes.com.br",
                "telefone_residencial": "(77)777777777",
                "telefone_celular": "(88)888888888",
                "telefone_comercial": ""
            },
            "dados_transacao": {
                "transacao": [
                    {
                        "data": "0000-00-00",
                        "cod_forma_pagamento": "33",
                        "forma_pagamento": "Pagamento Netshoes - Netshoes",
                        "parcelas": "1",
                        "gateway": "0",
                        "valor_total": "113.89",
                        "vencimento_boleto": "0000-00-00",
                        "mensagem_retorno": "",
                        "codigo_retorno": "",
                        "num_autorizacao": "",
                        "num_transacao": "",
                        "ident": "799995948",
                        "adquirente": "",
                        "num_comp_venda": "",
                        "data_pagamento": "2019-12-23 13:53:31",
                        "data_aprovacao": ""
                    }
                ]
            },
            "dados_transporte": {
                "modalidade": "Sedex",
                "codigo_rastreio": "",
                "valor_transporte": "14.00",
                "prazo_entrega": "5",
                "codigo_transportadora": "4",
                "tipo": "Expresso",
                "data_postagem": "0000-00-00 00:00:00",
                "data_entrega": "0000-00-00"
            }
        }
    ]
}

Get Nfe

Método

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

Descrição

Retorna os dados das notas fiscais dos pedidos faturados na plataforma.

Filtros

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

Nome	Tipo	Descrição
pedido	Integer(11)	Código do pedido.
chave	String	Chave de 44 dígitos de acesso para a nota fiscal.
pagina	integer(11)	Filtra a página exibida conforme o limite de produtos que é retornado
limite	integer(11)	Limita a busca para um número positivo igual ou menor a 300000.
data_ultima_atualizacao_de data_ultima_atualizacao_ate	String	Data de atualização da nota, no seguinte formato: "Y-m-d ou Y-m-d H:i:s". Exemplos: "2020-08-13" ou "2020-08-13 12:00:00"

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
pedido	pedido	Integer	Código do pedido.
notas_fiscais	serie	Integer	Número de série da chave da nota fiscal.
notas_fiscais	numero	String	Número da nota fiscal.
notas_fiscais	chave	String	Chave de 44 dígitos de acesso para a nota fiscal.
notas_fiscais	link	String	Link para consulta da nota fiscal.
notas_fiscais	data	String	Data de emissão da nota.
pedido	status_pedido	Integer	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.

Filtro usando JSON:

Exemplo Requisição JSON - GetNfe

{
    "data_ultima_atualizacao_de" : "yyyy-mm-dd",
    "data_ultima_atualizacao_ate" :"yyyy-mm-dd"
}

Filtro usando XML:

Exemplo requisição XML - GetNfe

<filtros>
   <pagina>1</pagina>
   <limite>2</limite>
</filtros>

Exemplo de retorno em JSON:

Exemplo retorno JSON - GetNfe

[
    {
        "pedido": "xxxxxxxx",
        "numero": "yyyyyyyy",
        "serie": "123456789",
        "chave": "101112131415",
        "link": "https//:www.site.org.br",
        "data": "2020-07-21",
        "status_pedido": "Entregue"
    },
    {
        "pedido": "aaaaaaaaaaa",
        "numero": "bbbbbbbbb",
        "serie": "987654321",
        "chave": "151413121110",
        "link": "https//:www.site.com.br",
        "data": "2020-07-20",
        "status_pedido": "Entregue"
    }
]

Get Status Pedidos

Método

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

Descrição

Este método retorna uma listagem dos status que os pedidos podem ter que estão cadastrados na Moovin.

Filtros

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

Nome	Tipo	Descrição
codigo	Integer(11)	Busca por um código específico de um status
tipo	String(20)	Busca os status pelo tipo. Valores disponíveis: ‘pendente’, ‘aprovado’, ‘cancelado’, ‘transporte’, ‘completo’ e ‘n/a’ para status sem tipo. Este filtro não é obrigatório, se não for definido, a busca retornará todos tipos de status.
limite	Integer(6)	Limita a busca para um número positivo igual ou menor a 300000.

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	status_pedidos		Campo principal da estrutura. Todos status de pedidos da consulta são retornados dentro dele.
status_pedidos	status		Cada um dos status será retornado dentro de um campo. Dentro dele está contidas todas as informações do status.
status	codigo_status	Integer(11)	Identificador do status de pedido na loja.
status	descricao_loja	Varchar(150)	Descrição do status de pedido configurada na plataforma.
status	descricao_cliente	Varchar(200)	Descrição do status apresentada para os clientes.
status	tipo	Varchar(20)	Tipo de status do pedido. “pendente” - Pendente “aprovado” - Aprovado “cancelado” - Cancelado “transporte” - Transporte “completo” - Completo “n/a” - Não definido Obs: Os tipos de status de pedidos se referem de uma forma mais genérica. Através dele que são muitas ações e fluxos relacionados a pedidos na plataforma.

Exemplo XML - GetEstoque

<status_pedido>

   <status>

       <codigo_status>1</codigo_status>

       <descricao_loja>Em compra</descricao_loja>

       <descricao_cliente>Em compra</descricao_cliente>

       <tipo>pendente</tipo>

   </status>

   <status>

       <codigo_status>2</codigo_status>

       <descricao_loja>Pendente</descricao_loja>

       <descricao_cliente>Pendente</descricao_cliente>

       <tipo>pendente</tipo>

   </status>

   <status>

       <codigo_status>3</codigo_status>

       <descricao_loja>Em Análise</descricao_loja>

       <descricao_cliente>Em Análise</descricao_cliente>

       <tipo>pendente</tipo>

   </status>

   <status>

       <codigo_status>4</codigo_status>

       <descricao_loja>Aprovado</descricao_loja>

       <descricao_cliente>Crédito e Cadastro Aprovados</descricao_cliente>

       <tipo>aprovado</tipo>

   </status>

   <status>

       <codigo_status>16</codigo_status>

       <descricao_loja>Entregue indenizado</descricao_loja>

       <descricao_cliente>Entregue</descricao_cliente>

       <tipo>completo</tipo>

   </status>

   <status>

       <codigo_status>17</codigo_status>

       <descricao_loja>Transporte</descricao_loja>

       <descricao_cliente>Transporte</descricao_cliente>

       <tipo>transporte</tipo>

   </status>

/status>

</status_pedido>

Get Estoque - Descontinuado

Método

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

Descrição

Este método retorna uma listagem com os dados de estoque.

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
cor	String(50)	Busca por produtos no estoque de uma cor específica
produto_codigo	String(40)	Busca por produtos no estoque que contenham este código
produto_codigo_exato	String(40)	Busca por produtos no estoque com um código específico
produto_codigo_cor	String(40)	Busca por produtos no estoque que contenham este código de variação de cor
produto_codigo_cor_exato	String(40)	Busca por produtos no estoque com um código de variação de cor específico
produto_codigo_tamanho	String(40)	Busca por produtos no estoque com um código de variação de tamanho específico
nome_produto	String(100)	Busca por produtos no estoque com um nome do produto.
data_modificacao_ini	Datetime	Busca por produtos que tiveram a data de modificacão inicial no valor do campo. OBS: O filtro deve ser usado apenas quando também usar junto com o campo data_modificacao_fim
data_modificacao_fim	Datetime	Busca por produtos que tiveram a data de modificacão até o valor do campo. OBS: O filtro deve ser usado apenas quando também usar junto com o campo data_modificacao_ini
pagina	Integer(10)	Filtra a página exibida conforme o limite de produtos que é retornado
disponivel	Integer(1)	Disponibilidade em estoque do produto 0 - Sem estoque 1 - Com estoque

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
estoque	codigo	String(40)	Código do estoque.
estoque	status	Integer(1)	Status do produto em estoque.
estoque	data	String(11)	Data do cadastro. Formato da data retornada: “Y-m-d H:i:s”.
estoque	data_estoque	String(11)	Data que foi salvo no estoque. Formato da data retornada: “Y-m-d H:i:s”.
estoque	link	String(250)	Link referência do produto.
estoque	variacao	String(20)	Variação do produto. Valores: tamanho, cor, cortamanho e nenhum.
estoque	codigo_marca	Integer(11)	Código da marca do produto.
estoque	marca	String(100)	Nome da marca do produto.
estoque	descricao_marca	String	Descrição da marca do produto.
estoque	titulo_completo	String(250)	Título completo do produto.
estoque	titulo	String(200)	Título do produto.
estoque	descricao	String	Descrição do produto.
estoque	faixa_etaria	Integer(1)	Faixa etária do produto. Retorna: “adulto” e “infantil”.
estoque	descricao_curta	String	Descrição curta do produto.
estoque	garantia	String(200)	Garantia do produto.
estoque	peso	String(10)	Peso do produto.
estoque	nfe_ncm	String(20)	Nota fiscal eletrônica ncm.
estoque	nfe_origem	Integer(1)	Origem da Nota fiscal eletrônica. Valores: “0” - Nacional; “1” - Importada diretamente; “2” - Importada indiretamente.
estoque	medida1	String(4)	Altura do produto.
estoque	medida2	String(4)	Largura do produto.
estoque	medida3	String(4)	Comprimento do produto.
estoque	meta_keywords	String(250)	Metas keywords do produto.
estoque	tags	String(200)	Tags do produto.
estoque	meta_description	String	Meta description do produto.
estoque	meta_title	String(250)	Meta title do produto.
estoque	meta_title_2	String(250)	Meta title 2 do produto.
estoque	meta_description_2	String	Meta description 2 do produto.
estoque	meta_keywords_2	String(250)	Metas keywords 2 do produto.
estoque	cores	Array	Conjunto de todas as variações cores do produto.
cores	cor		Cor relacionada ao conjunto de variações cores do produto.
cor	codigo_produto_cor	String(35)	Código da variação de cor.
cor	referencia	String(35)	Referência do produto estoque.
cor	pre_venda	Integer(1)	Defini se o produto está como pré venda ou não. Retorna: “0” - Não “1” - Sim
cor	qtd	String(11)	Quantidade da variação cor.
cor	data	String(11)	Data do cadastro. Formato da data retornada: “Y-m-d H:i:s”.
cor	link	String(250)	Link da referência do produto.
cor	cod_desconto	Integer(11)	Código do desconto produto estoque.
cor	status	Integer(1)	Status do produto estoque. Defini se ele está ativo ou inativo. Retorna: “0” - Inativo “1” - Ativo
cor	destaque	Integer(1)	Defini se o produto estoque está como destaque ou não. Retorna: “0” - Não “1” - Sim
cor	lancamento	Integer(1)	Defini se o produto estoque está como lançamento ou não. Retorna: “0” - Não “1” - Sim
cor	prazo_entrega_extra	Integer(3)	Prazo de entrega extra do produto estoque em dias.
cor	genero	String(1)	Gênero do produto estoque. Retorna: “M” - Masculino; “F” - Feminino; “U” - Unissex.
cor	vlr_custo	Float(9,2)	Valor de custo.
cor	vlr_antigo	Float(9,2)	Valor antigo.
cor	vlr_atual	Float(9,2)	Valor atual.
cor	vlr_antigo_atacado	Float(9,2)	Valor antigo atacado.
cor	vlr_atual_atacado	Float(9,2)	Valor atual atacado.
cor	cor_fabricante	String(35)	Cor do fabricante do produto estoque.
cor	cor	String(50)	Nome da cor.
cor	cor_secundaria	String(50)	Nome da segunda cor.
cor	valores	Array	Conjunto de valores da variação cores do produto.
valores	valor		Valo relacionada ao conjunto de valores.
valor	vlr_antigo	Float(9,2)	Valor antigo.
valor	vlr_atual	Float(9,2)	Valor atual.
valor	percentual_desconto	Float(9,2)	Percentual de desconto.
valor	data_inicial	Varchar(11)	Data inicial. Formato da data retornada: “Y-m-d H:i:s”.
valor	data_final	String(11)	Data final. Formato da data retornada: “Y-m-d H:i:s”.
valor	campanha	String(50)	Nome da campanha relacionada.
cor	tamanhos	Array	Conjunto de todos os tamanhos da variação de cor do produto.
tamanhos	tamanho		Tamanho relacionado ao conjunto de tamanhos.
tamanho	codigo_produto_tamanho	String(35)	Código do produto tamanho.
tamanho	cod_tamanho	Integer(11)	Código do tamanho.
tamanho	cod_loja	Integer(11)	Código da loja.
tamanho	tamanho	String(20)	Nome do tamanho.
tamanho	ean	String(13)	EAN do produto estoque.
tamanho	valores	Array	Conjunto de todos os valores de tamanho da variação cores do produto.
tamanho	medida1	String(4)	Altura da variação de tamanho.
tamanho	medida2	String(4)	Largura da variação de tamanho.
tamanho	medida3	String(4)	Comprimento da variação de tamanho.
tamanho	peso	String(10)	Peso da variação de tamanho.
valor	vlr_atual	Float(9,2)	Valor atual.
valor	percentual_desconto	Float(9,2)	Percentual de desconto.
valor	data_inicial	String(11)	Data inicial. Formato da data retornada: “Y-m-d H:i:s”.
valor	data_final	String(11)	Data final. Formato da data retornada: “Y-m-d H:i:s”.
valor	campanha	String(50)	Nome da campanha relacionada.
tamanho	tamanho_descricao	String(100)	Descrição do tamanho.
tamanho	qtd	Integer(11)	Quantidade de produtos do tamanho.
estoque	categorias	Array	Conjunto de todas as categorias do tamanho.
categorias	categoria		Categoria relacionada ao conjunto de categorias.
categoria	categoria_pai	Array	Contém os dados da categoria pai relacionada a categoria.
categoria_pai	nome	String(50)	Nome da categoria.
categoria_pai	codigo	Integer(11)	Código da categoria.
categoria_pai	categorias_filho	Array	Conjunto de categorias filho da categoria pai.
categorias_filho	categoria_filho		Categoria filho relacionada ao conjunto de categoria pai.
categoria_filho	nome	String(50)	Nome da categoria.
categoria_filho	codigo	Integer(11)	Código da categoria.

Get Tamanho

Método

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

Descrição

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

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
produto_codigo	String(40)	Busca por produtos no estoque que contenham este código
produto_codigo_cor	String(40)	Busca por produtos no estoque que contenham este código de variação de cor
produto_codigo_tamanho	String(40)	Busca por produtos no estoque com um código de variação de tamanho específico
pagina	Integer(10)	Filtra a página exibida conforme o limite de produtos que é retornado
disponivel	Integer(1)	Disponibilidade em estoque do produto 0 - Sem estoque 1 - Com estoque
data_de	Datetime	Busca a partir da data de criação da variação de tamanho
data_até	Datetime	Busca até a data de criação da variação de tamanho

Exemplo JSON - GetTamanho

{
    "produtos": [
        {
            "codigo": "000011CT00020007",
            "codigo_cor": "007979",
            "tamanhos": {
                "tamanho": [
                    {
                        "codigo_produto_tamanho": "00797947",
                        "cod_tamanho": "5",
                        "cod_loja": "1",
                        "tamanho": "47",
                        "ean": "7700007979479",
                        "medida1": "0",
                        "medida2": "0",
                        "medida3": "0",
                        "tamanho_descricao": "47",
                        "qtd": "99",
                        "valores": []
                    },
                    {
                        "codigo_produto_tamanho": "00797948",
                        "cod_tamanho": "6",
                        "cod_loja": "1",
                        "tamanho": "48",
                        "ean": "7700007979486",
                        "medida1": "0",
                        "medida2": "0",
                        "medida3": "0",
                        "tamanho_descricao": "48",
                        "qtd": "98",
                        "valores": []
                    },
                    {
                        "codigo_produto_tamanho": "00797949",
                        "cod_tamanho": "7",
                        "cod_loja": "1",
                        "tamanho": "49",
                        "ean": "7700007979493",
                        "medida1": "0",
                        "medida2": "0",
                        "medida3": "0",
                        "tamanho_descricao": "49",
                        "qtd": "94",
                        "valores": []
                    }
                ]
            }
        }
    ]
}

Exemplo XML- GetTamanho

<?xml version="1.0" encoding="UTF-8" ?>
<produtos>
    <produto>
        <codigo>000011CT00020007</codigo>
        <codigo_cor>007979</codigo_cor>
        <tamanhos>
            <tamanho>
                <codigo_produto_tamanho>00797947</codigo_produto_tamanho>
                <cod_tamanho>5</cod_tamanho>
                <cod_loja>1</cod_loja>
                <tamanho>47</tamanho>
                <ean>7700007979479</ean>
                <medida1>0</medida1>
                <medida2>0</medida2>
                <medida3>0</medida3>
                <tamanho_descricao>47</tamanho_descricao>
                <qtd>99</qtd>
                <valores />
            </tamanho>
            <tamanho>
                <codigo_produto_tamanho>00797948</codigo_produto_tamanho>
                <cod_tamanho>6</cod_tamanho>
                <cod_loja>1</cod_loja>
                <tamanho>48</tamanho>
                <ean>7700007979486</ean>
                <medida1>0</medida1>
                <medida2>0</medida2>
                <medida3>0</medida3>
                <tamanho_descricao>48</tamanho_descricao>
                <qtd>98</qtd>
                <valores />
            </tamanho>
            <tamanho>
                <codigo_produto_tamanho>00797949</codigo_produto_tamanho>
                <cod_tamanho>7</cod_tamanho>
                <cod_loja>1</cod_loja>
                <tamanho>49</tamanho>
                <ean>7700007979493</ean>
                <medida1>0</medida1>
                <medida2>0</medida2>
                <medida3>0</medida3>
                <tamanho_descricao>49</tamanho_descricao>
                <qtd>94</qtd>
                <valores />
            </tamanho>
        </tamanhos>
    </produto>
</produtos>

Get Cor

Método

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

Descrição

Este método retorna uma listagem com os produtos e suas variações de cores cadastradas.

Filtros

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

Nome	Tipo
limite	Integer(10)	Defini a quantidade de registros a retornar
produto_codigo_cor	String(40)	Busca por produtos no estoque que contenham este código de variação de cor
pagina	Integer(10)	Filtra a página exibida conforme o limite de produtos que é retornado
disponivel	Integer(1)	Disponibilidade em estoque do produto 0 - Sem estoque 1 - Com estoque
data_de	Datetime	Busca a partir da data de criação da variação cor
data_ate	Datetime	Busca até a data de criação da variação cor
kit	integer	0 - Não retorna produtos kit 1 - Retorna produtos Kit

Exemplo JSON - GetCor

{
    "produtos": [
        {
            "codigo": "06161616",
            "cores": {
                "cor": [
                    {
                        "codigo_produto_cor": "922337203685477580k",
                        "titulo": "Titulo do produto",
                        "descricao": "Descricao do produto",                                       
                        "referencia": "",
                        "pre_venda": "",
                        "qtd": "222",
                        "data": "2019-12-19 11:24:22",
                        "link": "teste",
                        "cod_desconto": "0",
                        "status": "1",
                        "destaque": "",
                        "lancamento": "1",
                        "utiliza_valor_tamanho": "0",
                        "prazo_entrega_extra": "2",
                        "genero": "M",
                        "cor": "Areia",
                        "cor_fabricante": "Preta",
                        "cor_secundaria": "Amarelo",
                        "valores": [
                            {
                                "vlr_antigo": "0.00",
                                "vlr_atual": "173.65",
                                "percentual_desconto": "0.00",
                                "data_inicial": "0000-00-00 00:00:00",
                                "data_final": "0000-00-00 00:00:00"
                            },
                            {
                                "vlr_antigo": "0.00",
                                "vlr_atual": "75.00",
                                "percentual_desconto": "0.00",
                                "data_inicial": "2018-09-17 00:00:00",
                                "data_final": "2018-09-28 00:00:00"
                            },
                            {
                                "vlr_antigo": "81.33",
                                "vlr_atual": "81.33",
                                "percentual_desconto": "16.00",
                                "data_inicial": "0000-00-00 00:00:00",
                                "data_final": "0000-00-00 00:00:00"
                            },
                            {
                                "vlr_antigo": "41.71",
                                "vlr_atual": "41.71",
                                "percentual_desconto": "0.00",
                                "data_inicial": "0000-00-00 00:00:00",
                                "data_final": "0000-00-00 00:00:00"
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

Exemplo XML - GetCor

<?xml version="1.0" encoding="UTF-8" ?>
<produtos>
    <produto>
        <codigo>06161616</codigo>
        <cores>
            <cor>
                <codigo_produto_cor>922337203685477580k</codigo_produto_cor>
                <referencia />
                <pre_venda />
                <qtd>222</qtd>
                <data>2019-12-19 11:24:22</data>
                <link>demanda-57264</link>
                <cod_desconto>0</cod_desconto>
                <status>1</status>
                <destaque />
                <lancamento>1</lancamento>
                <utiliza_valor_tamanho>0</utiliza_valor_tamanho>
                <prazo_entrega_extra>2</prazo_entrega_extra>
                <genero>M</genero>
                <cor>Areia</cor>
                <cor_fabricante>Preta</cor_fabricante>
                <cor_secundaria>Amarelo</cor_secundaria>
                <valores>
                    <vlr_antigo>0.00</vlr_antigo>
                    <vlr_atual>173.65</vlr_atual>
                    <percentual_desconto>0.00</percentual_desconto>
                    <data_inicial>0000-00-00 00:00:00</data_inicial>
                    <data_final>0000-00-00 00:00:00</data_final>
                </valores>
                <valores>
                    <vlr_antigo>0.00</vlr_antigo>
                    <vlr_atual>75.00</vlr_atual>
                    <percentual_desconto>0.00</percentual_desconto>
                    <data_inicial>2018-09-17 00:00:00</data_inicial>
                    <data_final>2018-09-28 00:00:00</data_final>
                </valores>
                <valores>
                    <vlr_antigo>81.33</vlr_antigo>
                    <vlr_atual>81.33</vlr_atual>
                    <percentual_desconto>16.00</percentual_desconto>
                    <data_inicial>0000-00-00 00:00:00</data_inicial>
                    <data_final>0000-00-00 00:00:00</data_final>
                </valores>
                <valores>
                    <vlr_antigo>41.71</vlr_antigo>
                    <vlr_atual>41.71</vlr_atual>
                    <percentual_desconto>0.00</percentual_desconto>
                    <data_inicial>0000-00-00 00:00:00</data_inicial>
                    <data_final>0000-00-00 00:00:00</data_final>
                </valores>
            </cor>
        </cores>
    </produto>
</produtos>

Get Formas de Pagamentos

Get Formas de Pagamento

Método

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

Descrição

Este método retorna uma listagem com as formas de pagamento.

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	String(15)	Busca pelo código de uma forma de pagamento específica.
status	Tinyint(1)	Busca por forma de pagamento de um status específico. 0 - Inativo 1 - Ativo 2 - Inativo invisível 3 - Ativo campanha

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