Entities API

Entities are a generic Model, now available in Antavo. New entities can be created and pre-existing models can be expanded and customized. The Entities API controls the access to these features and provides a unified view. The flexible nature of the entities modules means that the following endpoints are the most commonly used Antavo entities but have also been chosen to demonstrate the full range of options available. The Entities API examples page contains some applications for these features.

Currently, it is possible to expand factory entities and other entities may become available upon module activation.

Current list of Antavo Entities and their associate module, entity and supported actions

Label	Module	Entity	Create	Read	Update	Delete
<custom entity label>	custom	<custom entity>
Account	accounts	account
Challenge	challenges	challenge
Contest	contest lite	promotions
Coupon	coupons	coupon	–	–	–	–
Coupon Pool	coupons	pool
Customer	core	customer
Customer Account	accounts	customer-account	–	–	–	–
Loyalty Card	cards	card
Offers	offers	offer
Prize Wheel	prize-wheels	wheel
Product	products	product
Reward	rewards	reward
Reward category	reward_category
Store	stores	store
Tiers	tiers	tier
Transaction	core	transaction

This documentation demonstrated the API functionality available for a generic entity. A Reward custom entities is also included as an example of the possibilities with this module. Other entities may become available upon module activation.

This documentation demonstrated the API functionality available for a generic entity. A Reward custom entities is also included as an example of the possibilities with this module. Other entities may become available upon module activation.

Entities can be accessed using external_IDs (described here). This functionality has been omitted from the following endpoints to ensure clarity and maintain this section generic description.

The following API endpoints require the custom entities module to be enabled in the Backoffice and the corresponding custom entity must also be active. Entity fields must also be tagged as searchable in order to be used as additional parameters. Api requests can be submitted and processed with null attributes.

All server to server calls should follow the API security protocol and signing procedure and be aware of the API rate limits. There is a limit of 1000 requests per minute for each API key. Exceeding this limit will result in requests being blocked depending on the current load of the Antavo servers.

The OpenApi yaml file used to generate this documentation can be downloaded here