GET api/magento/catalog/products/stocklist

Gets products inventory stock information

Request Information

URI Parameters

None.

Body Parameters

product Ids

Collection of string

Request Formats

application/json, text/json

Sample:
[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample:
<ArrayOfString xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfString>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An array of item inventory stock information

Collection of SuiteBridge.MagentoWebService.catalogInventoryStockItemEntity
NameDescriptionTypeAdditional information
product_id

string

None.

sku

string

None.

qty

string

None.

is_in_stock

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "product_id": "sample string 1",
    "sku": "sample string 2",
    "qty": "sample string 3",
    "is_in_stock": "sample string 4"
  },
  {
    "product_id": "sample string 1",
    "sku": "sample string 2",
    "qty": "sample string 3",
    "is_in_stock": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCatalogInventoryStockItemEntity xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <catalogInventoryStockItemEntity>
    <product_id>sample string 1</product_id>
    <sku>sample string 2</sku>
    <qty>sample string 3</qty>
    <is_in_stock>sample string 4</is_in_stock>
  </catalogInventoryStockItemEntity>
  <catalogInventoryStockItemEntity>
    <product_id>sample string 1</product_id>
    <sku>sample string 2</sku>
    <qty>sample string 3</qty>
    <is_in_stock>sample string 4</is_in_stock>
  </catalogInventoryStockItemEntity>
</ArrayOfCatalogInventoryStockItemEntity>