| GET | /dealers/order/tracking | Retrieves tracking numbers based on order number. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderNumber | query | string | Yes | Order number to retrieve tracking for. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SessionToken | query | string | Yes | Session token received from successful authentication. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | model | T | No | Result value |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderNumber | form | string | No | Order number. |
| OrderDate | form | DateTime | No | Order date. |
| Status | form | OrderStatus | No | Order status. |
| Shipments | form | List<ShipmentResult> | No | List of shipments (if any). |
| Name | Value | |
|---|---|---|
| Open | 1 | |
| Completed | 2 | |
| Cancelled | 3 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShipmentId | form | int | No | ID of the shipment. |
| HasBeenDispatched | form | bool | No | Determines of the shipment has been dispatched. |
| DispatchDate | form | DateTime? | No | Date/time of dispatch. |
| Articles | form | List<ShipmentArticleResult> | No | List of articles in shipment. |
| Packages | form | List<ShipmentPackageResult> | No | List of packages for shipment. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderNumber | form | string | No | Order number. |
| ArticleNumber | form | string | No | Article number. |
| Quantity | form | int | No | Quantity. |
| CustomReference | form | string | No | Custom reference. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShipmentMethod | form | string | No | Shipment method. |
| TrackingNumber | form | string | No | Tracking number. |
| TrackingUrl | form | string | No | Tracking URL. |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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.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>