Products

Read the configurable products available to your Mimeeq account. Use these endpoints to build a catalogue integration, retrieve a product's configuration, or find related products.

These endpoints are read-only. Create and edit products in the Mimeeq app; this API section does not provide product creation, update, or deletion operations.

What you can do

Task	Operation
Find products using filters and pagination	List Products
Read a product's full configuration	Get Product
Find products related to a selected product	List Related Products

Before you start

Your API key needs the products:read scope. Start with List Products and use the returned productId in subsequent requests.

List Products supports filters for text, status, product type, configurator mode, privacy, ownership, visibility, lifecycle dates, and variant code. See the operation for the supported values. Follow Pagination when retrieving more than one page.

Product configuration and related resources

Get Product returns the full configuration. Its structure can vary by product and configurator type, so check the response before selecting fields for your integration. Use the lang parameter when you need localized fields, including the description, in a particular language.

Use Product Categories to work with the category hierarchy, and Product Groups for groups of products used for sharing or embedding.