POST api/NebimCommon/GetProductBySearch
Request Information
URI Parameters
None.
Body Parameters
ProductPagingRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| SearchText | string |
None. |
|
| Page | integer |
None. |
|
| Limit | integer |
None. |
|
| UserId | string |
None. |
|
| subCurrAccId | string |
None. |
|
| CurrAccCode | string |
None. |
|
| WithInventory | integer |
None. |
|
| WarehouseCode | string |
None. |
|
| CurrencyCode | string |
None. |
|
| PriceGroupCode | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"searchText": "sample string 1",
"page": 2,
"limit": 3,
"userId": "sample string 4",
"subCurrAccId": "sample string 5",
"currAccCode": "sample string 6",
"withInventory": 7,
"warehouseCode": "sample string 8",
"currencyCode": "sample string 9",
"priceGroupCode": "sample string 10"
}
application/xml, text/xml
Sample:
<ProductPagingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VolisServer.DTOs.Request"> <CurrAccCode>sample string 6</CurrAccCode> <CurrencyCode>sample string 9</CurrencyCode> <Limit>3</Limit> <Page>2</Page> <PriceGroupCode>sample string 10</PriceGroupCode> <SearchText>sample string 1</SearchText> <UserId>sample string 4</UserId> <WarehouseCode>sample string 8</WarehouseCode> <WithInventory>7</WithInventory> <subCurrAccId>sample string 5</subCurrAccId> </ProductPagingRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseModelOfListOfProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| Errors | Collection of string |
None. |
|
| Code | integer |
None. |
|
| Data | Collection of Product |
None. |
|
| Warning | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"success": true,
"message": "sample string 2",
"errors": [
"sample string 1",
"sample string 2"
],
"code": 3,
"data": [
{
"itemTypeCode": 64,
"itemCode": "sample string 1",
"itemDescription": "sample string 2",
"colorCode": "sample string 3",
"colorDescription": "sample string 4",
"itemDim1Code": "sample string 5",
"itemDim2Code": "sample string 6",
"itemDim3Code": "sample string 7",
"barcode": "sample string 8",
"qty": 1.0,
"vatRate": 1,
"priceCurrencyCode": "sample string 9",
"price": 1.0,
"lotCode": "sample string 10",
"inventory": 11.0,
"useSerialNumber": true,
"useContainerNumber": true,
"useLotNumber": true,
"useExpirationDate": true,
"useEarliestShippingDate": true,
"useProductionDate": true,
"useCapQty": true
},
{
"itemTypeCode": 64,
"itemCode": "sample string 1",
"itemDescription": "sample string 2",
"colorCode": "sample string 3",
"colorDescription": "sample string 4",
"itemDim1Code": "sample string 5",
"itemDim2Code": "sample string 6",
"itemDim3Code": "sample string 7",
"barcode": "sample string 8",
"qty": 1.0,
"vatRate": 1,
"priceCurrencyCode": "sample string 9",
"price": 1.0,
"lotCode": "sample string 10",
"inventory": 11.0,
"useSerialNumber": true,
"useContainerNumber": true,
"useLotNumber": true,
"useExpirationDate": true,
"useEarliestShippingDate": true,
"useProductionDate": true,
"useCapQty": true
}
],
"warning": true
}
application/xml, text/xml
Sample:
<ResponseModelOfArrayOfProductlmxkWvTr xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VolisServer.CustomClasses">
<Code>3</Code>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/VolisServer.Domain.ErpEntities">
<d2p1:Product>
<d2p1:Barcode>sample string 8</d2p1:Barcode>
<d2p1:ColorCode>sample string 3</d2p1:ColorCode>
<d2p1:ColorDescription>sample string 4</d2p1:ColorDescription>
<d2p1:Inventory>11</d2p1:Inventory>
<d2p1:ItemCode>sample string 1</d2p1:ItemCode>
<d2p1:ItemDescription>sample string 2</d2p1:ItemDescription>
<d2p1:ItemDim1Code>sample string 5</d2p1:ItemDim1Code>
<d2p1:ItemDim2Code>sample string 6</d2p1:ItemDim2Code>
<d2p1:ItemDim3Code>sample string 7</d2p1:ItemDim3Code>
<d2p1:ItemTypeCode>64</d2p1:ItemTypeCode>
<d2p1:LotCode>sample string 10</d2p1:LotCode>
<d2p1:Price>1</d2p1:Price>
<d2p1:PriceCurrencyCode>sample string 9</d2p1:PriceCurrencyCode>
<d2p1:Qty>1</d2p1:Qty>
<d2p1:UseCapQty>true</d2p1:UseCapQty>
<d2p1:UseContainerNumber>true</d2p1:UseContainerNumber>
<d2p1:UseEarliestShippingDate>true</d2p1:UseEarliestShippingDate>
<d2p1:UseExpirationDate>true</d2p1:UseExpirationDate>
<d2p1:UseLotNumber>true</d2p1:UseLotNumber>
<d2p1:UseProductionDate>true</d2p1:UseProductionDate>
<d2p1:UseSerialNumber>true</d2p1:UseSerialNumber>
<d2p1:VatRate>1</d2p1:VatRate>
</d2p1:Product>
<d2p1:Product>
<d2p1:Barcode>sample string 8</d2p1:Barcode>
<d2p1:ColorCode>sample string 3</d2p1:ColorCode>
<d2p1:ColorDescription>sample string 4</d2p1:ColorDescription>
<d2p1:Inventory>11</d2p1:Inventory>
<d2p1:ItemCode>sample string 1</d2p1:ItemCode>
<d2p1:ItemDescription>sample string 2</d2p1:ItemDescription>
<d2p1:ItemDim1Code>sample string 5</d2p1:ItemDim1Code>
<d2p1:ItemDim2Code>sample string 6</d2p1:ItemDim2Code>
<d2p1:ItemDim3Code>sample string 7</d2p1:ItemDim3Code>
<d2p1:ItemTypeCode>64</d2p1:ItemTypeCode>
<d2p1:LotCode>sample string 10</d2p1:LotCode>
<d2p1:Price>1</d2p1:Price>
<d2p1:PriceCurrencyCode>sample string 9</d2p1:PriceCurrencyCode>
<d2p1:Qty>1</d2p1:Qty>
<d2p1:UseCapQty>true</d2p1:UseCapQty>
<d2p1:UseContainerNumber>true</d2p1:UseContainerNumber>
<d2p1:UseEarliestShippingDate>true</d2p1:UseEarliestShippingDate>
<d2p1:UseExpirationDate>true</d2p1:UseExpirationDate>
<d2p1:UseLotNumber>true</d2p1:UseLotNumber>
<d2p1:UseProductionDate>true</d2p1:UseProductionDate>
<d2p1:UseSerialNumber>true</d2p1:UseSerialNumber>
<d2p1:VatRate>1</d2p1:VatRate>
</d2p1:Product>
</Data>
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<Message>sample string 2</Message>
<Success>true</Success>
<Warning>true</Warning>
</ResponseModelOfArrayOfProductlmxkWvTr>