Skip to main content

shipmentDelete

Delete a shipment and all associated data permanently.

Removes a shipment record and all related entities including shipment items and tracking information. This operation is irreversible and should be used with caution. Typically used for correcting errors or canceling shipments that were created in error.

Deletion process includes:

  • Removal of shipment record and metadata
  • Deletion of all associated shipment items
  • Removal of tracking and trace information

Validation requirements:

  • Shipment ID must reference an existing, accessible shipment
  • User must have appropriate permissions for destructive operations

Possible errors:

  • SHIPMENT_DELETE_ERROR: Failed to delete the shipment due to system error
  • SHIPMENT_NOT_FOUND_ERROR: Shipment with specified ID does not exist
  • VALIDATION_ERROR: Invalid shipment ID provided or shipment cannot be deleted in current status
  • FORBIDDEN: Insufficient permissions to delete shipments

AUTH: Role=[order.OWNER,order.EDITOR]

shipmentDelete(
  id: String!
): Boolean!

Arguments​

shipmentDelete.id ● String! non-null scalar​

Unique UUID identifier of the shipment to delete.

Must reference an existing shipment that is accessible to the current user and in a deletable status. This operation is irreversible and will permanently remove all shipment data.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.