Page Comparison

Possibility to cancel orders.

Content

Use of Service

Cancel API is used to cancel a shipment before the shipment is in transit (has arrived in the value chain).
The cancellation applies to all items in a shipment.
The shipment will be defined as in transit from the day before desired delivery date. Shipment without desired delivery date will be in transit immediately after booking. Pick-up shipments can be canceled until data has been transferred to the carrier.

Shipments that have been canceled cannot be resumed and data about a canceled shipment will not be handled in sent to the carrier.
It is not possible to cancel a shipments in transit with this API, to stop these shipments a shipment in transit contact the carrier customer service.

Successful cancellation will set eventlog API key 71, 60 or 73.
Even with successful cancelation there will be corner cases where the carrier will try to deliver/pick up the parcel, this is because the distribution can override and/or start their distribution outside of times defined by them in the system.

Since pick-up shipments (C2C/C2B) do not arrive in the value chain before they are actually picked up, more flexibility is available.
Pick-up shipments have a later cut off for cancellation, usually until 23:00 p.m. the day before pick-up. This depends on geography and carrier, contact your carrier for exact details.
Pick-up shipments can also be canceled if the pick-up attempt failed

Setup

Make sure you have the following information at hand before proceeding. Contact you transport carrier partner to obtain this information.

Limitations

Please note that this API is created for handling parcels delivered by distributors using the EDG or Buddy application. The solution currently does not support parcels delivered by the Plan&Go application.

Environments / Endpoints

Consider using the TEST-endpoint wile developing your system. By doing this you ensure that your test-data will not pollute any potential external systems.

https://staging-ws.di.no/ws/json/parcel/booking/v-1/order/cancel/{identifier}

https://ws.di.no/ws/json/parcel/booking/v-1/order/cancel/{identifier}

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. 

...

Request header

Bearer $SECRET_WS_TOKEN

Path-Parameters

Curl request

curl -X DELETE \
  https://staging-ws.di.no/ws/json/parcel/booking/v-1/order/cancel/70724761603243701 \
  -H 'Authorization: Bearer $SECRET_WS_TOKEN' \
  -H 'Content-Type: application/json' \

...

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.

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.

...

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

Error Keys