Skip to main content
POST
/
api
/
v1
/
customer
/
trips
/
{tripId}
/
reviews
Create Trip Review
curl --request POST \
  --url https://api.example.com/api/v1/customer/trips/{tripId}/reviews \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderId": "0197a813-0fb9-7d42-9c81-50c0f6d9ae5a",
  "driverRating": 5,
  "companyRating": 4,
  "driverComment": "Motorista pontual e cuidadoso.",
  "companyComment": "Viagem confortavel."
}
'
{
  "tripReviewId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tripId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "driverId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "driverRating": 123,
  "driverComment": "<string>",
  "companyRating": 123,
  "companyComment": "<string>",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
tripId
string<uuid>
required

Trip identifier.

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation.

Body

application/json

Trip review payload.

​
orderId
string<uuid>
required

Order that made the trip review eligible.

Example:

"0197a813-0fb9-7d42-9c81-50c0f6d9ae5a"

​
driverRating
integer
required

Driver rating from 1 to 5.

Required range: 1 <= x <= 5
Example:

5

​
companyRating
integer
required

Company rating from 1 to 5.

Required range: 1 <= x <= 5
Example:

4

​
driverComment
string | null

Driver comment.

Example:

"Motorista pontual e cuidadoso."

​
companyComment
string | null

Company comment.

Example:

"Viagem confortavel."

Response

Created

Avaliação de uma viagem comprada dentro de um pedido

​
tripReviewId
string<uuid>
required

Identificador único

​
tripId
string<uuid>
required

Viagem avaliada

​
orderId
string<uuid>
required

Pedido que originou a viagem avaliada

​
customerId
string<uuid>
required

Cliente que avaliou

​
driverId
string<uuid>
required

Motorista avaliado

​
companyId
string<uuid>
required

Empresa avaliada

​
driverRating
integer
required

Nota do motorista (1 a 5)

​
driverComment
string | null
required

Comentário sobre o motorista

​
companyRating
integer
required

Nota da empresa (1 a 5)

​
companyComment
string | null
required

Comentário sobre a empresa

​
createdBy
string<uuid> | null
required

Usuário que criou o registro, quando aplicável

​
createdAt
string<date-time>
required

Data de criação

​
updatedBy
string<uuid> | null
required

Usuário que fez a última atualização, quando aplicável

​
updatedAt
string<date-time>
required

Data da última atualização