Skip to main content
GET
/
api
/
v1
/
ops
/
promotions
/
{promotionalId}
/
multi-ticket-rule
Get Promotion Multi Ticket Rule
curl --request GET \
  --url https://api.example.com/api/v1/ops/promotions/{promotionalId}/multi-ticket-rule \
  --header 'Authorization: Bearer <token>'
{
  "promotionalMultiTicketRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "promotionalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "minTicketQuantity": 123,
  "maxTicketQuantity": 123,
  "sameOrder": true,
  "sameTrip": true,
  "samePassenger": true,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
promotionalId
string<uuid>
required

Promotion identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

Regra fixa de promoção por quantidade de passagens

​
promotionalMultiTicketRuleId
string<uuid>
required

Identificador único

​
promotionalId
string<uuid>
required

Promoção dona da regra

​
organizationId
string<uuid>
required

Organização da Company responsável pela promoção

​
companyId
string<uuid>
required

Company dona da promoção

​
minTicketQuantity
integer
required

Quantidade mínima de passagens exigida

​
maxTicketQuantity
integer | null
required

Quantidade máxima de passagens elegíveis, quando aplicável

​
sameOrder
boolean
required

Indica se as passagens devem estar no mesmo Order

​
sameTrip
boolean
required

Indica se as passagens devem pertencer à mesma Trip

​
samePassenger
boolean
required

Indica se as passagens devem ser do mesmo passageiro

​
applyTo
enum<string>
required

Onde o desconto é aplicado

Available options:
ALL_TICKETS,
EXTRA_TICKETS,
CHEAPEST_TICKET
​
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

​
deletedBy
string<uuid> | null
required

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

​
deletedAt
string<date-time> | null
required

Data de remoção lógica