API Reference

All-in-one Cancel

post
https://api.shipium.com/api/v1/deliveryexperience/cancel

All in one cancel endpoint which allows users to cancel a shipment, cancel a carrier selection, or cancel and void a label. All three cancellations can be done at once with a cascading cancel.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Information about the cancellation request.

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.

string

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

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.

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.

date-time

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

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.

Headers
string
Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?