Courier API › Trip

Rate Trip

posthttps://sandbox-api.gozem.co/courier/v1/trips/{trip_id}/rating

Submit a rating and optional comment for a completed trip.

Path parameters

trip_idstringrequired

Trip ID (TRP_xxx format or numeric ID)

min 1 charspattern ^(TRP_\d+|\d+)$

Body parameters

commentstring

Free-text feedback on the delivery

max 1000 chars

ratingintegerrequired

Score out of 5, 1 being the worst

1 to 5

Response 200

dataobjectrequired

The recorded rating

commentstring

Free-text feedback on the delivery

max 1000 chars

datestringrequired

Rating timestamp

date-time

ratingintegerrequired

Score out of 5, 1 being the worst

1 to 5

trip_idstringrequired

Unique trip identifier

messagestringrequired

Human-readable outcome. Defaults to `Ok`.

successbooleanrequired

Always `true` on a success response.

true

Errors

Every failure returns the same envelope. Branch on code — it is the stable contract; message is human-facing and may be reworded or localized. See the error reference for what each code means.

400401403404405409413415429500502