[v2.6] Void

Overview

This endpoint allows a user to cancel a shipment with a carrier.

Use of this endpoint does not guarantee a shipment has been cancelled.

Please verify with your carrier the cancellation of a pickup to ensure you will not be charged.

Request Body

Property	Data Type	Notes
shipmentId	string	The tracking number for the container or the master tracking number for the shipment.
voidType	enum	Shipment Container
isProduction	boolean	If testing, this should be set to false.
carrierServiceName	string	Name of the carrier service used to get the labels for the shipment.
carrierName	string	Name of the carrier.
shipFromCountryCodeIso2	string	ex: US
shipToCountryCodeIso2	string	ex: CA
shipToName	string	Name of the destination of the shipment.
shipDate	string	ex: 2024-08-28T20:07:12
includeTransactionXmls	boolean	True or false.

containersToVoid

Property	Data Type	Notes
containerId	string	Tracking number for the container.

additionalInformation

Property	Data Type	Notes
key	string
value	string

accountAssignment

Property	Data Type	Notes
accountNumber	string	Account number.
additionalAccountNumber	string	Additional account number, if applicable.
accessKey	string	Access key for carrier APIs.
userName	string	Username for carrier APIs.
password	string	Password for carrier APIs.

additionalInformation

Property	Data Type	Notes
key	string
value	string

Response

Property	Data Type	Notes
runTime	integer	int64
transactionId	string	System-generated transaction ID.

voidResultDto

Property	Data Type	Notes
resultStatus	enum	Failure PartialSuccess Success
statusDescription	string	Description of status of void request.

transactionHistoryInterfaces

Property	Data Type	Notes
carrierRequest	string	Request sent to carrier API.
carrierResponse	string	Response sent from carrier API.
sccRequest	string	Not applicable.
sccResponse	string	Not applicable.
carrierTransactionId	string	Transaction generated by carrier API.

parcelErrors

containerVoidResults

Property	Data Type	Notes
containerId	string	ID of the container.
successful	boolean	True or false.
statusDescription	string	Description of whether the void request was successful.

parcelErrors