Cargostream Scan API
- Håvard Neset
The purpose of this API is to fetch aliases for parcels and scanning them.
Content
Setup
| Example | Description |
|---|---|---|
Username (see Authentication section) | wsfoobar | A valid username. |
Password (see Authentication section) | a-very-very-long-password | A password matching given username. |
The user is a web service user
The user has access to the web service
cargostream.external.scannerThe user has access to the station specified in the request
Environments / endpoints
TEST PATCH | https://staging-ws.di.no/ws/json/scanner/v-1/scan |
PRODUCTION PATCH | https://ws.di.no/ws/json/scanner/v-1/scan |
Authentication
This endpoint requires the user to be authenticated. Refer to the documentation here for more information on how to obtain a valid token to use in your request.
Making a request
Clients using this API should not fail if new optional fields are added to the API. If a new field is added to the request or response on a later stage, existing clients should handle this in a way such as they just ignore the field.
The trackingReference must be already known to the system (created by e.g. the Parcel Booking API)
Do not share personal or sensitive information in this API.
Scan
Performs a full scan for the specified parcel
Creates a scan event
Trigger integrations set up for the station (activations, etc)
Request header
Key | Value |
|---|---|
Content-Type | application/json |
Request body
Name | Type | Example | Mandatory | Description |
|---|---|---|---|---|
trackingReference | string |
| The tracking reference or return code you want to scan | |
stationId | integer | 1 | The id of the station to scan at | |
scanMode | string |
|
| Specifies whether to perform a outgoing or incoming (return) scan. |
Response
Name | Type | Example | Description |
|---|---|---|---|
trackingReference | string | 370724762337566136 | The tracking reference of parcel you want to scan |
stationId | integer | 1 | The id of the station you scan at |
scanMode | string |
| The scan mode of the scan |
aliasDate | date | 2023-02-28 | The date the alias was generated for. Currently we only support generating alias for the current date. |
alias | string | A4 | The actual alias for the parcel |
integrations | Map<String, Boolean> | {
"DiActivation": true,
"PGActivation": false
} | A list/map of which integrations were triggered for this scan. If no integrations are set up for the station, the list will be empty. The list can be variable in size and new integrations can be added any time. |
Examples
Request
Response
Error handling
API requests that result in errors will return an appropriate HTTP status code to help you identify the type of error. You can use the table below to understand what each code means. og search online with the HTTP status code. The HTTP error keys used are based on the standard, and therefore available online (Tips to search “HTTP code XXX”)
In addition to HTTP status there may be more details in the errorKey field. Error Keys can be added at a later stage, clients should handle this as well as an empty value for errorKey.
HTTP Status code | Text | Description |
|---|---|---|
400 | Client or Validation Error | The request body/query string is not in the correct format. |
401 | Authentication Failure | Indicates that the Authorization header is either missing or incorrect. You can learn more about the Authorization header here. |
403 | Access denied | This indicates that the agent whose credentials were used in making this request was not authorized to perform this API call. It could be that you do not have access to the station you provided in your request. If you believe this is a mistake, please reach out to your contact so it can be rectified. |
405 | Method not allowed | This API request used the wrong HTTP verb/method. For example a PUT request will result in this error. |
4xx | Client error | Generally receiving an error code that starts with 4 indicates that the client needs to change something. |
500 | Unexpected Server Error | Oops! This may indicates an error on our side. Please try again, if the error continues notify your contact person |
Error response
In addition to the HTTP status code, most errors will also return a response body that contains more information to help you debug the error. A sample error response is shown below. The format of the error response body is explained after the example.
Sample error
Field | Description |
|---|---|
statusCode | The HTTP code associated with this error. |
errorKey | A machine parseable error code. |
errorMap | Additional details pertaining to the error. |