> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devmob.app.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Order

> Returns an order.



## OpenAPI

````yaml /api-reference/bko/openapi.json get /api/v1/bko/orders/{orderId}
openapi: 3.0.0
info:
  title: DEVMOB BKO API
  version: '1.0'
servers: []
security: []
tags:
  - name: Auth
    description: Authentication endpoints.
  - name: Benefit Category
    description: Global fare benefit category endpoints.
  - name: Benefit Program
    description: Platform fare benefit program endpoints.
  - name: Invite
    description: Invitation endpoints.
  - name: Member
    description: BKO internal member endpoints.
  - name: Order
    description: Order query endpoints.
  - name: Organization
    description: Organization management endpoints.
  - name: Organization Address
    description: Organization address endpoints.
  - name: Payment
    description: Payment query endpoints.
  - name: Permission
    description: Permission catalog endpoints.
  - name: Place
    description: Place lookup endpoints.
  - name: Point
    description: Global point catalog endpoints.
  - name: Profile
    description: Authenticated BKO profile endpoints.
  - name: Receivable
    description: Receivable query endpoints.
  - name: Report
    description: Platform report endpoints.
  - name: Role
    description: Internal and reusable role endpoints.
  - name: Storage
    description: Storage upload signing endpoints.
  - name: Transfer
    description: Transfer query endpoints.
  - name: User
    description: Platform user administration endpoints.
paths:
  /api/v1/bko/orders/{orderId}:
    get:
      tags:
        - Order
      summary: Get Order
      description: Returns an order.
      operationId: getOrder
      parameters:
        - name: orderId
          required: true
          in: path
          schema:
            type: string
            format: uuid
            description: Order identifier
            example: 0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a
        - name: fields
          required: false
          in: query
          description: >-
            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.
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          description: OK
        '400':
          content:
            application/json:
              example:
                errors:
                  - message: required
                    path: name
                message: Bad Request Error
                statusCode: 400
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 400
                    type: number
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                        path:
                          type: string
                      required:
                        - message
                        - path
                      type: object
                    type: array
                required:
                  - message
                  - statusCode
                type: object
          description: Bad Request Error
        '401':
          content:
            application/json:
              example:
                message: Missing or invalid access token
                statusCode: 401
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 401
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                message: Insufficient permissions
                statusCode: 403
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 403
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Forbidden
        '500':
          content:
            application/json:
              example:
                message: Internal Server Error
                statusCode: 500
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 500
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Internal Server Error
      security:
        - bearer: []
        - bearer: []
components:
  schemas:
    Order:
      type: object
      properties:
        orderId:
          type: string
          format: uuid
          description: Identificador único
        checkoutId:
          type: string
          format: uuid
          description: Referência ao checkout da compra
        customerId:
          type: string
          format: uuid
          description: Referência ao cliente comprador
        organizationId:
          type: string
          format: uuid
          description: Referência à organização da empresa
        companyId:
          type: string
          format: uuid
          description: Referência à empresa responsável pelos tickets do pedido
        soldById:
          type: string
          format: uuid
          description: Referência ao usuário responsável pela criação do pedido
        externalProvider:
          type: string
          description: Nome do provedor externo
        externalProviderId:
          type: string
          description: ID do pedido no provedor externo
        type:
          type: string
          enum:
            - ONLINE
            - POS
          description: Origem da compra
        code:
          type: string
          description: Código legível único do pedido
        amount:
          type: integer
          description: Valor total do pedido em centavos
        status:
          type: string
          enum:
            - PENDING
            - PAID
            - PAYMENT_FAILED
            - CANCELED
          description: Status do pedido (default PENDING)
        createdBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que criou o registro, quando aplicável
        createdAt:
          type: string
          format: date-time
          description: Data de criação
        updatedBy:
          type: string
          format: uuid
          nullable: true
          description: Usuário que fez a última atualização, quando aplicável
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização
      required:
        - orderId
        - checkoutId
        - customerId
        - organizationId
        - companyId
        - soldById
        - externalProvider
        - externalProviderId
        - type
        - code
        - amount
        - status
        - createdBy
        - createdAt
        - updatedBy
        - updatedAt
      description: Pedido de uma empresa dentro de um checkout
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````