Magento - Get Products
Description
Section titled “Description”This module allows querying products from your Magento 2 store with filters by name, type, status, visibility, and category.
Configuration
Section titled “Configuration”| Field | Type | Required | Description |
|---|---|---|---|
credentials_id | string | Yes | Credentials ID |
sku | string | No | Specific product SKU |
name | string | No | Search by name |
type_id | string | No | Product type |
status | string | No | 1=Enabled, 2=Disabled |
visibility | string | No | Catalog visibility |
category_id | string | No | Category ID |
sort_field | string | No | Sort field |
sort_direction | string | No | ASC or DESC |
page_size | number | No | Products per page |
current_page | number | No | Current page |
Credentials
Section titled “Credentials”| Field | Description |
|---|---|
store_url | Magento store base URL (e.g.: https://mystore.com) |
access_token | Integration access token with catalog read permissions |
Product Types (type_id)
Section titled “Product Types (type_id)”| Value | Description |
|---|---|
simple | Simple product |
configurable | Configurable product |
grouped | Grouped product |
bundle | Bundle product |
virtual | Virtual product |
downloadable | Downloadable product |
Visibility
Section titled “Visibility”| Value | Description |
|---|---|
1 | Not visible individually |
2 | Catalog |
3 | Search |
4 | Catalog and Search |
Output
Section titled “Output”{ "success": true, "products": [ { "id": 123, "sku": "PROD-001", "name": "Producto de ejemplo", "price": 99.99, "status": 1, "visibility": 4, "type_id": "simple", "custom_attributes": [] } ], "total": 150, "page_size": 20, "current_page": 1, "message": "20 products retrieved"}Usage Example
Section titled “Usage Example”Get product by SKU
Section titled “Get product by SKU”{ "credentials_id": "magento_tienda", "sku": "PROD-001"}Enabled products
Section titled “Enabled products”{ "credentials_id": "magento_tienda", "status": "1", "page_size": 50}- The Magento API uses searchCriteria for complex filters
- Default pagination is 20 products
- Custom attributes are in
custom_attributes - The SKU must be URL-encoded if it contains special characters
Related Nodes
Section titled “Related Nodes”- MagentoCreateProduct - Create new products
- MagentoUpdateProduct - Update existing products
- MagentoGetOrders - Query orders with products