2Service Services API

<back to all web services

GetOrderTracking

The following routes are available for this service:
GET/dealers/order/trackingRetrieves tracking numbers based on order number.
GetOrderTracking Parameters:
NameParameterData TypeRequiredDescription
OrderNumberquerystringYesOrder number to retrieve tracking for.
AuthenticatedRequest Parameters:
NameParameterData TypeRequiredDescription
SessionTokenquerystringYesSession token received from successful authentication.
OperationResult<T> Parameters:
NameParameterData TypeRequiredDescription
ResultmodelPartResultsNoResult value
OperationResult Parameters:
NameParameterData TypeRequiredDescription
IsSuccessfulmodelboolNoSpecifies if the operation was successful.
ErrorMessagemodelstringNoStates error message in case of unsuccessful operation.
PartResults Parameters:
NameParameterData TypeRequiredDescription
TotalNumberOfPartsformintNoTotal number of parts available.
HasMoreRecordsformboolNoIndication if there are more parts to retrieve.
PartsformList<PartInfoResult>NoPart records.
PartInfoResult Parameters:
NameParameterData TypeRequiredDescription
IdformintNoUnique ID for the part.
PartNumberformstringNoPart number.
DescriptionformstringNoDescription of the part.
ManufacturerformstringNoPart manufacturer.
CanBeOrderedformboolNoDetermines if the part can be ordered.
StatusTextformstringNoTextual representation of the status of the part.
AvailableStockQuantityformintNoAvailable stock to order.
AverageDeliveryInDaysformint?NoAverage days needed for delivery.
UnitPriceformdecimal?NoPrice of a single unit, excluding VAT.
EanNumberformstringNoEAN number.
ImagesformList<PartInfoResultImage>NoImages
SecondaryArticleNumbersformList<string>NoSecondary article numbers
ReplacementArticleNumbersformList<string>NoReplacement article numbers
StockQuantitiesformList<PartStockQuantity>NoStock quantities
PartInfoResultImage Parameters:
NameParameterData TypeRequiredDescription
ImageNumberformintNoImage number
ImageUrlformstringNoImage URL
PartStockQuantity Parameters:
NameParameterData TypeRequiredDescription
LocationIdformintNoLocation ID
LocationCodeformstringNoLocation code
StockQuantityformintNoStock quantity in location
OrderTrackingResult Parameters:
NameParameterData TypeRequiredDescription
OrderNumberformstringNoOrder number.
OrderDateformDateTimeNoOrder date.
StatusformOrderStatusNoOrder status.
ShipmentsformList<ShipmentResult>NoList of shipments (if any).
OrderStatus Enum:
NameValue
Open1
Completed2
Cancelled3
ShipmentResult Parameters:
NameParameterData TypeRequiredDescription
ShipmentIdformintNoID of the shipment.
HasBeenDispatchedformboolNoDetermines of the shipment has been dispatched.
DispatchDateformDateTime?NoDate/time of dispatch.
ArticlesformList<ShipmentArticleResult>NoList of articles in shipment.
PackagesformList<ShipmentPackageResult>NoList of packages for shipment.
ShipmentArticleResult Parameters:
NameParameterData TypeRequiredDescription
OrderNumberformstringNoOrder number.
ArticleNumberformstringNoArticle number.
QuantityformintNoQuantity.
CustomReferenceformstringNoCustom reference.
ShipmentPackageResult Parameters:
NameParameterData TypeRequiredDescription
ShipmentMethodformstringNoShipment method.
TrackingNumberformstringNoTracking number.
TrackingUrlformstringNoTracking URL.

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/order/tracking HTTP/1.1 
Host: services.acct.2service.nl 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrderTrackingResponse 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:OrderDate>0001-01-01T00:00:00</d2p1:OrderDate>
    <d2p1:OrderNumber>String</d2p1:OrderNumber>
    <d2p1:Shipments>
      <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>
    </d2p1:Shipments>
    <d2p1:Status>Open</d2p1:Status>
  </Result>
</OrderTrackingResponse>