URL Expired

The URL for this request expired after 30 days.

Information about the cancellation request.

shipmentId
string
Unique ID of the shipment. Either the shipmentShipmentId or the partnerShipmentId can be provided. Of the shipmentId, carrierSelectionId, shipiumLabelId, and carrierTrackingId, only one ID may be provided.

carrierSelectionId
string
Unique ID of the carrier selection to be cancelled. Of the shipmentId, carrierSelectionId, shipiumLabelId, and carrierTrackingId, only one ID may be provided.

shipiumLabelId
string
Unique Shipium ID of the label to be cancelled and voided with the carrier. Of the shipmentId, carrierSelectionId, shipiumLabelId, and carrierTrackingId, only one ID may be provided.

carrierTrackingId
string
Carrier tracking ID of the label to be voided with the carrier. Of the shipmentId, carrierSelectionId, shipiumLabelId, and carrierTrackingId, only one ID may be provided.

cancellationDateTime
date-time
The timestamp for when the entity/entities are cancelled. This field will default to now

cascadeCancel
boolean
An indicator to cascade the cancel down to any existing child entities. For example, if a shipmentId is passed, any associated carrier selection and label will also be cancelled/voided. If a carrierSelectionId is passed, any associated label will also be cancelled/voided. Defaults to false.

X-DELEGATED-PARTNER-ID
string

`` 200 Cancellation successful.

`` 400 Invalid inputs were provided.

`` 403 Not authenticated / authorized via OAuth.

`` 404 Unable to find the entity to cancel.

Example Usage

ShellNodeRubyPHPPython

Bearer

xxxxxxxxxx

curl --request POST \
     --url https://api.shipium.com/api/v1/deliveryexperience/cancel \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

Choose a response example:

200
400
403
404