s1 API Host

<back to all web services

GetCartRoutesRequest

The following routes are available for this service:
GET, OPTIONS/api/cart/routesAllows to get the route information for this account (disregarding cart content). The max amount of days is 7.User has to be authenticated to retrieve the information.
Parameters:
NameParameterData TypeRequiredDescription
startqueryDateTimeNoSet this if you want to have route information in the future. The default value is now.
endqueryDateTimeNoSet this if you want to specify the end date. The default value is now + 2 days unless it's over a weekend. We will then add days until it is monday.

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

<GetCartRoutesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Cart">
  <End>0001-01-01T00:00:00</End>
  <Start>0001-01-01T00:00:00</Start>
</GetCartRoutesRequest>

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

<GetCartRoutesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Cart">
  <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>
  <Routes i:nil="true" />
  <UrgentMessages xmlns:d2p1="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.UrgentMessages" i:nil="true" />
</GetCartRoutesResponse>