AVB LINQ Public API

<back to all web services

ProductDetailRequest

Products
The following routes are available for this service:
GET/products/{productId}Gets a Product by Id
ProductDetailRequest Parameters:
NameParameterData TypeRequiredDescription
ProductIdpathintNo
ProductDetailResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProductformProductDetailModelNo
ProductDetailModel Parameters:
NameParameterData TypeRequiredDescription
SkuformstringNo
BrandIdformint?No
BrandNameformstringNo
NameformstringNo
DescriptionformstringNo
Priceformdecimal?No
ProductStatusformbool?NoProduct Status override value
FinalProductStatusformboolNoThe "actual" (Final) Product Status
Approvalformbool?No
UpccodeformstringNo
Visibilityformint?No
CreatedDateformDateTime?No
DeletedDateformDateTime?No
CategoriesformList<CategoryStub>No
AssetsformList<UPCAsset>No
CustomFieldsformList<CustomFieldStub>No
BaseSystemReferencePriceformdecimal?No
MAPCompliantPriceformdecimal?No
OverridePriceformdecimal?No
OverrideStartDateformDateTime?No
OverrideEndDateformDateTime?No
PriceOnApplicationformstringNo
POSMformstringNo
UseRegularPriceformboolNo
FloorModelformboolNo
PackageComponentsformList<PackageComponentViewModel>No
PromotionsformList<PromotionStub>No
SKUAliasesformList<string>No
CategoryStub Parameters:
NameParameterData TypeRequiredDescription
CategoryIdformlongNo
NameformstringNo
ParentCategoryIdformlong?No
HasChildrenformboolNo
ProductsUrlformstringNo
UPCAsset Parameters:
NameParameterData TypeRequiredDescription
AssetTypeformstringNo
AssetTypeRankformintNo
AssetNameformstringNo
AssetDescriptionformstringNo
AssetUrlformstringNo
CustomFieldStub Parameters:
NameParameterData TypeRequiredDescription
CustomFieldProductIdformintNo
CustomFieldIdformintNo
NameformstringNo
DisplayNameformstringNo
FieldDataTypeformstringNo
ValueformstringNo
AccountIdformint?No
CustomFieldCategoryIdformint?No
IsGlobalformbool?No
IsValueEditableformbool?No
PackageComponentViewModel Parameters:
NameParameterData TypeRequiredDescription
ProductIdformintNo
SkuformstringNo
PromotionStub Parameters:
NameParameterData TypeRequiredDescription
PromotionNameformstringNo
PromotionPriceformdecimal?No
PromotionCompliantPriceformdecimal?No
RetailStartDateformDateTime?No
RetailEndDateformDateTime?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /products/{productId} HTTP/1.1 
Host: avb-pos.avbportal.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"product":{"sku":"String","brandId":0,"brandName":"String","name":"String","description":"String","price":0,"productStatus":false,"finalProductStatus":false,"approval":false,"upccode":"String","visibility":0,"createdDate":"0001-01-01T00:00:00.0000000","deletedDate":"0001-01-01T00:00:00.0000000","categories":[{"categoryId":0,"name":"String","parentCategoryId":0,"hasChildren":false,"productsUrl":"String"}],"assets":[{"assetType":"String","assetTypeRank":0,"assetName":"String","assetDescription":"String","assetUrl":"String"}],"customFields":[{"customFieldProductId":0,"customFieldId":0,"name":"String","displayName":"String","fieldDataType":"String","value":"String","accountId":0,"customFieldCategoryId":0,"isGlobal":false,"isValueEditable":false}],"baseSystemReferencePrice":0,"mapCompliantPrice":0,"overridePrice":0,"overrideStartDate":"0001-01-01T00:00:00.0000000","overrideEndDate":"0001-01-01T00:00:00.0000000","priceOnApplication":"String","posm":"String","useRegularPrice":false,"floorModel":false,"packageComponents":[{"productId":0,"sku":"String"}],"promotions":[{"promotionName":"String","promotionPrice":0,"promotionCompliantPrice":0,"retailStartDate":"0001-01-01T00:00:00.0000000","retailEndDate":"0001-01-01T00:00:00.0000000"}],"skuAliases":["String"]}}