Parcel Complaints API

The purpose of this API is register complaints for the delivery of a parcel.

Content

[ 1 Setup ] [ 2 Environments / endpoints ] [ 3 Authentication ] [ 4 Making a request ] [ 5 Examples ] [ 6 Response ] [ 7 Error handling ]

Setup

	Example	Description

	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 shop where the parcel is registered
We reserve the right to limit users who misuse this service.

Environments / endpoints

TEST POST	https://staging-ws.di.no/ws/json/parcel/complaints/v-1/register
PRODUCTION POST	https://ws.di.no/ws/json/parcel/complaints/v-1/register

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.

Request header

Key	Value

Key

Value

Authorization

Bearer "SECRET_WS_TOKEN"

See authentication on how to obtain a token

Content-Type

application/json

Request body

Name	Type	Example	Mandatory	Description

Name	Type	Example	Mandatory	Description
trackingReference	String	00370724763104893912	yes	The tracking reference of the parcel
code	String	A	yes	The complaint code - See table below for valid values and descriptions.
message	String	Parcel was not delivered	no	An optional message describing the complaint
complaintDate	Date	2025-05-25	yes	The date the complaint was registered
showComplaintOnDate	Date	2025-05-26	no	The complaint will be shown to the carrier on this date. If not provided, defaults to tomorrow

Valid complaint codes

Code	Description

Code	Description
A	The customer has not received the product.
Æ	The customer is receiving parcels meant for another customer.
L	The customer received a destroyed and unreadable product.
X	Self-defined complaint
Y	Self-defined message
P	Unfortunately you have received a wrong complaint which we strongly regret.
R	The customer is pleased with your deliveries and thank you for excellent service.
K

Examples

Response

A 200 response will be returned if the the complaint was successfully created. Otherwise a 400 response will be returned for invalid input.

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

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

{
    "statusCode": 401,
    "errorKey": "authentication.missing",
    "errorMap": {}
}

Field	Description

Field	Description
statusCode	The HTTP code associated with this error.
errorKey	A machine parseable error code.
errorMap	Additional details pertaining to the error.