# Delete a variant

```http
DELETE https://secure.yoprint.com/v1/api/store/{team_slug}/product/{hash_id}/variant/{id}
```

- API version: v1
- Operation ID: `v1_public_product_variant_destroy`
- Section: Products and catalog › [Product variants](https://developer.yoprint.com/reference/product-variants.md)
- Web page: https://developer.yoprint.com/reference/product-variants/v1-product-variant-destroy/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Deletes one variant unless it is in use, hides its stock rows and updates the product's `size_data` and `color_data`. A variant that was ever sold, has incoming or pending stock, or customer-owned stock, or is the product's last variant, is refused with 422 `variant_in_use` and the delete check report under `variants`: phase it out instead.

## Permission

Needs the Manage Products permission at the level that can update products.

## Side effects

- Hides the variant's stock rows.
- Rebuilds the product's size and color lists.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.
- `hash_id` (string, required): The product's id (`id` from List products). A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `EDhVUaC6jbLbed`.
- `id` (string, required): The variant's id (`id` from List a product's variants, or `attr_data[].id` from Load a product for a sales order line). A hash id from an earlier answer; unique keys and document numbers (such as `PO0042`) don't work here. Example `uAu3dAKIaHyAYk`.

## Request body

This operation takes no request body.

### Example request

```bash
curl -X DELETE 'https://secure.yoprint.com/v1/api/store/your-team/product/EDhVUaC6jbLbed/variant/uAu3dAKIaHyAYk' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (null, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": null,
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role cannot update products. This 403 has a short body, `{"message": "Insufficient Permission"}`, with no `success` or `error`. Fix: Ask a team owner to set Manage Products to "Users CAN view, update and create products".
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: No live variant with this id. The product id in the path is not checked: the variant is found by its own id. `error.code` is null and `error.message` names the record type. Fix: Check the id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: The variant is in use or is the last one (`error.code` `variant_in_use`; `error.variants` holds the delete check report). Fix: Phase it out instead, or delete the whole product.

## Related

- [Check whether variants can be deleted](https://developer.yoprint.com/reference/product-variants/v1-product-variant-delete-check.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant/delete_check`
- [Phase out variants (stop selling them)](https://developer.yoprint.com/reference/product-variants/v1-product-variant-phase-out.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant/phase_out`
