GET api/Product/{id}?type={type}
Gets a list of product.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Organization Id, Product Tag Id, Product Id. |
integer |
Required |
| type |
List Type. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of Product| Name | Description | Type | Additional information |
|---|---|---|---|
| UpdateType | string |
None. |
|
| InventoryAdjustmentReason | string |
None. |
|
| NewInventoryCount | integer |
None. |
|
| ItemId | integer |
None. |
|
| Name | string |
None. |
|
| Sku | string |
None. |
|
| SupplierId | integer |
None. |
|
| Supplier | string |
None. |
|
| ProductTypeId | integer |
None. |
|
| ProductType | string |
None. |
|
| UpdatedDate | date |
None. |
|
| UpdatedBy | string |
None. |
|
| UpdatedByName | string |
None. |
|
| GlobalId | string |
None. |
|
| BrandId | integer |
None. |
|
| Brand | string |
None. |
|
| PricePerUnitSale | decimal number |
None. |
|
| PricePerUnitPurchase | decimal number |
None. |
|
| Code | string |
None. |
|
| InventoryCount | integer |
None. |
|
| IsInventory | boolean |
None. |
|
| ItemStatusId | integer |
None. |
|
| ItemStatus | string |
None. |
|
| Description | string |
None. |
|
| Tags | string |
None. |
|
| TagIds | string |
None. |
|
| ProfilePhotoUrl | string |
None. |
|
| ProfilePhotoUrlM | string |
None. |
|
| ProfilePhotoUrlS | string |
None. |
|
| NameWithSku | string |
None. |
|
| ReorderCount | integer |
None. |
|
| Author | string |
None. |
|
| Isbn | string |
None. |
|
| Isbn13 | string |
None. |
|
| IsStoreDisplay | boolean |
None. |
|
| SortOrder | integer |
None. |
|
| IsFeatured | boolean |
None. |
|
| SearchName | string |
None. |
|
| SearchKeyword | string |
None. |
|
| OrganizationId | integer |
None. |
|
| CreatedBy | string |
None. |
|
| ProfilePhoto | string |
None. |
|
| IsQuoteItem | integer |
None. |
|
| AutoCompleteText | string |
None. |
|
| ItemParentChildGlobalId | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"UpdateType": "sample string 1",
"InventoryAdjustmentReason": "sample string 2",
"NewInventoryCount": 3,
"ItemId": 4,
"Name": "sample string 5",
"Sku": "sample string 6",
"SupplierId": 1,
"Supplier": "sample string 7",
"ProductTypeId": 1,
"ProductType": "sample string 8",
"UpdatedDate": "2025-12-12T12:01:28.9392892+00:00",
"UpdatedBy": "sample string 9",
"UpdatedByName": "sample string 10",
"GlobalId": "sample string 11",
"BrandId": 1,
"Brand": "sample string 12",
"PricePerUnitSale": 1.0,
"PricePerUnitPurchase": 1.0,
"Code": "sample string 13",
"InventoryCount": 1,
"IsInventory": true,
"ItemStatusId": 1,
"ItemStatus": "sample string 14",
"Description": "sample string 15",
"Tags": "sample string 16",
"TagIds": "sample string 17",
"ProfilePhotoUrl": "sample string 18",
"ProfilePhotoUrlM": "sample string 19",
"ProfilePhotoUrlS": "sample string 20",
"NameWithSku": "sample string 21",
"ReorderCount": 1,
"Author": "sample string 22",
"Isbn": "sample string 23",
"Isbn13": "sample string 24",
"IsStoreDisplay": true,
"SortOrder": 26,
"IsFeatured": true,
"SearchName": "sample string 28",
"SearchKeyword": "sample string 29",
"OrganizationId": 1,
"CreatedBy": "sample string 30",
"ProfilePhoto": "sample string 31",
"IsQuoteItem": 32,
"AutoCompleteText": "sample string 33",
"ItemParentChildGlobalId": "sample string 34"
},
{
"UpdateType": "sample string 1",
"InventoryAdjustmentReason": "sample string 2",
"NewInventoryCount": 3,
"ItemId": 4,
"Name": "sample string 5",
"Sku": "sample string 6",
"SupplierId": 1,
"Supplier": "sample string 7",
"ProductTypeId": 1,
"ProductType": "sample string 8",
"UpdatedDate": "2025-12-12T12:01:28.9392892+00:00",
"UpdatedBy": "sample string 9",
"UpdatedByName": "sample string 10",
"GlobalId": "sample string 11",
"BrandId": 1,
"Brand": "sample string 12",
"PricePerUnitSale": 1.0,
"PricePerUnitPurchase": 1.0,
"Code": "sample string 13",
"InventoryCount": 1,
"IsInventory": true,
"ItemStatusId": 1,
"ItemStatus": "sample string 14",
"Description": "sample string 15",
"Tags": "sample string 16",
"TagIds": "sample string 17",
"ProfilePhotoUrl": "sample string 18",
"ProfilePhotoUrlM": "sample string 19",
"ProfilePhotoUrlS": "sample string 20",
"NameWithSku": "sample string 21",
"ReorderCount": 1,
"Author": "sample string 22",
"Isbn": "sample string 23",
"Isbn13": "sample string 24",
"IsStoreDisplay": true,
"SortOrder": 26,
"IsFeatured": true,
"SearchName": "sample string 28",
"SearchKeyword": "sample string 29",
"OrganizationId": 1,
"CreatedBy": "sample string 30",
"ProfilePhoto": "sample string 31",
"IsQuoteItem": 32,
"AutoCompleteText": "sample string 33",
"ItemParentChildGlobalId": "sample string 34"
}
]
application/xml, text/xml
Sample:
<ArrayOfProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CustomersdbWebShared.Models">
<Product>
<Author>sample string 22</Author>
<AutoCompleteText>sample string 33</AutoCompleteText>
<Brand>sample string 12</Brand>
<BrandId>1</BrandId>
<Code>sample string 13</Code>
<CreatedBy>sample string 30</CreatedBy>
<Description>sample string 15</Description>
<GlobalId>sample string 11</GlobalId>
<InventoryAdjustmentReason>sample string 2</InventoryAdjustmentReason>
<InventoryCount>1</InventoryCount>
<IsFeatured>true</IsFeatured>
<IsInventory>true</IsInventory>
<IsQuoteItem>32</IsQuoteItem>
<IsStoreDisplay>true</IsStoreDisplay>
<Isbn>sample string 23</Isbn>
<Isbn13>sample string 24</Isbn13>
<ItemId>4</ItemId>
<ItemParentChildGlobalId>sample string 34</ItemParentChildGlobalId>
<ItemStatus>sample string 14</ItemStatus>
<ItemStatusId>1</ItemStatusId>
<Name>sample string 5</Name>
<NameWithSku>sample string 21</NameWithSku>
<NewInventoryCount>3</NewInventoryCount>
<OrganizationId>1</OrganizationId>
<PricePerUnitPurchase>1</PricePerUnitPurchase>
<PricePerUnitSale>1</PricePerUnitSale>
<ProductType>sample string 8</ProductType>
<ProductTypeId>1</ProductTypeId>
<ProfilePhoto>sample string 31</ProfilePhoto>
<ProfilePhotoUrl>sample string 18</ProfilePhotoUrl>
<ProfilePhotoUrlM>sample string 19</ProfilePhotoUrlM>
<ProfilePhotoUrlS>sample string 20</ProfilePhotoUrlS>
<ReorderCount>1</ReorderCount>
<SearchKeyword>sample string 29</SearchKeyword>
<SearchName>sample string 28</SearchName>
<Sku>sample string 6</Sku>
<SortOrder>26</SortOrder>
<Supplier>sample string 7</Supplier>
<SupplierId>1</SupplierId>
<TagIds>sample string 17</TagIds>
<Tags>sample string 16</Tags>
<UpdateType>sample string 1</UpdateType>
<UpdatedBy>sample string 9</UpdatedBy>
<UpdatedByName>sample string 10</UpdatedByName>
<UpdatedDate>2025-12-12T12:01:28.9392892+00:00</UpdatedDate>
</Product>
<Product>
<Author>sample string 22</Author>
<AutoCompleteText>sample string 33</AutoCompleteText>
<Brand>sample string 12</Brand>
<BrandId>1</BrandId>
<Code>sample string 13</Code>
<CreatedBy>sample string 30</CreatedBy>
<Description>sample string 15</Description>
<GlobalId>sample string 11</GlobalId>
<InventoryAdjustmentReason>sample string 2</InventoryAdjustmentReason>
<InventoryCount>1</InventoryCount>
<IsFeatured>true</IsFeatured>
<IsInventory>true</IsInventory>
<IsQuoteItem>32</IsQuoteItem>
<IsStoreDisplay>true</IsStoreDisplay>
<Isbn>sample string 23</Isbn>
<Isbn13>sample string 24</Isbn13>
<ItemId>4</ItemId>
<ItemParentChildGlobalId>sample string 34</ItemParentChildGlobalId>
<ItemStatus>sample string 14</ItemStatus>
<ItemStatusId>1</ItemStatusId>
<Name>sample string 5</Name>
<NameWithSku>sample string 21</NameWithSku>
<NewInventoryCount>3</NewInventoryCount>
<OrganizationId>1</OrganizationId>
<PricePerUnitPurchase>1</PricePerUnitPurchase>
<PricePerUnitSale>1</PricePerUnitSale>
<ProductType>sample string 8</ProductType>
<ProductTypeId>1</ProductTypeId>
<ProfilePhoto>sample string 31</ProfilePhoto>
<ProfilePhotoUrl>sample string 18</ProfilePhotoUrl>
<ProfilePhotoUrlM>sample string 19</ProfilePhotoUrlM>
<ProfilePhotoUrlS>sample string 20</ProfilePhotoUrlS>
<ReorderCount>1</ReorderCount>
<SearchKeyword>sample string 29</SearchKeyword>
<SearchName>sample string 28</SearchName>
<Sku>sample string 6</Sku>
<SortOrder>26</SortOrder>
<Supplier>sample string 7</Supplier>
<SupplierId>1</SupplierId>
<TagIds>sample string 17</TagIds>
<Tags>sample string 16</Tags>
<UpdateType>sample string 1</UpdateType>
<UpdatedBy>sample string 9</UpdatedBy>
<UpdatedByName>sample string 10</UpdatedByName>
<UpdatedDate>2025-12-12T12:01:28.9392892+00:00</UpdatedDate>
</Product>
</ArrayOfProduct>