--- title: "Listar Pedidos retornados pela busca" method: GET path: "/{alias}/search/orders" tags: ["Busca - Pedidos"] --- # Listar Pedidos retornados pela busca `GET /{alias}/search/orders` ## Request - Base URL: `https://api.dooki.com.br/v2` - URL: `https://api.dooki.com.br/v2/{alias}/search/orders` - Auth: API key in header `User-Token` and API key in header `User-Secret-Key` lista pedidos retornados pela busca ## Path parameters - `alias` string, required ## Query parameters - `filters` OrderSearchCriteria: Mapeia os filtros disponíveis para pesquisa de pedidos. - `freebie_id` integer[]: Brindes associados ao pedido. - `order_bump_id` integer[]: Order Bumps adicionados ao pedido. - `cashback` string[]: Filtra pedidos por status de cashback. - `upsell_id` integer[]: Upsells adquiridos após o checkout. - `woocommerce` string[]: Filtra pedidos sincronizados ou não com WooCommerce. - `utm_source` string[]: Origem da campanha de marketing (UTM Source). - `shopify_id` integer: Busca pedido pelo ID do pedido na Shopify. - `utm_campaign` string[]: Nome da campanha de marketing (UTM Campaign). - `customer_document` string: Documento do cliente associado ao pedido (CPF ou CNPJ). ## Response `200` Lista de pedidos através da busca - object - `data` object: Recursos adicionais do pedido, retornados sob demanda via parâmetro `include`. - `delivered` boolean: Indica se o pedido já foi entregue ao cliente. - `track_url` string: URL de rastreamento da entrega gerada pela transportadora. - `track_code` string: Código de rastreamento da entrega gerado pela transportadora. - `authorized` boolean: Indica se o pagamento do pedido foi autorizado pela adquirente/gateway. - `customer_id` integer: ID do cliente - `promocode_id` integer: ID do cupom de desconto aplicado ao pedido, quando houver. - `marketplace_id` integer: ID do marketplace de origem do pedido, quando a venda vem de um marketplace. - `marketplace_account_id` integer: ID da conta do marketplace vinculada ao pedido. - `has_recomm` boolean: Indica se o pedido teve origem no clique em um produto sugerido pelo e-mail de recomendação. - `number` number: Número do pedido - `marketplace_partner_id` integer: ID do parceiro/afiliado do marketplace associado ao pedido, quando aplicável. - `marketplace_sale_number` number: Número único da venda no marketplace de origem (usado quando não há `number` local do pedido). - `value_total` number, float: Valor total do pedido - `value_products` number, float: Valor dos produtos - `value_discount` number, float: Valor do desconto - `value_shipment` number, float: Valor do frete - `value_tax` number, float: Valor do imposto - `shipment_service` string: Método de entrega - `shipment_quote_id` integer: ID da cotação de frete utilizada no pedido. - `days_delivery` integer: Dias para entrega - `utm_source` string: Origem da campanha de marketing (parâmetro UTM `utm_source`) que originou o pedido. - `utm_campaign` string: Nome da campanha de marketing (parâmetro UTM `utm_campaign`) que originou o pedido. - `utm_term` string: Termo de busca (parâmetro UTM `utm_term`) que originou o pedido. - `utm_content` string: Conteúdo do anúncio/link (parâmetro UTM `utm_content`) que originou o pedido. - `utm_medium` string: Meio/canal de marketing (parâmetro UTM `utm_medium`) que originou o pedido. - `ip` string, ip: Endereço IP do comprador no momento da criação do pedido. - `items` OrderItem[]: Itens do pedido - `id` integer: ID do item no pedido - `product_id` integer: ID do produto - `sku_id` integer: ID do SKU - `item_sku` string: Código do SKU - `quantity` integer: Quantidade adquirida - `price` number, float: Preço do item - `price_cost` number, float: Custo do item - `shipment_cost` number, float: Custo de envio do item - `gift` boolean: Indica se é um item presente - `gift_value` number, float: Valor do item presente - `has_recomm` integer: Indica se possui recomendação - `is_digital` boolean: Indica se é um item digital - `freebie_id` integer, nullable: ID de item brinde (se aplicável) - `bundle_id` integer, nullable: ID do bundle (se aplicável) - `bundle_name` string, nullable: Nome do bundle (se aplicável) - `address` OrderAddress[]: Endereço de entrega - `id` integer: ID do endereço do pedido. - `order_id` integer: ID do pedido a que o endereço pertence. - `address_name` string: Apelido do endereço, usado para identificá-lo na loja. - `street` string: Rua - `number` integer: Número - `complement` string: Complemento - `reference` string: Referencia - `neighborhood` string: Bairro - `receiver` string: Nome do recebedor - `zipcode` integer: CEP do endereço de entrega. - `zip_code` integer: CEP do endereço de entrega. Mesmo valor de `zipcode`, mantido por compatibilidade. - `full_address` string: Endereço montado em uma linha, no formato 'rua, número - bairro' ou 'rua, número - complemento - bairro' quando houver complemento. - `city` string: Cidade - `uf` string: Estado - `country` string: País - `transactions` object: Transações de pagamento associadas ao pedido. - `data` object: Dados retornados junto da transação por meio de includes; `payment` e `metadata` vêm por padrão. - `id` integer: Identificador único da transação. - `customer_id` integer: ID do cliente que fez o pagamento. - `payment_id` integer: ID do meio de pagamento usado na transação. - `affiliation_id` integer: ID da afiliação de pagamento (adquirente/gateway) que processou a transação. - `marketplace_id` integer: ID do marketplace de origem da transação, quando aplicável. - `marketplace_account_id` integer: ID da conta do marketplace usada na transação, quando aplicável. - `authorized` boolean: Indica se a transação foi autorizada pela adquirente/gateway. - `captured` boolean: Indica se a transação foi capturada (pagamento efetivado). - `cancelled` boolean: Indica se a transação foi cancelada. - `can_be_captured` boolean: Indica se a transação pode ser capturada: exige transação autorizada, não cancelada, ainda não paga e meio de pagamento diferente de carteira digital e de Pix parcelado. - `can_be_cancelled` boolean: Indica se a transação pode ser cancelada: exige transação não cancelada e meio de pagamento diferente de carteira digital e de Pix parcelado. - `gateway_transaction_id` integer: ID da transação no gateway de pagamento. - `gateway_order_id` integer: ID do pedido correspondente no gateway de pagamento. - `gateway_authorization_code` string: Código de autorização devolvido pela adquirente/gateway. - `gateway_billet_id` integer: ID do boleto no gateway de pagamento, quando o meio de pagamento for boleto. - `amount` number, float: Valor total da transação, em reais. - `buyer_amount` number, float: Valor total cobrado do comprador, em reais, incluindo os juros do parcelamento. - `installment_value` number, float: Valor de cada parcela da transação, em reais; zero quando não há parcelamento. - `buyer_installment_value` number, float: Valor de cada parcela cobrada do comprador, em reais; zero quando não há parcelamento. - `installments` integer: Número de parcelas da transação. - `installment_formated` string: Parcelamento formatado no padrão `3x de R$ 300,00`, com o número de parcelas e o valor total da transação. - `buyer_installment_formated` string: Parcelamento formatado no padrão `3x de R$ 300,00`, com o número de parcelas e o valor total cobrado do comprador. - `status` string: Status da transação (`waiting_payment`, `authorized`, `paid`, `refused`, `cancelled` ou `handling_products`). - `error_message` string: Mensagem de erro devolvida pela adquirente/gateway quando a transação não é aprovada. - `bank_name` string: Nome do banco usado no pagamento; preenchido apenas em pagamentos por depósito. - `bank_alias` string: Alias do banco usado no pagamento, derivado do nome; preenchido apenas em pagamentos por depósito. - `truncated_card` string: Número parcial do cartão usado no pagamento, sem os dígitos sensíveis. - `holder_name` string: Nome do titular do cartão ou do meio de pagamento usado na transação. - `holder_document` string: Documento (CPF/CNPJ) do titular do cartão ou do meio de pagamento usado na transação. - `billet_url` string: URL do boleto gerado para a transação, quando o meio de pagamento for boleto. - `billet_barcode` string: Código de barras do boleto gerado para a transação. - `billet_date` string: Data de vencimento do boleto gerado para a transação. - `billet_our_number` string: Nosso número do boleto, identificador atribuído pelo banco emissor. - `billet_document_number` string: Número do documento do boleto, usado pelo banco emissor para identificar a cobrança. - `billet_whatsapp_link` string: Link do WhatsApp com a mensagem de cobrança do boleto pronta para envio ao cliente. - `antifraud_sale_id` integer: ID da análise da transação no serviço de antifraude. - `antifraud_status` string: Status devolvido pelo serviço de antifraude para a transação. - `antifraud_score` string: Pontuação de risco atribuída pelo serviço de antifraude à transação. - `sent_to_antifraud` string: Indica se a transação foi enviada para análise de antifraude. - `total_logs` integer: Quantidade de registros de log da transação. - `error_code` integer: Código do erro devolvido pela adquirente/gateway quando a transação não é aprovada. - `created_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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 - `date_delivery` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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. - `whatsapp` object: Mensagens configuradas para WhatsApp relacionadas ao pedido - `data` object: Dados dos links de mensagens pré-configuradas do WhatsApp para o pedido. - `billet` object: Mensagem de boleto via WhatsApp - `link` string, uri: Link do WhatsApp com mensagem pré-configurada - `message` string: Conteúdo da mensagem do boleto - `order_shipped` string, nullable: Mensagem de pedido enviado - `abandoned_cart` string, nullable: Mensagem de carrinho abandonado - `pix` string, nullable: Mensagem de Pix - `payment_link` string, nullable: Mensagem de link de pagamento - `pickup_address` object: Endereço de retirada do pedido, quando aplicável. - `data` Pickup: Endereço e condições de retirada do pedido definidos pela loja. - `id` integer: ID do endereço de retirada - `order_id` integer: ID do pedido relacionado - `country` string: País - `uf` string: Estado (sigla) - `city` string: Cidade - `neighborhood` string: Bairro - `street` string: Nome da rua - `number` string: Número do endereço - `zipcode` string: CEP - `full_address` string: Endereço completo - `complement` string, nullable: Complemento - `pickup_time_type` string: Tipo de horário de retirada - `pickup_time` integer: Horário de retirada - `only_weekdays` integer: Indica se a retirada é apenas em dias úteis (1 = sim, 0 = não) - `local_description` string: Descrição do local de retirada - `metadata` object: Metadados adicionais - `data` object[]: Lista de metadados - `key` string: Chave do metadado - `value` string: Valor do metadado - `status` object: Status atual do pedido - `data` object: Dados do status atual do pedido. - `id` integer: ID do status - `name` string: Nome do status - `alias` string: Alias identificador do status - `description` string: Descrição detalhada do status - `pix` object: Dados do pagamento via Pix associado ao pedido. - `data` object: Informações da cobrança Pix gerada para o pedido. - `pix_qr_code` string: Código QR do Pix - `pix_expiration_date` string, date-time: Data e hora de expiração do Pix - `promocode` object: Cupom de desconto aplicado ao pedido. - `data` OrderPromocode: Datas do cupom: período de vigência (`start_at` e `end_at`) e registro (`created_at` e `updated_at`). - `id` integer: ID do cupom. - `code` string: Código digitado pelo cliente no carrinho para aplicar o cupom. Único na loja, com no mínimo 3 e no máximo 40 caracteres. - `description` string: Descrição interna do cupom, com até 60 caracteres. Emojis são removidos ao salvar. - `customer_id` integer: ID do cliente para quem o cupom é exclusivo. Quando nulo, o cupom vale para qualquer cliente. - `active` boolean: Indica se o cupom está ativo. - `expired` boolean: Indica se a data de término do cupom já passou. - `discount_type` 'p' | 'v': Tipo do desconto do cupom: `p` para percentual e `v` para valor fixo em reais. - `for_the_price_of` boolean: Indica se o cupom é do tipo 'pelo preço de', em que cada produto elegível passa a custar o valor de `price_products`. - `cart_default` boolean: Indica se o cupom é aplicado automaticamente no carrinho. Um cupom percentual de 100% ou mais nunca é tratado como padrão. - `type_increment_value` string: Tipo do desconto como está gravado no cupom, com os mesmos valores de `discount_type` (`p` ou `v`). - `value` number, float: Valor do desconto: percentual quando `discount_type` for `p`, ou valor em reais quando for `v`. - `price_products` number, float: Preço aplicado a cada produto elegível quando `for_the_price_of` for verdadeiro. Obrigatório nesse caso. - `percent_products` number, float: Percentual de desconto aplicado ao preço de cada produto elegível, usado em vez de `price_products` quando for maior que zero. - `quantity` integer: Quantidade total de usos disponíveis do cupom. O cupom deixa de valer quando `used` alcança esse número. - `total_customers_used` integer: Quantidade de clientes distintos que já usaram o cupom. - `product_quantity` integer: Quantidade de produtos elegíveis que o cupom 'pelo preço de' considera no cálculo do total. - `product_max_quantity` integer: Quantidade máxima de produtos elegíveis a que o cupom se aplica. - `used` integer: Quantidade de vezes que o cupom já foi usado. - `items_count` integer: Quantidade de itens do carrinho considerada na regra do cupom. Campo legado: é gravado e devolvido, mas nenhuma regra desta API o aplica. - `min_value` number, float: Valor mínimo do subtotal do carrinho, em reais, para o cupom poder ser aplicado. - `use_percent` number, float: Proporção de uso do cupom, entre os usos já feitos e o total disponível. - `shipment_percent` number, float: Percentual de desconto aplicado ao frete, usado quando o cupom desconta no frete em vez de descontar nos produtos. - `accumulate` boolean: Indica se o cupom pode ser acumulado com outras promoções da loja. - `once_per_customer` boolean: Indica se cada cliente pode usar o cupom uma única vez. - `abandoned_cart` boolean: Indica se o cupom está vinculado a alguma configuração de recuperação de carrinho abandonado. - `newsletter` boolean: Indica se o cupom é entregue ao cliente que se inscreve na newsletter da loja. - `payments_ids` string: IDs dos meios de pagamento em que o cupom é aceito. - `free_shipment` boolean: Indica se o cupom concede frete grátis em vez de desconto no valor do pedido. - `ignore_promotion_products` boolean: Indica se o cupom deixa de valer para produtos que já estão em promoção. - `freebie_id` integer, nullable: Brinde concedido pelo cupom - `advertise` boolean: Divulgar o cupom com brinde no checkout - `start_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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. - `end_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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. - `created_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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. - `statuses` object: Histórico de status do pedido - `data` object[]: Histórico de status pelos quais o pedido passou. - `id` integer: ID do status - `name` string: Nome do status - `alias` string: Alias do status - `description` string: Descrição do status - `details` string, nullable: Detalhes adicionais do status - `created_at` BaseTimestamp: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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: Data e hora no formato de objeto devolvido pelo PHP, com o fuso horário em que foi registrada. - `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. - `payments` object[]: Lista de meios de pagamento disponíveis ou utilizados - `icon_url` string, uri: URL do ícone do meio de pagamento - `name` string: Nome do meio de pagamento - `alias` string: Alias identificador do meio de pagamento - `services` object: Serviços vinculados ao pedido - `data` object[]: Lista de serviços externos vinculados ao pedido (ex.: integrações de logística). - `customer` object: Cliente que realizou o pedido. - `data` Customer: Representa um cliente - `id` integer: Identificador único do cliente. - `merchant_id` integer: ID da loja à qual o cliente pertence. - `marketplace_id` integer: ID do marketplace de origem do cliente, quando o cadastro vem de um marketplace. - `active` boolean: Indica se o cliente está ativo. - `type` string: Tipo de pessoa do cliente: `f` para pessoa física, `j` para pessoa jurídica. - `cluster_id` integer: ID do cluster (grupo de clientes) ao qual o cliente está vinculado, quando houver. - `name` string: Nome do cliente. - `first_name` string: Primeiro nome do cliente, derivado de `name`. - `last_name` string: Sobrenome do cliente, derivado de `name`. - `generic_name` string: Nome de exibição do cliente: o `name` para pessoa física e a `razao_social` para pessoa jurídica. - `cpf` string: CPF do cliente, para pessoa física. - `spreadsheet` object: Dados do cliente desnormalizados para exportação em planilha, retornados sob demanda via `include`. - `data` object: Conjunto de dados do cliente usados na exportação em planilha. - `brands` string: Marcas dos produtos comprados pelo cliente no último pedido, separadas por vírgula. - `city` string: Cidade do endereço do cliente. - `purchased_brands` string: Marcas dos produtos comprados pelo cliente no último pedido, separadas por vírgula. - `last_order_date` object: Data do último pedido do cliente. - … - `last_order_value` string: Valor total do último pedido do cliente, em reais. - `purchased_categories` string: Categorias dos produtos comprados pelo cliente no último pedido, separadas por vírgula. - `number` string: Número do endereço do cliente. - `uf` string: Unidade federativa (estado) do endereço do cliente. - `phone` string: Telefone do cliente, com DDD e formatado. - `street` string: Nome da rua do endereço do cliente. - `phone_number` string: Número do telefone do cliente, sem o DDD. - `categories` string: Categorias dos produtos comprados pelo cliente no último pedido, separadas por vírgula. - `neighborhood` string: Bairro do endereço do cliente. - `complement` string: Complemento do endereço do cliente. - `phone_code` string: DDD do telefone do cliente. - `phone` object: Dados de telefone do cliente. - `area_code` string: Código de área (DDD) do telefone. - `full_number` string: Número completo do telefone, com DDD e sem formatação. - `number` string: Número do telefone, sem o DDD. - `formated_number` string: Número do telefone formatado para exibição. - `whatsapp_link` string, uri: Link para iniciar uma conversa no WhatsApp com o cliente. - `razao_social` string: Razão social do cliente, para pessoa jurídica. - `cnpj` string: CNPJ do cliente, para pessoa jurídica. - `state_registration` string: Inscrição estadual do cliente, para pessoa jurídica. - `email` string, email: E-mail do cliente. - `password` string: Senha de acesso do cliente. Enviada apenas na criação ou atualização, nunca retornada. - `birthday` string, date: Data de nascimento do cliente. - `newsletter` boolean: Indica se o cliente aceitou receber a newsletter da loja. - `whatsapp` boolean: Indica se o cliente aceitou receber mensagens no WhatsApp. - `social_driver` string: Provedor de login social usado no cadastro do cliente (ex.: Google, Facebook), quando aplicável. - `social_id` integer: Identificador do cliente no provedor de login social, quando o cadastro veio de login social. - `ip` string: Endereço IP do cliente no momento do cadastro. - `token` string: Token único do cliente, usado para autenticá-lo em ações como login automático. - `utm_source` string: Origem da campanha de marketing (parâmetro UTM `utm_source`) que originou o cadastro do cliente. - `utm_campaign` string: Nome da campanha de marketing (parâmetro UTM `utm_campaign`) que originou o cadastro do cliente. - `notes` string: Observações internas sobre o cliente. - `login_url` string, uri: URL de login automático do cliente na loja, gerada a partir do seu `token`. - `anonymized` boolean: Indica se os dados do cliente foram anonimizados por solicitação de exclusão (LGPD). ## Other responses - `400`: Requisição inválida - `404`: URL inválida ## Changes - **2026-11-03** `bbafb577e11c`: 1 info - endpoint added [Operation history](https://skmtc.dev/yampi/apis/yampi-api/changes/:alias/search/orders/get.md) --- [API](https://skmtc.dev/yampi/apis/yampi-api.md) - [All operations](https://skmtc.dev/yampi/apis/yampi-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yampi/apis/yampi-api/revisions/74739ec8876f?raw)