# Check whether variants can be deleted

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

- API version: v1
- Operation ID: `v1_public_product_variant_delete_check`
- 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-delete-check/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Read-only. For each variant, reports whether delete is allowed now and why not: ever sold, incoming stock, a pending stock operation, customer-owned stock, or the last variant. Shop stock, drafts and pricing rules are reported as warnings. A reason about documents gives their `count`, their `lines`, and up to five `examples`, live ones first: each has an `id`, its number as `label`, an `object_type`, `removed` (the document or its line was deleted) and `document_removed` (the document itself was). The `object_type` is `sales_order` or `quote` for published orders and drafts, and `purchase_order` for incoming stock. For a pending stock operation it is the stored type: `transfer`, `adjustment`, `general_defect`, `production_defect`, or `purchase_order` for a receipt, whose `id` is the receipt's. A blocked delete returns 422 variant_in_use with the same report.

## Permission

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

## 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`.

## Request body

Content type `application/json`, required.

Fields:

- `ids` (array of strings, required): A variant id of this product. No repeats. 1 to 500 items.

### Example request

```bash
curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/product/EDhVUaC6jbLbed/variant/delete_check' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "ids": [
      "HcFPJ9RLam4gNE",
      "yJCzauCZ07rsoS"
    ]
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `variants` (array of objects, required)
    - Each item:
      - `blockers` (array of objects, required)
        - Each item:
          - `reason` (string, required): One of: `"published_order"`, `"incoming_purchase_order"`, `"pending_stock_operation"`, `"customer_stock"`, `"last_variant"`.
          - `count` (integer, optional)
          - `examples` (array of objects, optional)
            - Each item:
              - `document_removed` (boolean, required)
              - `id` (string, required)
              - `label` (string | null, required)
              - `object_type` (string, required)
              - `removed` (boolean, required)
          - `lines` (integer, optional)
          - `units` (string, optional)
      - `deletable` (boolean, required)
      - `id` (string, required)
      - `warnings` (array of objects, required)
        - Each item:
          - `reason` (string, required): One of: `"shop_stock"`, `"draft_order"`, `"pricing_rule"`.
          - `count` (integer, optional)
          - `examples` (array of objects, optional)
          - `lines` (integer, optional)
          - `units` (string, optional)
          - `warehouses` (array of objects, optional)
            - Each item:
              - `id` (string | null, optional)
              - `label` (string | null, optional)
              - `units` (string, optional)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "variants": [
      {
        "blockers": [
          {
            "count": 2,
            "examples": [
              {
                "document_removed": false,
                "id": "CiK5Bpj6YC4Cm7",
                "label": "1001",
                "object_type": "sales_order",
                "removed": false
              }
            ],
            "lines": 3,
            "reason": "published_order",
            "units": "7"
          }
        ],
        "deletable": false,
        "id": "zSSqymW2yER9jw",
        "warnings": [
          {
            "count": 1,
            "examples": [
              {}
            ],
            "lines": 1,
            "reason": "shop_stock",
            "units": "12.5",
            "warehouses": [
              {
                "id": "MB5H7qBH1G60sv",
                "label": "Main warehouse",
                "units": "12.5"
              }
            ]
          }
        ]
      }
    ]
  },
  "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: An id is not a live variant of this product (`error.code` `page_not_found`), or the product is not a live variant product (`error.code` null). Fix: List the product's variants first.
- `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: `ids` is empty, has more than 500 or repeated ids. `error.code` is `validation_failed`. Fix: Send 1 to 500 distinct ids.

## Related

- [Delete a variant](https://developer.yoprint.com/reference/product-variants/v1-product-variant-destroy.md): `DELETE /v1/api/store/{team_slug}/product/{hash_id}/variant/{id}`
- [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`