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

# Retrieve a bin



## OpenAPI

````yaml /openapi.yaml get /bins/{id}
openapi: 3.1.0
info:
  title: Arcus ERP Public API
  version: 1.0.0
  description: >
    Arcus ERP public REST API. Designed for external integrations and data
    migration.


    **Authentication.** Bearer token (API key) via the `Authorization` header.

    Format: `Authorization: Bearer ark_live_ent_<code>_<random>` (or
    `ark_test_*` for sandbox).

    API keys are issued per-entity in **Settings > Developers > API Keys**.


    **Entity scoping.** The entity is encoded in the API key prefix; routes are
    flat

    (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform
    endpoints

    (migration, reconciliation, events, webhook endpoints, API keys) use the

    `/v1/entities/{entity_id}/...` form -- those are noted in their tags.


    **Key capabilities.**
      - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource).
      - Cursor-based pagination (`starting_after` / `ending_before` / `limit`).
      - Idempotency via the `Idempotency-Key` header.
      - Webhook events for asynchronous notification.
      - Conditional requests / ETag for cache validation.
servers:
  - url: https://api.arcuserp.com/v1
    description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys)
  - url: https://dev-api.arcuserp.com/v1
    description: >-
      Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev
      RDS)
security: []
paths:
  /bins/{id}:
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    get:
      tags:
        - Bins
      summary: Retrieve a bin
      operationId: getBinV1
      responses:
        '200':
          description: Bin
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Bin'
        '404':
          $ref: '#/components/responses/Error'
      security:
        - ApiKeyAuth:
            - bins:read
components:
  schemas:
    Bin:
      type: object
      description: >
        A warehouse bin location (zone/aisle/shelf/rack/position addressable).
        Bins belong to a `location_id` (Layer 4 scope). Deactivate is the
        soft-delete path; restore is the reverse. The sub-resource
        `/bins/{id}/products` tracks product-bin assignments (binned_products),
        where each row carries quantity and an `is_default_bin` flag. Scope:
        bins:read / bins:write / bins:delete.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        object:
          type: string
          example: bin
        entity_id:
          type: string
          format: uuid
          readOnly: true
        location_id:
          type: string
          format: uuid
          description: Layer 4 warehouse scope. Required.
        bin_code:
          type: string
          description: Operator-defined code unique per location. 1..50 chars.
        zone:
          type: string
          nullable: true
        aisle:
          type: string
          nullable: true
        shelf:
          type: string
          nullable: true
        rack:
          type: string
          nullable: true
        position:
          type: string
          nullable: true
        bin_type:
          type: string
          nullable: true
          description: >-
            Bin role hint (storage, pick, receiving, staging, etc.). Default
            `storage`.
          example: storage
        is_active:
          type: boolean
          default: true
          description: False = deactivated. Restore flips back to true.
        is_default:
          type: boolean
          default: false
          description: Marks the default bin for the location. At most one per location.
        sort_order:
          type: integer
          default: 0
        max_weight:
          type: number
          format: float
          nullable: true
          description: Optional capacity hint (lb).
        max_volume:
          type: number
          format: float
          nullable: true
          description: Optional capacity hint (cubic in).
        created_at:
          type: string
          format: date-time
          readOnly: true
    ErrorEnvelope:
      type: object
      description: |
        Canonical error response envelope. All API errors use this shape.
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: Machine-readable error key
          example: not_found
        code:
          type: string
          description: Machine-readable error code (often same as error)
          example: not_found
        type:
          type: string
          enum:
            - validation_error
            - permission_error
            - not_found
            - conflict
            - rate_limit
            - internal
            - expand_error
            - not_implemented
          example: not_found
        hint:
          type: string
          description: Human-readable one-sentence explanation (English)
          example: >-
            The requested order does not exist or does not belong to this
            entity.
        param:
          type: string
          description: The parameter that caused the error, if applicable
          example: expand[0]
        required:
          type: string
          description: The scope required (only on insufficient_scope errors)
          example: accounts:read
        request_id:
          type: string
          description: >-
            Unique request ID for support tracing (maps to CloudWatch log
            stream)
          example: req_abc123
  responses:
    Error:
      description: Error response (400/401/403/404/409/422/429/500)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: |
        API key issued per entity via Settings > Developers > API Keys.
        Each key carries scopes (e.g. orders:read, products:write).
        Bearer token format: Authorization: Bearer ark_live_ent_<code>_<random>
        Test keys use ark_test_ent_<code>_<random>. Both are issued per entity
        via Settings > Developers > API Keys.

````