Magento REST icon

Magento REST

Consume Magento REST API

Store → Get Store Groups

AI-generated

Summary

Fetch store groups from Magento REST API

Inputs

  • simplifyOutput — When enabled, flattens the response structure. Converts custom_attributes array to an object, flattens extension_attributes, and simplifies nested structures.

Output shape

Array of store group objects from Magento REST /rest/V1/store/storeGroups endpoint. Each object typically contains id, name, code, default_store_id, and store_views.

When simplifyOutput is true, the execute method calls flattenResponse which converts custom_attributes to an object, flattens extension_attributes into top-level keys (e.g., extension_), and removes nested wrappers. No additional input parameters are required for the API request itself.

Examples

Example 1: Basic retrieval without simplification

resource: Store, operation: Get Store Groups, simplifyOutput: false (default)

Example 2: Retrieval with output simplification

resource: Store, operation: Get Store Groups, simplifyOutput: true

Links

Discussion