Skip to main content
Soft-delete a store. The store data is retained but becomes inaccessible. Only the store owner can perform this action. 
POST /v1/actions/store/delete-store
Authentication: API Key (owner role required)

​
Request Body

FieldTypeRequiredDescription
idstringYesStore ID to delete (Short ID format STO_xxx)

​
Example Request

const { store } = await client.stores.delete({
  id: "STO_2aUyqjCzEIiEcYMKj7TZtw",
});
console.log(store.deletedAt);  // => "2026-01-15T12:00:00.000Z"

​
Success Response (200)

{
  "data": {
    "store": {
      "id": "STO_2aUyqjCzEIiEcYMKj7TZtw",
      "name": "My Digital Store",
      "status": "active",
      "logo": null,
      "supportEmail": null,
      "website": null,
      "slug": "my-digital-store-a1b2c3",
      "prodEnabled": false,
      "webhookSettings": null,
      "notificationSettings": null,
      "checkoutSettings": null,
      "deletedAt": "2026-01-15T12:00:00.000Z",
      "createdAt": "2026-01-15T10:30:00.000Z",
      "updatedAt": "2026-01-15T12:00:00.000Z"
    }
  }
}

​
Response Fields

Same as Create Store response fields, with deletedAt populated.

​
Error Responses

StatusErrorDescription
400Missing required field: idid not provided in request body
403Access denied: only owner can delete storeMerchant role is admin or member
404Store not foundStore ID does not exist or merchant is not a member
Deleting a store is a soft delete. The store data is retained but the store becomes inaccessible. This action cannot be undone through the API.