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 .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 }