Skip to content

elements_inventory

Jump to bottom
Francisco Dias edited this page Aug 20, 2026 · 1 revision

Inventory

The Inventory endpoints.

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_adjust_advanced_inventory_item_quantity

Adjust 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.


Syntax:

elements_adjust_advanced_inventory_item_quantity(_inventory_item_id, _body=undefined, _callback=undefined)
Argument Type Description
_inventory_item_id String
_body ElementsAdvancedInventoryItemQuantityAdjustment The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_adjust_simple_inventory_item_quantity

Adjust 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.


Syntax:

elements_adjust_simple_inventory_item_quantity(_inventory_item_id, _body=undefined, _callback=undefined)
Argument Type Description
_inventory_item_id String
_body ElementsSimpleInventoryItemQuantityAdjustment The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_create_advanced_inventory_item

Create 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.


Syntax:

elements_create_advanced_inventory_item(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateAdvancedInventoryItemRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_create_distinct_inventory_item

Create 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.


Syntax:

elements_create_distinct_inventory_item(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateDistinctInventoryItemRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsDistinctInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_create_simple_inventory_item

Create 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.


Syntax:

elements_create_simple_inventory_item(_body=undefined, _callback=undefined)
Argument Type Description
_body ElementsCreateSimpleInventoryItemRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_delete_advanced_inventory_item

Delete 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.


Syntax:

elements_delete_advanced_inventory_item(_inventory_item_id, _callback=undefined)
Argument Type Description
_inventory_item_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data Any
_request ElementsRequest

Back To Top

elements_delete_distinct_inventory_item

Delete 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.


Syntax:

elements_delete_distinct_inventory_item(_distinct_inventory_item_id, _callback=undefined)
Argument Type Description
_distinct_inventory_item_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data Any
_request ElementsRequest

Back To Top

elements_delete_simple_inventory_item

Delete 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.


Syntax:

elements_delete_simple_inventory_item(_inventory_item_id, _callback=undefined)
Argument Type Description
_inventory_item_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data Any
_request ElementsRequest

Back To Top

elements_get_advanced_inventory_item

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.


Syntax:

elements_get_advanced_inventory_item(_inventory_item_id, _callback=undefined)
Argument Type Description
_inventory_item_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_get_advanced_inventory_items

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.


Syntax:

elements_get_advanced_inventory_items(_offset=undefined, _count=undefined, _user_id=undefined, _search=undefined, _callback=undefined)
Argument Type Description
_offset Real
_count Real
_user_id String
_search String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_get_distinct_inventory_item

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.


Syntax:

elements_get_distinct_inventory_item(_inventory_item_id, _callback=undefined)
Argument Type Description
_inventory_item_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsDistinctInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_get_distinct_inventory_items

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.


Syntax:

elements_get_distinct_inventory_items(_offset=undefined, _count=undefined, _user_id=undefined, _profile_id=undefined, _search=undefined, _callback=undefined)
Argument Type Description
_offset Real
_count Real
_user_id String
_profile_id String
_search String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationDistinctInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_get_ledger_entries

Returns paginated ledger entries for a specific inventory item or user, sorted most-recent first. Exactly one of inventoryItemId or userId must be supplied. All other parameters are optional filters.

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.


Syntax:

elements_get_ledger_entries(_inventory_item_id=undefined, _user_id=undefined, _event_type=undefined, _from=undefined, _to=undefined, _offset=undefined, _count=undefined, _callback=undefined)
Argument Type Description
_inventory_item_id String Filter entries for a specific inventory item ID.
_user_id String Filter entries for a specific user ID (across all their inventory items).
_event_type String Optional event type filter. When omitted, all event types are returned.
_from Real Optional inclusive lower bound as epoch milliseconds. When omitted, no lower bound is applied.
_to Real Optional inclusive upper bound as epoch milliseconds. When omitted, no upper bound is applied.
_offset Real
_count Real
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationItemLedgerEntry or Undefined
_request ElementsRequest

Back To Top

elements_get_simple_inventory_item

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.


Syntax:

elements_get_simple_inventory_item(_inventory_item_id, _callback=undefined)
Argument Type Description
_inventory_item_id String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_get_simple_inventory_items

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.


Syntax:

elements_get_simple_inventory_items(_offset=undefined, _count=undefined, _user_id=undefined, _search=undefined, _callback=undefined)
Argument Type Description
_offset Real
_count Real
_user_id String
_search String
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsPaginationInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_update_advanced_inventory_item

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.


Syntax:

elements_update_advanced_inventory_item(_inventory_item_id, _body=undefined, _callback=undefined)
Argument Type Description
_inventory_item_id String
_body ElementsUpdateInventoryItemRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_update_distinct_inventory_item

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.


Syntax:

elements_update_distinct_inventory_item(_distinct_inventory_item_id, _body=undefined, _callback=undefined)
Argument Type Description
_distinct_inventory_item_id String
_body ElementsUpdateDistinctInventoryItemRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsDistinctInventoryItem or Undefined
_request ElementsRequest

Back To Top

elements_update_simple_inventory_item

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.


Syntax:

elements_update_simple_inventory_item(_inventory_item_id, _body=undefined, _callback=undefined)
Argument Type Description
_inventory_item_id String
_body ElementsUpdateInventoryItemRequest The body to be included in the http request.
_callback Function Callback with signature (status, data, request).

Returns:

N/A


Triggers:

Callback

Key Type Description
_status Real
_data ElementsInventoryItem or Undefined
_request ElementsRequest

GameMaker 2026

GMEXT-Elements

Guides

REST API

Schemas

Clone this wiki locally