INTEGRAÇÃO VIA API JSON

Para usar a api é necessário adicionar a chave API-KEY ao cabeçalho da requisição, para pegar o valor da chave você deve acessar o menu Loja → Perfil da Loja → Editar o registro e copiar o valor que se encontra no campo “Api key”.

Essa api é utilizada para criar ou atualizar os dados dos produtos, ou seja, pode ser utilizada para desenvolver ferramentas externas para o cadastro de produtos no Ecommerce.

Estes são os parâmetros que poderão ser utilizados na criação de seu aplicativo, com eles você conseguirá fazer a comunicação do seu aplicativo com o Ecommerce, lembrando que estes parâmetros deve ser seguidos perfeitamente para que não ocorra problemas na hora de levar os produtos para o Ecommerce. Então, não tente inventar coisas a mais do que já estão definidas na API, porque dependendo do que você fizer de errado o seu aplicativo pode dar muitos erros!

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
codigo_referencia

String

Sim

Campo de controle para usado pelo utilizador para relacionar o produto pai da loja virtual com o seu sistema.

 
nome

String

Sim

Nome do produto. Ex: Camiseta Timberland

 
marca

String

Não

Marca do produto. Ex: Timberland

 
genero

String

Não

Gênero do produto. Ex: Masculino

 
local_armazenagem

String

Não

Ex: A1

 
peso

Inteiro

Sim

Peso do produto em gramas, usado para calculo de frete.

 
ficha_tecnica

String

Não

Contém aspectos técnicos do produto.

 
resumo

String

Não

Um resumo rápido do produto para venda ao usuário.

 
destaque

Boleano

Não

Indica se o produto deve ou não aparecer como destaque na página principal. Valor Padrão: Falso.

 
lancamento

Boleano

Não

 
Indica se o produto deve ou não aparecer como lançamento na página principal. Valor Padrão: Falso.
 
ordenacao

Inteiro

Não

Usado para priorizar a ordenação dos produtos nas páginas de destaque e lançamento. Valor padrão: 0

 
ativo

Boleano

Não

Indica se o produto pai está ativo. Valor padrão: Verdadeiro.

 
categoria

Lista

Não

Ver tabela de categoria para mais informações.

 
produto_pai_relacionado

Lista

Não

Ver tabela de produto pai relacionados para mais informações.

 
produtos_filhos

Lista

Sim

Ver tabela de produto filho para mais informações.

 
atributos_extras

Lista

Não

Ver tabela de atributos extras para mais informações.

 
grupos_imagens

Lista

Não

Ver tabela de grupo de imagens para mais informações.

 

 

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
item

Lista

Não

Um produto pode estar em mais de uma cagoria. Ver tabela itens da cagoria:

Ex: Eletrônicos → Notebooks
Acessórios

 

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
nome

String

Sim

Ex: Eletrônicos

 

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
nome

String

Sim

Ex: ISBN

 
valor

String

Sim

Ex: 000012

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
codigo

String

Sim

Ex: 00001212

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
nome

String

Não

Nome do produto filho. Ex: Camiseta Timberland azul. Caso o nome não seja informado o sistema criará usando o produto pai e as variações.

 
valor_unitario

String

Sim

Valor do produto.

 
codigo_referencia

String

Sim

Campo de controle para ser usado pelo utilizador para relacionar o produto filho da loja virtual com o seu sistema.

 
codigo_fornecedor

String

Não

Código do produto no fornecedor.

 
variacoes

Lista

Não

Ver tabela de variações para mais informações.

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
variacao

String

Sim

Ex: Tamanho

 
nome

String

Sim

Ex: azul

 
valor

String

Sim

Ex: azul ou pode ser colocado um hexadecimal que representa a cor azul assim o usuário verá um caixa azul para ver a troca do produto.

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
descricao

String

Sim

Ex: Imagens da camiseta timberland azul

 
codigo_referencia_grupo

String

Sim

Campo de controle para ser usado pelo utilizador para relacionar o grupo de imagem da loja virtual com o seu sistema.

 
produtos

Lista

Sim

Ver tabela de produtos dos grupos de imagens para mais informações.

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
codigo_referencia

String

Sim

Campo de controle para ser usado pelo utilizador para relacionar o produto filho da loja virtual com o seu sistema.

Essa API é utilizada para CRIAR ou SUBSTITUIR Imagens.
 

Método: POST

Content-Type: multipart/form-data

 

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
codigo_referencia-xxx

String

Sim

Ex: Código de referência do grupo de imagens informados no json de produto. Onde xxx é um número sequencial.

 
rotulo-xxx

String

Não

Descrição da imagem. Onde xxx é um número sequencial.

 
ordem-xxx

Inteiro

Não

Ordem que as imagens devem aparecer. Onde xxx é um número sequencial.

 
imagem-xxx

File

Sim

Imagem binária. Onde xxx é um número sequencial.

Exemplo:


Você terá que passar no link : ?format=json

Ex de Link:

/api/v1/criar-atualizar-imagem-produto?format=json

EX de JSON:

{
	"codigo_referencia": "olaaaa",
	"imagens": [
		{
	    "nome":  "teste.png",
	    "ordem": 0,
	    "imagem": "base 64 - seguir formato como gerado no site: https://www.base64-image.de/"
		}
	]
}

Essa API é utilizada para listar os pedidos gerados pelo site.

 

 

Método: GET                                                                                                                                                      

Content-Type: application/json

Também é possível consultar os pedidos pela data de modificação, evitando assim ter que ler, a cada consulta, todos os pedidos, segue o exmplo:

https://sitedaempresa.com.br/api/v1/pedido?data_modificacao__gte=2021-11-05 03:00:00

Essa API é utilizada para atualizar o saldo dos produtos em estoque do Ecommerce.

 

 

Url: https://sitedaempresa.com.br/api/v1/atualizar-estoque-produto

Método: POST

Content-Type: application/json

 

Veja a seguir os parâmetros aceitos:

CAMPO

TIPO

REQUERIDO

DESCRIÇÃO

 
codigo_referencia

String

Sim

Campo de controle para ser usado pelo utilizador para relacionar o produto pai da loja virtual com o seu sistema.

 
Saldo

Inteiro

Sim

Saldo do produto em estoque. Ex: 5