# Get a product by part no

Gets a Product and its optional variants by partNo. The main product will be based on the product with the supplied partNo, status permitting.

Endpoint: GET /GetProductByPartNo
Version: 1.1

## Query parameters:

  - `partNo` (string, required)
    Part number of the product to get.

  - `statusSeed` (string, required)
    Accepts a comma separated string of Status internal ids. Lookup references in ListStatuses.

  - `storeSeed` (string)
    Accepts a comma separated string of store internal ids. The StoreOnHand property of the product will show the onHand values for supplied Stores if supplied.

  - `pricelistSeed` (string)
    A comma separated list of PriceList internal ids to use, if any. PriceLists supplied must be valid, either from the application's public priceList or any customer or company priceLists or any valid client priceLists. For clients configured to use priceListSeed exclusively in the API only the supplied priceLists will be used. If this is not configured, the supplied priceLists will be appended to the valid priceLists. If none is supplied, the default value for the application will be used in combination with any customer or company priceLists. This applies to both configurations.

  - `customerId` (string)
    Customer internal id. Checks for specific customer bound prices if provided.

  - `companyId` (string)
    Company internal id. Checks for specific company bound prices if provided. Note! customerId is mandatory in combination with companyId.

  - `cultureCode` (string)
    Specifies in which language to display culture specific information. If none is supplied, value is resolved from Application.

  - `currencyId` (string)
    Specifies in which currency to display prices. Uses Storm internal ids. If none is supplied, value is resolved from Application.

  - `salesAreaId` (string)
    Specifies the SalesArea to use. Uses Storm internal ids. If none is supplied, primary SalesArea on Application will be used.

## Response 200 fields (application/json):

  - `Id` (integer)
    Internal id of the product.

  - `Name` (string)
    The name of the product. When Product is a VariantType, this will be the value of the variant parameter(s). MaxLength: 255.

  - `Description` (string)
    Description of the product. MaxLength: max.

  - `PartNo` (string)
    Contains the partNo if the product is not a variant or if the product is fetched by PartNo or VariantUniqueName. If the product has a value here then the selected variant can be found by either PartNo or by Id. MaxLength: 50.

  - `SubHeader` (string)
    MaxLength: 25.

  - `Manufacturer` (object)

  - `Manufacturer.Id` (integer)
    Internal id of manufacturer.

  - `Manufacturer.Name` (string)
    MaxLength: 255.

  - `Manufacturer.PartNo` (string)
    MaxLength: 50.

  - `Manufacturer.LogoPath` (string)
    MaxLength: 255. Obsolete! - Use ImageKey

  - `Manufacturer.LogoKey` (string,null)
    A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{LogoKey}. Preset, height and width can be sent as parameters.

  - `Manufacturer.UniqueName` (string)
    A unique name that can be used in Urls and to get a Manufacturer. GetManufacturer and GetManufacturerByUniqueName gets the same Manufacturer. MaxLength: 255.

  - `Image` (string)
    MaxLength: 255. Obsolete! - Use ImageKey

  - `CampaignImage` (string)
    MaxLength: 255. Obsolete! - Use ImageKey with preset

  - `LargeImage` (string)
    MaxLength: 255. Obsolete! - Use ImageKey with preset

  - `ThumbnailImage` (string)
    MaxLength: 255. Obsolete! - Use ImageKey with preset

  - `Files` (array)
    If viewed on Product level this will be the product specific files. If viewed on a Variant it will be the variant specific files.

  - `Files.Id` (integer)
    This is the file internal id and it defines the kind of file it is. Not to be confused with entity ids. Values are application specific and should be like 'Front image', 'Back image'. See ListFileTypeIds for possible values.

  - `Files.Type` (integer)
    This is the FileTypeId mapped from Storm's predefined types. Types maps to mime types.

  - `Files.Path` (string)
    MaxLength: max. Obsolete! - Use Key

  - `Files.Name` (string)
    This is the Name of the product file. MaxLength: 50.

  - `Files.Description` (string)
    This is the Description of the product file. MaxLength: max.

  - `Files.Key` (string,null)
    A unique id for the file at our image server. Url for images are formed like http://[client specific CDN]/{Key}. Preset, height and width can be sent as parameters.

  - `Files.Extension` (string)
    This is the file type extension for the current file. Can be used to append after image key in url. MaxLength: 50.

  - `Files.Code` (string)
    This is the file's external Code. Can be use as is for grouping files if Id is not adequate. Or any other application specific purpose. MaxLength: 50.

  - `Files.SortOrder` (integer,null)
    This is the sortorder of the file within its file type Id.

  - `Files.ImageAltText` (string)
    Image alt text

  - `FlagIdSeed` (string)
    A comma separated list of flag internal ids. If viewed on Product level this will be the product specific flags. If viewed on a Variant it will be the variant specific flags. MaxLength: max.

  - `Price` (number)
    If viewed on Product level this can be a from-price. It will be the price of the cheapest variant. If viewed on a Variant it will be the variant specific price.

  - `PriceCatalog` (number,null)
    The original price, if specified. Same rules apply as for Price if it is a Product or a Variant.

  - `PriceRecommended` (number,null)
    The rule based price from a priceList, if specified. Same rules apply as for Price if it is a Product or a Variant.

  - `PriceFreight` (number,null)
    Obsolete! - Use ListDeliveryMethodByProduct if this is required.

  - `PriceFreightVatRate` (number,null)
    Obsolete! - Use ListDeliveryMethodByProduct if this is required.

  - `VatRate` (number)
    A rate to multiply with price to get price inc VAT. 25% VAT equals a VatRate of 1.25.

  - `RecommendedQuantity` (number,null)
    Indicates the default value used as quantity when buying the product. If IsRecommendedQuantityFixed is true, only multiples of this quantity should be allowed.

  - `OnHand` (object)

  - `OnHand.Value` (number)
    The aggregated value from all warehouses and locations in the current context (Web, Supplier or Store).

  - `OnHand.IncomingValue` (number)
    The incoming quantity on the next delivery.

  - `OnHand.NextDeliveryDate` (string,null)
    The next delivery data from supplier to client warehouse.

  - `OnHand.LeadtimeDayCount` (integer,null)
    The number of days it takes to ship from the supplier.

  - `OnHand.LastChecked` (string,null)
    When onHand info was last checked. Null if never.

  - `OnHand.IsActive` (boolean)
    Indicate if the product is stocked in a store.

  - `OnHand.IsReturnable` (boolean)
    Indicate if the product is returnable in a store.

  - `OnHand.Info` (array)
    List of IdValues for the OnHand data for this sku warehouse location combination. This will always be null unless fetched with any of the ProductOnHand methods.

  - `OnHand.Info.Id` (integer)
    The internal Id of the Entity. This Id might be different in different tiers such as Stage and Production. Use Code if hard coding is required.

  - `OnHand.Info.Value` (string)
    The Value of the Entity. MaxLength: max.

  - `OnHand.Info.Code` (string)
    The Code of the Entity, if existing. Use this value when hard coding is required. MaxLength: 255.

  - `OnHandStore` (object)

  - `OnHandSupplier` (object)

  - `Variants` (array)
    A list of variants for this Product, if any. If the Product is itself a variant this will be empty.

  - `PriceListId` (integer)

  - `Key` (string)

  - `Updated` (string,null)

  - `NavigationNodeKey` (string,null)

  - `CategoryId` (integer,null)
    Obsolete! - Use Categories

  - `CategoryName` (string)
    MaxLength: 50. Obsolete! - Use Categories

  - `ImageKey` (string,null)
    A unique id for the image at our image server. Url for images are formed like http://[client specific CDN]/{ImageKey}. Preset, height and width can be sent as parameters.

  - `VariantParametrics` (array)
    A list of this product's parametric values. Only used on variants.

  - `VariantParametrics.Name` (string)
    MaxLength: 50.

  - `VariantParametrics.Value` (string)
    MaxLength: max. Obsolete! - Use Value2 with Uom

  - `VariantParametrics.Id` (integer)
    Internal product parametric id.

  - `VariantParametrics.ValueId` (integer,null)
    Parametric value internal id if the parametric type is single list value.

  - `VariantParametrics.Description` (string)

  - `VariantParametrics.ValueDescription` (string)
    MaxLength: max.

  - `VariantParametrics.IsPrimary` (boolean)

  - `VariantParametrics.ValueIdSeed` (string)
    MaxLength: max.

  - `VariantParametrics.Value2` (string)
    The parametric value, if not a ListValue or a MultiValue parametric. MaxLength: max.

  - `VariantParametrics.Uom` (string)
    The unit of measurement, if any. MaxLength: 50.

  - `VariantParametrics.GroupId` (integer)
    Id of the parametric group.

  - `VariantParametrics.GroupName` (string)
    Name of the parametric group. MaxLength: 50.

  - `VariantParametrics.SortOrder` (integer)
    Use this to sort the parametric. The value is fetched from the variant group type's sort order in the first place and then from the category's sort order for the parametric values.

  - `VariantParametrics.Code` (string)
    An external application specific code use to identify this Parametric. MaxLength: 50.

  - `VariantParametrics.IsHidden` (boolean)
    Indicates if the parametric is hidden or not. This can be used to hide parametrics that are only used in application logic. Only non-hidden parametrics should be displayed in the frontend.

  - `StatusId` (integer)

  - `MetaTags` (string)
    Meta tags for SEO optimization. MaxLength: max.

  - `MetaDescription` (string)
    Meta description for SEO optimization. MaxLength: max.

  - `VariantName` (string)
    The complete variant name of the product. MaxLength: 255.

  - `DescriptionHeader` (string)
    DescriptionHeader for the product as specified in Storm Admin. MaxLength: 255.

  - `UniqueName` (string)
    A unique name that can be used in Urls and to get a Product. GetProduct and GetProductByUniqueName gets the same Product. MaxLength: 500.

  - `StockDisplayBreakPoint` (integer,null)
    A value that can be used for display logic regarding OnHand.

  - `Parametrics` (array)
    A list of this product's parametric values. Only Parametric values common to all variants for this product will be here. On Variant level this will contain Parametric values with distinguishing values that are not variant parametric values.

  - `Families` (array)
    A list of this product's families.

  - `Families.Id` (integer)
    The internal Id of the Entity.

  - `Families.Name` (string)
    The Name of the Entity. MaxLength: 50.

  - `Families.Description` (string)
    The Description of the Entity. MaxLength: 500.

  - `Families.Code` (string)
    The Code of the Entity. MaxLength: 50.

  - `IsBuyable` (boolean)
    Indicates if the item is buyable or not. Will always be false if the status is closed. An exception will be thrown if IsBuyable is false and an attempt to buy the item is made. The property can be used to hide or show the buy-button. Note that the value can differ for underlying variants.

  - `SubDescription` (string)
    Sub description from Storm Admin. MaxLength: max.

  - `Uom` (string)
    Short unit of measurement from Storm Admin. MaxLength: 50.

  - `UomCount` (number,null)
    Unit of measurement count

  - `EanCode` (string)
    This will be the EAN code of the selected variant of the product if any. Variants will have this set. MaxLength: 50.

  - `Type` (integer)
    Sku type internal id for this product. Might not be valid if there are variants with different types. Then variants must be examined. Also see ListSkutypes.

  - `Categories` (array)
    A list of categories ordered so the primary category is first.

  - `IsRecommendedQuantityFixed` (boolean)
    If this is set to true only multiples of RecommendedQuantity should be allowed.

  - `PopularityRank` (integer,null)
    A value used to sort items based on popularity. Lower values are more popular.

  - `CostPurchase` (number,null)
    CostPurchase from Storm Admin.

  - `CostUnit` (number,null)
    CostUnit from Storm Admin.

  - `Title` (string)
    Title for the product. As specified in Storm Admin. MaxLength: 255.

  - `ActualWeight` (number)
    Actual weight or gross weight for the product. As specified in Storm Admin.

  - `CommodityCode` (string)
    Commodity code for the product. As specified in Storm Admin.

  - `IsDropShipOnly` (boolean)
    True if this product is for drop ship only. False otherwise.

  - `Synonyms` (string)
    Synonyms from the Product in Storm. Can be used when indexing the product in any search engine. MaxLength: 500.

  - `IsSubscribable` (boolean)
    True if this product can be added to a Subscription. False otherwise.

  - `UnspscCode` (string)
    United Nations Standard Products and Services Code for the product. MaxLength: 50.

  - `PriceStandard` (number,null)
    The standard price, if specified. Same rules apply as for Price if it is a Product or a Variant.

  - `Width` (number,null)
    The logistic width as defined in Storm.

  - `Height` (number,null)
    The logistic height as defined in Storm.

  - `Depth` (number,null)
    The logistic depth as defined in Storm.

  - `IsDangerousGoods` (boolean)
    True if this product is considered as dangerous goods. False otherwise.

  - `HasQuantityBreaks` (boolean)
    True if this product has any quantity breaks. False otherwise.

  - `GroupByKey` (string)
    A key that can be used to group items on product. It is equal to the ProductId for non-variants and equals 'v'+variantId for variants. Should only be used when fetching product lists as variants. MaxLength: int.

  - `PriceIncVat` (number)
    The price including VAT calculated on the server side. Should be used to display prices including VAT.

  - `ImageAltText` (string)
    Default image alt text