Ver .md

sales.autocomplete_products

Produtos para o filtro de vendas. Produtos das plataformas externas (scope: "external") ou do Atomiks, filtrados por searchText. id é o que o filtro productIds espera.

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

Entrada

CampoTipoObrigatórioNota
searchTextstringnão
scope"atomiks" | "external"não
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "searchText": {
      "type": "string",
      "maxLength": 120
    },
    "scope": {
      "type": "string",
      "enum": [
        "atomiks",
        "external"
      ]
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/sales.autocomplete_products \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"searchText":"curso"}'

CLI:

node cli/atomiks.mjs sales.autocomplete_products --json '{"searchText":"curso"}'

MCP: ferramenta sales_autocomplete_products 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"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "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).