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

# List bins

> Returns active bins for the entity. Filter by `location_id` (Layer 4
warehouse scope). Page-based pagination (`page` + `per_page`); response
also includes a `zones` aggregate (bin count + occupied bins per zone)
for the UI rail. Requires the `bins:read` scope.




## OpenAPI

````yaml /openapi.yaml get /bins
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:
    get:
      tags:
        - Bins
      summary: List bins
      description: |
        Returns active bins for the entity. Filter by `location_id` (Layer 4
        warehouse scope). Page-based pagination (`page` + `per_page`); response
        also includes a `zones` aggregate (bin count + occupied bins per zone)
        for the UI rail. Requires the `bins:read` scope.
      operationId: listBinsV1
      parameters:
        - name: location_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: is_active
          in: query
          required: false
          schema:
            type: boolean
        - name: bin_type
          in: query
          required: false
          schema:
            type: string
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
      responses:
        '200':
          description: Bin list (page envelope)
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Bin'
                  zones:
                    type: array
                    description: Aggregate counts grouped by zone.
                    items:
                      type: object
                      properties:
                        zone:
                          type: string
                          nullable: true
                        bin_count:
                          type: string
                          description: Postgres bigint as string.
                        occupied_bins:
                          type: string
                  total:
                    type: integer
                  page:
                    type: integer
                  per_page:
                    type: integer
                  total_pages:
                    type: integer
      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
  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.

````