Skip to content

Consultar Pedidos

Endpoint

Método HTTP: GET

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

Parâmetros de Consulta

ParâmetroTipoDescrição
experiencestring requiredNome da experiencia criada. Obtido de POST /campaigns.
requestIdstring requiredID do pedido de recompensa. Obtido de POST /requests.

Exemplo de Requisição

sh
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

PropriedadeTipoDescrição
requestIdstringID do pedido de recompensa. Obtido de POST /requests.
valueintegerValor da recompensa entregue.
deliveredobjectInformações sobre a recompensa entregue.
delivered.valueintegerValor da recompensa entregue.
delivered.prizesarrayColeção de recompensas entregues.
delivered.prizes.valueintegerValor da recompensa que o cliente irá receber.
delivered.prizes.quantityintegerQuantidade de prêmios entregues.
delivered.prizes.namestringNome utilizado como identificador da recompensa na Plataforma.
delivered.prizes.titlestringTítulo da recompensa na Plataforma.
delivered.prizes.couponstringCupom ou código associado a recompensa.
canceledobjectInformações sobre recompensas canceladas.
canceled.valueintegerValor da recompensa cancelada.
canceled.prizesarrayColeção de recompensas canceladas.
statusstringStatus da solicitação.
detailobjectDetalhes da solicitação.
detail.descriptionstringDescrição da solicitação.
createdAtstringData criação do pedido.
concludedAtstringData conclusão do pedido.

Exemplo de Resposta

sh
{
    "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"
}

Direitos reservados © 2021-2025 Minu