v1

latestOpenAPI 3.0.02026-07-26376212496.4 KB

Checkout - Carrinhos abandonados

Listar carrinhos abandonados

listas os carrinhos abandonados com filtros personalizados

get/{alias}/checkout/carts

Path parameters

aliasstring required

Alias da loja

Query parameters

includestring[]

Incluir relacionamentos adicionais

[
  "?include=customer,payment,address"
]

qstring

Termo de busca. A API buscará pelo nome, e-mail ou telefone do cliente.

status'payment_refused' | 'no_transaction'

Status do pagamento associado ao carrinho.

has_transactionsboolean

Indica se o carrinho possui transações associadas (true ou false).

customersDataboolean

Filtra carrinhos que possuem dados de clientes associados (true ou false).

datestring

Permite buscar carrinhos com base em um período de data.

Filtros de carrinhos abandonados

{
  "q": "?q=joao",
  "status": "?status=payment_refused",
  "date": "?date=created_at:2025-01-01|2026-01-31"
}

Response

Lista de carrinhos abandonados

Example response

{
  "data": [
    {
      "customer": {
        "data": {
          "spreadsheet": {
            "data": {
              "phone": "(16) 98187-5668",
              "phone_number": "981875668",
              "phone_code": "16"
            }
          }
        }
      },
      "items": {
        "data": {
          "spreadsheet": {
            "data": {
              "phone": "(16) 98187-5668",
              "phone_number": "981875668",
              "phone_code": "16"
            }
          },
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo",
          "sku": {
            "data": {
              "sku": "SKU-TEST-API",
              "erp_id": "01-753-Rose",
              "barcode": "barcode-test",
              "title": "Produto X - Variação 030303 Amarelo",
              "allow_sell_without_customization": true,
              "quantity_managed": true
            }
          }
        }
      },
      "transactions": {
        "data": {
          "created_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "updated_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "capture_date": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "authorized_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "captured_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "cancelled_at": {
            "date": "2000-08-17 10:24:24",
            "timezone_type": 3,
            "timezone": "America/Sao_Paulo"
          },
          "metadata": [
            {
              "key": "discount_highlight",
              "value": "pix"
            }
          ]
        }
      },
      "metadata": {
        "data": [
          {
            "key": "discount_highlight",
            "value": "pix"
          }
        ]
      },
      "spreadsheet": {
        "data": {
          "customer_phone": "12991008531",
          "last_order_date": "2025-03-17",
          "products": "Produto de teste",
          "products_skus": "121313132",
          "categories": "Categoria teste com produtos,Categoria Herdeira",
          "brands": "Victoria's Secret",
          "purchase_url": "https://seguro.henriquerocha.com/cart?cart_token=6290b260-f531-11ef-9db0-f3f83349fc6d&utm_source=Planilha&utm_campaign=Carrinho Abandonado&forceCheckout=1&skipToCheckout=1&store_token=52c241f0b6247c028c49d8fe020184e240d35baf&forceLogout=1",
          "abandoned_step": "shippment",
          "count_recover_mail_sent": "0/4"
        }
      },
      "search": {
        "data": {
          "has_shipment_service": true,
          "has_address": true,
          "has_customer": true,
          "abandoned_step": "shippment",
          "created_at": "2025-03-17",
          "updated_at": "2025-03-17"
        }
      },
      "emails": {
        "data": [
          {
            "fire_date": "2025-03-17 11:53:41",
            "created_at": "2025-03-17 11:38:51",
            "updated_at": "2025-03-17 11:38:51"
          }
        ]
      }
    }
  ]
}