Delete Product

This page describes the request data identifiers and response structure required to delete a product (soft delete).

Data Identifier

{
  "dataID": "DELETE_PRODUCT",
  "seq": 344,
  "return_url": "/commerce/product/list"
}
KeyDescription
dataIDData identifier DELETE_PRODUCT
seqProduct to delete
return_urlWhere to go after deleting. Echoed back.

HTML

<form id="frm_delete_product">
  <input type="hidden" name="seq" value="344">
  <input type="hidden" name="return_url" value="/commerce/product/list">
  <button type="submit" class="btn btn-outline-danger">Delete</button>
</form>

Response Result

{
  "result": true,
  "return_url": "/commerce/product/list"
}
KeyDescription
resultDeleted or not (true / false)
return_urlThe return_url you sent
  • This is a soft delete. The product leaves lists, widgets and new orders, but existing orders keep their product snapshot. The product code is cleared so it can be reused.
  • Screen example: before deleting, show product.delete_impact from GET_PRODUCT (rows, stock, images, categories) in the confirm dialog.
  • Error codes — errors also come back as HTTP 200. Check result:false, then error_code (string) and error_message.
  • 401 — Sign-in required (Unauthorized).

Example

Delete "Logo Sticker Pack"

Soft delete only — orders keep their product snapshots.

<script setup>
const seq = 344
async function remove() {
  if (!confirm('Delete this product?')) return
  // Soft delete: sets delete_flg='Y'. Variants/inventory rows stay for order-history integrity.
  const { output } = await useNuxtApp().$connector({ dataID: 'DELETE_PRODUCT', seq, return_url: '/commerce/product/list' })
  if (output.result) navigateTo('/commerce/product/list')
}
</script>

<template>
  <div class="card border-danger shadow-sm">
    <div class="card-body d-flex justify-content-between align-items-center">
      <div>
        <h5 class="card-title text-danger mb-1">Delete "Logo Sticker Pack"</h5>
        <p class="text-secondary mb-0">Soft delete only — orders keep their product snapshots.</p>
      </div>
      <button class="btn btn-outline-danger" @click="remove">Delete #{{ seq }}</button>
    </div>
  </div>
</template>
<?php
$requestData = [
    'dataID'     => 'DELETE_PRODUCT',
    'seq'        => 344,
    'return_url' => '/commerce/product/list',
];
$output = $connector->request($requestData);

// Soft delete (delete_flg = 'Y'); order_item snapshots are unaffected.
echo $output['result'] ? 'Deleted' : 'Delete failed';