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

# Obter um pedido

> Lê um pedido com suas linhas. Requer orders:read. O valor do pedido e a referência de paciente são omitidos; o custo das linhas exige catalog.cost:read. 404 quando não existe ou pertence a outra clínica odontológica.



## OpenAPI

````yaml /openapi.pt.json get /v1/orders/{orderId}
openapi: 3.1.0
info:
  description: >-
    A API pública para desenvolvedores da Muveya: recursos /v1 somente leitura,
    limitados a um tenant e autenticados com uma chave de API opaca. Um
    orçamento de solicitações por chave.
  title: API para desenvolvedores da Muveya
  version: 0.1.0
servers:
  - description: Produção
    url: https://api.muveya.com
security: []
tags:
  - name: Chave de API
  - name: Clínicas
  - name: Depósitos
  - name: Catálogo
  - name: Inventário
  - name: Pedidos
  - name: Entregas
  - name: Análises
paths:
  /v1/orders/{orderId}:
    get:
      tags:
        - Pedidos
      summary: Obter um pedido
      description: >-
        Lê um pedido com suas linhas. Requer orders:read. O valor do pedido e a
        referência de paciente são omitidos; o custo das linhas exige
        catalog.cost:read. 404 quando não existe ou pertence a outra clínica
        odontológica.
      operationId: getOrder
      parameters:
        - name: orderId
          in: path
          required: true
          description: O id opaco do pedido.
          schema:
            type: string
      responses:
        '200':
          description: O recurso solicitado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
          headers:
            X-RateLimit-Limit:
              description: O orçamento de solicitações por chave na janela atual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitações restantes na janela atual (0 quando esgotadas).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos até a janela atual ser reiniciada.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado do orçamento de solicitações segundo o rascunho da IETF,
                por exemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política segundo o rascunho da IETF, por exemplo "120;w=60"
                (limite;segundos da janela).
              schema:
                type: string
        '401':
          description: >-
            A chave de API está ausente, é inválida, foi revogada, expirou ou
            está vinculada a uma clínica odontológica suspensa.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: A chave de API não tem o escopo que esta rota exige.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: O recurso não existe nesta clínica odontológica.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: A chave de API excedeu seu limite de solicitações na janela atual.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            Retry-After:
              description: >-
                Segundos (valor positivo) até que outra solicitação seja
                permitida.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: O orçamento de solicitações por chave na janela atual.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Solicitações restantes na janela atual (0 quando esgotadas).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Segundos até a janela atual ser reiniciada.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                Estado do orçamento de solicitações segundo o rascunho da IETF,
                por exemplo "limit=120, remaining=119, reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: >-
                Política segundo o rascunho da IETF, por exemplo "120;w=60"
                (limite;segundos da janela).
              schema:
                type: string
      security:
        - apiKeyBearer: []
components:
  schemas:
    Order:
      type: object
      additionalProperties: false
      required:
        - orderId
        - number
        - type
        - status
        - requesterId
        - clinicId
        - destinationWarehouseId
        - lines
        - version
      properties:
        orderId:
          type: string
        number:
          type: integer
        type:
          type: string
          enum:
            - general
            - clinical
        status:
          type: string
          enum:
            - draft
            - submitted
            - pending_approval
            - approved
            - rejected
            - cancelled
            - allocated
            - picking
            - dispatched
            - delivered
            - exception
            - received
            - partially_fulfilled
            - closed
        requesterId:
          type: string
        clinicId:
          type: string
        destinationWarehouseId:
          type: string
        preferredSourceWarehouseId:
          type: string
        justification:
          type: string
        patientRef:
          type: string
          description: >-
            Omitido (ausente) a menos que a chave tenha orders.patient_ref:read
            (nunca na /v1).
        lines:
          type: array
          items:
            $ref: '#/components/schemas/OrderLine'
        value:
          type: integer
          description: >-
            Total do pedido em unidades menores da moeda. Presente apenas com
            orders.value:read (nunca na /v1).
        currency:
          type: string
        approvalPlan:
          $ref: '#/components/schemas/OrderApprovalPlan'
        version:
          type: integer
    ProblemDetails:
      type: object
      additionalProperties: false
      required:
        - type
        - title
        - status
        - detail
        - instance
        - code
        - requestId
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          minimum: 400
          maximum: 599
        detail:
          type: string
        instance:
          type: string
        code:
          type: string
        requestId:
          type: string
    OrderLine:
      type: object
      additionalProperties: false
      required:
        - lineId
        - catalogItemId
        - sku
        - name
        - requestedQty
        - unitOfMeasure
        - category
        - highValue
      properties:
        lineId:
          type: string
        catalogItemId:
          type: string
        sku:
          type: string
        name:
          type: string
        requestedQty:
          type: integer
        unitOfMeasure:
          type: string
        category:
          type: string
        highValue:
          type: boolean
        unitCost:
          type: integer
          description: Presente apenas com o escopo catalog.cost:read.
        currency:
          type: string
    OrderApprovalPlan:
      type: object
      additionalProperties: false
      required:
        - policyVersion
        - requiresApproval
        - steps
      properties:
        policyVersion:
          type: integer
        requiresApproval:
          type: boolean
        steps:
          type: array
          items:
            type: object
            additionalProperties: false
            required:
              - stage
              - requiredScope
              - minApprovers
            properties:
              stage:
                type: string
              requiredScope:
                type: string
              minApprovers:
                type: integer
        evaluatedValue:
          type: integer
          description: Presente apenas com o escopo orders.value:read.
        currency:
          type: string
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        Chave de API opaca mvy_test_ enviada como token Bearer. O servidor
        deriva dela exatamente uma clínica odontológica; o caminho nunca leva um
        seletor de clínica odontológica.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.