whatsapp
              




 

 Compre on-line e retire na loja
 Produtos com 1 ano de garantia
 Entrega para todo o Brasil
 Parcelamento em até 3x sem juros

API E-commerce

Vamos direto ao ponto, porque programador não pode perder tempo certo?

Como gerar uma chave p/ API

Acesse o painel de controle da sua loja, clique no menu Configurações -> Usuários -> Cadastrar novo -> (A chave será gerada automaticamente), defina um nome, exemplo "API" e clique em Salvar, conforme mostra a imagem abaixo. Ou clique aqui pra ficar mais fácil.
Faça download da collection do POSTMAN com exemplos prontos clicando com o botão direito e em [Salvar link como].

URL da API

Em cada requisição você deve informar os parâmetros api_key e operacao, exemplo:

https://www.loja.vcnainternet.com.br/api.php?api_key=XXX&operacao=XXX

Todas as respostas do servidor serão no formato JSON.

Categoria de Produtos


ou https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=produto_categoria


Campo Tipo Descrição Obrigatório
id_cap int(11) Identificador único Não
desc_cap varchar(100) *Descrição Sim
obs_cap text Observações Não

Subcategoria de Produtos


ou https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=produto_subcategoria


Campo Tipo Descrição Obrigatório
id_sub int(11) Identificador único Não
id_cap int(11) *ID da categoria Sim
desc_sub varchar(100) *Descrição Sim

Produtos


Parâmetros de pesquisa:

id_pro: ID
cod_pro: Código

ou https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=produto


Campo Tipo Descrição Obrigatório
id_pro int(11) Identificador único Não
id_mar int(11) Marca Não
cod_pro varchar(100) *Código Sim
nome_pro varchar(255) *Nome / Título Sim
desc_pro text *Descrição longa. Obs.: Pra colocar as especificações técnicas automaticamente abaixo da descrição do produto informe no seguinte formato: #Opção|Valor
#Opção|Valor
Exemplo:
#Tecido|Algodão
Sim
preco_pro float(10,2) *Preço Sim
preco_avista_pro float(10,2) *Preço à vista Sim
pedido_minimo_pro int(11) *Pedido mínimo Sim
estoque_pro int(11) *Controle de estoque | 1=Sim,2=Não (produtos ilimitados) Sim
qtde_pro int(11) *Quantidade em estoque Sim
qtde_minima_pro int(11) *Quantidade mínima (para alertar de estoque baixo) Sim
peso_pro float(10,2) *Peso em KG Sim
altura_pro int(11) *Altura em CM Sim
largura_pro int(11) *Largura em CM Sim
comprimento_pro int(11) *Comprimento em CM Sim
description_pro varchar(180) Descrição para motores e busca Não
gtin_pro varchar(150) GTIN Não
marca_pro varchar(150) Marca Não
mpn_pro varchar(150) Número da peça MPN Não
situacao_pro int(11) *Disponibilidade | 1=Ativo,Inativo, 3=Em destaque,4=Oculto (só acessa com link) Sim
cod_bling_pro varchar(150) Código Bling Não
sincronismo_bling_pro int(11) *Sincronismo com Bling|1=Sim,2=Não Sim
participante_pro int(11) Pedir nome dos participantes Não
categorias varchar(150) Categorias / Subcategorias: Para associar o produto a uma ou mais categorias/subcategorias envie uma variável de nome categorias no seguinte formato: 10,22 onde 10 e 22 são os IDs das categorias.
Outro exemplo agora com subcategoria: 10,22|7,33 onde 10 e 22 são IDs das categorias e 7 e 33 são IDs das subcategorias de produtos.
Sim
fotos[ ] File Fotos (Upload múltiplo, é um array que pode ser enviado 1 ou vários arquivos ao mesmo tempo) Não
opcoes varchar(255) Opções (tamanhos, cores, etc). Para tamanhos, cores, etc envie uma variável de nome opcoes no seguinte formato: Cor|Azul=1,Verde=3,Amarelo=5 onde "Cor" seria a propriedade variável, "Azul" Seria uma das opções e "1" seria a quantidade disponível do azul e assim por diante. Não

Fotos / Imagens


ou https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=foto


Campo Tipo Descrição Obrigatório
id_fot int(11) Identificador único Não
id_pro int(11) *ID Produto Sim
ordenacao_fot int(11) Ordenação (Usado p/ ordenar as fotos no produto) Não
fotos[ ] File Fotos (Upload múltiplo, é um array que pode ser enviado 1 ou vários arquivos ao mesmo tempo) Sim

Fotos / Imagens - Excluir


Parâmetros opcionais:

id_fot
id_pro

Pra excluir todos os registros basta fazer a chamada para o endpoint sem enviar parâmetros.

https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=foto_del


Campo Tipo Descrição Obrigatório
id_fot int(11) Identificador único Não
id_pro int(11) *ID Produto Não

Clientes


Parâmetros opcionais:

situacao_cli

ou https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=cliente


Campo Tipo Descrição Obrigatório
id_cli int(11) Identificador único Não
razao_social_cli varchar(100) Razão Social Não
nome_fantasia_cli varchar(100) Nome Fantasia Não
cnpj_cli varchar(18) CNPJ Não
ie_cli varchar(150) Inscrição Estadual Não
responsavel_cli varchar(100) *Nome Sim
cpf_cli varchar(14) *CPF Sim
cep_cli varchar(9) *CEP Sim
endereco_cli varchar(100) *Endereço, nº Sim
complemento_cli varchar(100) Complemento Não
bairro_cli varchar(50) *Bairro Sim
cidade_cli varchar(50) *Cidade Sim
id_est char(2) *Estado (Exemplo: SC) Sim
telefone_cli varchar(50) *Telefone Sim
telefone2_cli varchar(100) *Celular Sim
email_cli varchar(255) *E-mail Sim
data_cadastro_cli date *Data de cadastro Sim
situacao_cli int(11) *Situação | 1=Ativo,2=Inativo Sim
senha_cli varchar(100) *Senha Sim
data_nascimento_cli date *Data de nascimento Sim
sexo_cli int(11) *Sexo | 1=M,2=F Sim
cep2_cli varchar(9) CEP (segundo endereço) Não
endereco2_cli varchar(150) Endereço, nº (segundo endereço) Não
complemento2_cli varchar(150) Complemento (segundo endereço) Não
bairro2_cli varchar(150) Bairro (segundo endereço) Não
cidade2_cli varchar(150) Cidade (segundo endereço) Não
id_est2 int(11) Estado (segundo endereço) Não
endereco_entrega_cli int(11) Endereço de entrega padrão | 1=Primeiro endereço,2=Segundo endereço Não
cashback_total_cli decimal(10,2) Total Cashback Resgatado Não
cashback_disponivel_cli decimal(10,2) Total Cashback Disponível Não
associado_cli int(11) Associado|1=Sim,2=Não Não
adimplente_cli int(11) Adimplente|1=Sim,2=Não Não
pauta_cli int(11) Pauta Não

Clientes - Excluir


Parâmetros opcionais:

id_cli
cnpj_cli
cpf_cli

Pra excluir todos os registros basta fazer a chamada para o endpoint sem enviar parâmetros.

https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=cliente_del


Campo Tipo Descrição Obrigatório
id_cli int(11) Identificador único Não
cnpj_cli varchar(18) CNPJ Não
cpf_cli varchar(14) *CPF Não

Pedidos


Parâmetros de pesquisa:

Por data: Envie os parâmetros data_inicial e data_final no formato dd/mm/YYYY
id_sts: Status do Pedido
id_str: Status da transação
id_cli: Cliente
id_ped: ID do pedido
faturado_ped: Faturado (valor padrão deste campo no cadastro do pedido é vazio)

https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=pedido


Campo Tipo Descrição Obrigatório
id_ped int(11) Identificador único Não
data_hora_ped datetime *Data do pedido Sim
valor_ped float(10,2) *Valor da compra Sim
valor_frete_ped float(10,2) *Valor do Frete Sim
prazo_frete_ped varchar(150) *Prazo de entrega Sim
id_tra_ped varchar(100) *Código da Transação Sim
codigo_rastreio_ped varchar(150) Código de rastreio Não
obs_ped text Observações Não
cupom_ped varchar(100) Cupom de desconto utilizado Não
cupom_desconto_ped int(11) % Cupom de desconto Não
origem_ped text Origem da compra Não
parcelamento_ped int(11) Nº Parcelas Não
parcelamento_sem_juros_ped int(11) Nº Parcelas sem juros Não
faturado_ped varchar(150) Faturado Não
chave_nfe_ped varchar(150) Chave NFe Não
json_nfe text *JSON NFe Sim
id_ssw int(11) SSW Não
id_frn int(11) Transportadora Frenet Não
forma_pgto varchar(150) Forma de pagamento Sim
status varchar(150) Status do pedido Sim
status_transacao varchar(150) Status da transação Sim
frete varchar(150) Frete escolhido Sim
transportadora varchar(150) Transportadora Sim
total_pedido varchar(150) Total do pedido Sim
itens JSON Itens do pedido
Campo Tipo Descrição Obrigatório
id_itp int(11) Identificador único Não
id_pro int(11) *ID Produto Sim
qtde_itp int(11) *Quantidade Sim
preco_itp float(10,2) *Preço unitário Sim
obs_itp text Observações Não
cod_pro int(11) opcao Sim
nome_pro varchar(150) Nome do produto Sim
opcao JSON Cores / Tamanhos, etc
Campo Tipo Descrição Obrigatório
desc_prv varchar(150) Cor / Tamanho, Etc Não
desc_opc varchar(150) Azul, Verde / P, M G, etc Não
Sim
Sim
dados_cliente JSON Dados do cliente
Campo Tipo Descrição Obrigatório
id_cli int(11) Identificador único Não
razao_social_cli varchar(100) Razão Social Não
nome_fantasia_cli varchar(100) Nome Fantasia Não
cnpj_cli varchar(18) CNPJ Não
ie_cli varchar(150) Inscrição Estadual Não
responsavel_cli varchar(100) *Nome Sim
cpf_cli varchar(14) *CPF Sim
cep_cli varchar(9) *CEP Sim
endereco_cli varchar(100) *Endereço, nº Sim
complemento_cli varchar(100) Complemento Não
bairro_cli varchar(50) *Bairro Sim
cidade_cli varchar(50) *Cidade Sim
id_est char(2) *Estado (Exemplo: SC) Sim
telefone_cli varchar(50) *Telefone Sim
telefone2_cli varchar(100) *Celular Sim
email_cli varchar(255) *E-mail Sim
data_cadastro_cli date *Data de cadastro Sim
situacao_cli int(11) *Situação | 1=Ativo,2=Inativo Sim
senha_cli varchar(100) *Senha Sim
data_nascimento_cli date *Data de nascimento Sim
sexo_cli int(11) *Sexo | 1=M,2=F Sim
cep2_cli varchar(9) CEP (segundo endereço) Não
endereco2_cli varchar(150) Endereço, nº (segundo endereço) Não
complemento2_cli varchar(150) Complemento (segundo endereço) Não
bairro2_cli varchar(150) Bairro (segundo endereço) Não
cidade2_cli varchar(150) Cidade (segundo endereço) Não
id_est2 int(11) Estado (segundo endereço) Não
endereco_entrega_cli int(11) Endereço de entrega padrão | 1=Primeiro endereço,2=Segundo endereço Não
cashback_total_cli decimal(10,2) Total Cashback Resgatado Não
cashback_disponivel_cli decimal(10,2) Total Cashback Disponível Não
associado_cli int(11) Associado|1=Sim,2=Não Não
adimplente_cli int(11) Adimplente|1=Sim,2=Não Não
pauta_cli int(11) Pauta Não
Sim

Pedidos - Atualizar


Utilize para atualizar informações do pedido e sincronizar com o seu sistema.

https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=pedido_atualizar


Campo Tipo Descrição Obrigatório
id_ped int(11) Identificador único Sim
codigo_rastreio_ped varchar(150) Código de rastreio Não
faturado_ped varchar(150) Faturado Não

Status de Pedidos


https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=status_pedido


Campo Tipo Descrição Obrigatório
id_sts int(11) *Identificador único Sim
desc_sts varchar(100) *Descrição Sim
cor_sts varchar(150) *Cor Sim
cod_sts int(11) Ordenação Não

Status de transações


https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=status_transacao


Campo Tipo Descrição Obrigatório
id_str int(11) *Identificador único Sim
origem_str varchar(100) *Gateway de pagamento Sim
codigo_str varchar(100) *Código Sim
desc_str varchar(255) *Descrição Sim

Formas de pagamento


https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=formas_pagamento


Campo Tipo Descrição Obrigatório
id_pgt int(11) *Identificador único Sim
desc_pgt varchar(100) *Descrição Sim

Tabelas de preço


Parâmetros de pesquisa:

id_pre: ID
cnpj_pre: CNPJ do cliente

ou https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=tabela_preco


Campo Tipo Descrição Obrigatório
id_pre int(11) Identificador único Não
cnpj_pre varchar(18) CNPJ Não
cod_pro_pre varchar(150) *Cód. Produto Sim
qtde_pre int(11) *Qtde. Sim
preco_pre decimal(10,2) *Preço Sim
pauta_pre int(11) Paula Não

Tabelas de preço - Excluir


Parâmetros opcionais:

id_pre
cnpj_pre

Pra excluir todos os registros basta fazer a chamada para o endpoint sem enviar parâmetros.

https://www.loja.vcnainternet.com.br/api.php?api_key=513646bfa599f9848fab551f57d814ef&operacao=tabela_preco_del


Campo Tipo Descrição Obrigatório
id_pre int(11) Identificador único Não
cnpj_pre varchar(18) CNPJ Não


Cartão de crédito Cartões de crédito
Boleto
Boleto Bancário
Pix
Pix
Depósito
Depósito em conta / Transferência bancária
Selos de Segurança
Compra Segura Site Seguro
Compra Segura

© Copyright 2024 - Samuca Webdesign (LOJA DEMONSTRAÇÃO) - CNPJ: 21.996.737/0001-86 | Rua Capitão Ernesto Nunes, 833, Apto 02 - Centro - São Bento do Sul - SC | CEP: 89281-145
by SAMUCA
Samuca Webdesign (LOJA DEMONSTRAÇÃO) e os cookies: Nosso site usa cookies para personalizar anúncios e melhorar a sua experiência no site. Ao continuar navegando, você concorda com a nossa Política de Privacidade.