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

# inventoryContainerAddItem

> Add a labeled unit or a product quantity to an unplaced container before receiving. This does not change stock. Replaying a request returns the current container without adding again. Reusing a request with different inputs returns IDEMPOTENCY_KEY_REUSED. Placed containers, already received or recorded items, and merchant mismatches return CONTAINER_ALREADY_PLACED, CONTAINER_ITEM_ALREADY_RECEIVED, CONTAINER_ITEM_ALREADY_RECORDED, or CONTAINER_MERCHANT_MISMATCH.

**Required scopes:** [`inventory_write`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_write)

**Store must have one of:** `WMS`

## Arguments

**containerId** `ID!` *required*

The container receiving the item.

**inventoryItemId** `ID`

The ID of one individually labeled unit.

**locationId** `ID!` *required*

The warehouse the caller expects the container to be in.

**productId** `ID`

The ID of the product being counted.

**quantity** `Int!` *required*

How many units to add, from 1 to 9999. An individually labeled unit requires a quantity of 1.

**requestId** `String!` *required*

A UUID identifying this addition within the container. Reuse it for retries. It does not expire.

## Returns

**inventoryContainerAddItem** `[InventoryContainer](/docs/api-reference/v3/reference/inventory/inventory-container)`

A permanently identified container operated by the authenticated warehouse. It can hold items before or after being registered to a bin.

**fields**

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the container was created.

**id** `ID!` *required*

The permanent opaque ID encoded on the label.

**items** `[InventoryContainerItemConnection!](/docs/api-reference/v3/pagination)` *required*

Active physical membership entries in this container, including before receiving and after placement.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.

**before** `String`

Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.

**first** `Int`

Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**Fields**

**edges** `[\[InventoryContainerItemEdge!\]!](/docs/api-reference/v3/pagination)` *required*

The list of edges (each a node plus its pagination `cursor`).

**fields**

**cursor** `String!` *required*

Opaque cursor for this item; pass to `after`/`before` to page from here.

**node** `[InventoryContainerItem!](/docs/api-reference/v3/reference/inventory/inventory-container-item)` *required*

The item at this edge.

**nodes** `[\[InventoryContainerItem!\]!](/docs/api-reference/v3/reference/inventory/inventory-container-item)` *required*

The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

**fields**

**id** `ID!` *required*

The opaque ID of this membership entry.

**inventoryItem** `[InventoryItem](/docs/api-reference/v3/reference/inventory/inventory-item)`

The individually tracked unit, when present and owned by the caller.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**product** `[InventoryProduct](/docs/api-reference/v3/reference/inventory/inventory-product)`

The product identified by the entry or by its individually tracked unit, when available.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**quantity** `Int!` *required*

The number of units still in this entry.

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**fields**

**endCursor** `String`

Cursor of the last edge in this page; pass to `after` to page forward.

**hasNextPage** `Boolean!` *required*

Whether more items exist after this page (drives forward pagination with `first`/`after`).

**hasPreviousPage** `Boolean!` *required*

Whether more items exist before this page (drives backward pagination with `last`/`before`).

**startCursor** `String`

Cursor of the first edge in this page; pass to `before` to page backward.

**location** `[Location](/docs/api-reference/v3/reference/inventory/location)`

The current warehouse, resolved through its bin when placed, otherwise through its direct warehouse assignment.

**Requires:** [`locations_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-locations_read)

**fields**

**city** `String`

The city of the location's address.

**company** `String`

The company name associated with the location.

**countryCode** `String`

The country code, e.g. "US".

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the record was created.

**id** `ID!` *required*

The id of this location.

**inventoryItems** `[InventoryItemConnection!](/docs/api-reference/v3/pagination)` *required*

Traceable inventory units at this warehouse.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.

**before** `String`

Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.

**first** `Int`

Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**Fields**

**edges** `[\[InventoryItemEdge!\]!](/docs/api-reference/v3/pagination)` *required*

The list of edges (each a node plus its pagination `cursor`).

**nodes** `[\[InventoryItem!\]!](/docs/api-reference/v3/reference/inventory/inventory-item)` *required*

The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**inventoryLevels** `[LocationInventoryLevelConnection!](/docs/api-reference/v3/pagination)` *required*

Per-product inventory levels held at this location.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.

**before** `String`

Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.

**first** `Int`

Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**Fields**

**edges** `[\[LocationInventoryLevelEdge!\]!](/docs/api-reference/v3/pagination)` *required*

The list of edges (each a node plus its pagination `cursor`).

**nodes** `[\[LocationInventoryLevel!\]!](/docs/api-reference/v3/reference/inventory/location-inventory-level)` *required*

The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**name** `String!` *required*

The location's display name.

**phone** `String`

The contact phone number for the location.

**postalCode** `String`

The postal or ZIP code, e.g. "84101".

**stateCode** `String`

The state or province code, e.g. "UT".

**storageLocations** `[StorageLocationConnection!](/docs/api-reference/v3/pagination)` *required*

Bins and other storage locations within this warehouse.

**Requires:** [`locations_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-locations_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.

**before** `String`

Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.

**first** `Int`

Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**Fields**

**edges** `[\[StorageLocationEdge!\]!](/docs/api-reference/v3/pagination)` *required*

The list of edges (each a node plus its pagination `cursor`).

**nodes** `[\[StorageLocation!\]!](/docs/api-reference/v3/reference/inventory/storage-location)` *required*

The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**street1** `String`

The first line of the street address.

**street2** `String`

The second line of the street address.

**updatedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the record was last updated.

**name** `String`

An optional warehouse-authored name. Names need not be unique.

## Example

```graphql theme={null}
mutation {
  inventoryContainerAddItem(containerId: "...", inventoryItemId: "...", locationId: "...", productId: "...", quantity: 10, requestId: "...") {
    createdAt
    id
    items {
      nodes {
        id
        quantity
      }
      pageInfo { hasNextPage endCursor }
    }
    name
  }
}
```


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