POST api/Products/SearchProductItems

Search product items

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PageIndex	Page index	integer	None.
PageSize	Page size	integer	None.
Type	The selected field for searching. Decription is not supported.	ProductFieldTypeEnum	None.
CustomFieldId	Required when Type is Custom. Supported type are Textbox, Url	integer	None.
Value	Text to search. Required. Case insensitiv. Only the exact match is searching.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PageIndex": 0,
  "PageSize": 10,
  "Type": 2,
  "CustomFieldId": null,
  "Value": "Test"
}

application/xml, text/xml

Sample:

<SearchProductItemsPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <CustomFieldId i:nil="true" />
  <PageIndex>0</PageIndex>
  <PageSize>10</PageSize>
  <Type>UserOrCompany</Type>
  <Value>Test</Value>
</SearchProductItemsPost>

Response Information

Resource Description

SearchProductItemsResult

Name	Description	Type	Additional information
ProductItems	A scroll with Product items.	SearchProductItem	None.

Response Formats

application/json, text/json

Sample:

{
  "ProductItems": {
    "PageIndex": 0,
    "PageSize": 10,
    "IsNextPage": false,
    "Items": [
      {
        "Id": 1,
        "UserProviderKey": null,
        "CustomerId": 1,
        "Description": null,
        "IsDisabled": false,
        "Data": [
          {
            "ProductFieldId": 1,
            "StringValue": null,
            "LongValue": null,
            "BoolValue": true,
            "DateValue": null,
            "SelectedItem": null,
            "DoubleValue": null
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<SearchProductItemsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <ProductItems>
    <IsNextPage>false</IsNextPage>
    <Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
      <d3p1:SearchProductItem>
        <d3p1:CustomerId>1</d3p1:CustomerId>
        <d3p1:Data>
          <d3p1:ProductItemFieldData>
            <d3p1:BoolValue>true</d3p1:BoolValue>
            <d3p1:DateValue i:nil="true" />
            <d3p1:DoubleValue i:nil="true" />
            <d3p1:LongValue i:nil="true" />
            <d3p1:ProductFieldId>1</d3p1:ProductFieldId>
            <d3p1:SelectedItem i:nil="true" />
            <d3p1:StringValue i:nil="true" />
          </d3p1:ProductItemFieldData>
        </d3p1:Data>
        <d3p1:Description i:nil="true" />
        <d3p1:Id>1</d3p1:Id>
        <d3p1:IsDisabled>false</d3p1:IsDisabled>
        <d3p1:UserProviderKey i:nil="true" />
      </d3p1:SearchProductItem>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
  </ProductItems>
</SearchProductItemsResult>