Versions Compared

Old Version 3

changes.mady.by.user Ingrid Oliversen

Saved on

compared with

New Version 4

changes.mady.by.user Ingrid Oliversen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The purpose of this API is to… to get details

Content

Table of Contents
maxLevel3

...

TEST

Status
colourBlue
titlePOSTGET

https://devstaging-ws.di.no/ws/json/parcel/booking/v-1/details/${shipmentId}

PRODUCTION

Status
colourBlue
titlePOSTGET

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

...

Info

  • 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

Authorization

Bearer "SECRET_WS_TOKEN"

See authentication on how to obtain a token

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

...

None

Response

Name

Type

Example

Mandatory

Description

shipmentId

String

7072476032242906970724760322123456

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

370724760322429077370724760322123456

yes

Tracking number for the given item

items-myPackGoSubmissionCode

String

TESTCODE

no

Submission code received from PostNord in case this is a myPackGo item

...

expand
Expand
titleApi response example
Code Block
{
    "shipmentId": "7072476032242906970724760322123456",
    "ediStatus": "EXPORT_OK",
    "items": [
        {
            "trackingReference": "37072476032242907737072476032123456",
            "myPackGoSubmissionCode": "TESTCODE"
        }
    ]
}
titleExample 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, 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 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.
...