Get v1 stock items product sku

GET /V1/stockItems/{productSku}

Path parameters

productSku string Required

Query parameters

scopeId integer

Responses

200

200 Success.
Hide response attributes Show response attributes object
- 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
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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 item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
400

400 Bad Request
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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 item
  
  Hide parameters attributes Show parameters attributes object
  
  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]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  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 item
  
  Hide parameters attributes Show parameters attributes object
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/stockItems/{productSku}

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/stockItems/{productSku}

Response examples (200)

{
  "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": {}
}

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 (400)

{
  "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)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}