s1 API Host

GetProductAugmentationRequest

The following routes are available for this service:
GET, OPTIONS	/api/admin/productaugmentation/{masterproductid}	Get the Product Augmentation.	User has to be authenticated and admin to retrieve the information.

Parameters:
Name	Parameter	Data Type	Required	Description
masterproductid	path	string	Yes

To override the Content-type in your clients 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.

POST /xml/reply/GetProductAugmentationRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: application/xml
Content-Length: length

<GetProductAugmentationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Admin.ProductAugmentation">
  <MasterProductId>String</MasterProductId>
</GetProductAugmentationRequest>

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

<GetProductAugementationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Admin.ProductAugmentation">
  <ProductAugmentation xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Products">
    <d2p1:AllowTecdocInformation>false</d2p1:AllowTecdocInformation>
    <d2p1:HiddenAssets xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:HiddenAttributes i:nil="true" />
    <d2p1:HideErpDescription>false</d2p1:HideErpDescription>
    <d2p1:MasterProductId>String</d2p1:MasterProductId>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Product>
      <d2p1:Aldoc>
        <d2p1:BrandId>String</d2p1:BrandId>
        <d2p1:BrandName>String</d2p1:BrandName>
        <d2p1:ProductId>String</d2p1:ProductId>
      </d2p1:Aldoc>
      <d2p1:AlfaCode>String</d2p1:AlfaCode>
      <d2p1:ArticleDataId>String</d2p1:ArticleDataId>
      <d2p1:ArticleNo>String</d2p1:ArticleNo>
      <d2p1:AutoElectra>
        <d2p1:BrandIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:ProductId>String</d2p1:ProductId>
      </d2p1:AutoElectra>
      <d2p1:AvailableLinkedWarehouse>0001-01-01T00:00:00</d2p1:AvailableLinkedWarehouse>
      <d2p1:AvailableNextRoute>0001-01-01T00:00:00</d2p1:AvailableNextRoute>
      <d2p1:BoschProductGroupId>String</d2p1:BoschProductGroupId>
      <d2p1:BrandId>String</d2p1:BrandId>
      <d2p1:BrandLabel>Onbekend</d2p1:BrandLabel>
      <d2p1:BrandName>String</d2p1:BrandName>
      <d2p1:BrutoPrice>0</d2p1:BrutoPrice>
      <d2p1:CanBackorder>false</d2p1:CanBackorder>
      <d2p1:CommercialName>String</d2p1:CommercialName>
      <d2p1:CountryCode>String</d2p1:CountryCode>
      <d2p1:DepositFee>0</d2p1:DepositFee>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DisposalFee>0</d2p1:DisposalFee>
      <d2p1:Documents i:nil="true" />
      <d2p1:EanCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:EnvironmentalTax>0</d2p1:EnvironmentalTax>
      <d2p1:GroupDiscounts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:HasCharacteristic>false</d2p1:HasCharacteristic>
      <d2p1:HasCompatibleCars>false</d2p1:HasCompatibleCars>
      <d2p1:HasSetParts>false</d2p1:HasSetParts>
      <d2p1:Hbase>
        <d2p1:Descriptions xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:Name>String</d2p1:Name>
        <d2p1:ProductGroupId>String</d2p1:ProductGroupId>
        <d2p1:ProductId>String</d2p1:ProductId>
      </d2p1:Hbase>
      <d2p1:Heijl>
        <d2p1:Descriptions xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:Name>String</d2p1:Name>
        <d2p1:ProductGroupId>String</d2p1:ProductGroupId>
        <d2p1:ProductId>String</d2p1:ProductId>
      </d2p1:Heijl>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Images xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:IsDisposalFee>false</d2p1:IsDisposalFee>
      <d2p1:IsFGas>false</d2p1:IsFGas>
      <d2p1:IsGaik>false</d2p1:IsGaik>
      <d2p1:IsInPromotion>false</d2p1:IsInPromotion>
      <d2p1:IsKnownProduct>false</d2p1:IsKnownProduct>
      <d2p1:IsLeadSurcharge>false</d2p1:IsLeadSurcharge>
      <d2p1:IsLeisureProduct>false</d2p1:IsLeisureProduct>
      <d2p1:IsNettoPriceProvided>false</d2p1:IsNettoPriceProvided>
      <d2p1:IsNextRoute>false</d2p1:IsNextRoute>
      <d2p1:IsNotRetourable>false</d2p1:IsNotRetourable>
      <d2p1:IsRentalProduct>false</d2p1:IsRentalProduct>
      <d2p1:IsRouteInfoProvided>false</d2p1:IsRouteInfoProvided>
      <d2p1:IsVheckRoute>false</d2p1:IsVheckRoute>
      <d2p1:LeadSurcharge>0</d2p1:LeadSurcharge>
      <d2p1:LongDescription>String</d2p1:LongDescription>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NettoPrice>0</d2p1:NettoPrice>
      <d2p1:OeNumbers i:nil="true" />
      <d2p1:Origins>None</d2p1:Origins>
      <d2p1:PriceLabel>String</d2p1:PriceLabel>
      <d2p1:ProductAttributes i:nil="true" />
      <d2p1:ProductGroup>String</d2p1:ProductGroup>
      <d2p1:ProductGroupId>String</d2p1:ProductGroupId>
      <d2p1:QuantityAllWarehouses>0</d2p1:QuantityAllWarehouses>
      <d2p1:QuantityLinkedWarehouse>0</d2p1:QuantityLinkedWarehouse>
      <d2p1:Relevance>0</d2p1:Relevance>
      <d2p1:RelevantProducts i:nil="true" />
      <d2p1:RemovalFee>0</d2p1:RemovalFee>
      <d2p1:RentalProductIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:RequiresLegitimation>false</d2p1:RequiresLegitimation>
      <d2p1:RouteExpiryDate>0001-01-01T00:00:00</d2p1:RouteExpiryDate>
      <d2p1:SetParts>
        <d2p1:KnownSetPartProductIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:UnknownSetParts i:nil="true" />
      </d2p1:SetParts>
      <d2p1:ShortDescription>String</d2p1:ShortDescription>
      <d2p1:SortOrder>0</d2p1:SortOrder>
      <d2p1:TecDoc>
        <d2p1:Descriptions xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:Name>String</d2p1:Name>
        <d2p1:ProductGroupId>String</d2p1:ProductGroupId>
        <d2p1:ProductId>String</d2p1:ProductId>
      </d2p1:TecDoc>
      <d2p1:ToolSpecial>
        <d2p1:Descriptions xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:Name>String</d2p1:Name>
        <d2p1:ProductGroupId>String</d2p1:ProductGroupId>
        <d2p1:ProductId>String</d2p1:ProductId>
      </d2p1:ToolSpecial>
      <d2p1:UnitsPerSale>0</d2p1:UnitsPerSale>
      <d2p1:UniversalParts>
        <d2p1:Descriptions xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d2p1:Name>String</d2p1:Name>
        <d2p1:ProductGroupId>String</d2p1:ProductGroupId>
        <d2p1:ProductId>String</d2p1:ProductId>
      </d2p1:UniversalParts>
    </d2p1:Product>
  </ProductAugmentation>
  <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:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <UrgentMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages" i:nil="true" />
</GetProductAugementationResponse>