This API can be used to generate and return a
...
label for an order generated in DI
...
Content
| Table of Contents |
|---|
Setup
Example | |
|---|---|
Username (see Authentication section) | wsfoobar |
Password (see Authentication section) | a-very-very-long-password |
Environments / endpoints
...
HTTP method GET
...
TEST
| https://staging-ws.di.no/ws/json/parcel/label/v-1/labels/{identifier}/{labelType} | ||||||
|---|---|---|---|---|---|---|---|
PRODUCTION
| https://ws.di.no/ws/json/parcel/label/v-1/labels/{identifier}/{labelType} |
...
Example
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
Request header
key | value example | comment | |
|---|---|---|---|
Authorization |
|
see Authentication | ||
Content-Type | application/json | |
Accept | application/pdf | label in pdf format |
Accept | application/json | warnings/ error messages in json format |
Request path parameters
key | value example | comment |
|---|---|---|
identifier | (00)370724760010119754 | can be either a trackingReference or a shipmentId. If a shipmentId is specified the resulting pdf can return a pdf containing several pages (one for each item) |
labelType | unified-large | What kind of label that is wanted. The type determines both layout and size of the label. Currently the following types are supported *:
|
Example request
Comment: Notice that you have to specify two paramters in accept header, i.e. label format and error messages format (json)Curl request example
with application/pdf response format
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --request GET --url https://staging-ws.di.no/ws/json/parcel/label/v-1/labels/00370724760010119754/unified-large \
--header "authorization: Bearer $SECRET_WS_TOKEN" \
--header 'content-type: application/json' \
--header 'accept: application/pdf,application/json' \ |
Error handling
If you make requests that the API doesn't support or an error in the API occurs, it will set a http status code that describes the error, and return a text string with an error message. Clients should gracefully handle that new error keys can be added at a later stage.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.
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. |
500 | Unexpected Server Error | Oops! This indicates an error on our side, and there is nothing more you can do. Please [email|mailto:support@di.no]Â us a description of your problem and we will see what we can do. |
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
| Code Block |
|---|
{
"statusCode": 401,
"errorKey": "authentication.missing",
"errorMap": {}
}
|
Field | Description |
|---|---|
statusCode | The HTTP code associated with this error. |
errorKey | A machine parseable error code. |
errorMap | Additional details pertaining to the error. |
Error keys
| Expand | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
|