> ## Documentation Index > Fetch the complete documentation index at: https://docs.yampi.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Listar carrinhos abandonados > listas os carrinhos abandonados com filtros personalizados Este endpoint suporta paginação por scroll\_id, ideal para navegar grandes volumes de dados sem perder a consistência da ordenação. Consulte a documentação completa para saber como funciona o ciclo de paginação. ## OpenAPI ````yaml get /{alias}/checkout/carts openapi: 3.0.0 info: title: Yampi API description: Documentação oficial da API da Yampi version: '2.0' servers: - url: https://api.dooki.com.br/v2 description: Endpoint de produção security: - ApiToken: [] ApiSecretKey: [] tags: - name: Catálogo - Atualização em massa x-folder: catalogo/atualizacao-em-massa - name: Catálogo - Avaliações de produtos x-folder: catalogo/produtos/avaliacoes-de-produtos - name: Catálogo - Categorias x-folder: catalogo/categorias - name: Catálogo - Coleções x-folder: catalogo/colecoes - name: Catálogo - Comentários de produtos x-folder: catalogo/produtos/comentarios-de-produtos - name: Catálogo - Customizações x-folder: catalogo/customizacoes - name: Catálogo - Estoques de SKU x-folder: catalogo/skus/estoques-de-sku - name: Catálogo - Feeds x-folder: catalogo/feeds - name: Catálogo - Filtros x-folder: catalogo/filtros - name: Catálogo - Grupos x-folder: catalogo/grupos - name: Catálogo - Imagens x-folder: catalogo/imagens - name: Catálogo - Looks x-folder: catalogo/looks - name: Catálogo - Kits x-folder: catalogo/kits - name: Catálogo - Marcas x-folder: catalogo/marcas - name: Catálogo - Notificações de estoque x-folder: catalogo/notificacoes-de-estoque - name: Catálogo - Produtos x-folder: catalogo/produtos - name: Catálogo - Produtos relacionados x-folder: catalogo/produtos/produtos-relacionados - name: Catálogo - Selos x-folder: catalogo/selos - name: Catálogo - Sincronizar estoques x-folder: catalogo/skus/sincronizar-estoques - name: Catálogo - SKUs x-folder: catalogo/skus - name: Catálogo - Valores de filtros x-folder: catalogo/filtros/valores-de-filtros - name: Catálogo - Valores de variações x-folder: catalogo/variacoes/valores-de-variacoes - name: Catálogo - Variações x-folder: catalogo/variacoes - name: Público - Catálogo x-folder: /publico/catalogo - name: Público - Busca x-folder: /publico/busca - name: Público - Loja x-folder: /publico/loja - name: Checkout - Bancos x-folder: checkout/bancos - name: Checkout - Links de Pagamento x-folder: checkout/links-de-pagamento - name: Checkout - Carrinhos abandonados x-folder: checkout/carrinhos-abandonados - name: Checkout - Configurações de pagamentos x-folder: checkout/configuracoes-de-pagamentos - name: Checkout - Formas de pagamentos x-folder: checkout/formas-de-pagamentos - name: Checkout - Gateways de pagamento x-folder: checkout/gateways-de-pagamento - name: Checkout - Parcelamento x-folder: checkout/parcelamento - name: Checkout - Status de pedidos x-folder: checkout/status-de-pedidos - name: Checkout - Transações x-folder: checkout/transacoes - name: Clientes - Cliente x-folder: clientes/cliente - name: Clientes - Clusters description: >- Clusters são grupos de clientes com condições comerciais flexíveis, como preço de produto, frete e forma de entrega x-folder: clientes/clusters - name: Clientes - Endereços x-folder: clientes/enderecos - name: Clientes - Regras de frete dos clusters x-folder: clientes/clusters/regras-de-frete-dos-clusters - name: Configurações - Carrinhos abandonados x-folder: configuracoes/carrinhos-abandonados - name: Configurações - Checkout x-folder: configuracoes/checkout - name: Configurações - Credenciais da loja x-folder: configuracoes/credenciais-da-loja - name: Configurações - Dados da loja x-folder: configuracoes/dados-da-loja - name: Configurações - Fotos x-folder: configuracoes/fotos - name: Configurações - Integrações x-folder: configuracoes/integracoes - name: Configurações - IPs bloqueados x-folder: configuracoes/ips-bloqueados - name: Configurações - Overview x-folder: configuracoes/overview - name: Conteúdo - Páginas x-folder: conteudo/paginas - name: Conteúdo - Redirecionamentos x-folder: conteudo/redirecionamentos - name: Descontos x-folder: descontos - name: Leads x-folder: leads - name: Logística - Armazéns x-folder: logistica/armazens - name: Logística - Simular frete x-folder: logistica/simular-frete - name: Logística - CEP x-folder: logistica/cep - name: Logística - Embalagens x-folder: logistica/embalagens - name: Logística - Estoques description: >- O lojista pode ter um cadastro de múltiplos estoques onde ele pode associar posteriormente os SKUS com suas respectivas quantidades. Um exemplo prático é permitir que ele consiga trabalhar com estoques de fornecedores externos com diferentes prazos de entrega. x-folder: logistica/estoques - name: Logística - Países x-folder: logistica/paises - name: Logística - Preços de frete x-folder: logistica/precos-de-frete - name: Logística - Reservas de estoque x-folder: logistica/reservas-de-estoque - name: Logística - Transportadoras x-folder: logistica/transportadoras - name: Logística - API de Frete x-folder: logistica/api-de-frete - name: Marketing x-folder: marketing - name: Marketing - Brindes x-folder: marketing/brindes - name: Pedidos - Comentários description: Endpoints de comentários de pedidos x-folder: pedidos/comentarios - name: Pedidos - Emails description: Endpoints de e-mails de pedidos x-folder: pedidos/emails - name: Pedidos - Endereços description: Endpoints de endereços de pedidos x-folder: pedidos/enderecos - name: Pedidos - Etiquetas description: Endpoints de etiquetas de pedidos x-folder: pedidos/etiquetas - name: Pedidos - Notas fiscais description: Endpoints de notas fiscais de pedidos x-folder: pedidos/notas-fiscais - name: Pedidos - Rastreamento description: Endpoints de emails de pedidos x-folder: pedidos/rastreamento - name: Pedidos - Pedido description: Endpoints de pedidos x-folder: pedidos/pedido - name: Promoções - Combos x-folder: promocoes/combos - name: Promoções - Desconto progressivo x-folder: promocoes/desconto-progressivo - name: Promoções - Frete grátis x-folder: promocoes/frete-gratis - name: Promoções - Order Bump x-folder: promocoes/orderbump - name: Promoções - Upsells x-folder: promocoes/upsells - name: Promoções - Carteira x-folder: promocoes/carteira - name: Sistema description: Endpoints informativos do sistema x-folder: sistema - name: Busca - Global x-folder: busca/global - name: Busca - Pedidos x-folder: busca/pedidos - name: Busca - Produtos x-folder: busca/produtos - name: Busca - Clientes x-folder: busca/clientes - name: Busca - Leads x-folder: busca/leads - name: Busca - Carrinhos x-folder: busca/carrinhos - name: Usuários x-folder: usuarios - name: Usuários - Convites x-folder: usuarios/convites - name: Usuários - Grupos x-folder: usuarios/grupos - name: Usuários - Permissões x-folder: usuarios/permissoes - name: Webhooks x-folder: webhooks - name: Loja Virtual - Scripts x-folder: loja-virtual/scripts - name: Modulo - Recurso description: Modulo - Recurso - name: Marketplaces - Atributos description: Marketplaces - Atributos - name: Marketplaces - Anúncios description: Marketplaces - Anúncios - name: Links de Pagamento description: Links de Pagamento - name: Checkout - Contas bancárias description: Checkout - Contas bancárias - name: Checkout - Vendedores description: Checkout - Vendedores - name: Configurações - E-mails description: Configurações - E-mails - name: Logística - Frete Público description: Logística - Frete Público - name: Marketplaces - Categorias description: Marketplaces - Categorias - name: Marketplaces - Contas description: Marketplaces - Contas - name: Marketplaces - Lista de erros description: Marketplaces - Lista de erros - name: Marketplaces description: Marketplaces - name: Métricas - Cashback description: Métricas - Cashback - name: Promoções - Cashbacks description: Promoções - Cashbacks - name: Promoções - Cashback description: Promoções - Cashback - name: Promoções - Cupons de desconto description: Promoções - Cupons de desconto - name: Promoções - Produtos description: Promoções - Produtos - name: Filas description: Filas paths: /{alias}/checkout/carts: get: tags: - Checkout - Carrinhos abandonados summary: Listar carrinhos abandonados description: listas os carrinhos abandonados com filtros personalizados operationId: GetCheckoutCarts parameters: - name: alias in: path description: Alias da loja required: true schema: type: string - name: include in: query description: Incluir relacionamentos adicionais schema: type: array items: type: string enum: - customer - payment - address - promocode - items - seller - transactions - whatsapp - whatsapp_app - spreadsheet - metadata - search - emails example: '?include=customer,payment,address' - $ref: '#/components/parameters/CartCriteria' responses: '200': description: Lista de carrinhos abandonados content: application/json: schema: allOf: - properties: data: type: array items: allOf: - $ref: '#/components/schemas/Cart' - $ref: '#/components/schemas/CartAdditionalResponse' type: object - $ref: '#/components/schemas/SimplePaginatorWithMeta' '400': description: Requisição inválida '404': description: Carrinhos abandonados não encontrados components: parameters: CartCriteria: name: filters in: query description: Filtros de carrinhos abandonados style: form explode: false schema: $ref: '#/components/schemas/CartCriteria' schemas: Cart: title: Carrinho description: Detalhes de um carrinho properties: id: type: integer merchant_id: type: integer readOnly: true example: '1' customer_id: type: integer token: type: string shipment_service_id: type: integer payment_alias: type: string has_recommendation: type: boolean is_upsell: type: boolean total_transactions: type: integer simulate_url: description: URL para simular o carrinho type: string format: uri unauth_simulate_url: description: URL para simular o carrinho sem autenticação type: string format: uri totalizers: properties: total_items: type: string subtotal: type: number format: float discount: type: number format: float shipment: type: number format: float shipment_original_value: type: number format: float nullable: true shipment_discount_value: type: number format: float shipment_discount_percent: type: string promocode_discount_value: type: number format: float combos_discount_value: type: number format: float total: type: number format: float subtotal_formated: type: string discount_formated: type: string total_formated: type: string shipment_formated: type: string type: object tracking_data: properties: name: type: string email: type: string format: email type: object utm_source: type: string utm_campaign: type: string utm_medium: type: string utm_term: type: string utm_content: type: string last_transaction_status: type: string type: object CartAdditionalResponse: properties: customer: properties: data: $ref: '#/components/schemas/Customer' type: object items: properties: data: $ref: '#/components/schemas/CartItemsRelated' type: object transactions: properties: data: type: object allOf: - $ref: '#/components/schemas/Transaction' - $ref: '#/components/schemas/TransactionAdditionalResponse' type: object payment: description: Informações sobre o meio de pagamento properties: data: description: Detalhes do pagamento properties: id: description: ID do meio de pagamento type: integer alias: description: Alias do meio de pagamento type: string name: description: Nome do meio de pagamento type: string has_config: description: Indica se há configuração disponível type: boolean active_config: description: Indica se a configuração está ativa type: boolean is_credit_card: description: Indica se é um cartão de crédito type: boolean is_deposit: description: Indica se é um pagamento por depósito type: boolean is_billet: description: Indica se é um boleto bancário type: boolean is_pix: description: Indica se é um pagamento via Pix type: boolean is_pix_in_installments: description: Indica se o Pix permite parcelamento type: boolean is_wallet: description: Indica se é um pagamento via carteira digital type: boolean icon_url: description: URL do ícone do meio de pagamento type: string format: uri type: object type: object metadata: description: Metadados adicionais properties: data: description: Lista de metadados type: array items: properties: key: description: Chave do metadado type: string example: discount_highlight value: description: Valor do metadado type: string example: pix type: object type: object spreadsheet: properties: data: description: Detalhes do cliente e da compra properties: customer_phone: description: Telefone do cliente type: string example: '12991008531' last_order_date: description: Data do último pedido type: string format: date example: '2025-03-17' products: description: Lista de produtos do pedido type: string example: Produto de teste products_skus: description: Lista de SKUs dos produtos type: string example: '121313132' categories: description: Categorias dos produtos adquiridos type: string example: Categoria teste com produtos,Categoria Herdeira brands: description: Marcas dos produtos adquiridos type: string example: Victoria's Secret purchase_url: description: URL de recuperação da compra type: string format: uri example: >- 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: description: Etapa em que o carrinho foi abandonado type: string example: shippment count_recover_mail_sent: description: Quantidade de e-mails de recuperação enviados type: string example: 0/4 type: object type: object search: description: Dados de busca sobre o carrinho abandonado properties: data: description: Detalhes do status do carrinho properties: has_shipment_service: description: Indica se há serviço de entrega type: boolean example: true has_address: description: Indica se há endereço cadastrado type: boolean example: true has_customer: description: Indica se há um cliente associado type: boolean example: true has_refused_payment: description: Indica se houve pagamento recusado type: boolean example: false abandoned_step: description: Etapa onde o carrinho foi abandonado type: string example: shippment count_recover_mail_sent: description: Quantidade de e-mails de recuperação enviados type: integer example: 0 created_at: description: Data de criação do carrinho type: string format: date example: '2025-03-17' updated_at: description: Data da última atualização do carrinho type: string format: date example: '2025-03-17' type: object type: object emails: description: Histórico de e-mails enviados properties: data: description: Lista de e-mails enviados para recuperação do carrinho type: array items: properties: id: description: ID do e-mail type: integer cart_id: description: ID do carrinho associado type: integer promocode_id: description: ID do cupom de desconto, se aplicável type: integer nullable: true turn: description: Número da tentativa de recuperação type: integer email: description: E-mail do destinatário type: string format: email subject: description: Assunto do e-mail type: string nullable: true fire_date: description: Data e hora programadas para envio do e-mail type: string format: date-time example: '2025-03-17 11:53:41' sent_at: description: Data e hora em que o e-mail foi enviado type: string format: date-time example: null nullable: true created_at: description: Data e hora de criação do registro do e-mail type: string format: date-time example: '2025-03-17 11:38:51' updated_at: description: Data e hora da última atualização do registro type: string format: date-time example: '2025-03-17 11:38:51' type: object type: object type: object SimplePaginatorWithMeta: title: SimplePaginatorWithMeta description: Representa uma paginação com meta properties: meta: properties: pagination: properties: total: type: integer example: '10' count: type: integer example: '30' per_page: type: integer example: '10' current_page: type: integer example: '1' total_pages: type: integer example: '3' links: properties: previous: type: string example: '' next: type: string example: '' type: object type: object type: object type: object CartCriteria: title: Filtros de Carrinhos Abandonados description: Mapeia os filtros disponíveis para pesquisa de carrinhos abandonados. properties: q: description: >- Termo de busca. A API buscará pelo nome, e-mail ou telefone do cliente. type: string example: '?q=joao' status: description: Status do pagamento associado ao carrinho. type: string enum: - payment_refused - no_transaction example: '?status=payment_refused' has_transactions: description: Indica se o carrinho possui transações associadas (true ou false). type: boolean example: '?has_transactions=true' customersData: description: >- Filtra carrinhos que possuem dados de clientes associados (true ou false). type: boolean example: '?customersData=true' date: description: Permite buscar carrinhos com base em um período de data. type: string example: '?date=created_at:2025-01-01|2026-01-31' type: object x-folder: checkout/carrinhos-abandonados Customer: title: Customer description: Representa um cliente properties: id: type: integer merchant_id: type: integer marketplace_id: type: integer active: type: boolean type: type: string cluster_id: type: integer name: type: string first_name: type: string last_name: type: string generic_name: type: string cpf: type: string spreadsheet: properties: data: properties: brands: type: string city: type: string purchased_brands: type: string last_order_date: properties: date: type: string format: date-time timezone_type: type: integer timezone: type: string type: object last_order_value: type: string purchased_categories: type: string number: type: string uf: type: string phone: type: string example: (16) 98187-5668 street: type: string phone_number: type: string example: '981875668' categories: type: string neighborhood: type: string complement: type: string phone_code: type: string example: '16' type: object type: object phone: properties: area_code: description: Código de área do telefone type: string full_number: description: Número do telefone type: string number: description: Número do telefone type: string formated_number: description: Número do telefone formatado type: string whatsapp_link: type: string format: uri type: object razao_social: type: string cnpj: type: string state_registration: type: string email: type: string format: email password: type: string writeOnly: true birthday: type: string format: date newsletter: type: boolean whatsapp: type: boolean social_driver: type: string social_id: type: integer ip: type: string readOnly: true token: type: string utm_source: type: string utm_campaign: type: string notes: type: string login_url: type: string format: uri anonymized: type: boolean type: object CartItemsRelated: type: object allOf: - $ref: '#/components/schemas/Customer' - $ref: '#/components/schemas/BaseTimestamp' - properties: sku: properties: data: $ref: '#/components/schemas/Sku' type: object type: object Transaction: title: Transações financeiras de um pedido properties: id: type: integer customer_id: description: ID do cliente type: integer payment_id: description: ID do pagamento type: integer affiliation_id: description: ID da afiliação type: integer marketplace_id: type: integer marketplace_account_id: type: integer authorized: type: boolean captured: type: boolean cancelled: type: boolean can_be_captured: type: boolean can_be_cancelled: type: boolean gateway_transaction_id: description: ID da transação no gateway type: integer gateway_order_id: type: integer gateway_authorization_code: type: string gateway_billet_id: type: integer amount: description: Valor type: number format: float buyer_amount: description: Valor type: number format: float installment_value: description: Valor type: number format: float buyer_installment_value: description: Valor type: number format: float installments: description: Número de parcelas type: integer installment_formated: description: Status da transação type: string buyer_installment_formated: description: Status da transação type: string status: description: Status da transação type: string error_message: type: string bank_name: type: string bank_alias: type: string truncated_card: type: string holder_name: description: Nome do titular type: string holder_document: description: Documento do titular type: string billet_url: type: string billet_barcode: type: string billet_date: type: string billet_our_number: type: string billet_document_number: type: string billet_whatsapp_link: type: string antifraud_sale_id: type: integer antifraud_status: type: string antifraud_score: type: string sent_to_antifraud: type: string total_logs: type: integer error_code: type: integer created_at: $ref: '#/components/schemas/BaseTimestamp' updated_at: $ref: '#/components/schemas/BaseTimestamp' capture_date: $ref: '#/components/schemas/BaseTimestamp' authorized_at: $ref: '#/components/schemas/BaseTimestamp' captured_at: $ref: '#/components/schemas/BaseTimestamp' cancelled_at: $ref: '#/components/schemas/BaseTimestamp' type: object TransactionAdditionalResponse: title: '' description: '' properties: payment: description: Informações sobre o meio de pagamento properties: data: description: Detalhes do pagamento properties: id: description: ID do meio de pagamento type: integer alias: description: Alias do meio de pagamento type: string name: description: Nome do meio de pagamento type: string has_config: description: Indica se há configuração disponível type: boolean active_config: description: Indica se a configuração está ativa type: boolean is_credit_card: description: Indica se é um cartão de crédito type: boolean is_deposit: description: Indica se é um pagamento por depósito type: boolean is_billet: description: Indica se é um boleto bancário type: boolean is_pix: description: Indica se é um pagamento via Pix type: boolean is_pix_in_installments: description: Indica se o Pix permite parcelamento type: boolean is_wallet: description: Indica se é um pagamento via carteira digital type: boolean icon_url: description: URL do ícone do meio de pagamento type: string format: uri type: object type: object metadata: description: Lista de metadados type: array items: properties: key: description: Chave do metadado type: string example: discount_highlight value: description: Valor do metadado type: string example: pix type: object type: object BaseTimestamp: properties: date: description: Data e hora no formato YYYY-MM-DD H:MM:SS. type: string example: '2000-08-17 10:24:24' timezone_type: description: Número de representação do timezone. type: integer example: 3 timezone: description: Fuso horário associado. type: string example: America/Sao_Paulo type: object Sku: title: SKU do catálogo description: '' properties: id: description: ID do SKU type: integer product_id: description: ID do produto ao qual o SKU pertence type: integer seller_id: description: ID do vendedor type: integer sku: description: Código do SKU type: string example: SKU-TEST-API token: description: Token único do SKU type: string erp_id: description: ID do SKU no ERP type: string example: 01-753-Rose blocked_sale: description: Vendas bloqueadas type: boolean example: false barcode: description: Código de barras do SKU type: string example: barcode-test title: description: Título completo do SKU type: string example: Produto X - Variação 030303 Amarelo allow_sell_without_customization: description: Permite vender sem personalização obrigatória type: boolean example: true price_cost: description: Preço de custo do SKU type: number format: float price_sale: description: Preço de venda do SKU type: number format: float price_discount: description: Preço com desconto aplicado type: number format: float combinations: description: Combinações de variações associadas ao SKU type: array items: type: string weight: description: Peso do SKU em kg type: number format: float height: description: Altura do SKU em cm type: number format: float width: description: Largura do SKU em cm type: number format: float length: description: Comprimento do SKU em cm type: number format: float quantity_managed: description: Indica se o controle de estoque está habilitado type: boolean example: true availability: description: Quantidade disponível em estoque type: integer availability_soldout: description: Quantidade disponível mesmo após esgotado type: integer order: description: Ordem de exibição do SKU para a página de produtos type: integer type: object securitySchemes: ApiToken: type: apiKey name: User-Token in: header ApiSecretKey: type: apiKey name: User-Secret-Key in: header ````