Page Comparison

Possibility to cancel orders.

Content

Table of Contents

minLevel	1
maxLevel	2
type	flat

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.

...

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

Expand

title	Example cases for delivery and pick-up shipments

	Case	Can be cancelled	Not able to cancel
1	B2C-Shipment with items X and Y desiredDeliveryDate 10/5.	Cancelling 8/5 or earlier Item X and Y are cancelled	Cancelling date 9/5 or later
2	B2C-Shipment desiredDeliveryDate not specified	not possible to cancel	not possible to cancel
3	C2C/C2B-Shipment desiredDeliveryDate 10/5	Cancelling 8/5 or earlier Cancelling 9/5 may work depending on time, contact your carrier for specific cut off time Cancelling 10/5 if current parcel status is not “Parcel picked up“ (eventlog API key 32)	Cancelling 9/5 after 23:00 p.m. (cut off time may vary, is carrier specific) Cancelling 10/5 or later if current parcel status is “Picked up” (eventlog API key 32)
4	C2C/C2B-Shipment passive return activated for shop desiredDeliveryDate not specified	Cancelling any time	after activation (set distributionDate with Parcel Edit Order API, same as case 3)
5	C2C/C2B-Shipment passive return activated for shop desiredDeliveryDate 10/5	Same as case 3	Same as case 3

Setup

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

	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 edit orders
The user has access to the shop registered on the parcel

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.

TEST

Status

colour	Blue
title	DELETE

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

PRODUCTION

Status

colour	Blue
title	DELETE

Code Block
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.

...

Info

Notes

Clients using this API should not fail if new fields are added to the response. If a new field is added to the response on a later stage, existing clients should handle this in a way such as they just ignore the field.

Request header

key

value example

comment

Authorization

Code Block
Bearer $SECRET_WS_TOKEN

See authentication on how to obtain a token

Content-Type

application/json

Path-Parameters

Name	Example	Description
shipmentId	70724761617883184	The message number of the order that will be edited

Curl request

Code Block

language	bash

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.

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 may indicates an error on our side. Please try again, if the error continues notify your contact person

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.

...

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