Skip to content

inventory

Jump to bottom
YYBartT edited this page Jan 18, 2026 · 1 revision

Inventory

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.


Back To Top

elements_inventory_get_advanced_inventory_item

Elements Operation: getAdvancedInventoryItem

This function gets the first (primary) inventory item for the specified item.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_get_advanced_inventory_item(_inventory_item_id, _callback=undefined)
Argument Type Description
_inventory_item_id String The ID of the inventory item.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_update_simple_inventory_item

Elements Operation: updateSimpleInventoryItem

This function updates an inventory item for the specified item.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_update_simple_inventory_item(_inventory_item_id, _body=undefined, _callback=undefined)
Argument Type Description
_inventory_item_id String The ID of the inventory item.
_body ElementsUpdateInventoryItemRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_delete_advanced_inventory_item

Elements Operation: deleteAdvancedInventoryItem

This function deletes the inventory item as identified by the given item name/ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_delete_advanced_inventory_item(_inventory_item_id, _callback=undefined)
Argument Type Description
_inventory_item_id String The ID of the inventory item.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data Undefined
_request ElementsRequest


Back To Top

elements_inventory_adjust_advanced_inventory_item_quantity

Elements Operation: adjustAdvancedInventoryItemQuantity

This function adjusts the quantity of the first (primary) inventory item for the specified item. This implicitly will create the InventoryItem if it does not exist. The inventory item value

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_adjust_advanced_inventory_item_quantity(_inventory_item_id, _body=undefined, _callback=undefined)
Argument Type Description
_inventory_item_id String The ID of the inventory item.
_body ElementsAdvancedInventoryItemQuantityAdjustment The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_get_advanced_inventory_items

Elements Operation: getAdvancedInventoryItems

This function searches all inventory items in the system and returns the metadata for all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_get_advanced_inventory_items(_offset=undefined, _count=undefined, _user_id=undefined, _search=undefined, _callback=undefined)
Argument Type Description
_offset Real The offset of the first result to return in the page.
_count Real The number of results to return in the page.
_user_id String The specific User ID to filter on.
_search String The search filter to use.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsPaginationInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_create_advanced_inventory_item

Elements Operation: createAdvancedInventoryItem

This function creates an inventory item for the specified item.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_create_advanced_inventory_item(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateAdvancedInventoryItemRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_get_distinct_inventory_items

Elements Operation: getDistinctInventoryItems

This function searches all inventory items in the system and returns the metadata for all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_get_distinct_inventory_items(_offset=undefined, _count=undefined, _user_id=undefined, _profile_id=undefined, _search=undefined, _callback=undefined)
Argument Type Description
_offset Real The offset of the first result to return in the page.
_count Real The number of results to return in the page.
_user_id String The specific User ID to filter on.
_profile_id String The unique ID of the profile itself.
_search String The search filter to use.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsPaginationDistinctInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_create_distinct_inventory_item

Elements Operation: createDistinctInventoryItem

This function creates an inventory item for the specified item.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_create_distinct_inventory_item(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateDistinctInventoryItemRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsDistinctInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_update_distinct_inventory_item

Elements Operation: updateDistinctInventoryItem

This function updates an inventory item for the specified item.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_update_distinct_inventory_item(_distinct_inventory_item_id, _body=undefined, _callback=undefined)
Argument Type Description
_distinct_inventory_item_id String The ID of the distinct inventory item.
_body ElementsUpdateDistinctInventoryItemRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsDistinctInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_delete_distinct_inventory_item

Elements Operation: deleteDistinctInventoryItem

This function deletes the inventory item as identified by the given item name/ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_delete_distinct_inventory_item(_distinct_inventory_item_id, _callback=undefined)
Argument Type Description
_distinct_inventory_item_id String The ID of the distinct inventory item.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data Undefined
_request ElementsRequest


Back To Top

elements_inventory_get_distinct_inventory_item

Elements Operation: getDistinctInventoryItem

This function gets the first (primary) inventory item for the specified item.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_get_distinct_inventory_item(_inventory_item_id, _callback=undefined)
Argument Type Description
_inventory_item_id String The ID of the inventory item.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsDistinctInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_get_simple_inventory_item

Elements Operation: getSimpleInventoryItem

This function gets the first (primary) inventory item for the specified item.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_get_simple_inventory_item(_inventory_item_id, _callback=undefined)
Argument Type Description
_inventory_item_id String The ID of the inventory item.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_update_simple_inventory_item_1

Elements Operation: updateSimpleInventoryItem_1

This function updates an inventory item for the specified item.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_update_simple_inventory_item_1(_inventory_item_id, _body=undefined, _callback=undefined)
Argument Type Description
_inventory_item_id String The ID of the inventory item.
_body ElementsUpdateInventoryItemRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_delete_simple_inventory_item

Elements Operation: deleteSimpleInventoryItem

This function deletes the inventory item as identified by the given item name/ID.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_delete_simple_inventory_item(_inventory_item_id, _callback=undefined)
Argument Type Description
_inventory_item_id String The ID of the inventory item.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data Undefined
_request ElementsRequest


Back To Top

elements_inventory_adjust_simple_inventory_item_quantity

Elements Operation: adjustSimpleInventoryItemQuantity

This function adjusts the quantity of the first (primary) inventory item for the specified item. This implicitly will create the InventoryItem if it does not exist. The inventory item value

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_adjust_simple_inventory_item_quantity(_inventory_item_id, _body=undefined, _callback=undefined)
Argument Type Description
_inventory_item_id String The ID of the inventory item.
_body ElementsSimpleInventoryItemQuantityAdjustment The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_get_simple_inventory_items

Elements Operation: getSimpleInventoryItems

This function searches all inventory items in the system and returns the metadata for all matches against the given search filter.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_get_simple_inventory_items(_offset=undefined, _count=undefined, _user_id=undefined, _search=undefined, _callback=undefined)
Argument Type Description
_offset Real The offset of the first result to return in the page.
_count Real The number of results to return in the page.
_user_id String The specific User ID to filter on.
_search String The search filter to use.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsPaginationInventoryItem
_request ElementsRequest


Back To Top

elements_inventory_create_simple_inventory_item

Elements Operation: createSimpleInventoryItem

This function creates an inventory item for the specified item.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.


Syntax:

elements_inventory_create_simple_inventory_item(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateSimpleInventoryItemRequest The body to be included in the HTTP request.
_callback Function The function - with signature (status, data, request) - that will be executed upon request completion.



Returns:

N/A


Triggers:

Callback Function

Key Type Description
_status Real
_data ElementsInventoryItem
_request ElementsRequest


GameMaker 2026

GMEXT-Elements

Guides

REST API

Schemas

Clone this wiki locally