API atual/Referência completa/Carrinhos abandonados

Detectar e limpar

Roda a detecção de carrinhos abandonados agora e apaga registros antigos.

A detecção já roda sozinha em segundo plano; detect serve para forçar uma passada (por exemplo depois de ajustar as regras de recuperação). cleanup é a faxina: apaga registros antigos para a lista não crescer sem fim. As duas gravam no registro de atividades do administrador.

Rodar a detecção

POST/api/v1/admin/abandoned-carts/detectAdmin

Detecta carrinhos abandonados agora

Corpo da requisição

threshold_hoursinteger

Horas de inatividade para considerar abandonado. Se omitido ou menor que 1, usa o menor atraso das regras de recuperação ativas (ou 2 horas se não houver regras).

Exemplo de requisição: detectar

bash

curl -X POST "$BASE_URL/api/v1/admin/abandoned-carts/detect" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "threshold_hours": 3
  }'

Resposta: detectar

200Detecção concluída

json

{
  "message": "abandoned cart detection complete",
  "detected": 4
}

Campos da resposta

messagestring

Texto fixo de confirmação.

detectedinteger

Quantos registros novos foram criados. A atualização de cópias existentes não entra na conta.

Erros: detectar

Status	Quando	Corpo de exemplo
401	Token ausente ou inválido.	`{"error":"authentication required"}`
403	O módulo `abandoned-cart` está desligado na loja.	`{"error":"module_disabled","module":"abandoned-cart"}`
403	Falta o privilégio `manage_abandoned_carts` (ou `manage_orders`). Vale também para leitura.	`{"error":"insufficient privileges","required":"manage_abandoned_carts"}`
503	O serviço de detecção não está disponível nesta instalação.	`{"error":"detection not available"}`
500	Falha ao consultar os carrinhos.	`{"error":"failed to detect abandoned carts","detail":"..."}`

Apagar registros antigos

POST/api/v1/admin/abandoned-carts/cleanupAdmin

Apaga registros de carrinhos abandonados antigos

Corpo da requisição

older_than_daysintegerpadrão: 90

Apaga registros abandonados há mais que este número de dias. Menor que 1 vira 90. O corpo é obrigatório (pode ser {}).

Exemplo de requisição: limpar

bash

curl -X POST "$BASE_URL/api/v1/admin/abandoned-carts/cleanup" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "older_than_days": 90
  }'

Resposta: limpar

200Limpeza concluída

json

{
  "message": "old abandoned carts deleted",
  "deleted": 128
}

Campos da resposta

messagestring

Texto fixo de confirmação.

deletedinteger

Quantos registros foram apagados.

Erros: limpar

Status	Quando	Corpo de exemplo
401	Token ausente ou inválido.	`{"error":"authentication required"}`
403	O módulo `abandoned-cart` está desligado na loja.	`{"error":"module_disabled","module":"abandoned-cart"}`
403	Falta o privilégio `manage_abandoned_carts` (ou `manage_orders`). Vale também para leitura.	`{"error":"insufficient privileges","required":"manage_abandoned_carts"}`
400	Corpo ausente ou que não é JSON.	`{"error":"invalid request body","detail":"EOF"}`
500	Falha ao apagar.	`{"error":"failed to delete old carts","detail":"..."}`

Veja também

Detectar e limpar

Roda a detecção de carrinhos abandonados agora e apaga registros antigos.

Rodar a detecção

POST/api/v1/admin/abandoned-carts/detectAdmin

Detecta carrinhos abandonados agora

Corpo da requisição

threshold_hoursinteger

Horas de inatividade para considerar abandonado. Se omitido ou menor que 1, usa o menor atraso das regras de recuperação ativas (ou 2 horas se não houver regras).

Exemplo de requisição: detectar

bash

curl -X POST "$BASE_URL/api/v1/admin/abandoned-carts/detect" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "threshold_hours": 3
  }'

Resposta: detectar

200Detecção concluída

json

{
  "message": "abandoned cart detection complete",
  "detected": 4
}

Campos da resposta

messagestring

Texto fixo de confirmação.

detectedinteger

Quantos registros novos foram criados. A atualização de cópias existentes não entra na conta.

Erros: detectar

Status	Quando	Corpo de exemplo
401	Token ausente ou inválido.	`{"error":"authentication required"}`
403	O módulo `abandoned-cart` está desligado na loja.	`{"error":"module_disabled","module":"abandoned-cart"}`
403	Falta o privilégio `manage_abandoned_carts` (ou `manage_orders`). Vale também para leitura.	`{"error":"insufficient privileges","required":"manage_abandoned_carts"}`
503	O serviço de detecção não está disponível nesta instalação.	`{"error":"detection not available"}`
500	Falha ao consultar os carrinhos.	`{"error":"failed to detect abandoned carts","detail":"..."}`

Apagar registros antigos

POST/api/v1/admin/abandoned-carts/cleanupAdmin

Apaga registros de carrinhos abandonados antigos

Corpo da requisição

older_than_daysintegerpadrão: 90

Apaga registros abandonados há mais que este número de dias. Menor que 1 vira 90. O corpo é obrigatório (pode ser {}).

Exemplo de requisição: limpar

bash

curl -X POST "$BASE_URL/api/v1/admin/abandoned-carts/cleanup" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "older_than_days": 90
  }'

Resposta: limpar

200Limpeza concluída

json

{
  "message": "old abandoned carts deleted",
  "deleted": 128
}

Campos da resposta

messagestring

Texto fixo de confirmação.

deletedinteger

Quantos registros foram apagados.

Erros: limpar

Status	Quando	Corpo de exemplo
401	Token ausente ou inválido.	`{"error":"authentication required"}`
403	O módulo `abandoned-cart` está desligado na loja.	`{"error":"module_disabled","module":"abandoned-cart"}`
403	Falta o privilégio `manage_abandoned_carts` (ou `manage_orders`). Vale também para leitura.	`{"error":"insufficient privileges","required":"manage_abandoned_carts"}`
400	Corpo ausente ou que não é JSON.	`{"error":"invalid request body","detail":"EOF"}`
500	Falha ao apagar.	`{"error":"failed to delete old carts","detail":"..."}`