> ## 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 o histórico de custódia de um pedido

> Lê o histórico de custódia de um pedido, sem dados sensíveis: o status, as movimentações do registro e os registros de entrega, recebimento e encerramento. Requer fulfillment:read. 404 quando não existe ou pertence a outra clínica odontológica.



## OpenAPI

````yaml /openapi.pt.json get /v1/fulfillments/{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/fulfillments/{orderId}:
    get:
      tags:
        - Entregas
      summary: Obter o histórico de custódia de um pedido
      description: >-
        Lê o histórico de custódia de um pedido, sem dados sensíveis: o status,
        as movimentações do registro e os registros de entrega, recebimento e
        encerramento. Requer fulfillment:read. 404 quando não existe ou pertence
        a outra clínica odontológica.
      operationId: getCustodyHistory
      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/CustodyHistory'
          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:
    CustodyHistory:
      type: object
      additionalProperties: false
      required:
        - orderId
        - status
        - movements
      properties:
        orderId:
          type: string
        status:
          type: string
          enum:
            - allocating
            - allocated
            - picking
            - dispatched
            - delivered
            - exception
            - received
            - partially_fulfilled
            - closed
        movements:
          type: array
          items:
            $ref: '#/components/schemas/StockMovement'
        delivery:
          type: object
          additionalProperties: false
          required:
            - actorUserId
            - deliveredAt
            - boxIds
          properties:
            actorUserId:
              type: string
            deliveredAt:
              type: string
              format: date-time
            boxIds:
              type: array
              items:
                type: string
            exception:
              type: object
              additionalProperties: false
              required:
                - reason
              properties:
                reason:
                  type: string
                note:
                  type: string
        receipt:
          type: object
          additionalProperties: false
          required:
            - actorUserId
            - receivedAt
            - acceptedBoxIds
            - disputed
          properties:
            actorUserId:
              type: string
            receivedAt:
              type: string
              format: date-time
            acceptedBoxIds:
              type: array
              items:
                type: string
            disputed:
              type: array
              items:
                type: object
                additionalProperties: false
                required:
                  - boxId
                  - reason
                  - quarantine
                properties:
                  boxId:
                    type: string
                  reason:
                    type: string
                  quarantine:
                    type: boolean
                  note:
                    type: string
        closure:
          type: object
          additionalProperties: false
          required:
            - actorUserId
            - closedAt
          properties:
            actorUserId:
              type: string
            closedAt:
              type: string
              format: date-time
    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
    StockMovement:
      type: object
      additionalProperties: false
      required:
        - movementId
        - type
        - boxId
        - catalogItemId
        - quantityDelta
        - actorId
        - occurredAt
        - recordedAt
      properties:
        movementId:
          type: string
        type:
          type: string
          enum:
            - receive
            - reserve
            - release
            - pick
            - dispatch
            - transfer_in
            - transfer_out
            - split_out
            - split_in
            - consume
            - return
            - adjust_gain
            - adjust_loss
            - expire
            - quarantine
            - dispose
        boxId:
          type: string
        catalogItemId:
          type: string
        quantityDelta:
          type: integer
        actorId:
          type: string
        occurredAt:
          type: string
          format: date-time
        recordedAt:
          type: string
          format: date-time
        reservedDelta:
          type: integer
        secondActorId:
          type: string
        fromWarehouseId:
          type: string
        toWarehouseId:
          type: string
        reasonCode:
          type: string
        idempotencyKey:
          type: string
        correlationId:
          type: string
        splitId:
          type: string
          description: >-
            Compartilhado pelas movimentações de uma mesma separação em um
            contêiner derivado.
  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.