Versions Compared

Key

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

Possibility to cancel orders.

Content

Table of Contents

Use of Service Cancel API

Cancel API may be used in order to cancel transport assignments before the shipment arrives in the value chain where the shipment will be in transit.
The cancellation applies to all items in a shipment.

Transport assignment for the shipment will be in transit from the day before desired delivery date. Shipment without a defined desired delivery date will be under transport immediately after booking.
Pick-up shipment can be canceled until data has been transferred to the carrier.

Shipments that have been canceled cannot be resumed and will not be handled in the distribution.
Shipments under transport can be called for by the transporters customer service.

Examples 

Case

Can be cancelled

Not able to cancel

1

B2C-Shipment with items X and Y

  • desiredDeliveryDate 10/5.

(tick) Cancelling 8/5 or earlier
Item X and Y are cancelled

(error) 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

(tick) Cancelling 8/5 or earlier

(tick) Cancelling 9/5 may work depending on time, contact your carrier for specific cut off time

(tick) Cancelling 10/5 if current parcel status is not “Parcel picked up“ (eventlog API key 32)

(error) Cancelling 9/5 after carrier specific cut off

(error) 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

(tick) Cancelling any time

after activation (set distributionDate with Edit 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.

...