--- title: "Visualizar detalhes de um pedido" method: GET path: "/{alias}/orders/{id}" tags: ["Pedidos - Pedido"] --- # Visualizar detalhes de um pedido `GET /{alias}/orders/{id}` Visualiza os detalhes de um determinado pedido a partir do seu ID ## Path parameters - `alias` string, required - `id` integer, required ## Query parameters - `include` string[] ## Response `200` Detalhes do pedido - object - `data` object[] — Detalhes de um pedido - `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 - `order_id` integer - `address_name` string - `street` string — Rua - `number` integer — Número - `complement` string — Complemento - `reference` string — Referencia - `neighborhood` string — Bairro - `receiver` string — Nome do recebedor - `zipcode` integer — CEP - `zip_code` integer — CEP - `full_address` string - `city` string — Cidade - `uf` string — Estado - `country` string — País - `transactions` object — Transações de pagamento associadas ao pedido. - `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 - `date_delivery` 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. - `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 - `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 — Representa um código promocional - `id` integer - `code` string - `description` string - `customer_id` integer - `active` boolean - `expired` boolean - `discount_type` 'p' | 'v' - `for_the_price_of` boolean - `cart_default` boolean - `type_increment_value` string - `value` number, float - `price_products` number, float - `percent_products` number, float - `quantity` integer - `total_customers_used` integer - `product_quantity` integer - `product_max_quantity` integer - `used` integer - `items_count` integer - `min_value` number, float - `use_percent` number, float - `shipment_percent` number, float - `accumulate` boolean - `once_per_customer` boolean - `abandoned_cart` boolean - `newsletter` boolean - `payments_ids` string - `free_shipment` boolean - `ignore_promotion_products` boolean - `start_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. - `end_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. - `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. - `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 - `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. - `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 - `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 ## Other responses - `404` — Quando o recurso especificado não existe --- [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)