s1 API Host

<back to all web services

OrdersRequest

The following routes are available for this service:
GET, OPTIONS/api/ordersGet a list orders ordered by order date (latest first)Only possible if the user is authenticated
Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintYesThe amount that needs to be skipped
TakequeryintYesThe amount that needs to be taken
SearchTermquerystringNoSearch value for order reference

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/OrdersRequest HTTP/1.1 
Host: api-beta.ghs-automotive.nl 
Content-Type: application/xml
Content-Length: length

<OrdersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/S1.Api.Domain.Models.Orders">
  <SearchTerm>String</SearchTerm>
  <Skip>0</Skip>
  <Take>0</Take>
</OrdersRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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