Parcel details API

The purpose of this API is to…

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 for booking
The user has access to the shop where registering the parcel
The shop has access to the specified transport solution

Environments / endpoints

TEST POST	https://dev-ws.di.no/ws/json/parcel/booking/v-1/details/${shipmentId}
PRODUCTION POST	https://ws.di.no/ws/json/parcel/booking/v-1/details/${shipmentId}

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
Content-Type	application/json

Request body

Name	Type	Example	Mandatory	Max Length	Description
shipmentId	String path-variable	https://dev-ws.di.no/ws/json/parcel/booking/v-1/details/70724760322429069	yes	35	The id-number of the shipment is given as a value in the URL

Response

Name	Type	Example	Mandatory	Description
shipmentId	String	70724760322429069	yes	The id-number of the shipment
ediStatus	String	EXPORT_OK	yes	The current EDI-status of the shipment
items	Array		yes	List of one or more items in the shipment
items-trackingReference	String	370724760322429077	yes	Tracking number for the given item
items-myPackGoSubmissionCode	String	TESTCODE	no	Submission code received from PostNord in case this is a myPackGo item

Examples

Api response example

{
    "shipmentId": "70724760322429069",
    "ediStatus": "EXPORT_OK",
    "items": [
        {
            "trackingReference": "370724760322429077",
            "myPackGoSubmissionCode": "TESTCODE"
        }
    ]
}

Example 2

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.

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

{
    "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.