Cancel a claim
cancel_claimCancel a delivery claim, including accepted ones. Check cancellation terms first, then pass the cancel_state to apply a free or paid fee.
Instructions
Cancels a claim (including an already accepted one). Get the terms with get_cancel_info first and pass its cancel_state: with paid the cancellation fee is charged. version comes from get_claim. 409 errors: old_version, inappropriate_status, free_cancel_is_unavailable.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| version | Yes | Claim version from the latest get_claim response. | |
| claim_id | Yes | Claim id (claim_id, 32–64 characters) from the create_claim or search_claims response. | |
| cancel_state | Yes | Cancellation mode from get_cancel_info: free — no charge, paid — a fee applies. |