Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.solomon.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Comece em quatro passos

Configure sua integração com a Solomon e envie seus primeiros pedidos, produtos e eventos.

​
Passo 1: Configure o acesso à API

Durante o onboarding, na seção de integração de plataforma de vendas, selecione a opção “API” e clique para gerar os dois tokens de integração, que serão exibidos na tela.
Para se autenticar na Solomon API, você precisa de uma API Key válida. Para isso:
  1. Acesse a aba de Chaves de API no canto superior direito (clicando no nome da sua loja).
  2. Crie uma nova chave com um nome de identificação, do tipo “Plataforma Própria”
  3. Marque os escopos write_orders e write_products
    Nesse caso, você pode gerar uma API Key tanto para ambiente live quanto para sandbox.
Guarde suas chaves em um local seguro. Elas serão usadas para autenticar todas as requisições feitas.

​
Passo 2: Envie seu primeiro pedido

Faça uma requisição POST para o endpoint de pedidos:
curl -X POST https://admin-api.solomon.com.br/admin/v1/order \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "orderId": "ord_123456789",
    "number": 10234,
    "name": "Pedido #10234",
    "orderStatus": 0,
    "createdAt": "2026-01-10T14:32:10Z",
    "updatedAt": "2026-01-10T14:35:42Z",
    "totalPrice": 249.90,
    "totalDiscounts": 20,
    "shippingPrice": 19.90,
    "paymentMethod": 2,
    "installments": 3,
    "currency": "BRL",
    "discountCode": "WELCOME10",
    "provinceCode": "SP",
    "countryCode": "BR",
    "utmSource": "facebook",
    "utmMedium": "cpc",
    "utmCampaign": "promo_janeiro",
    "utmContent": "video_1",
    "utmTerm": "tenis masculino",
    "userId": "d81a69cf-82d5-4aad-9ecd-5945b3cf3528",
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
    "browserIp": "189.45.123.10",
    "cartToken": "cart_abcd1234",
    "customer": {
      "customerId": "cus_987654321",
      "name": "Cliente Teste",
      "email": "cliente_teste@email.com",
      "phone": "+5511999999999",
      "provinceCode": "SP",
      "countryCode": "BR",
      "zip": "12230-000",
      "city": "São José dos Campos",
      "createdAt": "2025-11-02T10:15:00Z",
      "updatedAt": "2026-01-10T14:30:00Z"
    },
    "items": [
      {
        "itemId": "item_1",
        "productId": "prod_123",
        "variantId": "var_azul_42",
        "quantity": 1,
        "price": 199.90,
        "discount": 20.00,
        "createdAt": "2026-01-10T14:32:10Z",
        "updatedAt": "2026-01-10T14:32:10Z"
      }]
  }'
Se a requisição for bem-sucedida, o pedido será registrado na Solomon.

​
Passo 3: Envie seus produtos

Faça uma requisição POST para o endpoint de produtos:
curl -X POST https://admin-api.solomon.com.br/admin/v1/product \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": "prod_123",
    "productName": "Tênis Esportivo Verde",
    "createdAt": "2026-01-10T14:00:00Z",
    "updatedAt": "2026-01-10T14:00:00Z",
    "status": 1,
    "variants": [{
      "variantId": "var_azul_42",
      "title": "Tênis Esportivo Verde - Azul 42",
      "sku": "TEN-VER-AZU-42",
      "price": 199.90,
      "currency": "BRL",
      "createdAt": "2026-01-10T14:00:00Z",
      "updatedAt": "2026-01-10T14:00:00Z"
    }]
  }'
Se a requisição for bem-sucedida, o produto será registrado na Solomon.
O envio de produtos é essencial para que dados de funil de produto e estatísticas apareçam na plataforma. Envie o catálogo completo logo no início da integração e mantenha-o atualizado conforme produtos forem criados ou alterados.

​
Passo 4: Envie um evento com o SDK

Instale o SDK da Solomon:
npm install @solomon/events
Inicialize o SDK no seu frontend ou backend:
import { SolomonSDK } from "@solomon/events";

const solomon = new SolomonSDK({
  companyId: "SEU_COMPANY_ID",
});
Envie um evento de purchase:
solomon.track("CHECKOUT_COMPLETED", {
  items: [{
    item_id: "item_1",
    item_quantity: 1
  }]
}, {
  email: "cliente_teste@email.com",
  phone: "+5511999999999",
  customer_id: "cus_987654321",
  cart_token: "cart_abcd1234"
});
A Solomon utiliza esses eventos para fazer a atribuição correta de cada pedido.

​
Próximos passos

Agora que você conseguiu enviar seu primeiro pedido, explore outras funcionalidades essenciais:

Enviar e atualizar pedidos

Aprenda como enviar pedidos completos, lidar com atualizações de status e evitar duplicações.

Enviar e atualizar produtos

Envie e mantenha o catálogo de produtos sincronizado com a Solomon.

Enviar eventos do site

Utilize o SDK para rastrear os demais eventos do site, como page view, add to cart e initiate checkout.

Explorar a Referência da API

Entenda como desenvolver soluções de forma técnica com a Solomon.
Need help? See our full documentation or join our community.