Get part details for a single part.
Endpoint:
GET v1/Part/{id}?format={format}&dealerPricing={dealerPricing}&allWarehouses={allWarehouses}&zipCode={zipCode}&warehouseId={warehouseId}&includeUnavailable={includeUnavailable}
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
Part Id |
string |
Required |
format | string |
Default value is json |
|
dealerPricing |
1 - include dealer pricing |
byte |
Default value is 0 |
allWarehouses |
1 - include pricing for all warehouses |
byte |
Default value is 0 |
zipCode |
If provided, the API will return price break information for the nearest warehouse |
string |
None. |
warehouseId |
If provided, the API will return price break information for the given warehouse |
string |
None. |
includeUnavailable |
0 - Returns only parts that are not on seasonal outage [Default] 1 - Include all parts regardless of seasonal outages |
byte |
Default value is 0 |
Body Parameters
None.
Response Information
PartApiName | Description | Type | Additional information |
---|---|---|---|
Id | string |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
WebDescription | string |
None. |
|
PartFamilyId | integer |
None. |
|
PartFamilyWebId | string |
None. |
|
PartFamilyName | string |
None. |
|
CategoryId | string |
None. |
|
CategoryWebId | string |
None. |
|
CategoryName | string |
None. |
|
BrandId | string |
None. |
|
BrandWebId | string |
None. |
|
BrandName | string |
None. |
|
NewDate | date |
None. |
|
ImageName | string |
None. |
|
ImageThumb | string |
None. |
|
ImageMedium | string |
None. |
|
ImageFamilyName | string |
None. |
|
ImageFamilyThumb | string |
None. |
|
ImageFamilyMedium | string |
None. |
|
WebUrl | string |
None. |
|
SoldInQuantitiesOf | string |
None. |
|
Looks | integer |
None. |
|
Discontinued | byte |
None. |
|
Signature | byte |
None. |
|
Exclusive | byte |
None. |
|
Ium | string |
None. |
|
VolumeUom | string |
None. |
|
WeightUom | string |
None. |
|
StockCodeIml | string |
None. |
|
StockCodeMar | string |
None. |
|
StockCodeLaw | string |
None. |
|
StockCodeTra | string |
None. |
|
StockCodeTyl | string |
None. |
|
StockCodeGre | string |
None. |
|
StockCodeMxm | string |
None. |
|
StockCodeLeb | string |
None. |
|
StockCodeStb | string |
None. |
|
StockIml | integer |
None. |
|
StockMar | integer |
None. |
|
StockLaw | integer |
None. |
|
StockTra | integer |
None. |
|
StockTyl | integer |
None. |
|
StockGre | integer |
None. |
|
StockMxm | integer |
None. |
|
StockLeb | integer |
None. |
|
StockStb | integer |
None. |
|
StockTotal | integer |
None. |
|
NoUps | byte |
None. |
|
UlEtl | string |
None. |
|
EpaNum | string |
None. |
|
IsSale | byte |
None. |
|
IsNew | byte |
None. |
|
IsSecond | byte |
None. |
|
EachUpc | string |
None. |
|
EachMsrp | decimal number |
None. |
|
EachPrice | decimal number |
None. |
|
EachVolume | string |
None. |
|
EachDimWeight | string |
None. |
|
EachWeight | string |
None. |
|
EachLength | string |
None. |
|
EachWidth | string |
None. |
|
EachHeight | string |
None. |
|
CaseUpc | string |
None. |
|
CaseQuantity | string |
None. |
|
CaseVolume | string |
None. |
|
CaseDimWeight | string |
None. |
|
CaseWeight | string |
None. |
|
CaseLength | string |
None. |
|
CaseWidth | string |
None. |
|
CaseHeight | string |
None. |
|
PalletUpc | string |
None. |
|
PalletQuantity | string |
None. |
|
PalletVolume | string |
None. |
|
PalletDimWeight | string |
None. |
|
PalletWeight | string |
None. |
|
PalletLength | string |
None. |
|
PalletWidth | string |
None. |
|
PalletHeight | string |
None. |
|
Warranty | string |
None. |
|
Hazmat | byte |
None. |
|
Prop65 | byte |
None. |
|
LegacyPartId | string |
None. |
Response Examples
application/json, text/json :
{ "Id": "sample string 1", "Name": "sample string 2", "Description": "sample string 3", "WebDescription": "sample string 4", "PartFamilyId": 5, "PartFamilyWebId": "sample string 6", "PartFamilyName": "sample string 7", "CategoryId": "sample string 8", "CategoryWebId": "sample string 9", "CategoryName": "sample string 10", "BrandId": "sample string 11", "BrandWebId": "sample string 12", "BrandName": "sample string 13", "NewDate": "2025-05-13T10:25:07.6374245-07:00", "ImageName": "sample string 15", "ImageThumb": "https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 16", "ImageMedium": "https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 17", "ImageFamilyName": "sample string 18", "ImageFamilyThumb": "https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 19", "ImageFamilyMedium": "https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 20", "WebUrl": "sample string 21", "SoldInQuantitiesOf": "sample string 22", "Looks": 23, "Discontinued": 64, "Signature": 64, "Exclusive": 64, "Ium": "sample string 27", "VolumeUom": "sample string 28", "WeightUom": "sample string 29", "StockCodeIml": "sample string 30", "StockCodeMar": "sample string 31", "StockCodeLaw": "sample string 32", "StockCodeTra": "sample string 33", "StockCodeTyl": "sample string 34", "StockCodeGre": "sample string 35", "StockCodeMxm": "sample string 36", "StockCodeLeb": "sample string 37", "StockCodeStb": "sample string 38", "StockIml": 1, "StockMar": 1, "StockLaw": 1, "StockTra": 1, "StockTyl": 1, "StockGre": 1, "StockMxm": 1, "StockLeb": 1, "StockStb": 1, "StockTotal": 1, "NoUps": 64, "UlEtl": "sample string 40", "EpaNum": "sample string 41", "IsSale": 64, "IsNew": 64, "IsSecond": 64, "EachUpc": "sample string 45", "EachMsrp": 46.0, "EachPrice": 1.0, "EachVolume": "sample string 47", "EachDimWeight": "sample string 48", "EachWeight": "sample string 49", "EachLength": "sample string 50", "EachWidth": "sample string 51", "EachHeight": "sample string 52", "CaseUpc": "sample string 53", "CaseQuantity": "sample string 54", "CaseVolume": "sample string 55", "CaseDimWeight": "sample string 56", "CaseWeight": "sample string 57", "CaseLength": "sample string 58", "CaseWidth": "sample string 59", "CaseHeight": "sample string 60", "PalletUpc": "sample string 61", "PalletQuantity": "sample string 62", "PalletVolume": "sample string 63", "PalletDimWeight": "sample string 64", "PalletWeight": "sample string 65", "PalletLength": "sample string 66", "PalletWidth": "sample string 67", "PalletHeight": "sample string 68", "Warranty": "sample string 69", "Hazmat": 64, "Prop65": 64, "LegacyPartId": "sample string 72" }
text/javascript :
{"Id":"sample string 1","Name":"sample string 2","Description":"sample string 3","WebDescription":"sample string 4","PartFamilyId":5,"PartFamilyWebId":"sample string 6","PartFamilyName":"sample string 7","CategoryId":"sample string 8","CategoryWebId":"sample string 9","CategoryName":"sample string 10","BrandId":"sample string 11","BrandWebId":"sample string 12","BrandName":"sample string 13","NewDate":"2025-05-13T10:25:07.6374245-07:00","ImageName":"sample string 15","ImageThumb":"https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 16","ImageMedium":"https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 17","ImageFamilyName":"sample string 18","ImageFamilyThumb":"https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 19","ImageFamilyMedium":"https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 20","WebUrl":"sample string 21","SoldInQuantitiesOf":"sample string 22","Looks":23,"Discontinued":64,"Signature":64,"Exclusive":64,"Ium":"sample string 27","VolumeUom":"sample string 28","WeightUom":"sample string 29","StockCodeIml":"sample string 30","StockCodeMar":"sample string 31","StockCodeLaw":"sample string 32","StockCodeTra":"sample string 33","StockCodeTyl":"sample string 34","StockCodeGre":"sample string 35","StockCodeMxm":"sample string 36","StockCodeLeb":"sample string 37","StockCodeStb":"sample string 38","StockIml":1,"StockMar":1,"StockLaw":1,"StockTra":1,"StockTyl":1,"StockGre":1,"StockMxm":1,"StockLeb":1,"StockStb":1,"StockTotal":1,"NoUps":64,"UlEtl":"sample string 40","EpaNum":"sample string 41","IsSale":64,"IsNew":64,"IsSecond":64,"EachUpc":"sample string 45","EachMsrp":46.0,"EachPrice":1.0,"EachVolume":"sample string 47","EachDimWeight":"sample string 48","EachWeight":"sample string 49","EachLength":"sample string 50","EachWidth":"sample string 51","EachHeight":"sample string 52","CaseUpc":"sample string 53","CaseQuantity":"sample string 54","CaseVolume":"sample string 55","CaseDimWeight":"sample string 56","CaseWeight":"sample string 57","CaseLength":"sample string 58","CaseWidth":"sample string 59","CaseHeight":"sample string 60","PalletUpc":"sample string 61","PalletQuantity":"sample string 62","PalletVolume":"sample string 63","PalletDimWeight":"sample string 64","PalletWeight":"sample string 65","PalletLength":"sample string 66","PalletWidth":"sample string 67","PalletHeight":"sample string 68","Warranty":"sample string 69","Hazmat":64,"Prop65":64,"LegacyPartId":"sample string 72"}
application/xml, text/xml :
<PartApi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models"> <BrandId>sample string 11</BrandId> <BrandName>sample string 13</BrandName> <BrandWebId>sample string 12</BrandWebId> <CaseDimWeight>sample string 56</CaseDimWeight> <CaseHeight>sample string 60</CaseHeight> <CaseLength>sample string 58</CaseLength> <CaseQuantity>sample string 54</CaseQuantity> <CaseUpc>sample string 53</CaseUpc> <CaseVolume>sample string 55</CaseVolume> <CaseWeight>sample string 57</CaseWeight> <CaseWidth>sample string 59</CaseWidth> <CategoryId>sample string 8</CategoryId> <CategoryName>sample string 10</CategoryName> <CategoryWebId>sample string 9</CategoryWebId> <Description>sample string 3</Description> <Discontinued>64</Discontinued> <EachDimWeight>sample string 48</EachDimWeight> <EachHeight>sample string 52</EachHeight> <EachLength>sample string 50</EachLength> <EachMsrp>46</EachMsrp> <EachPrice>1</EachPrice> <EachUpc>sample string 45</EachUpc> <EachVolume>sample string 47</EachVolume> <EachWeight>sample string 49</EachWeight> <EachWidth>sample string 51</EachWidth> <EpaNum>sample string 41</EpaNum> <Exclusive>64</Exclusive> <Hazmat>64</Hazmat> <Id>sample string 1</Id> <ImageFamilyMedium>https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 20</ImageFamilyMedium> <ImageFamilyName>sample string 18</ImageFamilyName> <ImageFamilyThumb>https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 19</ImageFamilyThumb> <ImageMedium>https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 17</ImageMedium> <ImageName>sample string 15</ImageName> <ImageThumb>https://scotts-hawthorne-public-prod.s3-us-west-2.amazonaws.com/PROD/sample string 16</ImageThumb> <IsNew>64</IsNew> <IsSale>64</IsSale> <IsSecond>64</IsSecond> <Ium>sample string 27</Ium> <LegacyPartId>sample string 72</LegacyPartId> <Looks>23</Looks> <Name>sample string 2</Name> <NewDate>2025-05-13T10:25:07.6374245-07:00</NewDate> <NoUps>64</NoUps> <PalletDimWeight>sample string 64</PalletDimWeight> <PalletHeight>sample string 68</PalletHeight> <PalletLength>sample string 66</PalletLength> <PalletQuantity>sample string 62</PalletQuantity> <PalletUpc>sample string 61</PalletUpc> <PalletVolume>sample string 63</PalletVolume> <PalletWeight>sample string 65</PalletWeight> <PalletWidth>sample string 67</PalletWidth> <PartFamilyId>5</PartFamilyId> <PartFamilyName>sample string 7</PartFamilyName> <PartFamilyWebId>sample string 6</PartFamilyWebId> <Prop65>64</Prop65> <Signature>64</Signature> <SoldInQuantitiesOf>sample string 22</SoldInQuantitiesOf> <StockCodeGre>sample string 35</StockCodeGre> <StockCodeIml>sample string 30</StockCodeIml> <StockCodeLaw>sample string 32</StockCodeLaw> <StockCodeLeb>sample string 37</StockCodeLeb> <StockCodeMar>sample string 31</StockCodeMar> <StockCodeMxm>sample string 36</StockCodeMxm> <StockCodeStb>sample string 38</StockCodeStb> <StockCodeTra>sample string 33</StockCodeTra> <StockCodeTyl>sample string 34</StockCodeTyl> <StockGre>1</StockGre> <StockIml>1</StockIml> <StockLaw>1</StockLaw> <StockLeb>1</StockLeb> <StockMar>1</StockMar> <StockMxm>1</StockMxm> <StockStb>1</StockStb> <StockTotal>1</StockTotal> <StockTra>1</StockTra> <StockTyl>1</StockTyl> <UlEtl>sample string 40</UlEtl> <VolumeUom>sample string 28</VolumeUom> <Warranty>sample string 69</Warranty> <WebDescription>sample string 4</WebDescription> <WebUrl>sample string 21</WebUrl> <WeightUom>sample string 29</WeightUom> </PartApi>