s1 API Host

<back to all web services

GetProductRouteRequest

The following routes are available for this service:
GET,OPTIONS/api/products/{id}/routeGet route and pricing info for a product by an id.User has to be authenticated.
Parameters:
NameParameterData TypeRequiredDescription
IdpathstringYesThe id of the product (9 numbers long)
WithoutRouteInfoqueryboolNoIf set to true, will not return route info which will decrease response times.
WithoutNettoPricequeryboolNoIf set to true, will not return net prices which will decrease response times.

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

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

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

<ProductRouteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Products">
  <Product>
    <AvailableLinkedWarehouse>0001-01-01T00:00:00</AvailableLinkedWarehouse>
    <AvailableNextRoute>0001-01-01T00:00:00</AvailableNextRoute>
    <GroupDiscounts xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <IsNextRoute>false</IsNextRoute>
    <IsVheckRoute>false</IsVheckRoute>
    <NettoPrice>0</NettoPrice>
    <QuantityAllWarehouses>0</QuantityAllWarehouses>
    <QuantityLinkedWarehouse>0</QuantityLinkedWarehouse>
    <RouteExpiryDate>0001-01-01T00:00:00</RouteExpiryDate>
  </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" />
</ProductRouteResponse>