The Admin API is designed in such a way that all entities of the system can be read in the same way. Once an entity is registered in the system, it can be written and read via API - this also applies to your custom entities. The appropriate routes for the entity are generated automatically and follow the REST pattern.
ManufacturerEntityis registered as
product_manufacturerin the system and can be read
ProductEntityhas an association with the property name
manufacturer, which refers to the
- The manufacturer of a product can then be read over
For an entity object, the system automatically creates the following routes through which the entity object can be read:
|Fetch a list of entities
|Fetch a single entity
|Perform a more sophisticated search
|Perform a more sophisticated search and fetching only matching ids
The Admin API supports a wide range of filtering, aggregation and sorting capabilities. However, according to the REST definition, data should only be read via GET, we have provided the
/api/v3/search/* route for this.
The behaviour of that endpoint follows the concepts described in the Search Criteria article.