Delete a product

DELETE/v1/api/store/{team_slug}/product/{hash_id}

v1Operation ID v1_public_products_destroy

Deletes a product that is not in use. Refused with 422 product_in_use, carrying the same report as delete_check under product, when the product is in use; phase it out instead (a variant product phases out its sizes and colors). Deleting a variant product deletes its live sizes and colors with it, and deleting a product hides its stock rows.

In use means: ever on a published sales order or quote (removed lines and deleted orders count), stock still incoming on a purchase order, a pending stock operation, or stock a customer owns. A deleted product can be restored.

Permission

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

Business rules

• Check first with Check whether a product can be deleted; the delete checks again.

Side effects

• Hides the product's stock rows (a restore brings them back).
• For a variant product, deletes its live variants with it.

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.

• datanullrequired
• 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: already deleted, or not the team's. error.code is null and error.message names the record type.

  Fix

  Check the id.

• 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

  The product is in use (error.code product_in_use); error.product holds the delete check report.

  Fix

  Phase it out instead.

Related

• POSTCheck whether a product can be deleted/v1/api/store/{team_slug}/product/{hash_id}/delete_check
• POSTPhase out a simple product/v1/api/store/{team_slug}/product/{hash_id}/phase_out
• PATCHRestore a deleted product/v1/api/store/{team_slug}/product/{hash_id}/restore

Example request

curl

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

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}