Entrar

Crear evaluación

POST https://{organization}.myguper.com/api/register/feedback/review

Registra una evaluación de un cliente para un pedido específico. Solo una evaluación por pedido está permitida — un segundo POST para el mismo orderId devuelve 409.

La evaluación lleva un discriminador type que indica qué escala sigue el rating:

  • type: csat — nota de 1 a 5 (Customer Satisfaction)
  • type: nps — nota de 0 a 10 (Net Promoter Score)

comment siempre es obligatorio (texto libre, no puede quedar vacío después de trim). categoryId es opcional — envíalo solo si la organización creó la categoría correspondiente antes. Cuando se omite, la evaluación queda sin categoría.

Try-it values populated from environment ACME (Demo)


Autenticación

Token

Send your user token in the x-guper-authorization header.

Encabezados

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Cuerpo de la petición

Content-Type: application/json

{
    "personId": 12345,
    "orderId": "ORD-789",
    "type": "csat",
    "rating": 5,
    "comment": "Great delivery, on time and well packaged.",
    "categoryId": 1,                                            // optional
    "source": "journey",                                        // optional
    "data": "<data>"                                            // optional
}

Respuestas

{
    "id": 1,
    "personId": 12345,
    "orderId": "ORD-789",
    "type": "csat",
    "categoryId": 1,
    "rating": 5,
    "comment": "Great delivery, on time and well packaged.",
    "source": "journey",
    "data": null,
    "createdAt": "2026-05-14T11:00:00-03:00",
    "updatedAt": "2026-05-14T11:00:00-03:00"
}
Copied to clipboard