Restore a deleted product

PATCH/v1/api/store/{team_slug}/product/{hash_id}/restore

v1Operation ID v1_public_product_restore

Restores a deleted product, its stock rows, and its variants that were removed when the product was deleted (variants deleted individually beforehand remain deleted). Phase-out status is preserved. Repeating a restore on a non-deleted product is safe (returns 200 with restored: false). No request body.

The response describes what was restored:

product: The restored product in the products list row shape.
restored: true when restored by this call; false when it was already active.
variants_restored: All live variants after the restore, in ID order (including variants left active by pre-v3.7.0 deletes).
variants_still_deleted: Variants that remain deleted because they were deleted individually beforehand.
stock_rows_restored: Number of stock rows restored.
stock_units_restored: Total units held in the restored stock rows.
phased_out: true if the restored product is phased out (or all its live variants are phased out).
name_clash: true if another live product of the team shares the same brand, title, and supplier code (a warning, not a refusal).

A product the team does not have, deleted or not, returns 404 product_not_found; an ID that cannot be decoded returns generic 404.

Permission

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

Side effects

Brings back the product's stock rows.

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

This operation takes no request body.

Response

200Successful response.

dataobjectrequired
Child fields (8)
- name_clashbooleanrequired
- phased_outbooleanrequired
- productobjectrequired
  A product, plus what the products list shows about it. Counted and loaded in the list query, never one query per row.
  Child fields (26)
  - deleted_atstring (date-time) | nullrequired
  - deleted_byobject | nullrequired
    Who deleted the product; null while live, or when nobody was recorded.
    Child fields (2)
    idstringrequired
    namestringrequired
  - deleted_variant_countinteger | nullrequired
    Variant products: sizes and colors deleted on their own, not with the product, which a restore leaves deleted; one per size and color combination, and none for a combination that is live again (added back after its delete). Null for simple products.
  - idstringrequired
  - phased_out_byobject | nullrequired
    Who phased out a simple product; null while on sale, for variant products, or when nobody was recorded. A deleted user keeps their name.
    Child fields (2)
    idstringrequired
    namestringrequired
  - phased_out_variant_countinteger | nullrequired
    Variant products: how many of variant_count are phased out. Null for simple products.
  - titlestringrequired
  - trashedbooleanrequired
  - typestringrequired
    One of: "simple", "variant"
  - variant_countinteger | nullrequired
    Variant products: their live sizes and colors; for a deleted product, the ones its restore brings back. Null for simple products.
  - barcodestring | null
    Simple products only.
  - brandstring | null
  - color_dataarray of objects
    A variant product's colors; [] for simple products.
    Fields of each item (3)
    idstringrequired
    labelstring | nullrequired
    hexstring | null
  - default_priceinteger | number | string | null
    The selling price of a simple product. Variant products price each size and color instead (List a product's variants). Null when not set. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.
  - descriptionstring | null
  - enableboolean
  - phased_outboolean
    Simple products only. Variant products phase out their sizes and colors.
  - phased_out_atstring (date-time) | null
    Simple products only.
  - price_dataobject | array
    Simple products only. Prices for pricing groups, as saved: keyed by the pricing group's internal number (not its hash id), each {"price": <thousandths>}. An empty list [] when there are none.
  - size_dataarray of objects
    A variant product's sizes; [] for simple products.
    Fields of each item (2)
    idstringrequired
    labelstring | nullrequired
  - supplier_idstring | null
  - taxableboolean
  - track_inventoryboolean
    Simple products only.
  - variant_typestring
    Variant products only.
    One of: "size", "color", "size_color"
  - vendor_idstring | null
    The vendor's id, or null.
  - weightnumber | string | null
    Simple products only.
- restoredbooleanrequired
- stock_rows_restoredintegerrequired
- stock_units_restoredstringrequired
  A decimal string without trailing zeros, such as "12.5".
- variants_restoredarray of objectsrequired
  Fields of each item (4)
  - color_labelstring | nullrequired
  - idstringrequired
  - phased_outbooleanrequired
  - size_labelstring | nullrequired
- variants_still_deletedarray of objectsrequired
  - Same fields as data.variants_restored.
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
The team has no such product, deleted or not (error.code product_not_found).
Fix
Check the id; list deleted products with status=deleted.

DELETEDelete a product/v1/api/store/{team_slug}/product/{hash_id}
GETList products/v1/api/store/{team_slug}/product

Example request

curl

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

Example response 200

{
  "data": {
    "name_clash": false,
    "phased_out": false,
    "product": {
      "brand": "Northwind",
      "color_data": [],
      "default_price": null,
      "deleted_at": null,
      "deleted_by": null,
      "deleted_variant_count": 0,
      "description": null,
      "enable": true,
      "id": "Xe3wCbaZYrxJAI",
      "phased_out_by": null,
      "phased_out_variant_count": 1,
      "size_data": [
        {
          "id": "S",
          "label": "S"
        },
        {
          "id": "M",
          "label": "M"
        },
        {
          "id": "L",
          "label": "L"
        }
      ],
      "supplier_id": null,
      "taxable": true,
      "title": "Classic Hoodie",
      "trashed": false,
      "type": "variant",
      "variant_count": 3,
      "variant_type": "size",
      "vendor_id": null
    },
    "restored": true,
    "stock_rows_restored": 2,
    "stock_units_restored": "12.5",
    "variants_restored": [
      {
        "color_label": null,
        "id": "HcFPJ9RLam4gNE",
        "phased_out": false,
        "size_label": "S"
      },
      {
        "color_label": null,
        "id": "yJCzauCZ07rsoS",
        "phased_out": true,
        "size_label": "M"
      },
      {
        "color_label": null,
        "id": "JAJVLphHcr9BxT",
        "phased_out": false,
        "size_label": "L"
      }
    ],
    "variants_still_deleted": [
      {
        "color_label": null,
        "id": "oL85v7lFzkPXRi",
        "phased_out": false,
        "size_label": "XL"
      }
    ]
  },
  "status": 200,
  "success": true
}

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI spec Support: support@yoprint.com yoprint.com