---
title: "GET /bins/received-assignments"
method: GET
path: "/bins/received-assignments"
---

# GET /bins/received-assignments

`GET /bins/received-assignments`

## Request

- Base URL: `https://api.mamaearth.ca` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mamaearth.ca/bins/received-assignments`
- Auth: none declared
- TypeScript: <https://skmtc.dev/mamaearth/apis/mama-earth-api/docs/bins/received-assignments/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `keyset` BinAssignmentKeyset, required: Defines keyset for paginating BinAssignments.
  - `seek` 'BEFORE' | 'AFTER': Whether the page referred to by this keyset comes before or after those values.
  - `size` integer, nullable
  - `dateField` 'RECEIVED_AT': Defines which datetime field the keyset corresponds to.
  - `id` integer, nullable
  - `date` string, date-time, nullable
- `date` string, date, required

## Response `200`

getReceivedBinAssignments 200 response

- KeysetPageBinAssignmentReusableBinAssignmentBinAssignmentKeyset: Represents a page paginated by a keyset.
  - `data` BinAssignmentReusableBinAssignment[], required
    - `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.
  - `previousKeyset` BinAssignmentKeyset, required: Defines keyset for paginating BinAssignments.
    - `seek` 'BEFORE' | 'AFTER': Whether the page referred to by this keyset comes before or after those values.
    - `size` integer, nullable
    - `dateField` 'RECEIVED_AT': Defines which datetime field the keyset corresponds to.
    - `id` integer, nullable
    - `date` string, date-time, nullable
  - `nextKeyset` BinAssignmentKeyset, required: Defines keyset for paginating BinAssignments.
    - `seek` 'BEFORE' | 'AFTER': Whether the page referred to by this keyset comes before or after those values.
    - `size` integer, nullable
    - `dateField` 'RECEIVED_AT': Defines which datetime field the keyset corresponds to.
    - `id` integer, nullable
    - `date` string, date-time, nullable

---

[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.dev/mamaearth/apis/mama-earth-api/revisions/2693a8db8dbd?raw)