POST api/Product

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CategoryID	integer	None.
Sections	Collection of integer	None.
TextSearch	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CategoryID": 1,
  "Sections": [
    1,
    2
  ],
  "TextSearch": "sample string 1"
}

application/xml, text/xml

Sample:

<ProductsSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iCircleCommon">
  <CategoryID>1</CategoryID>
  <Sections xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Sections>
  <TextSearch>sample string 1</TextSearch>
</ProductsSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ProductS

Name	Type	Additional information
ProductID	integer	None.
Name	string	None.
SKU	string	None.
QuantityDiscountID	integer	None.
PackSize	integer	None.
Price	decimal number	None.
Inventory2	integer	None.
Inventory3	integer	None.
InventoryDate	date	None.
BarCode	string	None.
PackStepSize	integer	None.
PackInfo1	integer	None.
PackInfo2	integer	None.
PackInfo3	integer	None.
PackInfoLabel1	string	None.
PackInfoLabel2	string	None.
PackInfoLabel3	string	None.
UsePackForQuantityTable	boolean	None.
PackSizeEditable	boolean	None.
PackLabel	string	None.
MinimumQuantity	integer	None.
Inventory	integer	None.
Categories	Collection of CategoryS	None.
Sections	Collection of SectionS	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ProductID": 1,
    "Name": "sample string 2",
    "SKU": "sample string 3",
    "QuantityDiscountID": 1,
    "PackSize": 1,
    "Price": 4.0,
    "Inventory2": 1,
    "Inventory3": 1,
    "InventoryDate": "2026-07-10T16:59:09.36191+02:00",
    "BarCode": "sample string 5",
    "PackStepSize": 1,
    "PackInfo1": 1,
    "PackInfo2": 1,
    "PackInfo3": 1,
    "PackInfoLabel1": "sample string 6",
    "PackInfoLabel2": "sample string 7",
    "PackInfoLabel3": "sample string 8",
    "UsePackForQuantityTable": true,
    "PackSizeEditable": true,
    "PackLabel": "sample string 9",
    "MinimumQuantity": 1,
    "Inventory": 10,
    "Categories": [
      {
        "CategoryID": 1,
        "Name": "sample string 2",
        "ParentCategoryID": 3,
        "DisplayOrder": 4
      },
      {
        "CategoryID": 1,
        "Name": "sample string 2",
        "ParentCategoryID": 3,
        "DisplayOrder": 4
      }
    ],
    "Sections": [
      {
        "SectionID": 1,
        "Name": "sample string 2",
        "ParentSectionID": 3,
        "DisplayOrder": 4
      },
      {
        "SectionID": 1,
        "Name": "sample string 2",
        "ParentSectionID": 3,
        "DisplayOrder": 4
      }
    ]
  },
  {
    "ProductID": 1,
    "Name": "sample string 2",
    "SKU": "sample string 3",
    "QuantityDiscountID": 1,
    "PackSize": 1,
    "Price": 4.0,
    "Inventory2": 1,
    "Inventory3": 1,
    "InventoryDate": "2026-07-10T16:59:09.36191+02:00",
    "BarCode": "sample string 5",
    "PackStepSize": 1,
    "PackInfo1": 1,
    "PackInfo2": 1,
    "PackInfo3": 1,
    "PackInfoLabel1": "sample string 6",
    "PackInfoLabel2": "sample string 7",
    "PackInfoLabel3": "sample string 8",
    "UsePackForQuantityTable": true,
    "PackSizeEditable": true,
    "PackLabel": "sample string 9",
    "MinimumQuantity": 1,
    "Inventory": 10,
    "Categories": [
      {
        "CategoryID": 1,
        "Name": "sample string 2",
        "ParentCategoryID": 3,
        "DisplayOrder": 4
      },
      {
        "CategoryID": 1,
        "Name": "sample string 2",
        "ParentCategoryID": 3,
        "DisplayOrder": 4
      }
    ],
    "Sections": [
      {
        "SectionID": 1,
        "Name": "sample string 2",
        "ParentSectionID": 3,
        "DisplayOrder": 4
      },
      {
        "SectionID": 1,
        "Name": "sample string 2",
        "ParentSectionID": 3,
        "DisplayOrder": 4
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfProductS xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iCircleCommon">
  <ProductS>
    <BarCode>sample string 5</BarCode>
    <Categories>
      <CategoryS>
        <CategoryID>1</CategoryID>
        <DisplayOrder>4</DisplayOrder>
        <Name>sample string 2</Name>
        <ParentCategoryID>3</ParentCategoryID>
      </CategoryS>
      <CategoryS>
        <CategoryID>1</CategoryID>
        <DisplayOrder>4</DisplayOrder>
        <Name>sample string 2</Name>
        <ParentCategoryID>3</ParentCategoryID>
      </CategoryS>
    </Categories>
    <Inventory>10</Inventory>
    <Inventory2>1</Inventory2>
    <Inventory3>1</Inventory3>
    <InventoryDate>2026-07-10T16:59:09.36191+02:00</InventoryDate>
    <MinimumQuantity>1</MinimumQuantity>
    <Name>sample string 2</Name>
    <PackInfo1>1</PackInfo1>
    <PackInfo2>1</PackInfo2>
    <PackInfo3>1</PackInfo3>
    <PackInfoLabel1>sample string 6</PackInfoLabel1>
    <PackInfoLabel2>sample string 7</PackInfoLabel2>
    <PackInfoLabel3>sample string 8</PackInfoLabel3>
    <PackLabel>sample string 9</PackLabel>
    <PackSize>1</PackSize>
    <PackSizeEditable>true</PackSizeEditable>
    <PackStepSize>1</PackStepSize>
    <Price>4</Price>
    <ProductID>1</ProductID>
    <QuantityDiscountID>1</QuantityDiscountID>
    <SKU>sample string 3</SKU>
    <Sections>
      <SectionS>
        <DisplayOrder>4</DisplayOrder>
        <Name>sample string 2</Name>
        <ParentSectionID>3</ParentSectionID>
        <SectionID>1</SectionID>
      </SectionS>
      <SectionS>
        <DisplayOrder>4</DisplayOrder>
        <Name>sample string 2</Name>
        <ParentSectionID>3</ParentSectionID>
        <SectionID>1</SectionID>
      </SectionS>
    </Sections>
    <UsePackForQuantityTable>true</UsePackForQuantityTable>
  </ProductS>
  <ProductS>
    <BarCode>sample string 5</BarCode>
    <Categories>
      <CategoryS>
        <CategoryID>1</CategoryID>
        <DisplayOrder>4</DisplayOrder>
        <Name>sample string 2</Name>
        <ParentCategoryID>3</ParentCategoryID>
      </CategoryS>
      <CategoryS>
        <CategoryID>1</CategoryID>
        <DisplayOrder>4</DisplayOrder>
        <Name>sample string 2</Name>
        <ParentCategoryID>3</ParentCategoryID>
      </CategoryS>
    </Categories>
    <Inventory>10</Inventory>
    <Inventory2>1</Inventory2>
    <Inventory3>1</Inventory3>
    <InventoryDate>2026-07-10T16:59:09.36191+02:00</InventoryDate>
    <MinimumQuantity>1</MinimumQuantity>
    <Name>sample string 2</Name>
    <PackInfo1>1</PackInfo1>
    <PackInfo2>1</PackInfo2>
    <PackInfo3>1</PackInfo3>
    <PackInfoLabel1>sample string 6</PackInfoLabel1>
    <PackInfoLabel2>sample string 7</PackInfoLabel2>
    <PackInfoLabel3>sample string 8</PackInfoLabel3>
    <PackLabel>sample string 9</PackLabel>
    <PackSize>1</PackSize>
    <PackSizeEditable>true</PackSizeEditable>
    <PackStepSize>1</PackStepSize>
    <Price>4</Price>
    <ProductID>1</ProductID>
    <QuantityDiscountID>1</QuantityDiscountID>
    <SKU>sample string 3</SKU>
    <Sections>
      <SectionS>
        <DisplayOrder>4</DisplayOrder>
        <Name>sample string 2</Name>
        <ParentSectionID>3</ParentSectionID>
        <SectionID>1</SectionID>
      </SectionS>
      <SectionS>
        <DisplayOrder>4</DisplayOrder>
        <Name>sample string 2</Name>
        <ParentSectionID>3</ParentSectionID>
        <SectionID>1</SectionID>
      </SectionS>
    </Sections>
    <UsePackForQuantityTable>true</UsePackForQuantityTable>
  </ProductS>
</ArrayOfProductS>