Phase out variants (stop selling them)

POST/v1/api/store/{team_slug}/product/{hash_id}/variant/phase_out

v1Operation ID v1_public_product_variant_phase_out

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_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• hash_idstringrequired

  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

application/json, required.

Which variants?

Send one of these 2 bodies.

Listed variantsEvery variant

Listed variants

Up to 500 variant ids of this product.

• idsarray of stringsrequired

  A variant id of this product. No repeats.

  • 1 to 500 items

Example request

curl

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

Every live variant of the product when the request runs.

• allbooleanrequired
  • One of: true

Example request

curl

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

200Successful response.

• dataarray of objectsrequired
  Fields of each item (7)

  • changedbooleanrequired

    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.

  • idstringrequired
  • phased_outbooleanrequired
  • phased_out_atstring (date-time) | nullrequired
  • phased_out_byobject | nullrequired

    Who phased it out; null while on sale, or when nobody was recorded.

    Child fields (2)

    • idstringrequired
    • namestringrequired
  • color_labelstring | null
  • size_labelstring | null
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You 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".

• 404Not 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.

• 422The 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

• POSTPut phased-out variants back on sale/v1/api/store/{team_slug}/product/{hash_id}/variant/resume

Example request: Listed variants

curl

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"    ]  }'

curl

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  }'

Example response 200

Response

{
  "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
}