| GET | /dealers/shipment/{ShipmentId} | Retrieves shipment based on it's ID. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ShipmentId | path | int | Yes | Shipment ID to retrieve the status 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 |
|---|---|---|---|---|
| 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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /dealers/shipment/{ShipmentId} HTTP/1.1
Host: services.acct.2service.nl
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Result":{"ShipmentId":0,"HasBeenDispatched":false,"DispatchDate":"0001-01-01T00:00:00.0000000","Articles":[{"OrderNumber":"String","ArticleNumber":"String","Quantity":0,"CustomReference":"String"}],"Packages":[{"ShipmentMethod":"String","TrackingNumber":"String","TrackingUrl":"String"}]},"IsSuccessful":false,"ErrorMessage":"String"}