HC小区接口文档

删除商品接口文档

一、接口名称

删除商品

二、接口描述

该接口用于删除指定的商品信息,需要提供商铺ID和商品ID。

三、接口路径

http://ip:port/app/product.deleteProduct

四、请求方法

POST

五、请求头

参数名称 必填 类型 描述
Authorization 是 String 用户认证token,通过登录接口获取
app-id 是 String 应用ID,由系统分配
transaction-id 是 String 请求流水号,格式:1000000000+YYYYMMDDhhmmss+6位序列
sign 是 String 签名
req-time 是 String 请求时间,格式:YYYYMMDDhhmmss

六、请求参数

6.1 请求体(JSON格式)

参数名称 必填 类型 描述
shopId 是 String 商铺ID,不能为空
productId 是 String 商品ID,不能为空

七、返回值

7.1 返回值(JSON格式)

参数名称 必填 类型 描述
code 是 String 返回码,0 表示成功,其他表示失败
msg 是 String 返回信息,成功或失败原因
data 否 Object 返回数据,通常为空

八、示例请求

POST /app/product.deleteProduct
Headers:
{
  "Authorization": "Bearer xxxxxx",
  "app-id": "mall-goods",
  "transaction-id": "100000000020231201143456123456",
  "sign": "xxxxxx",
  "req-time": "20231201143456"
}
Body:
{
  "shopId": "123456",
  "productId": "789012"
}

九、示例响应

成功响应

{
  "code": "0",
  "msg": "成功",
  "data": null
}

失败响应

{
  "code": "1001",
  "msg": "商品不存在或删除失败",
  "data": null
}

十、业务逻辑说明

  1. 参数校验:检查 shopId 和 productId 是否为空,若为空则返回错误。
  2. 删除商品:调用 IProductInnerServiceSMO.deleteProduct() 方法执行删除操作。
  3. 事务处理:使用 @Java110Transactional 确保数据一致性。
  4. 返回结果:如果删除成功,返回 code=0;否则抛出异常并返回错误信息。

十一、注意事项

  • 仅支持 POST 请求。
  • 必须提供有效的 shopId 和 productId。
  • 删除操作不可逆,请谨慎调用。