The purpose of this API is to mark a parcel as “wanted” “enquired” for distribution or not. This information will be transferred to the whole system including CargoStream.
...
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
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 for booking
The user has access to the shop the parcel (trackingReference) is connected to
Environments / endpoints
TEST
|
| ||||||||
PRODUCTION
|
|
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
| Info |
|---|
|
...
Name | Type | Example | Max Length | Mandatory | Description |
|---|---|---|---|---|---|
wanted | boolean | true |
| Indication if parcel should be marked as “Wanted” (true) or “Unwanted” (false) |
Response
HTTP Status code | Description |
|---|---|
200 | Parcel was successfully changed. |
Examples
Request
| Code Block |
|---|
{
"wanted": false
} |
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”)
...
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 shop or transportsolution 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.
...