sales_recovery.list

Listar transações para recuperar. Transações da sub-aba (failed: recusadas e chargeback; canceled; pixExpired: Pix em aberto; bankSlipExpired: boleto em aberto; refunded), mais novas primeiro, com comprador, produto, oferta, valor e método. searchText busca em nome, e-mail, produto, oferta e código.

Endpoint: POST https://app.atomiks.com.br/api/v1/sales_recovery.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: sales_recovery_list
Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId sales_recovery.list)

Entrada

Campo	Tipo	Obrigatório
`subTab`	"failed" \| "canceled" \| "pixExpired" \| "bankSlipExpired" \| "refunded"	sim
`filters`	object	não
`searchText`	string	não
`page`	integer	não
`perPage`	integer	não

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "subTab": {
      "type": "string",
      "enum": [
        "failed",
        "canceled",
        "pixExpired",
        "bankSlipExpired",
        "refunded"
      ]
    },
    "filters": {
      "type": "object",
      "properties": {
        "transactionPeriod": {
          "type": "object",
          "properties": {
            "from": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            },
            "to": {
              "type": "string",
              "format": "date-time",
              "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
            }
          }
        },
        "searchText": {
          "type": "string",
          "maxLength": 200
        },
        "contactName": {
          "type": "string",
          "maxLength": 200
        },
        "contactEmail": {
          "type": "string",
          "maxLength": 200
        },
        "contactDocument": {
          "type": "string",
          "maxLength": 200
        },
        "transactionShortenId": {
          "type": "string",
          "maxLength": 200
        },
        "externalId": {
          "type": "string",
          "maxLength": 200
        },
        "contactTags": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmSource": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmMedium": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmCampaign": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmTerm": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "utmContent": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "src": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "sck": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "transactionStatus": {
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "pending",
              "paid",
              "canceled",
              "refunded",
              "chargedBack",
              "failed"
            ]
          }
        },
        "projectIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "funnelIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "productIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "offerIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "orderBumpOfferIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "excludeOrderBumpOfferIds": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "transactionRecurrence": {
          "type": "string",
          "enum": [
            "OneTime",
            "Recurrent",
            "Trial"
          ]
        },
        "saleKind": {
          "type": "string",
          "enum": [
            "new",
            "invoice"
          ]
        },
        "currency": {
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 3
          }
        },
        "valueOfLastPurchase": {
          "type": "object",
          "properties": {
            "min": {
              "type": "number",
              "minimum": 0,
              "maximum": 100000
            },
            "max": {
              "type": "number",
              "minimum": 0,
              "maximum": 100000
            }
          }
        },
        "transactionType": {
          "maxItems": 3,
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "credit",
              "pix",
              "boleto"
            ]
          }
        },
        "suspectedFraudOnly": {
          "type": "boolean"
        },
        "couponCode": {
          "type": "string",
          "maxLength": 200
        },
        "externalPageUrl": {
          "type": "string",
          "maxLength": 200
        },
        "gatewayOrigin": {
          "type": "string",
          "maxLength": 200
        },
        "productName": {
          "type": "string",
          "maxLength": 200
        },
        "offerCode": {
          "type": "string",
          "maxLength": 200
        },
        "installments": {
          "type": "integer",
          "minimum": 0,
          "maximum": 100
        }
      }
    },
    "searchText": {
      "type": "string",
      "maxLength": 200
    },
    "page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100000
    },
    "perPage": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": [
    "subTab"
  ]
}

Exemplo

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

CLI:

node cli/atomiks.mjs sales_recovery.list --json '{"subTab":"failed","page":1,"perPage":20}'

MCP: ferramenta sales_recovery_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": {
          "code": {
            "type": "string"
          },
          "shortenCode": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "pending",
              "paid",
              "canceled",
              "refunded",
              "chargedBack",
              "failed"
            ]
          },
          "buyer": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "email": {
                "type": "string"
              }
            },
            "required": [
              "name",
              "email"
            ],
            "additionalProperties": false
          },
          "product": {
            "type": "string"
          },
          "offer": {
            "type": "string"
          },
          "createdAt": {
            "type": "string"
          },
          "saleValue": {
            "type": "number"
          },
          "paymentMethod": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "credit",
                  "pix",
                  "boleto"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "failReason": {
            "type": [
              "string",
              "null"
            ]
          },
          "cancellationReason": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "code",
          "shortenCode",
          "status",
          "buyer",
          "product",
          "offer",
          "createdAt",
          "saleValue",
          "paymentMethod",
          "failReason",
          "cancellationReason"
        ],
        "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).