# Inventory

## get\_inventory()

This function returns the current characters inventory items.

#### Usage

`get_inventory()`

#### Returns

`None` or an object containing the size of the inventory and a `list` of items. Empty slots in the `items` list will be set to `None`.

```
{
	'size': 109,
	'gold': 99920517441,
	'items': [{
		'model': 3888,
		'servername': 'ITEM_CH_M_HEAVY_07_HA_C_SUPER',
		'name': 'ITEM_CH_M_HEAVY_07_HA_C_SUPER',
		'quantity': 1,
		'plus': 64,
		'durability': 8953
	}, {
		'model': 3890,
		'servername': 'ITEM_CH_M_HEAVY_07_BA_C_SUPER',
		'name': 'ITEM_CH_M_HEAVY_07_BA_C_SUPER',
		'quantity': 1,
		'plus': 64,
		'durability': 8947
	}, {
		'model': 3889,
		'servername': 'ITEM_CH_M_HEAVY_07_SA_C_SUPER',
		'name': 'ITEM_CH_M_HEAVY_07_SA_C_SUPER',
		'quantity': 1,
		'plus': 64,
		'durability': 8959
	}, {
		'model': 3892,
		'servername': 'ITEM_CH_M_HEAVY_07_AA_C_SUPER',
		'name': 'ITEM_CH_M_HEAVY_07_AA_C_SUPER',
		'quantity': 1,
		'plus': 64,
		'durability': 8943
	}, {
		'model': 3891,
		'servername': 'ITEM_CH_M_HEAVY_07_LA_C_SUPER',
		'name': 'ITEM_CH_M_HEAVY_07_LA_C_SUPER',
		'quantity': 1,
		'plus': 64,
		'durability': 8953
	}, {
		'model': 3893,
		'servername': 'ITEM_CH_M_HEAVY_07_FA_C_SUPER',
		'name': 'ITEM_CH_M_HEAVY_07_FA_C_SUPER',
		'quantity': 1,
		'plus': 64,
		'durability': 8967
	}, {
		'model': 4188,
		'servername': 'ITEM_CH_BOW_11_A_RARE',
		'name': 'Mirage Illusion Bow',
		'quantity': 1,
		'plus': 8,
		'durability': 72
	}, {
		'model': 3823,
		'servername': 'ITEM_MALL_QUIVER',
		'name': 'Arrows',
		'quantity': 360,
		'plus': 0,
		'durability': 0
	}, None, {
		'model': 1856,
		'servername': 'ITEM_CH_EARRING_08_A',
		'name': 'Black Pearl Earring',
		'quantity': 1,
		'plus': 0,
		'durability': 0
	}, {
		'model': 1892,
		'servername': 'ITEM_CH_NECKLACE_08_A',
		'name': 'Black Pearl Necklace',
		'quantity': 1,
		'plus': 0,
		'durability': 0
	}, {
		'model': 1820,
		'servername': 'ITEM_CH_RING_08_A',
		'name': 'Black Pearl Ring',
		'quantity': 1,
		'plus': 0,
		'durability': 0
	}, {
		'model': 1820,
		'servername': 'ITEM_CH_RING_08_A',
		'name': 'Black Pearl Ring',
		'quantity': 1,
		'plus': 0,
		'durability': 0
	}, {
		'model': 4220,
		'servername': 'ITEM_CH_SHIELD_09_C_RARE',
		'name': 'Scale Shield',
		'quantity': 1,
		'plus': 8,
		'durability': 87
	}, {
		'model': 3851,
		'servername': 'ITEM_MALL_GLOBAL_CHATTING',
		'name': 'Global chatting',
		'quantity': 33,
		'plus': 0,
		'durability': 0
	}, None, {
		'model': 9279,
		'servername': 'ITEM_COS_P_FLUTE_WHITE',
		'name': 'White Wolf Summon Scroll',
		'quantity': 1,
		'plus': 0,
		'durability': 0
	}, {
		'model': 5913,
		'servername': 'ITEM_MALL_MP_SUPERSET_5_BAG',
		'name': 'MP Recovery potion (X-large)',
		'quantity': 1564,
		'plus': 0,
		'durability': 0
	}, {
		'model': 5912,
		'servername': 'ITEM_MALL_HP_SUPERSET_5_BAG',
		'name': 'HP Recovery potion (X-large)',
		'quantity': 9643,
		'plus': 0,
		'durability': 0
	}, {
		'model': 5912,
		'servername': 'ITEM_MALL_HP_SUPERSET_5_BAG',
		'name': 'HP Recovery potion (X-large)',
		'quantity': 10000,
		'plus': 0,
		'durability': 0
	}, {
		'model': 8,
		'servername': 'ITEM_ETC_HP_POTION_05',
		'name': 'HP Recovery Potion (X-Large)',
		'quantity': 91,
		'plus': 0,
		'durability': 0
	}, {
		'model': 5913,
		'servername': 'ITEM_MALL_MP_SUPERSET_5_BAG',
		'name': 'MP Recovery potion (X-large)',
		'quantity': 10000,
		'plus': 0,
		'durability': 0
	}, {
		'model': 5912,
		'servername': 'ITEM_MALL_HP_SUPERSET_5_BAG',
		'name': 'HP Recovery potion (X-large)',
		'quantity': 10000,
		'plus': 0,
		'durability': 0
	}, {
		'model': 5913,
		'servername': 'ITEM_MALL_MP_SUPERSET_5_BAG',
		'name': 'MP Recovery potion (X-large)',
		'quantity': 10000,
		'plus': 0,
		'durability': 0
	}, None, {
		'model': 5913,
		'servername': 'ITEM_MALL_MP_SUPERSET_5_BAG',
		'name': 'MP Recovery potion (X-large)',
		'quantity': 10000,
		'plus': 0,
		'durability': 0
	}, {
		'model': 28681,
		'servername': 'ITEM_ETC_E091216_SNOWFLAKE',
		'name': 'Snow flake',
		'quantity': 26,
		'plus': 0,
		'durability': 0
	}, None, None, None, {
		'model': 2198,
		'servername': 'ITEM_ETC_SCROLL_RETURN_02',
		'name': 'Special Return Scroll',
		'quantity': 44,
		'plus': 0,
		'durability': 0
	}, {
		'model': 24662,
		'servername': 'ITEM_EVENT_COS_P_MYOWON_SCROLL',
		'name': 'Monkey Summon Scroll',
		'quantity': 1,
		'plus': 0,
		'durability': 0
	}
	etc...
	]
}
```

## get\_storage()

This function returns the current characters storage items. If the character has not entered storage, this function will return no items.

#### Usage

`get_storage()`

#### Returns

`None` or an object containing the size of the storage and a `list` of items.

## get\_guild\_storage()

This function returns the current characters guild storage items. If the character has not entered guild storage, this function will return no items.

#### Usage

`get_guild_storage()`

#### Returns

`None` or an object containing the size of the guild storage and a `list` of items.

## get\_job\_pouch()

This function returns the current characters job pouch items.

#### Usage

`get_job_pouch()`

#### Returns

`None` or an object containing the size of the job pouch and a `list` of items.

## sort\_inventory()

This function sorts the player's inventory. Sorting is done in a separate thread and will *not* notify you when it completes.

#### Usage

sort\_inventory()

#### Returns

`True/False`

## use\_return\_scroll()

This function will use a return scroll from the player's inventory.

#### Usage

`use_return_scroll()`

#### **Returns**

`True/False`

## reverse\_return(type, name)

Uses a reverse return scroll.

#### **Type**

```
0 - Return to last return scroll
1 - Return to last death
2 - Move to party member
3 - Move to location
```

#### **Usage**

The name argument can either be a party member name or location name.

`reverse_return(0, '')`

#### **Returns**

`True` if a reverse return was used or `False` if one could not be found.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://plugins.phbot.org/phbot-api/inventory.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.