s1 API Host

<back to all web services

GetProductRequest

The following routes are available for this service:
GET,OPTIONS/api/products/{id}Get a product by an id.User has to be authenticated.
Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYesThe id of the product (9 numbers long)
CarIdquerystringNoThe carid. If this id is provided, additional product attributes will be provided specific for this car.
LicensePlatequerystringNoThe car license plate. If this is provided, additional product attributes will be provided specific for this car.

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/GetProductRequest HTTP/1.1 
Host: s1-api-tst.fource.nl 
Content-Type: application/xml
Content-Length: length

<GetProductRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Products">
  <CarId>String</CarId>
  <Id>String</Id>
  <LicensePlate>String</LicensePlate>
</GetProductRequest>

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

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