Magento2
GET /V1/stockStatuses/{productSku}

Path parameters

  • productSku string Required

Query parameters

  • scopeId integer

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • product_id integer Required
    • stock_id integer Required
    • qty integer Required
    • stock_status integer Required
    • stock_item object Required

      Interface StockItem

      Hide stock_item attributes Show stock_item 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

    • extension_attributes object

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

    Hide response attributes Show response attributes object
    • product_id integer Required
    • stock_id integer Required
    • qty integer Required
    • stock_status integer Required
    • stock_item object Required

      Interface StockItem

      Hide stock_item attributes Show stock_item 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

    • extension_attributes object

      ExtensionInterface class for @see \Magento\CatalogInventory\Api\Data\StockStatusInterface
  • 400

    400 Bad Request

    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/stockStatuses/{productSku} 
curl \
 --request GET 'https://magento2.winkelstraat.mac/rest/all/V1/stockStatuses/{productSku}'
Response examples (200) 
{
  "product_id": 42,
  "stock_id": 42,
  "qty": 42,
  "stock_status": 42,
  "stock_item": {
    "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": {}
  },
  "extension_attributes": {}
}
Response examples (200) 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <product-id type="integer">42</product-id>
  <stock-id type="integer">42</stock-id>
  <qty type="integer">42</qty>
  <stock-status type="integer">42</stock-status>
  <stock-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>
  </stock-item>
  <extension-attributes>
  </extension-attributes>
</root>
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 (400) 
<?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>