API开放平台

TIP

# 商品满折满减促销新增修改

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/product/v1/addOrModifyFullDiscount/{openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例：

{
  "title": "商品达到满折满减",
  "code": "cuxiao-1101",
  "description": "以下商品满10件打8折",
  "startDate": "2020-11-24",
  "endDate": "2020-12-24",
  "tradeType": "3",
  "tradeRange": "2",
  "applyRangeType": "0",
  "maxSaleAmount": "1",
  "promotionType": "2",
  "calcUnitName": "箱",
  "calcType": "1",
  "deptName": "财务部3,营销一部",
  "customerLevelId": "8715900737400193117,6512588339505979227",
  "cmId": "7536574795612874580",
  "productTypes": [
    {
      "id": "6676783261756264839",
      "sourceCode": ""
    },
    {
      "id": "6676783261756264839",
      "sourceCode": ""
    }
  ],
  "promotionStep": [
    {
      "stepLimit": "10",
      "discountAmount": "5",
      "discountRatio": ""
    }
  ]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
title VARCHAR(100) 是 促销主题
code VARCHAR(100) 否 促销方案编号，新增操作时code不能为空。促销id,促销方案第三方编码,促销方案编号不能同时为空,fullDiscountId、sourceCode、code如果同时存在，优先级依次降低
sourceCode VARCHAR(100) 否 促销方案第三方编码。促销id,促销方案第三方编码,促销方案编号不能同时为空,fullDiscountId、sourceCode、code如果同时存在，优先级依次降低
fullDiscountId VARCHAR(32) 否 促销id,促销方案第三方编码,促销方案编号不能同时为空,fullDiscountId、sourceCode、code如果同时存在，优先级依次降低
description VARCHAR(100) 是 促销说明
startDate VARCHAR(32) 是 开始日期。格式：yyyy-MM-dd
endDate VARCHAR(32) 是 结束日期。格式：yyyy-MM-dd
tradeType VARCHAR(32) 是 促销对象。1：标准客户，2：经销商，3：终端门店
tradeRange VARCHAR (32) 是 客户范围。1：指定客户范围，2：指定具体客户
applyRangeType VARCHAR (32) 否 适用范围。0：不限，1：业务员代下单，2：客户自主下单。不传默认值为0
maxSaleAmount VARCHAR(100) 否 累计促销额度
promotionType VARCHAR(32) 是 促销类型。1：按数量，2：按金额
calcType VARCHAR(32) 是 促销规则。1：满折，2：满减
fullMinusRule VARCHAR(32) 否 满减规则。0：阶梯满减，1：循环满减。当calcType=2才能启用，不传默认值为0
calcUnitName VARCHAR(32) 否 商品统计单位。promotionType=1时必传
productType VARCHAR(32) 是 1：按商品，2：按商品类型
ownerDeptId VARCHAR(32) 否 所属部门id。ownerDeptId、ownerDeptSource、CodeownerDeptCode、ownerDeptName可同时为空，如果同时存在，优先级依次降低
ownerDeptName VARCHAR(100) 否 所属部门名称。ownerDeptId、ownerDeptSource、CodeownerDeptCode、ownerDeptName可同时为空，如果同时存在，优先级依次降低
ownerDeptCode VARCHAR(100) 否 所属部门编码。ownerDeptId、ownerDeptSource、CodeownerDeptCode、ownerDeptName可同时为空，如果同时存在，优先级依次降低
ownerDeptSourceCode VARCHAR(100) 否 所属部门第三方系统的唯一标识。ownerDeptId、ownerDeptSource、CodeownerDeptCode、ownerDeptName可同时为空，如果同时存在，优先级依次降低
deptId VARCHAR(32) 否 客户属性-部门id，多个值以“,”分隔
deptName VARCHAR(100) 否 客户属性-部门名称，多个值以“,”分隔
deptCode VARCHAR(100) 否 客户属性-部门编码，多个值以“,”分隔
deptSourceCode VARCHAR(100) 否 客户属性-部门第三方系统的唯一标识，多个值以“,”分隔
customerLevelId VARCHAR(32) 否 客户属性-客户级别id，多个值以“,”分隔
customerLevelSourceCode VARCHAR(100) 否 客户属性-客户级别第三方系统的唯一标识，多个值以“,”分隔
customerLevelName VARCHAR(100) 否 客户属性-客户级别名称，多个值以“,”分隔
districtLevelId VARCHAR(32) 否 客户属性-销售区域级别id，多个值以“,”分隔
districtLevelCode VARCHAR(100) 否 客户属性-销售区域级别编码，多个值以“,”分隔
districtLevelName VARCHAR(100) 否 客户属性-销售区域级别名称，多个值以“,”分隔
typeId VARCHAR(32) 否 客户属性-类型id，多个值以“,”分隔
typeCode VARCHAR(100) 否 客户属性-类型编码，多个值以“,”分隔
typeName VARCHAR(100) 否 客户属性-类型名称，多个值以“,”分隔
typeSourceCode VARCHAR(100) 否 客户属性-类型第三方系统的唯一标识，多个值以“,”分隔
districtId VARCHAR(32) 否 客户属性-销售区域id，多个值以“,”分隔
districtCode VARCHAR(100) 否 客户属性-销售区域编码，多个值以“,”分隔
districtName VARCHAR(100) 否 客户属性-销售区域名称，多个值以“,”分隔
districtSourceCode VARCHAR(100) 否 客户属性-销售区域第三方系统的唯一标识，多个值以“,”分隔
uperCusId VARCHAR(32) 否 客户属性-上级客户i，多个值以“,”分隔
uperCusCode VARCHAR(100) 否 客户属性-上级客户编码，多个值以“,”分隔
uperCusName VARCHAR(100) 否 客户属性-上级客户名称，多个值以“,”分隔
uperCusSourceCode VARCHAR(100) 否 客户属性-上级客户第三方系统的唯一标识，多个值以“,”分隔
kasysId VARCHAR(32) 否 客户属性-ka系统id，多个值以“,”分隔
kasysName VARCHAR(100) 否 客户属性-ka系统名称，多个值以“,”分隔
dealerId VARCHAR(32) 否 客户属性-经销商id，多个值以“,”分隔
dealerCode VARCHAR(100) 否 客户属性-经销商编码，多个值以“,”分隔
dealerName VARCHAR(100) 否 客户属性-经销商名称，多个值以“,”分隔
dealerSourceCode VARCHAR(100) 否 客户属性-经销商第三方系统的唯一标识，多个值以“,”分隔
gradationId VARCHAR(32) 否 客户属性-客户层次id，多个值以“,”分隔
gradationCode VARCHAR(100) 否 客户属性-客户层次编码，多个值以“,”分隔
gradationName VARCHAR(100) 否 客户属性-客户层次名称，多个值以“,”分隔
perScaleId VARCHAR(32) 否 客户属性-人员规模id，多个值以“,”分隔
perScaleName VARCHAR(100) 否 客户属性-人员规模名称，多个值以“,”分隔
cusSourceId VARCHAR(32) 否 客户属性-来源id，多个值以“,”分隔
cusSourceName VARCHAR(100) 否 客户属性-来源名称，多个值以“,”分隔
tradeId VARCHAR(32) 否 客户属性-行业id，多个值以“,”分隔
tradeName VARCHAR(100) 否 客户属性-行业名称，多个值以“,”分隔
tradingareaBigId VARCHAR(32) 否 客户属性-大商圈id，多个值以“,”分隔
tradingareaBigName VARCHAR(100) 否 客户属性-大商圈名称，多个值以“,”分隔
tradingareaNomalId VARCHAR(32) 否 客户属性-商圈id，多个值以“,”分隔
tradingareaNomalName VARCHAR(100) 否 客户属性-商圈名称，多个值以“,”分隔
exts List 否 自定义字段列表
exts.cmExtKey VARCHAR(100) 否 自定义字段key
exts.cmExtValue VARCHAR(4000) 否 自定义字段value，多个值以“,”分隔
cmId VARCHAR(2000) 否 指定客户-经销商id，多个值以“,”分隔。tradeRange为1时，cmId、cmSourceCode、 cmCode、cmName不能同时为空，如果同时存在，优先级依次降低
cmCode VARCHAR(4000) 否 指定客户-经销商编码，多个值以“,”分隔。tradeRange为1时，cmId、cmSourceCode、 cmCode、cmName不能同时为空，如果同时存在，优先级依次降低
cmName VARCHAR(4000) 否 指定客户-经销商名称，多个值以“,”分隔。tradeRange为1时，cmId、cmSourceCode、 cmCode、cmName不能同时为空，如果同时存在，优先级依次降低
cmSourceCode VARCHAR(4000) 否 指定客户-经销商第三方系统的唯一标识，多个值以“,”分隔。tradeRange为1时，cmId、cmSourceCode、 cmCode、cmName不能同时为空，如果同时存在，优先级依次降低
tpmActivityId VARCHAR(32) 否 TPM活动方案ID（ID，编码，名称任选其一）
tpmActivityCode VARCHAR(100) 否 TPM活动方案编码（ID，编码，名称任选其一）
tpmActivityName VARCHAR(100) 否 TPM活动方案名称（ID，编码，名称任选其一）
products List 否 商品信息列表
products.id VARCHAR(32) 否 商品id，id、code、sourceCode不能同时为空
products.code VARCHAR(100) 否 商品编码，id、code、sourceCode不能同时为空
products.sourceCode VARCHAR (100) 否 商品第三方系统的唯一标识，id、code、sourceCode不能同时为空
productTypes List 否 商品类型信息列表
productTypes.id VARCHAR(32) 否 商品类型id，商品类型id和商品类型第三方系统的唯一标识不能同时为空
productTypes.sourceCode VARCHAR (100) 否 商品类型第三方系统的唯一标识，商品类型id和商品类型第三方系统的唯一标识不能同时为空个
promotionStep List 坎级相关信息列表
promotionStep.stepLimit VARCHAR(32) 是 坎级起始值
promotionStep.discountAmount VARCHAR(32) 否 坎级的满减数量，满减时使用且必传
promotionStep.discountRatio VARCHAR(32) 否 坎级的折扣，满折时使用且必传

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": "",
    "return_data": "{id:5932650281301050811}"
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明
return_data String 促销id

# 商品满折满减促销终止

请求方式： POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/product/v1/stopFullDiscount/{ openid }/{ timestamp }/{ digest }/{ msg_id }在线调试
请求示例：

{
    "fullDiscountId": "5932650281301050831"
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
fullDiscountId VARCHAR(32) 否 满折满减促销id，fullDiscountId、sourceCode、code不能同时为空，如果同时存在，优先级依次降低
code VARCHAR(100) 否 满折满减促销编号，fullDiscountId、sourceCode、code不能同时为空，如果同时存在，优先级依次降低
sourceCode VARCHAR(100) 否 促销方案第三方编码，fullDiscountId、sourceCode、code不能同时为空，如果同时存在，优先级依次降低

响应示例：

{
    "msg_id": "PRD00002",
    "return_code": 100205,
    "return_msg": "满折满减促销ID、编号不能同时为空！"
}

参数说明：

参数 类型 说明
msg_id String 请求消息ID
return_code int 响应编码。0：成功，1：失败。其他详见附录错误码说明 (opens new window)
return_msg String 响应说明

← 商品特价促销接口 →