Autenticação
# Exemplo em formato curl
curl \
-X POST endereco-do-endpoint \
-F 'authentication=123456789ASDFGHJ' \
-F 'domain=seudominio.com.br'
Para usar esta API você precisa de um Token de API. Entre em contato conosco atendimento@tricommerce.com.br e solicite o seu.
O processo de autenticação acontece com o envio de parâmetros através do Header das requisições. Seu token e domínio devem ser enviados junto de todas requisições feitas à API.
PARÂMETROS DE AUTENTICAÇÃO
| Nome do Header | Tipo | Valor |
|---|---|---|
| authentication | String | Seu token de acesso |
| domain | String | O domínio da sua loja, exemplo: minhaloja.com.br |
Marcas: listar - POST
# Exemplo em formato curl
curl \
-X POST https://app.tricommerce.com.br/api/marcas \
-F 'authentication=seu_token' \
-F 'domain=seudominio.com.br'
URL de chamada:
https://app.tricommerce.com.br/api/marcas
Chamando este Endpoint sem especificar conteúdo, a API retornará a listagem de marcas cadastradas.
Marcas: gravar - POST
# Exemplo em formato curl
curl \
-X POST https://app.tricommerce.com.br/api/marcas \
-F 'authentication=seu_token' \
-F 'domain=seudominio.com.br'
URL de chamada:
https://app.tricommerce.com.br/api/marcas
Chamando este Endpoint especificando conteúdo em formato JSON, a API irá gravar ou atualizar os dados.
Exemplo de Requisição JSON:
[
{
"id_marcas" : 28,
"titulo" : "Loren Ipsun",
"telefone" : "(99) 99999-9999",
"site" : "https://sitedamarca.com.br",
"prazo" : "0",
"ativo" : "1",
"destaque" : "1"
},
{
"id_marcas" : 29,
"titulo" : "Et dolor",
"telefone" : "(99) 99999-9999",
"site" : "https://sitedamarca.com.br",
"prazo" : "0",
"ativo" : "1",
"destaque" : "1"
}
]
PARÂMETROS
| Campo | Tipo | Descrição |
|---|---|---|
| id_marcas | Integer | (opcional) Código da marca em caso de atualização. |
| titulo | String | Título da marca. |
| prazo | Integer | (opcional) prazo de expedição dos produtos. |
| telefone | String | (opcional) telefone da marca. |
| site | String | (opcional) site da marca. |
| ativo | Boolean | (opcional) marca deve ficar ativa ou não. Caso náo informado o valor default é 1 (true). |
| destaque | Boolean | (opcional) marca deve ficar em destaque ou não. Caso náo informado o valor default é 0 (false) |
Categorias: listar - POST
# Exemplo em formato curl
curl \
-X POST https://app.tricommerce.com.br/api/categorias \
-F 'authentication=seu_token' \
-F 'domain=seudominio.com.br'
URL de chamada:
https://app.tricommerce.com.br/api/categorias
Chamando este Endpoint sem especificar conteúdo, a API retornará a listagem de categorias cadastradas.
Categorias: gravar - POST
# Exemplo em formato curl
curl \
-X POST https://app.tricommerce.com.br/api/categorias \
-F 'authentication=seu_token' \
-F 'domain=seudominio.com.br'
URL de chamada:
https://app.tricommerce.com.br/api/categorias
Chamando este Endpoint especificando conteúdo em formato JSON, a API irá gravar ou atualizar os dados.
Exemplo de Requisição JSON:
[
{
"id_categorias" : 128,
"id_pai" : 1,
"titulo" : "Loren Ipsun",
"descricao" : "Loren Ipsun",
"ativo" : "1",
"destaque" : "1"
},
{
"id_categorias" : 129,
"id_pai" : 1,
"titulo" : "Et dolor",
"descricao" : "Et dolor",
"ativo" : "1",
"destaque" : "1"
}
]
PARÂMETROS
| Campo | Tipo | Descrição |
|---|---|---|
| id_categorias | Integer | (opcional) Código da categoria em caso de atualização. |
| id_pai | Integer | (opcional) Código da categoria pai, caso seja subcategoria. |
| titulo | String | Título da categoria. |
| descricao | String | Descrivo da categoria para SEO. |
| ativo | Boolean | (opcional) categoria deve ficar ativa ou não. Caso náo informado o valor default é 1 (true). |
| destaque | Boolean | (opcional) categoria deve ficar em destaque ou não. Caso náo informado o valor default é 0 (false) |
Produtos: listar - POST
# Exemplo em formato curl
curl \
-X POST https://app.tricommerce.com.br/api/produtos \
-F 'authentication=seu_token' \
-F 'domain=seudominio.com.br'
URL de chamada:
https://app.tricommerce.com.br/api/produtos
Chamando este Endpoint sem especificar conteúdo, a API retornará a listagem de produtos cadastrados.
Produtos: gravar - POST
# Exemplo em formato curl
curl \
-X POST https://app.tricommerce.com.br/api/produtos \
-F 'authentication=seu_token' \
-F 'domain=seudominio.com.br'
URL de chamada:
https://app.tricommerce.com.br/api/produtos
Chamando este Endpoint especificando conteúdo em formato JSON, a API irá gravar ou atualizar os dados.
Exemplo de Requisição JSON:
[
{
"id_externo" : 28,
"titulo" : "Loren Ipsun",
"referencia" : 100,
"id_categorias" : 0,
"id_marcas" : 0,
"ativo" : 1,
"destaque" : 1,
"descricao" : "Loren ipsun et dolor set amet nullan actia",
"preco": 125.9,
"estoque": 10,
"ipi": 5,
"peso": 2,
"altura": 2,
"largura": 2,
"profundidade": 2,
"social_title": "Loren Ipsun",
"social_keywords": "Loren, Ipsun",
"social_description": "Loren ipsun et dolor set amet nullan actia",
"restricao_idade": 1,
"compra_whatsapp": 0,
"tipo": 1,
"imagens": [
"https://linkdaimagem.com.br/image.png",
"https://linkdaimagem.com.br/image2.png"
]
},
{
"id_externo" : 29,
"titulo" : "Et dolor set",
"referencia" : 100,
"id_categorias" : 1,
"id_marcas" : 1,
"ativo" : 1,
"destaque" : 1,
"descricao" : "Loren ipsun et dolor set amet nullan actia",
"ipi": 5,
"peso": 6,
"altura": 5,
"largura": 4,
"profundidade": 3,
"social_title": "Et dolor set",
"social_keywords": "Et, dolor, set",
"social_description": "Loren ipsun et dolor set amet nullan actia",
"restricao_idade": 0,
"compra_whatsapp": 1,
"tipo": 2,
"imagens": [
"https://linkdaimagem.com.br/image.png",
"https://linkdaimagem.com.br/image2.png"
],
"variacoes": [
{
"id_externo": 123,
"titulo": "P",
"preco": 99.99,
"estoque": 2
},
{
"id_externo": 124,
"titulo": "G",
"preco": 109.99,
"estoque": 1
}
]
}
]
PARÂMETROS
| Campo | Tipo | Descrição |
|---|---|---|
| id_externo | Integer | Código externo do produto (seu id único). |
| titulo | String | Título do produto. |
| descricao | String | (opcional) Descritivo do produto. |
| referência | String | Referência do produto. |
| id_categorias | Integer | (opcional) Código da categoria a qual pertence. |
| id_marcas | Integer | (opcional) Código da marca a qual pertence. |
| preço | Float | (opcional) Preço do produto (utilizado para produtos simples). |
| estoque | Integer | (opcional) Quantidade em estoque disponível (utilizado para produtos simples). |
| IPI | Integer | (opcional) Percentual de IPI do produto. |
| peso | Float | (opcional) Peso do produto. |
| altura | Float | (opcional) Altura do produto. |
| largura | Float | (opcional) Largura do produto. |
| profundidade | Float | (opcional) Profundidade do produto. |
| social_title | String | (opcional) Título do produto para SEO. |
| social_keywords | String | (opcional) Palavras-chave do produto para SEO. |
| social_description | String | (opcional) Descrição do produto para SEO. |
| ativo | Boolean | (opcional) produto deve ficar ativo ou não. Caso náo informado o valor default é 1 (true). |
| destaque | Boolean | (opcional) produto deve ficar em destaque ou não. Caso náo informado o valor default é 0 (false). |
| restricao_idade | Boolean | (opcional) indica se o produto é destinado para maiores de idade (bebidas alcoólicas, etc). Caso náo informado o valor default é 0 (false). |
| compra_whatsapp | Boolean | (opcional) indica se o produto está na modalidade de compra pelo whatsapp (sem disponibilidade de checkout). Caso náo informado o valor default é 0 (false). |
| tipo | Integer |
(opcional) tipo do produto. 1 = Simples 2 = Com variação |
| imagens | String[] | (opcional) vetor contendo a URL (caminho completo) das imagens do produto. Caso omitido, as imagens previamente cadastradas são mantidas. Caso passado, as imagens do produto serão sobrescritas pelas passadas na requisição |
| variacoes | Variacao[] |
(opcional) utilizado em produtos com variação, é um vetor contendo as informações das variações a serem cadastradas, em formato de objeto, informando os seguintes campos obrigatórios: - id_externo (string): Código externo da variação (seu id único); - titulo (string): Título da variação; - preco (float): Preço da variação (seu id único); - estoque (integer): Quantidade em estoque da variação (seu id único). |
Pedidos: listar - POST
# Exemplo em formato curl
curl \
-X POST https://app.tricommerce.com.br/api/pedidos \
-F 'authentication=seu_token' \
-F 'domain=seudominio.com.br'
URL de chamada:
https://app.tricommerce.com.br/api/pedidos
Chamando este Endpoint sem especificar conteúdo, a API retornará a listagem de pedidos com pagamento aprovado e importado = 0
Após efetuar a leitura, você deverá efetuar uma requisição de Atualizar Pedido (conforme descrito na próxima sessão), atualizando o valor para importado = 1.
Desta forma, o pedido não será repetido nas próximas leituras.
Exemplo de Retorno JSON:
[
{
"id_pedidos": "1",
"data": "2021-12-06",
"nome": "Fulano de Tal",
"tel_fixo": "5430000000",
"tel_movel": "54990900909",
"cpf": "00011122233",
"data_nascimento": "1975-06-01",
"email": "teste@cliente.com.br",
"endereco": "Rua de Teste",
"numero": "123",
"complemento": "Apto de Teste",
"bairro": "Teste",
"cidade": "Bento Goncalves",
"estado": "RS",
"cep": "95700-000",
"cod_regiao": "01",
"transportador_cnpj": "00000000000000",
"valor_frete": "0",
"valor_desconto": "0",
"total": "196.00",
"pagamento_forma": "2",
"pagamento_nro_parcelas": "1",
"itens": [
{
"produto_codigo": "12",
"quantidade": "1",
"preco_unitario": "280.00"
}
]
}
]
PARÂMETROS
| Campo | Tipo | Descrição |
|---|---|---|
| id_pedidos | Integer | Código do pedido. |
| data | Date | Data do pedido. |
| nome | String | Nome do cliente. |
| tel_fixo | Integer | Telefone fixo. |
| tel_movel | Integer | Telefone celular. |
| cpf | Integer | CPF do cliente. |
| data_nascimento | Date | Data de nascimento. |
| String | Endereço de e-mail do cliente. | |
| endereco | String | Logradouro do cliente. |
| numero | Integer | Número para entrega. |
| complemento | String | Complemento do endereço |
| bairro | String | Bairro |
| cidade | String | Cidade |
| estado | String | Estado |
| cep | String | CEP |
| cod_regiao | String | Código IBGE do município. |
| valor_frete | Float | Valor do frete (quando disponível). |
| valor_desconto | Float | Valor do desconto (quando disponível). |
| total | Float | Total do pedido |
| pagamento_forma | Integer | Forma de pagamento: 1 = cartão 2 = boleto 3 = dinheiro 4 = PIX |
| pagamento_nro_parcelas | Integer | Quantidade de parcelas |
| itens | Array | Array contendo os itens do pedido |
| itens[produto_codigo] | String | Código externo do produto (quando disponível) |
| itens[quantidade] | Integer | Quantidade do item |
| itens[preco_unitario] | Float | Preço unitário do item |
Pedidos: atualizar - POST
# Exemplo em formato curl
curl \
-X POST https://app.tricommerce.com.br/api/pedidos \
-F 'authentication=seu_token' \
-F 'domain=seudominio.com.br'
URL de chamada:
https://app.tricommerce.com.br/api/pedidos
Chamando este Endpoint especificando conteúdo em formato JSON, a API irá atualizar os dados do pedido especificado.
Exemplo de Requisição JSON:
{
"id_pedidos" : 1,
"numero_nota" : 12387,
"ultimo_status" : 3,
"importado" : 1
}
PARÂMETROS
| Campo | Tipo | Descrição |
|---|---|---|
| id_pedidos | Integer | Número do pedido a ser atualizado. |
| numero_nota | String | (opcional) Número da nota fiscal. Enviar somente em caso de ultimo_status = 3. |
| ultimo_status | Integer |
Código do status a ser gravado: 1 = Aguardando Pagamento 2 = Pagamento Aprovado 3 = Pedido em Separação 4 = Enviado para Transporte 5 = Entrega Realizada 6 = Pedido Cancelado |
| importado | Boolean | (opcional) Indica se o pedido já foi importado via API, removendo ele assim da fila. |