Skip to content

Magento - Get Products

This module allows querying products from your Magento 2 store with filters by name, type, status, visibility, and category.

FieldTypeRequiredDescription
credentials_idstringYesCredentials ID
skustringNoSpecific product SKU
namestringNoSearch by name
type_idstringNoProduct type
statusstringNo1=Enabled, 2=Disabled
visibilitystringNoCatalog visibility
category_idstringNoCategory ID
sort_fieldstringNoSort field
sort_directionstringNoASC or DESC
page_sizenumberNoProducts per page
current_pagenumberNoCurrent page
FieldDescription
store_urlMagento store base URL (e.g.: https://mystore.com)
access_tokenIntegration access token with catalog read permissions
ValueDescription
simpleSimple product
configurableConfigurable product
groupedGrouped product
bundleBundle product
virtualVirtual product
downloadableDownloadable product
ValueDescription
1Not visible individually
2Catalog
3Search
4Catalog and Search
{
"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"
}
{
"credentials_id": "magento_tienda",
"sku": "PROD-001"
}
{
"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
  • MagentoCreateProduct - Create new products
  • MagentoUpdateProduct - Update existing products
  • MagentoGetOrders - Query orders with products