/

catalog Inventory Stock Registry V1Get Low Stock Items Get

get

Retrieves a list of SKU's with low inventory qty

Query parameters

scopeIdstringOptional

(Required)

Example: <integer>

qtystringOptional

(Required)

Example: <number>

currentPagestringOptionalExample: <integer>

pageSizestringOptionalExample: <integer>

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/V1/stockItems/lowStock/

HTTPcURLJavaScriptPython

GET /V1/stockItems/lowStock/ HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "items": [
    {
      "qty": "<number>",
      "is_in_stock": "<boolean>",
      "is_qty_decimal": "<boolean>",
      "show_default_notification_message": "<boolean>",
      "use_config_min_qty": "<boolean>",
      "min_qty": "<number>",
      "use_config_min_sale_qty": "<integer>",
      "min_sale_qty": "<number>",
      "use_config_max_sale_qty": "<boolean>",
      "max_sale_qty": "<number>",
      "use_config_backorders": "<boolean>",
      "backorders": "<integer>",
      "use_config_notify_stock_qty": "<boolean>",
      "notify_stock_qty": "<number>",
      "use_config_qty_increments": "<boolean>",
      "qty_increments": "<number>",
      "use_config_enable_qty_inc": "<boolean>",
      "enable_qty_increments": "<boolean>",
      "use_config_manage_stock": "<boolean>",
      "manage_stock": "<boolean>",
      "low_stock_date": "<string>",
      "is_decimal_divided": "<boolean>",
      "stock_status_changed_auto": "<integer>",
      "item_id": "<integer>",
      "product_id": "<integer>",
      "stock_id": "<integer>",
      "extension_attributes": "<object>"
    },
    {
      "qty": "<number>",
      "is_in_stock": "<boolean>",
      "is_qty_decimal": "<boolean>",
      "show_default_notification_message": "<boolean>",
      "use_config_min_qty": "<boolean>",
      "min_qty": "<number>",
      "use_config_min_sale_qty": "<integer>",
      "min_sale_qty": "<number>",
      "use_config_max_sale_qty": "<boolean>",
      "max_sale_qty": "<number>",
      "use_config_backorders": "<boolean>",
      "backorders": "<integer>",
      "use_config_notify_stock_qty": "<boolean>",
      "notify_stock_qty": "<number>",
      "use_config_qty_increments": "<boolean>",
      "qty_increments": "<number>",
      "use_config_enable_qty_inc": "<boolean>",
      "enable_qty_increments": "<boolean>",
      "use_config_manage_stock": "<boolean>",
      "manage_stock": "<boolean>",
      "low_stock_date": "<string>",
      "is_decimal_divided": "<boolean>",
      "stock_status_changed_auto": "<integer>",
      "item_id": "<integer>",
      "product_id": "<integer>",
      "stock_id": "<integer>",
      "extension_attributes": "<object>"
    }
  ],
  "search_criteria": {
    "mapper_interface_name": "occae",
    "criteria_list": [
      {
        "mapper_interface_name": "cupidatat esse",
        "criteria_list": [
          {
            "value": "<Circular reference to #/components/schemas/framework-criteria-interface detected>"
          },
          {
            "value": "<Circular reference to #/components/schemas/framework-criteria-interface detected>"
          }
        ],
        "filters": [
          "consequat fugiat ut consectetur laboris",
          "ullamco qui eu nu"
        ],
        "orders": [
          "Ut dolore ullamco",
          "fugiat exercitation"
        ],
        "limit": [
          "quis laborum id a",
          "fugia"
        ]
      },
      {
        "mapper_interface_name": "ex eiusmod incididunt",
        "criteria_list": [
          {
            "value": "<Circular reference to #/components/schemas/framework-criteria-interface detected>"
          },
          {
            "value": "<Circular reference to #/components/schemas/framework-criteria-interface detected>"
          }
        ],
        "filters": [
          "tempor anim occaecat ex",
          "in sit incididunt"
        ],
        "orders": [
          "aliquip in Lorem nulla sunt",
          "officia nostrud"
        ],
        "limit": [
          "eiusmod nulla commodo esse laborum",
          "et eu sit in"
        ]
      }
    ],
    "filters": [
      "occaecat in ipsum exercitation",
      "ullamco ut in"
    ],
    "orders": [
      "pariatur culpa qui",
      "irure"
    ],
    "limit": [
      "id",
      "labore reprehenderit"
    ]
  },
  "total_count": -24705707
}