Skip to main content

carrierDelete

Permanently delete a carrier from the system.

Removes the carrier and all associated configuration including warehouse assignments and service settings. This action cannot be undone and will affect any shipping operations that depend on this carrier. Ensure the carrier is not actively used before deletion.

Possible errors:

  • CARRIER_NOT_FOUND_ERROR: Carrier with the specified ID does not exist in the system
  • CARRIER_DELETE_ERROR: Failed to delete the carrier due to data source issues or referential integrity constraints
  • FORBIDDEN: Insufficient permissions to delete carriers

AUTH: Role=[logistics.OWNER]

carrierDelete(
  id: Int!
): Boolean!

Arguments​

carrierDelete.id ● Int! non-null scalar​

Unique identifier of the carrier to delete.

Must be a positive integer representing a valid carrier ID in the system. This ID is used to locate the specific carrier for permanent removal.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.