Skip to main content
POST
/
api
/
v1
/
ops
/
orders
Create Order
curl --request POST \
  --url https://api.example.com/api/v1/ops/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tickets": [
    {
      "tripItineraryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "seatId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "passenger": {
        "name": "Maria Silva",
        "document": "36641876870",
        "documentType": "CPF",
        "birthDate": "1990-01-01"
      }
    }
  ],
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "checkoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "soldById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "externalProvider": "<string>",
  "externalProviderId": "<string>",
  "code": "<string>",
  "amount": 123,
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

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.

Body

application/json

Create order

​
tickets
object[]
required

Tickets

Minimum array length: 1
​
customerId
string<uuid>

Existing customer identifier

​
customer
object

Customer data to create when customerId is not provided

Response

Created

Pedido de uma empresa dentro de um checkout

​
orderId
string<uuid>
required

Identificador único

​
checkoutId
string<uuid>
required

Referência ao checkout da compra

​
customerId
string<uuid>
required

Referência ao cliente comprador

​
organizationId
string<uuid>
required

Referência à organização da empresa

​
companyId
string<uuid>
required

Referência à empresa responsável pelos tickets do pedido

​
soldById
string<uuid>
required

Referência ao usuário responsável pela criação do pedido

​
externalProvider
string
required

Nome do provedor externo

​
externalProviderId
string
required

ID do pedido no provedor externo

​
type
enum<string>
required

Origem da compra

Available options:
ONLINE,
POS
​
code
string
required

Código legível único do pedido

​
amount
integer
required

Valor total do pedido em centavos

​
status
enum<string>
required

Status do pedido (default PENDING)

Available options:
PENDING,
PAID,
PAYMENT_FAILED,
CANCELED
​
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