Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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:

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:

Code Block
languagejs
themeMidnight
{
   "filtro1": "valor",
   "filtro2": "valor"
}

Filtro usando XML:

Code Block
languageactionscript3
themeMidnight
<filtros>
   <filtro1>valor</filtro1>
   <filtro2>valor</filtro2>
</filtros>

...

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. 

Image Removed

Estrutura de retornos

...

Code Block
themeMidnight
linenumberstrue
{
   error: "codigo",
   message: "Mensagem de retorno"
}

...

Code Block
themeMidnight
linenumberstrue
<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

...

titleGet Reservas Estoque

Get Reservas Estoque

...

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

...

Code Block
themeMidnight
titleExemplo de XML - getReservasEstoque
linenumberstrue
<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>

...

titleGet Quantidade Estoque

Get Quantidade Estoque

...

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.

...

Exemplo de retorno XML:

Code Block
themeMidnight
titleExemplo de XML
linenumberstrue
<?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>
Code Block
themeMidnight
titleExemplo de Json - getQuantidadeEstoque
linenumberstrue
{
	"estoque":[
	{
		"produto_codigo_tamanho":"720162",
		"qtd":"10",
		"cod_loja":1
	}]
}

...

titleGet Produtos

Get Produtos

...

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.

...

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

...

id

...

Integer(11)

...

Busca por um produto com Id específico.

...

titleGet Preco

Get Preco

...

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

Descrição

...

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

...

data_modificacao_de

...

Busca por alterações feitas entre estas datas

Formato: YYYY-MM-DD

...

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.

...

Exemplo de retorno Json:

Code Block
themeMidnight
titleGet Preco
linenumberstrue
{
    "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"
                }
            ]
        }
    ]
}

...

titleGet Imagens

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.

...

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:

Code Block
themeMidnight
linenumberstrue
<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>

...

titleGet Clientes

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.

...

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.

...

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.

...

Autoriza receber Newsletter:

0” - Não

1” - Sim

...

Autoriza receber Sms:

0” - Não

1” - Sim

...

Exemplo de retorno XML:

Code Block
themeMidnight
linenumberstrue
<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>

...

titleGet Pedidos

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.

...

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).

...

Define se o pedido obteve uma troca 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

...

Data e hora da atualização do pedido.

exemplo: 2015-09-11 17:38:45

...

Número do pedido que obteve a troca

...

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.

...

valor_acrescimo

...

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.

...

url_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(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.

...

Code Block
themeMidnight
linenumberstrue
<filtros>
 <codigo>29355</codigo>
</filtros>
Code Block
themeMidnight
titleExemplo JSON - GetPedidoV2
linenumberstrue
{
    "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"
            }
        }
    ]
}

...

titleGet Nfe

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.

...

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.

...

Nome

...

Tipo

...

Descrição

...

pedido

...

Integer

...

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

...

Chave de 44 dígitos de acesso para a nota fiscal.

...

link

...

String

...

Link para consulta da nota fiscal.

...

data

...

String

...

Data de emissão da nota.

...

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:

Code Block
themeMidnight
titleExemplo Requisição JSON - GetNfe
linenumberstrue
{
    "data_ultima_atualizacao_de" : "yyyy-mm-dd",
    "data_ultima_atualizacao_ate" :"yyyy-mm-dd"
}

Filtro usando XML:

Code Block
themeMidnight
titleExemplo requisição XML - GetNfe
linenumberstrue
<filtros>
   <pagina>1</pagina>
   <limite>2</limite>
</filtros>

...

Code Block
themeMidnight
titleExemplo retorno JSON - GetNfe
linenumberstrue
[
    {
        "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"
    }
]

...

titleGet Status Pedidos

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.

Code Block
themeMidnight
titleExemplo XML - GetEstoque
linenumberstrue
<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>

...

titleGet Estoque - Descontinuado

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

...

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

...

Disponibilidade em estoque do produto

- Sem estoque

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

...

titleGet Tamanho

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.

...

Disponibilidade em estoque do produto

0 - Sem estoque

1 - Com estoque

...

Code Block
themeMidnight
titleExemplo JSON - GetTamanho
linenumberstrue
{
    "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": []
                    }
                ]
            }
        }
    ]
}
Code Block
themeMidnight
titleExemplo XML- GetTamanho
linenumberstrue
<?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>

...

titleGet Cor

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.

...

Disponibilidade em estoque do produto

0 - Sem estoque

1 - Com estoque

...

Code Block
themeMidnight
titleExemplo JSON - GetCor
linenumberstrue
{
    "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"
                            }
                        ]
                    }
                ]
            }
        }
    ]
}
Code Block
themeMidnight
titleExemplo XML - GetCor
linenumberstrue
<?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>

...

titleGet 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

...

titleGet 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
themeMidnight
titleExemplo Retorno XML
linenumberstrue
<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>

...

titleSave 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. 

...

produto_codigo_cor (*)

...

String(35)

...

Código para identificação da variação de cor do produto.

...

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.

...

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

...

Medidas do tamanho 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

...

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. Esse código deve ser único.

...

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. Esse código deve ser único.

...

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. Esse código deve ser único.

...

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

...

Integer(1)

...

Define se a característica é de produto ou estoque ou ambos. Valores:

  • Estoque
  • Produto
  • Ambos

...

exibe_descricao

...

String(3)

...

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

...

link

...

String

Formato de link que será utilizado para acessar o produto na loja.

...

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.

...

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
themeMidnight
titleExemplo XML - saveProduto
linenumberstrue
<produtos>
	<produto>
		<atualiza>1</atualiza>
		<produto_codigo />
		<produto_codigo_cor />
		<produto_codigo_tam />
		<titulo />
		<preco_custo />
		<meta_title />
		<meta_keywords />
		<meta_description />
		<faixa_etaria />
		<cor />
		<cor_secundaria />
		<cor_fabricante />
		<nfe_origem>1</nfe_origem>
		<ean13/>
		<nfe_ncm />
		<tamanho />
		<variacao />
		<referencia />
		<marca />
		<descricao />
		<caracteristicas_tecnicas />
		<peso />
		<medidas />
		<destaque />
		<lancamento />
		<genero />
		<status />
		<data_cadastro />
		<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
themeMidnight
titleExemplo Json - saveProduto
linenumberstrue
{
  "produto": [
    {
      "atualiza": 1,
      "produto_codigo": "1234",
      "produto_codigo_cor": "1234-5",
      "produto_codigo_tam": "12345-5-1",
      "titulo": "Teste Moovin",
      "faixa_etaria": 0,
      "cor": "Preto",
      "cor_secundaria": "Branco",
      "cor_fabricante": "Preto/Branco",
      "tamanho": "M",
      "variacao": "cortamanho",
      "referencia": "12345",
      "marca": "Adidas",
      "descricao": "Teste Moovin Descrição",
      "ean13": "1111111111111",
      "nfe_origem": "1",
      "nfe_ncm": "12345",
      "caracteristicas_tecnicas": "",
      "peso": 99.9,
      "medidas": "10x30x20",
      "destaque": 1,
      "lancamento": 0,
      "genero": "1",
      "status": 1,
      "data_cadastro": "",
      "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": "1",
            "principal": "1",
            "imagem_variacao": "1"
          }
        ]
      }
    }
  ]
}

...

titleSave Estoque - Descontinuado

Save Estoque - Descontinuado

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 (*)

...

Integer(11)

...

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.

...

pre_venda

...

Integer(1)

...

Informa se o produto está em pré venda:

1 – Ativa

0 – Inativa

Caso o campo não seja informado, o valor de pré venda não será alterado.

...

data_pre_venda

...

String(10)

...

Data de pré venda, na qual o produto será enviado para o cliente. Exemplo: ‘2016-11-02’.

...

tamanho

...

String(20)

...

Nome do tamanho do produto.

...

tamanho_descricao

...

String(100)

...

Descrição do tamanho do produto.

...

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
themeMidnight
titleExemploXML - saveEstoque
linenumberstrue
collapsetrue
<estoques>
  <estoque>
     <produto_codigo_tamanho>720162</produto_codigo_tamanho>
     <qtd>10</qtd>
     <cod_loja>1</cod_loja>
     <acao>1</acao>
	 <prazo_extra>10</prazo_extra>
  </estoque>
</estoques>
Code Block
themeMidnight
titleExemplo Json - saveEstoque
linenumberstrue
collapsetrue
{
  "estoque":[
     {
        "produto_codigo_tamanho":"720162",
        "qtd":"10",
        "cod_loja":"1",
        "acao":"1",
        "prazo_extra":"10"
     }
  ]
}

...

titleSave Estoque V2

Save Estoque V2

Método

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

Descrição

Realiza os mesmos processos do método saveEstoque, porém a requisição deve ser enviada com um produto por vez, para que o retorno seja tratado de forma individual.

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 (*)

...

Integer(11)

...

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.

...

pre_venda

...

Integer(1)

...

Informa se o produto está em pré venda:

1 – Ativa

0 – Inativa

Caso o campo não seja informado, o valor de pré venda não será alterado.

...

data_pre_venda

...

String(10)

...

Data de pré venda, na qual o produto será enviado para o cliente. Exemplo: ‘2016-11-02’.

...

tamanho

...

String(20)

...

Nome do tamanho do produto.

...

tamanho_descricao

...

String(100)

...

Descrição do tamanho do produto.

...

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
themeMidnight
titleExemploXML - saveEstoque
linenumberstrue
<estoques>
  <estoque>
     <produto_codigo_tamanho>720162</produto_codigo_tamanho>
     <qtd>10</qtd>
     <cod_loja>1</cod_loja>
     <acao>1</acao>
     <prazo_extra>10</prazo_extra>
  </estoque>
</estoques>
Code Block
themeMidnight
titleExemplo Json - saveEstoque
linenumberstrue
{
  "estoque":[
     {
        "produto_codigo_tamanho":"720162",
        "qtd":"10",
        "cod_loja":"1",
        "acao":"1",
		"prazo_extra":"10"
     }
  ]
}

...

titleSave Produtos Tags

Save Produtos Tag

Método

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

Descrição

Salva ou atualiza tags.

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(100)

...

Nome da tag.

...

codigo

...

String(11)

...

Numero de identificação da tag.

...

status

...

Integer(1)

...

Informa se a tag deve estar ativa ou não:

1 – Ativa

0 – Inativa

Caso o campo não seja informado, virá com o valor 0 - Inativa

...

data_inicial

...

String(19)

...

Data inicial para a exibição da tag, em todos os produtos em que esteja vinculada. Deve ser enviada no seguinte formato: Y-m-d

Exemplos: ‘2015-12-20’, ‘2016-02-13’.

...

data_final

...

String(19)

...

Data final para a exibição da tag, em todos os produtos em que esteja vinculada. Deve ser enviada no seguinte formato: Y-m-d

Exemplos: ‘2015-12-20’, ‘2016-02-13’.

...

imagem_lista

...

String(150)

...

Caminho até onde a imagem em miniatura está armazenada atualmente, online.

Deve ser informado no formato:

http://exemplo.com.br/nome-da-imagem.ext

...

imagem_detalhe

...

String(150)

...

Caminho até onde a imagem de tamanho original está armazenada atualmente, online.

Deve ser informado no formato:

http://exemplo.com.br/nome-da-imagem.ext

Code Block
themeMidnight
titleExemplo XML - saveProdutosTag
linenumberstrue
<data>
  <tag>
    <nome>nomeTag</nome>
     <codigo>1</codigo>
     <status>0</status>
     <data_inicial>2016-03-25</data_inicial>
     <data_final>2016-03-25</data_final>
     <imagem_lista>http://exemplo.com.br/nome-da-imagem.ext</imagem_lista>
     <imagem_detalhe>http://exemplo.com.br/nome-da-imagem.ext</imagem_detalhe>
  </tag>
</data>
Code Block
themeMidnight
titleExemplo Json - saveProdutosTag
linenumberstrue
{
   "tag": [
    {
       "nome": "nomeTag",
       "codigo": "1",
       "status": "0",
       "data_inicial": "2016-03-25",
       "data_final": "2016-03-25",
       "imagem_lista": "http://exemplo.com.br/nome-da-imagem.ext",
       "imagem_detalhe": "http://exemplo.com.br/nome-da-imagem.ext"
    }
  ]
}

...

titleSave Produtos Tags Relationship

Save Produtos Tags Relationship

Método

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

Descrição

Salva ou atualiza as tags que um produto possui.

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

...

String(35)

...

Código para identificação da variação de cor do produto. Esse código deve ser único

...

tags (*)

...

Array

...

Conjunto contendo tags relacionadas ao produto.

...

tag (*)

...

String(100)

...

Nome da tag, deve ser o mesmo de uma tag criada anteriormente.

Observações

Se o campo produto_codigo_cor estiver vazio, todas as cores do produto enviado serão vinculadas as tags recebidas. Se o campo produto_codigo_cor for definido, somenta esta cor do produto será vinculada a tag.

Code Block
themeMidnight
titleExemplo XML - saveProdutosTagsRelationship
linenumberstrue
<data>
	<produto>
		<produto_codigo>1234</produto_codigo>
		<produto_codigo_cor>1234-1</produto_codigo_cor>
		<tags>
			<tag>TAG1</tag>
			<tag>TAG2</tag>
		</tags>
	</produto>
</data>
Code Block
themeMidnight
titleExemplo Json - removeProdutosTagsRelationship
linenumberstrue
{
  "produto": [
    {
      "produto_codigo": "1234",
      "produto_codigo_cor": "1234-1",
      "tags": {
        "tag": [
          "TAG1",
          "TAG2"
        ]
      }
    }
  ]
}

...

titleRemove Produtos Tags Relationship

Remove Produtos Tags Relationship

Método

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

Descrição

Remove as tags que um produto possui, remove o vínculo entre as tags do produto informado.

Dados

Os dados enviados para remover 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

...

String(35)

...

Código para identificação da variação de cor do produto. Esse código deve ser único

...

tags (*)

...

Array

...

Conjunto contendo tags relacionadas ao produto.

...

tag (*)

...

String(100)

...

Nome da tag, deve ser o mesmo de uma tag criada anteriormente.

Observações

Se o campo produto_codigo_cor estiver vazio, todas as cores do produto enviado serão vinculadas as tags recebidas. Se o campo produto_codigo_cor for definido, somente esta cor terá suas tags removidas.

Code Block
themeMidnight
titleExemplo XML - removeProdutosTagsRelationship
linenumberstrue
<data>
	<produto>
		<produto_codigo>1234</produto_codigo>
		<produto_codigo_cor>1234-1</produto_codigo_cor>
		<tags>
			<tag>TAG1</tag>
			<tag>TAG2</tag>
		</tags>
	</produto>
</data>
Code Block
themeMidnight
titleExemplo Json - removeProdutosTagsRelationship
linenumberstrue
{
  "produto": [
    {
      "produto_codigo": "1234",
      "produto_codigo_cor": "1234-1",
      "tags": {
        "tag": [
          "TAG1",
          "TAG2"
        ]
      }
    }
  ]
}

...

titleSave Categorias

Save Categorias

Método

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

Descrição

Salva ou atualiza as categorias.

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

...

categoria (*)

...

Array

...

Conjunto que conterá as categorias.

...

categoria_pai (*)

...

Array

...

Categoria pai.

...

nome (*)

...

String(100)

...

Nome da categoria pai.

...

codigo (*)

...

Integer(11)

...

Código da categoria pai.

...

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.

...

categorias_neto

...

Array

...

Conjunto de categoria_neto.

...

categoria_neto

...

Array

...

Categoria neto.

...

nome

...

String(100)

...

Nome da categoria neto.

...

caracteristicas

...

Array

...

Característica relacionada ao conjunto de Características.

...

nome

...

String(50)

...

Nome da característica.

...

codigo

...

Integer(11)

...

Código 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

...

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

...

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.

...

nome

...

String(50)

...

Nome do atributo.

Code Block
themeMidnight
titleExemplo XML - saveCategorias