# Check whether a product can be deleted

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

- API version: v1
- Operation ID: `v1_public_product_delete_check`
- Section: Products and catalog › [Products](https://developer.yoprint.com/reference/products.md)
- Web page: https://developer.yoprint.com/reference/products/v1-product-delete-check/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Checks whether a product can be safely deleted. Returns a report under `product` (`id`, `deletable`, `blockers`, `warnings`, and `phased_out`).

Deleting is blocked (`blockers`) when any of the following apply (for variant products, checked across all sizes and colors, including deleted ones for sales):
- The product was ever on a published sales order or quote (including removed lines and deleted orders).
- Stock is still incoming on an open purchase order line.
- A stock operation (transfer or adjustment) is pending.
- A customer currently owns stock of the product.

Non-blocking warnings (`warnings`) include:
- Shop stock currently exists.
- The product appears on draft sales orders or quotes.
- Active pricing rules apply to the product.

A reason about documents gives their `count`, their `lines`, and up to five `examples`.

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

This operation takes no request body.

### Example request

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

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `product` (object, required)
    - `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)
    - `phased_out` (boolean, required): A simple product that is phased out, or a variant product with no live size or color still on sale (including one with none left at all): "phase out instead" has nothing left to do.
    - `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": {
    "product": {
      "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",
      "phased_out": false,
      "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: No live product with this id. `error.code` is null and `error.message` names the record type. Fix: Check the id.

## Notes

- When `deletable` is false and `phased_out` is false, phase the product out instead.

## Related

- [Delete a product](https://developer.yoprint.com/reference/products/v1-products-destroy.md): `DELETE /v1/api/store/{team_slug}/product/{hash_id}`
- [Phase out a simple product](https://developer.yoprint.com/reference/products/v1-product-phase-out.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/phase_out`