---
title: "GET /bins/{barcode}"
method: GET
path: "/bins/{barcode}"
---

# GET /bins/{barcode}

`GET /bins/{barcode}`

## Path parameters

- `barcode` BinBarcode, required — Represents a UPC-A barcode of 11 digits. The checksum is not stored, it should be generated when needed, and otherwise not sent by clients during API calls.
  - `orderBarcode` boolean — We reserve the prefix 90 for order barcodes, so that we are able to distinguish an order from bin barcodes without doing an API or DB lookup.
  - `singleUseBinBarcode` boolean — Checks if this barcode is a single-use bin barcode.
  - `packagingBarcode` boolean

## Response `200`

getBin 200 response

- Bin
  - `id` BinBarcode, required — Represents a UPC-A barcode of 11 digits. The checksum is not stored, it should be generated when needed, and otherwise not sent by clients during API calls.
    - `orderBarcode` boolean — We reserve the prefix 90 for order barcodes, so that we are able to distinguish an order from bin barcodes without doing an API or DB lookup.
    - `singleUseBinBarcode` boolean — Checks if this barcode is a single-use bin barcode.
    - `packagingBarcode` boolean
  - `status` 'IN_STOCK' | 'DISPATCHED' | 'RETIRED', required
  - `created` string, date-time, required
  - `assignment` BinAssignmentReusableBinAssignment, required — An assignment to a reusable bin, modeled by Bin
    - `id` integer, required
    - `binId` BinBarcode, required — Represents a UPC-A barcode of 11 digits. The checksum is not stored, it should be generated when needed, and otherwise not sent by clients during API calls.
      - `orderBarcode` boolean — We reserve the prefix 90 for order barcodes, so that we are able to distinguish an order from bin barcodes without doing an API or DB lookup.
      - `singleUseBinBarcode` boolean — Checks if this barcode is a single-use bin barcode.
      - `packagingBarcode` boolean
    - `orderId` integer, required
    - `user` UserBasic, required
      - `active` boolean
    - `dispatch` BinScan, required — Describes a bin being scanned, either to dispatch or to receive it.
      - `admin` UserBasic, required
        - `active` boolean
      - `timestamp` string, date-time, required — The date time at which the scan occurred.
    - `dueAt` string, date-time, required
    - `chargeAt` string, date-time, required
    - `chargeAttempts` BinChargeAttempts, required
      - `count` integer, required
      - `lastAttemptedAt` string, date-time, required
      - `lastErrorMessage` string, required
    - `receipt` BinScan, required — Describes a bin being scanned, either to dispatch or to receive it.
      - `admin` UserBasic, required
        - `active` boolean
      - `timestamp` string, date-time, required — The date time at which the scan occurred.
    - `charge` BinCharge, required — Describes charging a customer for a bin, for example because it was lost or broken.
      - `id` integer, required — The id of the charge
      - `admin` UserBasic, required
        - `active` boolean
      - `timestamp` string, date-time, required — The date time at which the charge occurred.
      - `amount` number, required — The amount charged.
      - `paymentMethod` 'CREDIT_CARD' | 'ACCOUNT_CREDITS', required — Describes how a payment was made.
    - `refund` BinCharge, required — Describes charging a customer for a bin, for example because it was lost or broken.
      - `id` integer, required — The id of the charge
      - `admin` UserBasic, required
        - `active` boolean
      - `timestamp` string, date-time, required — The date time at which the charge occurred.
      - `amount` number, required — The amount charged.
      - `paymentMethod` 'CREDIT_CARD' | 'ACCOUNT_CREDITS', required — Describes how a payment was made.
  - `pickup` ScheduledBinPickup, required
    - `stopRequestId` integer, required
    - `scheduleByDate` string, date, required
  - `retirement` BinRetirement, required — Describes a bin being retired.
    - `admin` UserBasic, required
      - `active` boolean
    - `timestamp` string, date-time, required — The date time at which the charge occurred.
    - `reason` 'NOT_READY' | 'BASE_DAMAGE' | 'LID_DAMAGE' | 'ENVIRONMENTAL_DAMAGE' | 'BARCODE_DAMAGE' | 'OTHER_DAMAGE' | 'MISSING_CUSTOMER' | 'MISSING_CUSTOMER_GOODWILL' | 'MISSING_LOGISTICS' | 'WORN_OUT', required

---

[API](https://skmtc.dev/mamaearth/apis/mama-earth-api.md) · [All operations](https://skmtc.dev/mamaearth/apis/mama-earth-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mamaearth/mama-earth-api/revisions/42b90383d711/schema)