Skip to main content

List Products

GET 
/api/magento2/integration-instances/:magento2IntegrationInstance/products

Paginated list of Magento 2 products scoped to one integration instance.

Path params:

  • magento2IntegrationInstance (required, integer) — Magento 2 IntegrationInstance ID.

Pagination: default per_page=25. Default sort: -id.

Quick filters (exact): type_id, status, visibility, magento_parent_id, attribute_set_id, integration_instance_id.

Special filters:

  • filter[search] — LIKE across sku + name; numeric values also match magento_entity_id.
  • filter[sku_product_id] — mapped / unmapped / all, or a numeric SKU.io product id.
  • filter[archived] — true (archived only), false (active only — default behavior), all.
  • filter[integration_instance_ids] — accepted as a no-op for channel-layout parity.

Advanced filters (AdvancedFilterBuilder, operator-aware):

  • Text columns (operators: equals, not_equals, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty): sku, name, type_id, status, visibility.
  • Numeric columns (operators: equals, not_equals, greater_than, greater_than_or_equal, less_than, less_than_or_equal, between, is_empty, is_not_empty): price, cost, weight.
  • Datetime columns (operators: equals, not_equals, greater_than, less_than, is_within, is_empty, is_not_empty): magento_created_at, magento_updated_at, created_at, updated_at.

Sorts: id, magento_entity_id, sku, name, type_id, status, visibility, price, cost, weight, attribute_set_id, magento_parent_id, magento_created_at, magento_updated_at, created_at, updated_at.

Eager-loads: integrationInstance, parent (the configurable parent for simple variants).

Request​

Responses​

OK

Response Headers
    Content-Type