GET api/Product/GetProduct?productId={productId}
Gets product by productId
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
productId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
BO.Models.Products.ProductBasicName | Description | Type | Additional information |
---|---|---|---|
ProductId | integer |
None. |
|
Name | string |
None. |
|
Size | string |
None. |
|
Quantity | integer |
None. |
|
MinQuantity | integer |
None. |
|
ProductCategoryId | integer |
None. |
|
Active | boolean |
None. |
|
Price | decimal number |
None. |
|
FormattedPrice | string |
None. |
|
LastCost | decimal number |
None. |
|
Description | string |
None. |
|
SellByThe | integer |
None. |
|
OrderByThe | integer |
None. |
|
ImageId | integer |
None. |
|
NZPrice | decimal number |
None. |
|
GBPrice | decimal number |
None. |
|
SmallImage | BO.Image |
None. |
|
MasterPrice | decimal number |
Required Data type: Currency |
|
NZMasterPrice | decimal number |
Required Data type: Currency |
|
GBMasterPrice | decimal number |
Required Data type: Currency |
|
StockLevel | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "ProductId": 1, "Name": "sample string 2", "Size": "sample string 3", "Quantity": 4, "MinQuantity": 5, "ProductCategoryId": 6, "Active": true, "Price": 8.0, "FormattedPrice": "sample string 9", "LastCost": 10.0, "Description": "sample string 11", "SellByThe": 12, "OrderByThe": 13, "ImageId": 14, "NZPrice": 15.0, "GBPrice": 16.0, "SmallImage": { "$id": "2", "ImageId": 1, "Name": "sample string 2", "Alt": "sample string 3", "ProductId": 4, "ContentType": "sample string 5" }, "MasterPrice": 6.4, "NZMasterPrice": 12.0, "GBMasterPrice": 12.8, "StockLevel": 17 }
application/xml, text/xml
Sample:
<ProductBasic xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BO.Models.Products"> <Active>true</Active> <Description>sample string 11</Description> <FormattedPrice>sample string 9</FormattedPrice> <GBPrice>16</GBPrice> <ImageId>14</ImageId> <LastCost>10</LastCost> <MinQuantity>5</MinQuantity> <NZPrice>15</NZPrice> <Name>sample string 2</Name> <OrderByThe>13</OrderByThe> <Price>8</Price> <ProductCategoryId>6</ProductCategoryId> <ProductId>1</ProductId> <Quantity>4</Quantity> <SellByThe>12</SellByThe> <Size>sample string 3</Size> <SmallImage xmlns:d2p1="http://schemas.datacontract.org/2004/07/BO"> <d2p1:Alt>sample string 3</d2p1:Alt> <d2p1:ContentType>sample string 5</d2p1:ContentType> <d2p1:ImageId>1</d2p1:ImageId> <d2p1:Name>sample string 2</d2p1:Name> <d2p1:ProductId>4</d2p1:ProductId> </SmallImage> <StockLevel>17</StockLevel> </ProductBasic>