> ## 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.

# List a stock box ledger

> Lists the append-only ledger of one box, oldest first. Requires inventory:read. Returns one terminal page of the box's movements; 404 when the box is absent or in another workspace.



## OpenAPI

````yaml /openapi.en.json get /v1/inventory/boxes/{boxId}/movements
openapi: 3.1.0
info:
  description: >-
    The Muveya public developer API: opaque-API-key-authenticated,
    tenant-scoped, read-only /v1 resources. One rate-limit budget per key.
  title: Muveya Developer API
  version: 0.1.0
servers:
  - description: Production
    url: https://api.muveya.com
security: []
tags:
  - name: API key
  - name: Clinics
  - name: Warehouses
  - name: Catalog
  - name: Inventory
  - name: Orders
  - name: Fulfillments
  - name: Analytics
paths:
  /v1/inventory/boxes/{boxId}/movements:
    get:
      tags:
        - Inventory
      summary: List a stock box ledger
      description: >-
        Lists the append-only ledger of one box, oldest first. Requires
        inventory:read. Returns one terminal page of the box's movements; 404
        when the box is absent or in another workspace.
      operationId: listStockBoxMovements
      parameters:
        - name: boxId
          in: path
          required: true
          description: The opaque stock box id.
          schema:
            type: string
      responses:
        '200':
          description: The requested page of resources.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - data
                  - hasMore
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/StockMovement'
                  hasMore:
                    type: boolean
                  nextCursor:
                    type: string
                    description: >-
                      Opaque keyset cursor for the next page; present only when
                      hasMore is true.
          headers:
            X-RateLimit-Limit:
              description: The per-key request budget for the current window.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Requests left in the current window (0 when exhausted).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                IETF draft budget snapshot, e.g. "limit=120, remaining=119,
                reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: IETF draft policy, e.g. "120;w=60" (limit;window-seconds).
              schema:
                type: string
        '401':
          description: >-
            The API key is missing, invalid, revoked, expired, or bound to a
            suspended workspace.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: The API key lacks the scope this route requires.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: The parent resource does not exist in this workspace.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: The API key exceeded its rate limit for the current window.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
          headers:
            Retry-After:
              description: Positive delta-seconds until another request is allowed.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Limit:
              description: The per-key request budget for the current window.
              schema:
                type: integer
                minimum: 1
            X-RateLimit-Remaining:
              description: Requests left in the current window (0 when exhausted).
              schema:
                type: integer
                minimum: 0
            X-RateLimit-Reset:
              description: Seconds until the current window resets.
              schema:
                type: integer
                minimum: 1
            RateLimit:
              description: >-
                IETF draft budget snapshot, e.g. "limit=120, remaining=119,
                reset=60".
              schema:
                type: string
            RateLimit-Policy:
              description: IETF draft policy, e.g. "120;w=60" (limit;window-seconds).
              schema:
                type: string
      security:
        - apiKeyBearer: []
components:
  schemas:
    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: Shared by the movements of one separation into a derived container.
    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: >-
        Opaque mvy_test_ API key sent as a Bearer token. It derives exactly one
        workspace server-side; the path never carries a workspace selector.

````

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