ExilProductions/VRChatBackendDocs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
aa707d1deb9b3d436e6dab60d6d4eeb1406c0478
VRChatBackendDocs/Apis/InventoryApi.md
ExilProductions aa707d1deb add subdir
2026-02-15 17:39:26 +01:00

414 lines
13 KiB
Markdown
Raw Blame History

# InventoryApi
All URIs are relative to *https://api.vrchat.cloud/api/1*
| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**consumeOwnInventoryItem**](InventoryApi.md#consumeOwnInventoryItem) | **PUT** /inventory/{inventoryItemId}/consume | Consume Own Inventory Item |
| [**deleteOwnInventoryItem**](InventoryApi.md#deleteOwnInventoryItem) | **DELETE** /inventory/{inventoryItemId} | Delete Own Inventory Item |
| [**equipOwnInventoryItem**](InventoryApi.md#equipOwnInventoryItem) | **PUT** /inventory/{inventoryItemId}/equip | Equip Own Inventory Item |
| [**getInventory**](InventoryApi.md#getInventory) | **GET** /inventory | Get Inventory |
| [**getInventoryCollections**](InventoryApi.md#getInventoryCollections) | **GET** /inventory/collections | List Inventory Collections |
| [**getInventoryDrops**](InventoryApi.md#getInventoryDrops) | **GET** /inventory/drops | List Inventory Drops |
| [**getInventoryTemplate**](InventoryApi.md#getInventoryTemplate) | **GET** /inventory/template/{inventoryTemplateId} | Get Inventory Template |
| [**getOwnInventoryItem**](InventoryApi.md#getOwnInventoryItem) | **GET** /inventory/{inventoryItemId} | Get Own Inventory Item |
| [**getUserInventoryItem**](InventoryApi.md#getUserInventoryItem) | **GET** /user/{userId}/inventory/{inventoryItemId} | Get User Inventory Item |
| [**shareInventoryItemDirect**](InventoryApi.md#shareInventoryItemDirect) | **POST** /inventory/cloning/direct | Share Inventory Item Direct |
| [**shareInventoryItemPedestal**](InventoryApi.md#shareInventoryItemPedestal) | **GET** /inventory/cloning/pedestal | Share Inventory Item by Pedestal |
| [**spawnInventoryItem**](InventoryApi.md#spawnInventoryItem) | **GET** /inventory/spawn | Spawn Inventory Item |
| [**unequipOwnInventorySlot**](InventoryApi.md#unequipOwnInventorySlot) | **DELETE** /inventory/{inventoryItemId}/equip | Unequip Own Inventory Slot |
| [**updateOwnInventoryItem**](InventoryApi.md#updateOwnInventoryItem) | **PUT** /inventory/{inventoryItemId} | Update Own Inventory Item |
<a name="consumeOwnInventoryItem"></a>
# **consumeOwnInventoryItem**
> InventoryConsumptionResults consumeOwnInventoryItem(inventoryItemId)
Consume Own Inventory Item
Returns the modified InventoryItem object as held by the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
### Return type
[**InventoryConsumptionResults**](../Models/InventoryConsumptionResults.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="deleteOwnInventoryItem"></a>
# **deleteOwnInventoryItem**
> SuccessFlag deleteOwnInventoryItem(inventoryItemId)
Delete Own Inventory Item
Deletes an InventoryItem from the inventory of the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
### Return type
[**SuccessFlag**](../Models/SuccessFlag.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="equipOwnInventoryItem"></a>
# **equipOwnInventoryItem**
> InventoryItem equipOwnInventoryItem(inventoryItemId, EquipInventoryItemRequest)
Equip Own Inventory Item
Returns the modified InventoryItem object as held by the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
| **EquipInventoryItemRequest** | [**EquipInventoryItemRequest**](../Models/EquipInventoryItemRequest.md)| | [optional] |
### Return type
[**InventoryItem**](../Models/InventoryItem.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="getInventory"></a>
# **getInventory**
> Inventory getInventory(n, offset, holderId, equipSlot, order, tags, types, flags, notTypes, notFlags, archived)
Get Inventory
Returns an Inventory object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **n** | **Integer**| The number of objects to return. | [optional] [default to 60] |
| **offset** | **Integer**| A zero-based offset from the default object sorting from where search results start. | [optional] [default to null] |
| **holderId** | **String**| The UserID of the owner of the inventory; defaults to the currently authenticated user. | [optional] [default to null] |
| **equipSlot** | **String**| Filter for inventory retrieval. | [optional] [default to ] [enum: , drone, portal, warp] |
| **order** | **String**| Sort order for inventory retrieval. | [optional] [default to null] [enum: newest, newest_created, oldest, oldest_created] |
| **tags** | **String**| Filter tags for inventory retrieval (comma-separated). | [optional] [default to null] |
| **types** | **String**| Filter for inventory retrieval. | [optional] [default to bundle] [enum: bundle, droneskin, emoji, portalskin, prop, sticker, warpeffect] |
| **flags** | **String**| Filter flags for inventory retrieval (comma-separated). | [optional] [default to instantiatable] [enum: archivable, cloneable, consumable, equippable, instantiatable, trashable, ugc, unique] |
| **notTypes** | **String**| Filter out types for inventory retrieval (comma-separated). | [optional] [default to bundle] [enum: bundle, droneskin, emoji, portalskin, prop, sticker, warpeffect] |
| **notFlags** | **String**| Filter out flags for inventory retrieval (comma-separated). | [optional] [default to instantiatable] [enum: archivable, cloneable, consumable, equippable, instantiatable, trashable, ugc, unique] |
| **archived** | **Boolean**| Filter archived status for inventory retrieval. | [optional] [default to null] |
### Return type
[**Inventory**](../Models/Inventory.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInventoryCollections"></a>
# **getInventoryCollections**
> List getInventoryCollections()
List Inventory Collections
Returns a list of collection names.
### Parameters
This endpoint does not need any parameter.
### Return type
**List**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInventoryDrops"></a>
# **getInventoryDrops**
> List getInventoryDrops(active)
List Inventory Drops
Returns a list of InventoryDrop objects.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **active** | **Boolean**| Filter for users&#39; listings and inventory bundles. | [optional] [default to null] |
### Return type
[**List**](../Models/InventoryDrop.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getInventoryTemplate"></a>
# **getInventoryTemplate**
> InventoryTemplate getInventoryTemplate(inventoryTemplateId)
Get Inventory Template
Returns an InventoryTemplate object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryTemplateId** | **String**| Must be a valid inventory template ID. | [default to null] |
### Return type
[**InventoryTemplate**](../Models/InventoryTemplate.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getOwnInventoryItem"></a>
# **getOwnInventoryItem**
> InventoryItem getOwnInventoryItem(inventoryItemId)
Get Own Inventory Item
Returns an InventoryItem object held by the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
### Return type
[**InventoryItem**](../Models/InventoryItem.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="getUserInventoryItem"></a>
# **getUserInventoryItem**
> InventoryItem getUserInventoryItem(userId, inventoryItemId)
Get User Inventory Item
Returns an InventoryItem object held by the given user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **userId** | **String**| Must be a valid user ID. | [default to null] |
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
### Return type
[**InventoryItem**](../Models/InventoryItem.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="shareInventoryItemDirect"></a>
# **shareInventoryItemDirect**
> OkStatus shareInventoryItemDirect(itemId, duration, ShareInventoryItemDirectRequest)
Share Inventory Item Direct
Share content directly with other users.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **itemId** | **String**| Id for inventory item sharing. | [default to null] |
| **duration** | **Integer**| The duration before the sharing pedestal despawns. | [default to 90] |
| **ShareInventoryItemDirectRequest** | [**ShareInventoryItemDirectRequest**](../Models/ShareInventoryItemDirectRequest.md)| | |
### Return type
[**OkStatus**](../Models/OkStatus.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="shareInventoryItemPedestal"></a>
# **shareInventoryItemPedestal**
> InventorySpawn shareInventoryItemPedestal(itemId, duration)
Share Inventory Item by Pedestal
Returns an InventorySpawn object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **itemId** | **String**| Id for inventory item sharing. | [default to null] |
| **duration** | **Integer**| The duration before the sharing pedestal despawns. | [default to 90] |
### Return type
[**InventorySpawn**](../Models/InventorySpawn.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="spawnInventoryItem"></a>
# **spawnInventoryItem**
> InventorySpawn spawnInventoryItem(id)
Spawn Inventory Item
Returns an InventorySpawn object.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | **String**| Id for inventory item spawning. | [default to null] |
### Return type
[**InventorySpawn**](../Models/InventorySpawn.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="unequipOwnInventorySlot"></a>
# **unequipOwnInventorySlot**
> String unequipOwnInventorySlot(inventoryItemId)
Unequip Own Inventory Slot
Unequips the InventoryItem in the given slot of the inventory of the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Selector for inventory slot management. | [default to ] [enum: , drone, portal, warp] |
### Return type
**String**
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
<a name="updateOwnInventoryItem"></a>
# **updateOwnInventoryItem**
> InventoryItem updateOwnInventoryItem(inventoryItemId, UpdateInventoryItemRequest)
Update Own Inventory Item
Returns the modified InventoryItem object as held by the currently logged in user.
### Parameters
|Name | Type | Description | Notes |
|------------- | ------------- | ------------- | -------------|
| **inventoryItemId** | **String**| Must be a valid inventory item ID. | [default to null] |
| **UpdateInventoryItemRequest** | [**UpdateInventoryItemRequest**](../Models/UpdateInventoryItemRequest.md)| | [optional] |
### Return type
[**InventoryItem**](../Models/InventoryItem.md)
### Authorization
[authCookie](../README.md#authCookie)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
Reference in New Issue View Git Blame Copy Permalink