Consultar Pedidos

Endpoint

Método HTTP: GET

URL: /experiences/{experience}/requests/{requestId}

Parâmetros de Consulta

Parâmetro	Tipo	Descrição
experience	string required	Nome da experiencia criada. Obtido de POST /campaigns.
requestId	string required	ID do pedido de recompensa. Obtido de POST /requests.

Exemplo de Requisição

curl --request GET \
  --url https://api.minu.biz/v1/experiences/{experience}/requests/{requestId} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>'

Propriedades de Resposta

Se a requisição for bem-sucedida, a API retornará as seguintes propriedades no formato JSON.

Propriedade	Tipo	Descrição
requestId	string	ID do pedido de recompensa. Obtido de POST /requests.
value	integer	Valor da recompensa entregue.
delivered	object	Informações sobre a recompensa entregue.
delivered.value	integer	Valor da recompensa entregue.
delivered.prizes	array	Coleção de recompensas entregues.
delivered.prizes.value	integer	Valor da recompensa que o cliente irá receber.
delivered.prizes.quantity	integer	Quantidade de prêmios entregues.
delivered.prizes.name	string	Nome utilizado como identificador da recompensa na Plataforma.
delivered.prizes.title	string	Título da recompensa na Plataforma.
delivered.prizes.coupon	string	Cupom ou código associado a recompensa.
canceled	object	Informações sobre recompensas canceladas.
canceled.value	integer	Valor da recompensa cancelada.
canceled.prizes	array	Coleção de recompensas canceladas.
status	string	Status da solicitação.
detail	object	Detalhes da solicitação.
detail.description	string	Descrição da solicitação.
createdAt	string	Data criação do pedido.
concludedAt	string	Data conclusão do pedido.

Exemplo de Resposta

{
    "requestId": "62e8274f64abd3c501af74e3",
    "value": 10,
    "delivered": {
        "value": 10,
        "prizes": [
             {
                "value": 10,
                "quantity": 1,
                "name": "cupom-ifood-20",
                "title": "Cupom iFood R$20",
                "coupon": "cupon_minu"
             }
        ]
    },
    "canceled": {
        "value": 0,
        "prizes": []
    },
    "status": "Success",
    "detail": {
       "description": "Pedido processado com sucesso"
    },
    "createdAt": "2025-07-09T00:00:00",
    "concludedAt": "2025-07-10T00:00:00"
}