2Service Services API

GetShipments

The following routes are available for this service:
GET	/dealers/shipments	Retrieves shipments.

**GetShipments** Parameters:
Name	Parameter	Data Type	Required	Description
DateFrom	query	DateTime	Yes	Start of date range to retrieve shipments for.
DateTo	query	DateTime?	No	End of date range to retrieve shipments for.

**AuthenticatedRequest** Parameters:
Name	Parameter	Data Type	Required	Description
SessionToken	query	string	Yes	Session token received from successful authentication.

**OperationResult<T>** Parameters:
Name	Parameter	Data Type	Required	Description
Result	model	T	No	Result value

**OperationResult** Parameters:
Name	Parameter	Data Type	Required	Description
IsSuccessful	model	bool	No	Specifies if the operation was successful.
ErrorMessage	model	string	No	States error message in case of unsuccessful operation.

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

GET /dealers/shipments HTTP/1.1 
Host: services.acct.2service.nl 
Accept: application/xml

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

<ShipmentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_2Service.Webservices.ServiceModel.Dealers">
  <ErrorMessage xmlns="http://schemas.datacontract.org/2004/07/_2Service.Webservices.ServiceModel">String</ErrorMessage>
  <IsSuccessful xmlns="http://schemas.datacontract.org/2004/07/_2Service.Webservices.ServiceModel">false</IsSuccessful>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/_2Service.Webservices.ServiceModel.Dealers" xmlns="http://schemas.datacontract.org/2004/07/_2Service.Webservices.ServiceModel">
    <d2p1:ShipmentResult>
      <d2p1:Articles>
        <d2p1:ShipmentArticleResult>
          <d2p1:ArticleNumber>String</d2p1:ArticleNumber>
          <d2p1:CustomReference>String</d2p1:CustomReference>
          <d2p1:OrderNumber>String</d2p1:OrderNumber>
          <d2p1:Quantity>0</d2p1:Quantity>
        </d2p1:ShipmentArticleResult>
      </d2p1:Articles>
      <d2p1:DispatchDate>0001-01-01T00:00:00</d2p1:DispatchDate>
      <d2p1:HasBeenDispatched>false</d2p1:HasBeenDispatched>
      <d2p1:Packages>
        <d2p1:ShipmentPackageResult>
          <d2p1:ShipmentMethod>String</d2p1:ShipmentMethod>
          <d2p1:TrackingNumber>String</d2p1:TrackingNumber>
          <d2p1:TrackingUrl>String</d2p1:TrackingUrl>
        </d2p1:ShipmentPackageResult>
      </d2p1:Packages>
      <d2p1:ShipmentId>0</d2p1:ShipmentId>
    </d2p1:ShipmentResult>
  </Result>
</ShipmentsResponse>