Pular para o conteúdo principal

Consultar performance de uma promoção

GET 
/seller/v1/promotions/:promotion_id/performance

Consulta os indicadores acumulados de performance de uma promoção para o seller.

Escopo da Operação​

Retorna o valor bruto vendido, a quantidade de itens, o ticket médio e os subsídios pagos pelo canal e pelo seller para a promoção identificada por promotion_id. O identificador deve ser o UUID público da participação do seller na promoção.

Indicadores​

  • sales.gross_merchandise_value: valor bruto total vendido na campanha.
  • sales.items_quantity: quantidade total de itens vendidos.
  • sales.average_ticket: valor médio por item vendido.
  • investment.channel: subsídio total pago pelo canal.
  • investment.seller: subsídio total pago pelo seller.
  • inventory: disponibilidade, quantidade reservada e limite contratado, disponível como objeto somente para promoções coupon_discount criadas pelo canal e aderidas pelo seller, quando o contador estiver rastreado. reserved representa os cupons já utilizados e available é o saldo calculado como max(limit - reserved, 0); quando limit for null, available também será null. Em promoções de autosserviço, de entrada automática ou sem contador, o campo será null.
  • calculated_at: data e hora da última consolidação dos indicadores, ou null quando ainda não houver consolidação.

O limite de venda por SKU deve ser consultado em GET /seller/v1/promotions/{promotion_id}/skus.

Parâmetros​

  • promotion_id: identificador público da promoção consultada. A consulta é isolada pelo seller autenticado e não retorna dados de participações de outros sellers.
ATENÇÃO

Os indicadores são consolidados de forma assíncrona, em processamento próximo do tempo real. Campanhas de alto volume podem ser recalculadas em lote, portanto a resposta não representa uma leitura transacional. Use calculated_at para avaliar o frescor dos dados.

Dica

No ambiente de sandbox não há pedidos reais; por isso, o endpoint retorna indicadores zerados nesse ambiente.

Request​

Responses​

Sucesso