Get a product by unique name

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

Request
query Parameters
uniqueName
required
string

Unique name of the product

statusSeed
required
string

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.

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.

Responses
200

Success

500

Internal Server Error

get/ProductService.svc/rest/GetProductByUniqueName
Response samples
{
  • "Id": 0,
  • "Name": "string",
  • "Description": "string",
  • "PartNo": "string",
  • "SubHeader": "string",
  • "Manufacturer": {
    },
  • "Image": "string",
  • "CampaignImage": "string",
  • "LargeImage": "string",
  • "ThumbnailImage": "string",
  • "Files": [
    ],
  • "FlagIdSeed": "string",
  • "Price": 0,
  • "PriceCatalog": 0,
  • "PriceRecommended": 0,
  • "PriceFreight": 0,
  • "PriceFreightVatRate": 0,
  • "VatRate": 0,
  • "RecommendedQuantity": 0,
  • "OnHand": {
    },
  • "OnHandStore": {
    },
  • "OnHandSupplier": {
    },
  • "Variants": [
    ],
  • "PriceListId": 0,
  • "Key": "string",
  • "Updated": "2019-08-24T14:15:22Z",
  • "NavigationNodeKey": "string",
  • "CategoryId": 0,
  • "CategoryName": "string",
  • "ImageKey": "string",
  • "VariantParametrics": [
    ],
  • "StatusId": 0,
  • "MetaTags": "string",
  • "MetaDescription": "string",
  • "VariantName": "string",
  • "DescriptionHeader": "string",
  • "UniqueName": "string",
  • "StockDisplayBreakPoint": 0,
  • "Parametrics": [
    ],
  • "Families": [
    ],
  • "IsBuyable": true,
  • "SubDescription": "string",
  • "Uom": "string",
  • "UomCount": 0,
  • "EanCode": "string",
  • "Type": 0,
  • "Categories": [
    ],
  • "IsRecommendedQuantityFixed": true,
  • "PopularityRank": 0,
  • "CostPurchase": 0,
  • "CostUnit": 0,
  • "Title": "string",
  • "ActualWeight": 0,
  • "CommodityCode": "string",
  • "IsDropShipOnly": true,
  • "Synonyms": "string",
  • "IsSubscribable": true,
  • "UnspscCode": "string",
  • "PriceStandard": 0,
  • "Width": 0,
  • "Height": 0,
  • "Depth": 0,
  • "IsDangerousGoods": true,
  • "HasQuantityBreaks": true,
  • "GroupByKey": "string",
  • "PriceIncVat": 0
}