Check whether a product can be deleted

POST/v1/api/store/{team_slug}/product/{hash_id}/delete_check

v1Operation ID v1_public_product_delete_check

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_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 (1)

  • productobjectrequired
    Child fields (5)

    • blockersarray of objectsrequired
      Fields of each item (5)

      • reasonstringrequired
        • One of: "published_order", "incoming_purchase_order", "pending_stock_operation", "customer_stock", "last_variant"
      • countinteger
      • examplesarray of objects
        Fields of each item (5)

        • document_removedbooleanrequired
        • idstringrequired
        • labelstring | nullrequired
        • object_typestringrequired
        • removedbooleanrequired
      • linesinteger
      • unitsstring
    • deletablebooleanrequired
    • idstringrequired
    • phased_outbooleanrequired

      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.

    • warningsarray of objectsrequired
      Fields of each item (6)

      • reasonstringrequired
        • One of: "shop_stock", "draft_order", "pricing_rule"
      • countinteger
      • examplesarray of objects
      • linesinteger
      • unitsstring
      • warehousesarray of objects
        Fields of each item (3)

        • idstring | null
        • labelstring | null
        • unitsstring
• 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

  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

• DELETEDelete a product/v1/api/store/{team_slug}/product/{hash_id}
• POSTPhase out a simple product/v1/api/store/{team_slug}/product/{hash_id}/phase_out

Example request

curl

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'

Example response 200

Response

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