--- title: "Listar carrinhos abandonados" method: GET path: "/{alias}/checkout/carts" tags: ["Checkout - Carrinhos abandonados"] --- # Listar carrinhos abandonados `GET /{alias}/checkout/carts` listas os carrinhos abandonados com filtros personalizados ## Path parameters - `alias` string, required ## Query parameters - `include` string[] - `filters` CartCriteria — Mapeia os filtros disponíveis para pesquisa de carrinhos abandonados. - `q` string — 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_transactions` boolean — Indica se o carrinho possui transações associadas (true ou false). - `customersData` boolean — Filtra carrinhos que possuem dados de clientes associados (true ou false). - `date` string — Permite buscar carrinhos com base em um período de data. ## Response `200` Lista de carrinhos abandonados - object — Representa uma paginação com meta - `data` object[] - `id` integer - `merchant_id` integer - `customer_id` integer - `token` string - `shipment_service_id` integer - `payment_alias` string - `has_recommendation` boolean - `is_upsell` boolean - `total_transactions` integer - `simulate_url` string, uri — URL para simular o carrinho - `unauth_simulate_url` string, uri — URL para simular o carrinho sem autenticação - `totalizers` object - `total_items` string - `subtotal` number, float - `discount` number, float - `shipment` number, float - `shipment_original_value` number, float, nullable - `shipment_discount_value` number, float - `shipment_discount_percent` string - `promocode_discount_value` number, float - `combos_discount_value` number, float - `total` number, float - `subtotal_formated` string - `discount_formated` string - `total_formated` string - `shipment_formated` string - `tracking_data` object - `name` string - `email` string, email - `utm_source` string - `utm_campaign` string - `utm_medium` string - `utm_term` string - `utm_content` string - `last_transaction_status` string - `customer` object - `data` Customer — Representa um cliente - `id` integer - `merchant_id` integer - `marketplace_id` integer - `active` boolean - `type` string - `cluster_id` integer - `name` string - `first_name` string - `last_name` string - `generic_name` string - `cpf` string - `spreadsheet` object - `data` object - `brands` string - `city` string - `purchased_brands` string - `last_order_date` object - … - `last_order_value` string - `purchased_categories` string - `number` string - `uf` string - `phone` string - `street` string - `phone_number` string - `categories` string - `neighborhood` string - `complement` string - `phone_code` string - `phone` object - `area_code` string — Código de área do telefone - `full_number` string — Número do telefone - `number` string — Número do telefone - `formated_number` string — Número do telefone formatado - `whatsapp_link` string, uri - `razao_social` string - `cnpj` string - `state_registration` string - `email` string, email - `password` string - `birthday` string, date - `newsletter` boolean - `whatsapp` boolean - `social_driver` string - `social_id` integer - `ip` string - `token` string - `utm_source` string - `utm_campaign` string - `notes` string - `login_url` string, uri - `anonymized` boolean - `items` object - `data` CartItemsRelated — Representa um cliente - `id` integer - `merchant_id` integer - `marketplace_id` integer - `active` boolean - `type` string - `cluster_id` integer - `name` string - `first_name` string - `last_name` string - `generic_name` string - `cpf` string - `spreadsheet` object - `data` object - `brands` string - `city` string - `purchased_brands` string - `last_order_date` object - … - `last_order_value` string - `purchased_categories` string - `number` string - `uf` string - `phone` string - `street` string - `phone_number` string - `categories` string - `neighborhood` string - `complement` string - `phone_code` string - `phone` object - `area_code` string — Código de área do telefone - `full_number` string — Número do telefone - `number` string — Número do telefone - `formated_number` string — Número do telefone formatado - `whatsapp_link` string, uri - `razao_social` string - `cnpj` string - `state_registration` string - `email` string, email - `password` string - `birthday` string, date - `newsletter` boolean - `whatsapp` boolean - `social_driver` string - `social_id` integer - `ip` string - `token` string - `utm_source` string - `utm_campaign` string - `notes` string - `login_url` string, uri - `anonymized` boolean - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer — Número de representação do timezone. - `timezone` string — Fuso horário associado. - `sku` object - `data` Sku - `id` integer — ID do SKU - `product_id` integer — ID do produto ao qual o SKU pertence - `seller_id` integer — ID do vendedor - `sku` string — Código do SKU - `token` string — Token único do SKU - `erp_id` string — ID do SKU no ERP - `blocked_sale` boolean — Vendas bloqueadas - `barcode` string — Código de barras do SKU - `title` string — Título completo do SKU - `allow_sell_without_customization` boolean — Permite vender sem personalização obrigatória - `price_cost` number, float — Preço de custo do SKU - `price_sale` number, float — Preço de venda do SKU - `price_discount` number, float — Preço com desconto aplicado - `combinations` string[] — Combinações de variações associadas ao SKU - `weight` number, float — Peso do SKU em kg - `height` number, float — Altura do SKU em cm - `width` number, float — Largura do SKU em cm - `length` number, float — Comprimento do SKU em cm - `quantity_managed` boolean — Indica se o controle de estoque está habilitado - `availability` integer — Quantidade disponível em estoque - `availability_soldout` integer — Quantidade disponível mesmo após esgotado - `order` integer — Ordem de exibição do SKU para a página de produtos - `transactions` object - `data` object - `id` integer - `customer_id` integer — ID do cliente - `payment_id` integer — ID do pagamento - `affiliation_id` integer — ID da afiliação - `marketplace_id` integer - `marketplace_account_id` integer - `authorized` boolean - `captured` boolean - `cancelled` boolean - `can_be_captured` boolean - `can_be_cancelled` boolean - `gateway_transaction_id` integer — ID da transação no gateway - `gateway_order_id` integer - `gateway_authorization_code` string - `gateway_billet_id` integer - `amount` number, float — Valor - `buyer_amount` number, float — Valor - `installment_value` number, float — Valor - `buyer_installment_value` number, float — Valor - `installments` integer — Número de parcelas - `installment_formated` string — Status da transação - `buyer_installment_formated` string — Status da transação - `status` string — Status da transação - `error_message` string - `bank_name` string - `bank_alias` string - `truncated_card` string - `holder_name` string — Nome do titular - `holder_document` string — Documento do titular - `billet_url` string - `billet_barcode` string - `billet_date` string - `billet_our_number` string - `billet_document_number` string - `billet_whatsapp_link` string - `antifraud_sale_id` integer - `antifraud_status` string - `antifraud_score` string - `sent_to_antifraud` string - `total_logs` integer - `error_code` integer - `created_at` BaseTimestamp - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer — Número de representação do timezone. - `timezone` string — Fuso horário associado. - `updated_at` BaseTimestamp - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer — Número de representação do timezone. - `timezone` string — Fuso horário associado. - `capture_date` BaseTimestamp - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer — Número de representação do timezone. - `timezone` string — Fuso horário associado. - `authorized_at` BaseTimestamp - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer — Número de representação do timezone. - `timezone` string — Fuso horário associado. - `captured_at` BaseTimestamp - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer — Número de representação do timezone. - `timezone` string — Fuso horário associado. - `cancelled_at` BaseTimestamp - `date` string — Data e hora no formato YYYY-MM-DD H:MM:SS. - `timezone_type` integer — Número de representação do timezone. - `timezone` string — Fuso horário associado. - `payment` object — Informações sobre o meio de pagamento - `data` object — Detalhes do pagamento - `id` integer — ID do meio de pagamento - `alias` string — Alias do meio de pagamento - `name` string — Nome do meio de pagamento - `has_config` boolean — Indica se há configuração disponível - `active_config` boolean — Indica se a configuração está ativa - `is_credit_card` boolean — Indica se é um cartão de crédito - `is_deposit` boolean — Indica se é um pagamento por depósito - `is_billet` boolean — Indica se é um boleto bancário - `is_pix` boolean — Indica se é um pagamento via Pix - `is_pix_in_installments` boolean — Indica se o Pix permite parcelamento - `is_wallet` boolean — Indica se é um pagamento via carteira digital - `icon_url` string, uri — URL do ícone do meio de pagamento - `metadata` object[] — Lista de metadados - `key` string — Chave do metadado - `value` string — Valor do metadado - `payment` object — Informações sobre o meio de pagamento - `data` object — Detalhes do pagamento - `id` integer — ID do meio de pagamento - `alias` string — Alias do meio de pagamento - `name` string — Nome do meio de pagamento - `has_config` boolean — Indica se há configuração disponível - `active_config` boolean — Indica se a configuração está ativa - `is_credit_card` boolean — Indica se é um cartão de crédito - `is_deposit` boolean — Indica se é um pagamento por depósito - `is_billet` boolean — Indica se é um boleto bancário - `is_pix` boolean — Indica se é um pagamento via Pix - `is_pix_in_installments` boolean — Indica se o Pix permite parcelamento - `is_wallet` boolean — Indica se é um pagamento via carteira digital - `icon_url` string, uri — URL do ícone do meio de pagamento - `metadata` object — Metadados adicionais - `data` object[] — Lista de metadados - `key` string — Chave do metadado - `value` string — Valor do metadado - `spreadsheet` object - `data` object — Detalhes do cliente e da compra - `customer_phone` string — Telefone do cliente - `last_order_date` string, date — Data do último pedido - `products` string — Lista de produtos do pedido - `products_skus` string — Lista de SKUs dos produtos - `categories` string — Categorias dos produtos adquiridos - `brands` string — Marcas dos produtos adquiridos - `purchase_url` string, uri — URL de recuperação da compra - `abandoned_step` string — Etapa em que o carrinho foi abandonado - `count_recover_mail_sent` string — Quantidade de e-mails de recuperação enviados - `search` object — Dados de busca sobre o carrinho abandonado - `data` object — Detalhes do status do carrinho - `has_shipment_service` boolean — Indica se há serviço de entrega - `has_address` boolean — Indica se há endereço cadastrado - `has_customer` boolean — Indica se há um cliente associado - `has_refused_payment` boolean — Indica se houve pagamento recusado - `abandoned_step` string — Etapa onde o carrinho foi abandonado - `count_recover_mail_sent` integer — Quantidade de e-mails de recuperação enviados - `created_at` string, date — Data de criação do carrinho - `updated_at` string, date — Data da última atualização do carrinho - `emails` object — Histórico de e-mails enviados - `data` object[] — Lista de e-mails enviados para recuperação do carrinho - `id` integer — ID do e-mail - `cart_id` integer — ID do carrinho associado - `promocode_id` integer, nullable — ID do cupom de desconto, se aplicável - `turn` integer — Número da tentativa de recuperação - `email` string, email — E-mail do destinatário - `subject` string, nullable — Assunto do e-mail - `fire_date` string, date-time — Data e hora programadas para envio do e-mail - `sent_at` string, date-time, nullable — Data e hora em que o e-mail foi enviado - `created_at` string, date-time — Data e hora de criação do registro do e-mail - `updated_at` string, date-time — Data e hora da última atualização do registro - `meta` object - `pagination` object - `total` integer - `count` integer - `per_page` integer - `current_page` integer - `total_pages` integer - `links` object - `previous` string - `next` string ## Other responses - `400` — Requisição inválida - `404` — Carrinhos abandonados não encontrados --- [API](https://skmtc.net/yampi/apis/yampi-api.md) · [All operations](https://skmtc.net/yampi/apis/yampi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yampi/yampi-api/revisions/fa16c50bef09/schema)