Versions Compared

Key

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

...

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.

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
titleExamplesExample 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.

(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 23:00 p.m. (cut off time may vary, is 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 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

...