external_recovery.abandonment_list

Listar carrinhos abandonados das plataformas externas. Carrinhos abandonados avisados pelas plataformas (cart.abandoned.v1), mais novos primeiro, com contato, produto, oferta, valor (0 quando a plataforma não manda) e plataforma. searchText busca em contato, e-mail, produto e oferta.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "searchText": {
      "type": "string",
      "maxLength": 200
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "perPage": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/external_recovery.abandonment_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":1,"perPage":20}'

CLI:

node cli/atomiks.mjs external_recovery.abandonment_list --json '{"page":1,"perPage":20}'

MCP: ferramenta external_recovery_abandonment_list com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "leadId": {
            "type": [
              "string",
              "null"
            ]
          },
          "leadName": {
            "type": [
              "string",
              "null"
            ]
          },
          "productName": {
            "type": [
              "string",
              "null"
            ]
          },
          "offerName": {
            "type": [
              "string",
              "null"
            ]
          },
          "offerValue": {
            "type": "number"
          },
          "currency": {
            "type": [
              "string",
              "null"
            ]
          },
          "platform": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "leadId",
          "leadName",
          "productName",
          "offerName",
          "offerValue",
          "currency",
          "platform",
          "createdAt"
        ],
        "additionalProperties": false
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "page": {
          "type": "number"
        },
        "perPage": {
          "type": "number"
        },
        "countItens": {
          "type": "number"
        },
        "countPages": {
          "type": "number"
        }
      },
      "required": [
        "page",
        "perPage",
        "countItens",
        "countPages"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "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).