| 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 | PartResults | 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 |
|---|---|---|---|---|
| TotalNumberOfParts | form | int | No | Total number of parts available. |
| HasMoreRecords | form | bool | No | Indication if there are more parts to retrieve. |
| Parts | form | List<PartInfoResult> | No | Part records. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | Unique ID for the part. |
| PartNumber | form | string | No | Part number. |
| Description | form | string | No | Description of the part. |
| Manufacturer | form | string | No | Part manufacturer. |
| CanBeOrdered | form | bool | No | Determines if the part can be ordered. |
| StatusText | form | string | No | Textual representation of the status of the part. |
| AvailableStockQuantity | form | int | No | Available stock to order. |
| AverageDeliveryInDays | form | int? | No | Average days needed for delivery. |
| UnitPrice | form | decimal? | No | Price of a single unit, excluding VAT. |
| EanNumber | form | string | No | EAN number. |
| Images | form | List<PartInfoResultImage> | No | Images |
| SecondaryArticleNumbers | form | List<string> | No | Secondary article numbers |
| ReplacementArticleNumbers | form | List<string> | No | Replacement article numbers |
| StockQuantities | form | List<PartStockQuantity> | No | Stock quantities |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ImageNumber | form | int | No | Image number |
| ImageUrl | form | string | No | Image URL |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LocationId | form | int | No | Location ID |
| LocationCode | form | string | No | Location code |
| StockQuantity | form | int | No | Stock quantity in location |
| 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 .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Result:
{
OrderNumber: String,
OrderDate: 0001-01-01,
Status: Open,
Shipments:
[
{
ShipmentId: 0,
HasBeenDispatched: False,
DispatchDate: 0001-01-01,
Articles:
[
{
OrderNumber: String,
ArticleNumber: String,
Quantity: 0,
CustomReference: String
}
],
Packages:
[
{
ShipmentMethod: String,
TrackingNumber: String,
TrackingUrl: String
}
]
}
]
},
IsSuccessful: False,
ErrorMessage: String
}