# Phase out variants (stop selling them)

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

- API version: v1
- Operation ID: `v1_public_product_variant_phase_out`
- 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-phase-out/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Phased-out variants can no longer be added to new sales order or quote lines (422 `variant_phased_out`). Existing lines, purchase orders, stock and pricing rules keep working. Repeating the call keeps the original phase-out time. Send `ids`, or `all: true` to phase out every live variant of the product as it is when the request runs (a variant added meanwhile is included, one deleted meanwhile is skipped); not both. The response lists the requested rows in id order, with `all: true` every live one, each with `changed`: true when this request phased it out, false when it was already phased out (its time and author unchanged). To undo, resume the rows marked true.

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

Which variants? Send one of these 2 bodies: **Listed variants**, **Every variant**.

### Listed variants

Variant 1 of 2. On the web page: https://developer.yoprint.com/reference/product-variants/v1-product-variant-phase-out/#variant-listed-variants

Up to 500 variant ids of this product.

Fields:

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

Example request (Listed variants):

```bash
curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/product/EDhVUaC6jbLbed/variant/phase_out' \
  -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"
    ]
  }'
```

### Every variant

Variant 2 of 2. On the web page: https://developer.yoprint.com/reference/product-variants/v1-product-variant-phase-out/#variant-every-variant

Every live variant of the product when the request runs.

Fields:

- `all` (boolean, required): One of: `true`.

Example request (Every variant):

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

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `changed` (boolean, required): True when this request changed the row's sale state; false when it was already in the requested state and kept its earlier time and author. An undo reverses only the rows marked true.
    - `id` (string, required)
    - `phased_out` (boolean, required)
    - `phased_out_at` (string (date-time) | null, required)
    - `phased_out_by` (object | null, required): Who phased it out; null while on sale, or when nobody was recorded.
      - `id` (string, required)
      - `name` (string, required)
    - `color_label` (string | null, optional)
    - `size_label` (string | null, optional)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": [
    {
      "changed": true,
      "color_label": null,
      "id": "HcFPJ9RLam4gNE",
      "phased_out": true,
      "phased_out_at": "2026-11-01T02:00:00+00:00",
      "phased_out_by": {
        "id": "lOURnovd3hkIQI",
        "name": "Alex Rivera"
      },
      "size_label": "S"
    },
    {
      "changed": false,
      "color_label": null,
      "id": "yJCzauCZ07rsoS",
      "phased_out": true,
      "phased_out_at": "2026-10-30T01:00:00+00:00",
      "phased_out_by": {
        "id": "lOURnovd3hkIQI",
        "name": "Alex Rivera"
      },
      "size_label": "M"
    }
  ],
  "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, or the product is not a live variant product. Nothing is changed. `error.code` is null and `error.message` names the record type. Fix: List the 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: Both `ids` and `all` are sent, or `ids` is empty or has more than 500 or repeated ids. `error.code` is `validation_failed`. Fix: Send one of them.

## Related

- [Put phased-out variants back on sale](https://developer.yoprint.com/reference/product-variants/v1-product-variant-resume.md): `POST /v1/api/store/{team_slug}/product/{hash_id}/variant/resume`