Class EntitiesClientGetOptionsAbstract

The version of the API to use when fetching the Entities. Refer to the list of entities and their supported API versions.

A list of criteria to be used to filter the results. Each entity exposes a specific list of criteria. Refer to the Entities SDK documentation in the Admin app for more information.

The entity type to be fetched. e.g. 'item' If reference is passed, the entity name of the reference will be used.

The federated id of the entity to be fetched. If id is passed, federatedId will be ignored.

A list of federated ids of the entities to be fetched. If id or federatedId is passed, federatedIds will be ignored.

The id of the entity to be fetched. If referenceis passed, the id of the reference will be used.

The next page key received from the previous call. This is only used for pagination with entities that support V2 API.

A reference to the entity to be fetched. e.g. item:123. If reference is passed, it overrides entityName and id.

Deprecated

use suffix instead.

A list of relations to be fetched. e.g. ['type', 'typeProperties']. Each entity exposes a specific list of relations. Refer to the Entities SDK documentation in the Admin app for more information.

A number of results to skip. This is only used for pagination with entities that support the Search API.

Used to skip hydrating relationships.

Used to specify a suffix to the resource path.

The number of results to fetch. This is only used for pagination with entities that support the Search API.