Skip to main content
POST
Get Inventory Items

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Given an entity type, entity identifier and container details, will get the entity's inventory items.

Given an entity type, entity identifier and container details, will get the entity's inventory items.

Count
number
required

Number of items to retrieve. This value is optional. Maximum page size is 50. The default value is 10

CollectionId
string

The id of the entity's collection to perform this action on. (Default="default")

ContinuationToken
string

An opaque token used to retrieve the next page of items in the inventory, if any are available. Should be null on initial request.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Entity
object

The entity to perform this action on.

Filter
string

OData Filter to refine the items returned. InventoryItem properties 'type', 'id', and 'stackId' can be used in the filter. For example: "type eq 'currency'"

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026