Ver .md

products.hub_sales

Vendas do produto. Vendas do CRM desse produto, as 100 mais recentes, com contato (nome), valor (centavos), origem e se foram canceladas. A RLS de contato decide o que aparece.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/products.hub_sales (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: products_hub_sales
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId products.hub_sales)

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/products.hub_sales \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs products.hub_sales --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta products_hub_sales com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "contactId": {
            "type": "string"
          },
          "contactName": {
            "type": [
              "string",
              "null"
            ]
          },
          "valueCents": {
            "type": "number"
          },
          "source": {
            "type": "string"
          },
          "soldAt": {
            "type": "string"
          },
          "cancelled": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "contactId",
          "contactName",
          "valueCents",
          "source",
          "soldAt",
          "cancelled"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).