API documentation
Method list
Test your request
Changelog


deleteCourierPackage
The method allows you to delete a previously created shipment. The method removes the shipment from the BaseLinker system and from the courier system if the courier API allows it


Input parameters
courier_codevarchar(20)Courier code
package_idintShipment ID, optional if package_number is provided
package_numbervarchar(40)Shipping number (consignment number), optional if package_id was provided
force_deletebool(optional, false by default) Forcing a shipment to be removed from BaseLinker database in the case of an error with the removal of the shipment in the courier API.



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code



Sample
Input data:
Output data:
A sample request in php: