Magento2

Retrieves a list of SKU's with low inventory qty

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://magento2.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"Magento2 MCP server": {
  "url": "https://magento2.doc.winkelstraat.nl/mcp"
}
Close
GET /V1/stockItems/lowStock/

Retrieves a list of SKU's with low inventory qty

Query parameters

  • scopeId integer Required
  • qty number Required
  • currentPage integer
  • pageSize integer

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • items array[object] Required

      Items

      Hide items attributes Show items attributes object

      Interface StockItem

      • item_id integer
      • product_id integer
      • stock_id integer

        Stock identifier

      • qty number Required
      • is_in_stock boolean Required

        Stock Availability

      • is_qty_decimal boolean Required
      • show_default_notification_message boolean Required
      • use_config_min_qty boolean Required
      • min_qty number Required

        Minimal quantity available for item status in stock

      • use_config_min_sale_qty integer Required
      • min_sale_qty number Required

        Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation

      • use_config_max_sale_qty boolean Required
      • max_sale_qty number Required

        Maximum Qty Allowed in Shopping Cart data wrapper

      • use_config_backorders boolean Required
      • backorders integer Required

        Backorders status

      • use_config_notify_stock_qty boolean Required
      • notify_stock_qty number Required

        Notify for Quantity Below data wrapper

      • use_config_qty_increments boolean Required
      • qty_increments number Required

        Quantity Increments data wrapper

      • use_config_enable_qty_inc boolean Required
      • enable_qty_increments boolean Required

        Whether Quantity Increments is enabled

      • use_config_manage_stock boolean Required
      • manage_stock boolean Required

        Can Manage Stock

      • low_stock_date string Required
      • is_decimal_divided boolean Required
      • stock_status_changed_auto integer Required
      • extension_attributes object

        ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface

    • search_criteria object Required

      Interface StockItemCriteriaInterface

      Hide search_criteria attributes Show search_criteria attributes object
      • mapper_interface_name string Required

        Associated Mapper Interface name

      • criteria_list array[object] Required

        Criteria objects added to current Composite Criteria

        Hide criteria_list attributes Show criteria_list attributes object

        Interface CriteriaInterface

        • mapper_interface_name string Required

          Associated Mapper Interface name

        • criteria_list array[object] Required

          Criteria objects added to current Composite Criteria

          Interface CriteriaInterface

          Interface CriteriaInterface

        • filters array[string] Required

          List of filters

        • orders array[string] Required

          Ordering criteria

        • limit array[string] Required

          Limit

      • filters array[string] Required

        List of filters

      • orders array[string] Required

        Ordering criteria

      • limit array[string] Required

        Limit

    • total_count integer Required

      Total count.

    Hide response attributes Show response attributes object
    • items array[object] Required

      Items

      Hide items attributes Show items attributes object

      Interface StockItem

      • item_id integer
      • product_id integer
      • stock_id integer

        Stock identifier

      • qty number Required
      • is_in_stock boolean Required

        Stock Availability

      • is_qty_decimal boolean Required
      • show_default_notification_message boolean Required
      • use_config_min_qty boolean Required
      • min_qty number Required

        Minimal quantity available for item status in stock

      • use_config_min_sale_qty integer Required
      • min_sale_qty number Required

        Minimum Qty Allowed in Shopping Cart or NULL when there is no limitation

      • use_config_max_sale_qty boolean Required
      • max_sale_qty number Required

        Maximum Qty Allowed in Shopping Cart data wrapper

      • use_config_backorders boolean Required
      • backorders integer Required

        Backorders status

      • use_config_notify_stock_qty boolean Required
      • notify_stock_qty number Required

        Notify for Quantity Below data wrapper

      • use_config_qty_increments boolean Required
      • qty_increments number Required

        Quantity Increments data wrapper

      • use_config_enable_qty_inc boolean Required
      • enable_qty_increments boolean Required

        Whether Quantity Increments is enabled

      • use_config_manage_stock boolean Required
      • manage_stock boolean Required

        Can Manage Stock

      • low_stock_date string Required
      • is_decimal_divided boolean Required
      • stock_status_changed_auto integer Required
      • extension_attributes object

        ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockItemInterface

    • search_criteria object Required

      Interface StockItemCriteriaInterface

      Hide search_criteria attributes Show search_criteria attributes object
      • mapper_interface_name string Required

        Associated Mapper Interface name

      • criteria_list array[object] Required

        Criteria objects added to current Composite Criteria

        Hide criteria_list attributes Show criteria_list attributes object

        Interface CriteriaInterface

        • mapper_interface_name string Required

          Associated Mapper Interface name

        • criteria_list array[object] Required

          Criteria objects added to current Composite Criteria

          Interface CriteriaInterface

          Interface CriteriaInterface

        • filters array[string] Required

          List of filters

        • orders array[string] Required

          Ordering criteria

        • limit array[string] Required

          Limit

      • filters array[string] Required

        List of filters

      • orders array[string] Required

        Ordering criteria

      • limit array[string] Required

        Limit

    • total_count integer Required

      Total count.
  • 401

    401 Unauthorized

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Errors list

      Hide errors attributes Show errors attributes object

      Error details

      • message string

        Error message

      • parameters array[object]

        Error parameters list

        Hide parameters attributes Show parameters attributes object

        Error parameters item

        • resources string

          ACL resource

        • fieldName string

          Missing or invalid field name

        • fieldValue string

          Incorrect field value

    • code integer

      Error code

    • parameters array[object]

      Error parameters list

      Hide parameters attributes Show parameters attributes object

      Error parameters item

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

    • trace string

      Stack trace
GET /V1/stockItems/lowStock/ 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/stockItems/lowStock/?scopeId=42&qty=42.0'
Response examples (200) 
{
  "items": [
    {
      "item_id": 42,
      "product_id": 42,
      "stock_id": 42,
      "qty": 42.0,
      "is_in_stock": true,
      "is_qty_decimal": true,
      "show_default_notification_message": true,
      "use_config_min_qty": true,
      "min_qty": 42.0,
      "use_config_min_sale_qty": 42,
      "min_sale_qty": 42.0,
      "use_config_max_sale_qty": true,
      "max_sale_qty": 42.0,
      "use_config_backorders": true,
      "backorders": 42,
      "use_config_notify_stock_qty": true,
      "notify_stock_qty": 42.0,
      "use_config_qty_increments": true,
      "qty_increments": 42.0,
      "use_config_enable_qty_inc": true,
      "enable_qty_increments": true,
      "use_config_manage_stock": true,
      "manage_stock": true,
      "low_stock_date": "string",
      "is_decimal_divided": true,
      "stock_status_changed_auto": 42,
      "extension_attributes": {}
    }
  ],
  "search_criteria": {
    "mapper_interface_name": "string",
    "criteria_list": [
      {
        "mapper_interface_name": "string",
        "criteria_list": [
          {}
        ],
        "filters": [
          "string"
        ],
        "orders": [
          "string"
        ],
        "limit": [
          "string"
        ]
      }
    ],
    "filters": [
      "string"
    ],
    "orders": [
      "string"
    ],
    "limit": [
      "string"
    ]
  },
  "total_count": 42
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <items type="array">
    <item>
      <item-id type="integer">42</item-id>
      <product-id type="integer">42</product-id>
      <stock-id type="integer">42</stock-id>
      <qty type="float">42.0</qty>
      <is-in-stock type="boolean">true</is-in-stock>
      <is-qty-decimal type="boolean">true</is-qty-decimal>
      <show-default-notification-message type="boolean">true</show-default-notification-message>
      <use-config-min-qty type="boolean">true</use-config-min-qty>
      <min-qty type="float">42.0</min-qty>
      <use-config-min-sale-qty type="integer">42</use-config-min-sale-qty>
      <min-sale-qty type="float">42.0</min-sale-qty>
      <use-config-max-sale-qty type="boolean">true</use-config-max-sale-qty>
      <max-sale-qty type="float">42.0</max-sale-qty>
      <use-config-backorders type="boolean">true</use-config-backorders>
      <backorders type="integer">42</backorders>
      <use-config-notify-stock-qty type="boolean">true</use-config-notify-stock-qty>
      <notify-stock-qty type="float">42.0</notify-stock-qty>
      <use-config-qty-increments type="boolean">true</use-config-qty-increments>
      <qty-increments type="float">42.0</qty-increments>
      <use-config-enable-qty-inc type="boolean">true</use-config-enable-qty-inc>
      <enable-qty-increments type="boolean">true</enable-qty-increments>
      <use-config-manage-stock type="boolean">true</use-config-manage-stock>
      <manage-stock type="boolean">true</manage-stock>
      <low-stock-date>string</low-stock-date>
      <is-decimal-divided type="boolean">true</is-decimal-divided>
      <stock-status-changed-auto type="integer">42</stock-status-changed-auto>
      <extension-attributes>
      </extension-attributes>
    </item>
  </items>
  <search-criteria>
    <mapper-interface-name>string</mapper-interface-name>
    <criteria-list type="array">
      <criteria-list>
        <mapper-interface-name>string</mapper-interface-name>
        <criteria-list type="array">
          <criteria-list>
          </criteria-list>
        </criteria-list>
        <filters type="array">
          <filter>string</filter>
        </filters>
        <orders type="array">
          <order>string</order>
        </orders>
        <limit type="array">
          <limit>string</limit>
        </limit>
      </criteria-list>
    </criteria-list>
    <filters type="array">
      <filter>string</filter>
    </filters>
    <orders type="array">
      <order>string</order>
    </orders>
    <limit type="array">
      <limit>string</limit>
    </limit>
  </search-criteria>
  <total-count type="integer">42</total-count>
</root>
Response examples (401) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (401) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}
Response examples (default) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <message>string</message>
  <errors type="array">
    <error>
      <message>string</message>
      <parameters type="array">
        <parameter>
          <resources>string</resources>
          <fieldName>string</fieldName>
          <fieldValue>string</fieldValue>
        </parameter>
      </parameters>
    </error>
  </errors>
  <code type="integer">42</code>
  <parameters type="array">
    <parameter>
      <resources>string</resources>
      <fieldName>string</fieldName>
      <fieldValue>string</fieldValue>
    </parameter>
  </parameters>
  <trace>string</trace>
</root>