POST Inventory/OutOfStockProducts

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Criteria	"ByValue" or "ByItemThreshold"	string	None.
CriteriaByValue	when Criteria is "ByValue", this is used as the threshold. When Criteria is "ByItemThreshold", this is ignored.	decimal number	None.
Lang		string	None.
StoreID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Criteria": "sample string 1",
  "CriteriaByValue": 2.0,
  "Lang": "sample string 3",
  "StoreID": 4
}

application/xml, text/xml

Sample:

<OutOfStockRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Inventory">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 3</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">4</StoreID>
  <Criteria>sample string 1</Criteria>
  <CriteriaByValue>2</CriteriaByValue>
</OutOfStockRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Product

Name	Type	Additional information
ID	integer	None.
Name	string	None.
Reference	string	None.
Quantity	decimal number	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Name": "sample string 2",
    "Reference": "sample string 3",
    "Quantity": 4.0
  },
  {
    "ID": 1,
    "Name": "sample string 2",
    "Reference": "sample string 3",
    "Quantity": 4.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Inventory">
  <Product>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <Quantity>4</Quantity>
    <Reference>sample string 3</Reference>
  </Product>
  <Product>
    <ID>1</ID>
    <Name>sample string 2</Name>
    <Quantity>4</Quantity>
    <Reference>sample string 3</Reference>
  </Product>
</ArrayOfProduct>