AVB LINQ Public API

ProductDetailRequest

Products

The following routes are available for this service:
GET	/products/{productId}	Gets a Product by Id

**ProductDetailRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ProductId	path	int	No

**ProductDetailResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Product	form	ProductDetailModel	No

**ProductDetailModel** Parameters:
Name	Parameter	Data Type	Required	Description
Sku	form	string	No
BrandId	form	int?	No
BrandName	form	string	No
Name	form	string	No
Description	form	string	No
Price	form	decimal?	No
ProductStatus	form	bool?	No	Product Status override value
FinalProductStatus	form	bool	No	The "actual" (Final) Product Status
Approval	form	bool?	No
Upccode	form	string	No
Visibility	form	int?	No
CreatedDate	form	DateTime?	No
DeletedDate	form	DateTime?	No
Categories	form	List<CategoryStub>	No
Assets	form	List<UPCAsset>	No
CustomFields	form	List<CustomFieldStub>	No
BaseSystemReferencePrice	form	decimal?	No
MAPCompliantPrice	form	decimal?	No
OverridePrice	form	decimal?	No
OverrideStartDate	form	DateTime?	No
OverrideEndDate	form	DateTime?	No
PriceOnApplication	form	string	No
POSM	form	string	No
UseRegularPrice	form	bool	No
FloorModel	form	bool	No
PackageComponents	form	List<PackageComponentViewModel>	No
Promotions	form	List<PromotionStub>	No
SKUAliases	form	List<string>	No

**CategoryStub** Parameters:
Name	Parameter	Data Type	Required
CategoryId	form	long	No
Name	form	string	No
ParentCategoryId	form	long?	No
HasChildren	form	bool	No
ProductsUrl	form	string	No

**UPCAsset** Parameters:
Name	Parameter	Data Type	Required
AssetType	form	string	No
AssetTypeRank	form	int	No
AssetName	form	string	No
AssetDescription	form	string	No
AssetUrl	form	string	No

**CustomFieldStub** Parameters:
Name	Parameter	Data Type	Required
CustomFieldProductId	form	int	No
CustomFieldId	form	int	No
Name	form	string	No
DisplayName	form	string	No
FieldDataType	form	string	No
Value	form	string	No
AccountId	form	int?	No
CustomFieldCategoryId	form	int?	No
IsGlobal	form	bool?	No
IsValueEditable	form	bool?	No

**PackageComponentViewModel** Parameters:
Name	Parameter	Data Type	Required	Description
ProductId	form	int	No
Sku	form	string	No

**PromotionStub** Parameters:
Name	Parameter	Data Type	Required
PromotionName	form	string	No
PromotionPrice	form	decimal?	No
PromotionCompliantPrice	form	decimal?	No
RetailStartDate	form	DateTime?	No
RetailEndDate	form	DateTime?	No

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProductDetailResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.API.DTO">
  <Product xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.API.Models">
    <d2p1:Approval>false</d2p1:Approval>
    <d2p1:Assets>
      <d2p1:UPCAsset>
        <d2p1:AssetDescription>String</d2p1:AssetDescription>
        <d2p1:AssetName>String</d2p1:AssetName>
        <d2p1:AssetType>String</d2p1:AssetType>
        <d2p1:AssetTypeRank>0</d2p1:AssetTypeRank>
        <d2p1:AssetUrl>String</d2p1:AssetUrl>
      </d2p1:UPCAsset>
    </d2p1:Assets>
    <d2p1:BaseSystemReferencePrice>0</d2p1:BaseSystemReferencePrice>
    <d2p1:BrandId>0</d2p1:BrandId>
    <d2p1:BrandName>String</d2p1:BrandName>
    <d2p1:Categories>
      <d2p1:CategoryStub>
        <d2p1:CategoryId>0</d2p1:CategoryId>
        <d2p1:HasChildren>false</d2p1:HasChildren>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:ParentCategoryId>0</d2p1:ParentCategoryId>
        <d2p1:ProductsUrl>String</d2p1:ProductsUrl>
      </d2p1:CategoryStub>
    </d2p1:Categories>
    <d2p1:CreatedDate>0001-01-01T00:00:00</d2p1:CreatedDate>
    <d2p1:CustomFields>
      <d2p1:CustomFieldStub>
        <d2p1:AccountId>0</d2p1:AccountId>
        <d2p1:CustomFieldCategoryId>0</d2p1:CustomFieldCategoryId>
        <d2p1:CustomFieldId>0</d2p1:CustomFieldId>
        <d2p1:CustomFieldProductId>0</d2p1:CustomFieldProductId>
        <d2p1:DisplayName>String</d2p1:DisplayName>
        <d2p1:FieldDataType>String</d2p1:FieldDataType>
        <d2p1:IsGlobal>false</d2p1:IsGlobal>
        <d2p1:IsValueEditable>false</d2p1:IsValueEditable>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Value>String</d2p1:Value>
      </d2p1:CustomFieldStub>
    </d2p1:CustomFields>
    <d2p1:DeletedDate>0001-01-01T00:00:00</d2p1:DeletedDate>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:FinalProductStatus>false</d2p1:FinalProductStatus>
    <d2p1:FloorModel>false</d2p1:FloorModel>
    <d2p1:MAPCompliantPrice>0</d2p1:MAPCompliantPrice>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:OverrideEndDate>0001-01-01T00:00:00</d2p1:OverrideEndDate>
    <d2p1:OverridePrice>0</d2p1:OverridePrice>
    <d2p1:OverrideStartDate>0001-01-01T00:00:00</d2p1:OverrideStartDate>
    <d2p1:POSM>String</d2p1:POSM>
    <d2p1:PackageComponents xmlns:d3p1="http://schemas.datacontract.org/2004/07/Avb.Linq.Common.Contracts.Models">
      <d3p1:PackageComponentViewModel>
        <d3p1:ProductId>0</d3p1:ProductId>
        <d3p1:Sku>String</d3p1:Sku>
      </d3p1:PackageComponentViewModel>
    </d2p1:PackageComponents>
    <d2p1:Price>0</d2p1:Price>
    <d2p1:PriceOnApplication>String</d2p1:PriceOnApplication>
    <d2p1:ProductStatus>false</d2p1:ProductStatus>
    <d2p1:Promotions>
      <d2p1:PromotionStub>
        <d2p1:PromotionCompliantPrice>0</d2p1:PromotionCompliantPrice>
        <d2p1:PromotionName>String</d2p1:PromotionName>
        <d2p1:PromotionPrice>0</d2p1:PromotionPrice>
        <d2p1:RetailEndDate>0001-01-01T00:00:00</d2p1:RetailEndDate>
        <d2p1:RetailStartDate>0001-01-01T00:00:00</d2p1:RetailStartDate>
      </d2p1:PromotionStub>
    </d2p1:Promotions>
    <d2p1:SKUAliases xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:SKUAliases>
    <d2p1:Sku>String</d2p1:Sku>
    <d2p1:Upccode>String</d2p1:Upccode>
    <d2p1:UseRegularPrice>false</d2p1:UseRegularPrice>
    <d2p1:Visibility>0</d2p1:Visibility>
  </Product>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ProductDetailResponse>