> ## 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 insumo do catálogo

> Lê um insumo do catálogo pelo id. Requer catalog:read; custo, moeda, estado e base exigem catalog.cost:read. Verifique costStatus antes de usar o valor com a unidade atual. 404 quando não existe ou pertence a outra clínica odontológica.



## OpenAPI

````yaml /openapi.pt.json get /v1/catalog/items/{itemId}
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/catalog/items/{itemId}:
    get:
      tags:
        - Catálogo
      summary: Obter um insumo do catálogo
      description: >-
        Lê um insumo do catálogo pelo id. Requer catalog:read; custo, moeda,
        estado e base exigem catalog.cost:read. Verifique costStatus antes de
        usar o valor com a unidade atual. 404 quando não existe ou pertence a
        outra clínica odontológica.
      operationId: getCatalogItem
      parameters:
        - name: itemId
          in: path
          required: true
          description: O id opaco do item do catálogo.
          schema:
            type: string
      responses:
        '200':
          description: O recurso solicitado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogItem'
          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:
    CatalogItem:
      type: object
      additionalProperties: false
      required:
        - itemId
        - sku
        - name
        - categoryId
        - unitOfMeasure
        - criticality
        - tracksLot
        - tracksSerial
        - tracksExpiry
        - highValue
        - status
      properties:
        itemId:
          type: string
        sku:
          type: string
        name:
          type: string
        description:
          type: string
        categoryId:
          type: string
        unitOfMeasure:
          type: string
          enum:
            - unit
            - box
            - pack
            - bottle
            - ampoule
            - milliliter
            - liter
            - gram
            - kilogram
            - pair
            - kit
        brand:
          type: string
        photoKeys:
          type: array
          items:
            type: string
        packaging:
          type: string
        criticality:
          type: string
          enum:
            - low
            - medium
            - high
        tracksLot:
          type: boolean
        tracksSerial:
          type: boolean
        tracksExpiry:
          type: boolean
        highValue:
          type: boolean
        status:
          type: string
          enum:
            - draft
            - active
            - inactive
        cost:
          type: integer
          minimum: 0
          maximum: 9007199254740991
          description: >-
            Custo registrado em unidades menores da moeda. Interprete-o com
            costStatus e costMeasurement; exige catalog.cost:read.
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: ISO-4217. Presente apenas com catalog.cost:read.
        costStatus:
          type: string
          enum:
            - unset
            - verified
            - review_required
            - invalid
          description: >-
            Aplicabilidade do custo e qualidade do dado. Omitido, junto com
            todos os metadados de custo, sem catalog.cost:read.
        costMeasurement:
          type: object
          additionalProperties: false
          required:
            - unitOfMeasure
            - measurementVersion
            - quantityProtocol
          properties:
            unitOfMeasure:
              type: string
              enum:
                - unit
                - box
                - pack
                - bottle
                - ampoule
                - milliliter
                - liter
                - gram
                - kilogram
                - pair
                - kit
            measurementVersion:
              type: integer
              minimum: 1
              maximum: 9007199254740991
            quantityProtocol:
              type: string
              const: base_number_v1
      oneOf:
        - not:
            anyOf:
              - required:
                  - costStatus
              - required:
                  - cost
              - required:
                  - currency
              - required:
                  - costMeasurement
        - required:
            - costStatus
          properties:
            costStatus:
              const: unset
          not:
            anyOf:
              - required:
                  - cost
              - required:
                  - currency
              - required:
                  - costMeasurement
        - required:
            - costStatus
            - cost
            - currency
            - costMeasurement
          properties:
            costStatus:
              const: verified
        - required:
            - costStatus
            - cost
            - currency
          properties:
            costStatus:
              const: review_required
        - required:
            - costStatus
          properties:
            costStatus:
              const: invalid
          not:
            required:
              - costMeasurement
          oneOf:
            - required:
                - cost
                - currency
            - not:
                anyOf:
                  - required:
                      - cost
                  - required:
                      - currency
    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
  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.