younifyd
Menu

Get Catalog Mapped Variants

Get the list of mapped variants of a model related to a catalog

GET/api/rest/v1/catalogs/{id}/mapped-models/{model_code}/variants

Use it in a workflow

  1. Add a step and choose the Akeneo connector.
  2. Pick the Get Catalog Mapped Variants action (under Catalog products).
  3. Fill in the fields below, then reference the result from later steps as {{getCatalogMappedVariants.response.data}}.

Request

Path parameters

idstring (uuid)required

This path parameter is used to specify the unique identifier of the catalog you want to retrieve or manipulate. It is essential for identifying the specific entity in the API requests. Ensure that the catalog ID is correctly formatted and corresponds to an existing entity in the system.

model_codestringrequired

Model code

Query parameters

search_afterstring

Cursor when using the `search_after` pagination method type. It is essential for navigating through pages in cursor-based pagination, providing more efficient pagination for large datasets. Should never be set manually, see [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default "cursor to the first page"

limitinteger

Specify the maximum number of results to return per page. It is useful for controlling the amount of data returned in a single request, especially when dealing with large datasets. See [Pagination](https://api.akeneo.com/documentation/pagination.html) section for more details.

Default 10

updated_beforestring (date)

Filter products that have been updated BEFORE the provided date. It is useful for retrieving products that haven't been modified since a specific date, which is essential for historical data analysis and reporting. This filter uses the PIM products updated date and is only available on Catalogs endpoints.

updated_afterstring (date)

Filter products that have been updated AFTER the provided date. It is useful for retrieving only recently modified products, which is essential for synchronization and incremental data processing. This filter uses the PIM products updated date and is only available on Catalogs endpoints.

Response

Returns 200 with an object. Read it in later steps with {{getCatalogMappedVariants.response.data.<field>}}.

Need more? See the Akeneo guide for connection setup and behaviour shared by every action.