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

# Inventory Collections

> Use PlayFab Economy v2 Inventory Collections to partition player inventory into named groups for characters, loadouts, or storage containers.

# Collections

<Info>
  Economy v2 is now Generally Available. For support and feedback, go to the [PlayFab Forum](https://community.playfab.com).
</Info>

The Economy v2 Inventory service introduces the concept of collections that can add greater flexibility and support for your inventory needs. Collections are the mechanism that allows for a single player/PlayerId to have multiple inventories. This feature can be used to manage multiple inventories for different characters for the same player, having separate inventories for different platforms, and more!

Inventory API calls can take in a `CollectionId` parameter that specifies the collection/inventory to perform the action in. Creating a new collection is done by adding an item/stack to an unused CollectionId.

## Managing Inventory Collections

### GetInventoryCollectionIds

Using the `GetInventoryCollectionIds` API, you can get a list of `CollectionId`s for a given player. Players are limited to only accessing their own list of IDs. Title Entities can pass in an `Entity` parameter to indicate which player's inventory they wish to access.

An example `GetInventoryCollectionIds` request:

```json theme={null}
{
  "Entity": {
    "Type": "title_player_account",
    "Id": "ABCD12345678"
  },
  "Count": 15,
  "ContinuationToken": "abc="
}
```

This request would return the following response:

```json theme={null}
{
  "data": {
  "CollectionIds": [
    "default",
    "main_character"
    ]
  }
}
```

#### Continuation Tokens

The `ContinuationToken` field that is returned from a search response can be passed into an inventory request to paginate through multiple counts of results.

### Adding a New Inventory Collection

Creating a new collection for a player is done by performing any write request with a new CollectionId.

For example, the following `AddInventoryItems` request uses the collectionId `main_character`

```json theme={null}
{
    "Entity": {
        "Type": "title_player_account",
        "Id": "ABCD12345678"
    },
    "CollectionId": "main_character",
    "Item": {
        "Id": "0b440353-bdbc-48d8-8873-f0988c1f9d8b",
    },
    "Amount": 10,
}
```

The above request would either create a brand new inventory collection and add 10 of the item to it or add 10 to the existing `main_character` inventory collection if it already existed.

### DeleteInventoryCollection

In the `DeleteInventoryCollectionId` API, you can define the `CollectionId`
you wish to delete. Deleting is an asynchronous operation and may take longer for collections that are large. The collection won't be able to be remade until the delete operation is complete.

An example `DeleteInventoryCollectionIds` request:

```json theme={null}
{
  "Entity": {
    "Type": "title_player_account",
    "Id": "ABCD12345678"
  },
  "CollectionId": "main_character"
}
```

<Note>
  Currently, APIs are the only way to delete Inventory Collections. Game Manager can currently only be used to view and add items to new and existing collections. Additional functionality will be added in the future.
</Note>

### ExecuteInventoryOperations API

You can set a `CollectionId` parameter in the `ExecuteInventoryOperations` API. This parameter allows you to define the collection where you want the operations to be performed in.

An example `ExecuteInventoryOperations` request with stacks:

```json theme={null}
{
    "Entity": {
        "Type": "title_player_account",
        "Id": "ABCD12345678"
    },
    "CollectionId": "main_character",
    "Operations": [
        {
            "Update": {
                "Item" {
                    "Id": "0b440353-bdbc-48d8-8873-f0988c1f9d8b",
                    "Amount": 10
                }
            }
        },
        {
            "Subtract": {
                "Item" {
                    "Id": "0b440353-bdbc-48d8-8873-f0988c1f9d8b",
                },
                "Amount": 5
            }
        }
    ]
}
```


## Related topics

- [PFInventoryDeleteInventoryCollectionAsync](/services/playfab/api-references/c/pfinventory/functions/pfinventorydeleteinventorycollectionasync.md)
- [PFInventoryDeleteInventoryCollectionRequest](/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorydeleteinventorycollectionrequest.md)
- [PFInventoryGetInventoryCollectionIdsRequest](/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygetinventorycollectionidsrequest.md)
- [PFInventoryGetInventoryCollectionIdsAsync](/services/playfab/api-references/c/pfinventory/functions/pfinventorygetinventorycollectionidsasync.md)
- [PFInventoryGetInventoryCollectionIdsResponse](/services/playfab/api-references/c/pfinventorytypes/structs/pfinventorygetinventorycollectionidsresponse.md)