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 响应说明

# 查询满折满减促销接口

请求方式：** POST（HTTPS）
请求地址： https://openapi.waiqin365.com/api/product/v1/queryFullDiscountPromotion/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试 (opens new window)
请求包体：


{
    "promotionId":"",
    "code":"",
    "sourceCode":"",
    "tradeType":"",
    "ownerDeptIds":"",
	"start_create_date":"2021-03-29",
	"end_create_date":"2021-03-29",
	"start_modify_date":"2021-03-29",
	"end_modify_date":"2021-03-29"
}

请求信息

参数 类型 必填 说明
promotionId VARCHAR(32) 否 促销id。promotionId、sourceCode、code如果同时存在，优先级依次降低
code VARCHAR(100) 否 促销编号。promotionId、sourceCode、code如果同时存在，优先级依次降低
sourceCode VARCHAR(100) 否 促销方案第三方编码。promotionId、sourceCode、code如果同时存在，优先级依次降低
tradeType VARCHAR(32) 否 促销对象 1 标准客户 2 经销商 3 终端门店
ownerDeptIds VARCHAR(100) 否 部门id（查询时不级联下级部门），多个用英文逗号分隔
start_create_date TIMESTAMP 否 创建时间开始，格式：“yyyy-MM-dd”
end_create_date TIMESTAMP 否 创建时间结束，格式：“yyyy-MM-dd”
start_modify_date TIMESTAMP 否 修改时间开始，格式：“yyyy-MM-dd”
end_modify_date TIMESTAMP 否 修改时间结束，格式：“yyyy-MM-dd”
page_number INT 否 页码默认1
page_length INT 否 每页记录条数，page_length为空时默认分页1000条

返回结果：

{
    "return_code":"0",
    "return_msg":null,
    "msg_id":null,
    "response_data":
    [
        {
            "id":"8513121636572377191",
            "status":"1",
            "createTime":"2021-03-30 14:53:17",
            "modifyTime":"2021-04-01 09:25:28",
            "code":"base02",
            "title": "满减满折",
            "startTime":"2021-04-03",
            "endTime":"2021-04-03",
            "tradeType":"3",
            "tradeRange":"1",
            "applyRangeType":"0",
            "promotionType": "1",
            "calcUnitName":"箱",
            "calcType":"1",
            "maxSaleAmount": "10000.30000",
            "saleAmount": "122",
            "productType": "1",
            "description": "促销说明",
            "fullMinusRule": "0",
            "promotionStatus": "TODO",
            "tpmActivityId": "",
            "tpmActivityName": "",
            "classIds": "4638315050773561214,4823236422556352886",
            "customerDept":[
                {
                    "sourceCode":"",
                    "code":"",
                    "name":"领导层",
                    "id":"6831472257980005622"
                }
            ],
            "promotionCustomer": [
                {
                    "cmName": "0227",
                    "cmCode": "CUS010148",
                    "cmId": "9069526468147157787",
                    "cmSourceCode": ""
                }
            ],
            "dealer":[
                {
                    "sourceCode":"",
                    "code":"CUS000002",
                    "name":"直营经销商",
                    "id":"8078723553496786531"
                }
            ],
            "promotionProduct":[
                {
                    "pdCode":"10002",
                    "pdSourceCode":"",
                    "pdId":"7407531258183844770"
                }
            ],
            "promotionStep":[
                {
                    "id":"",
                    "stepLimit":"1",
                    "discountAmount":"",
                    "discountRatio":"2"      
                }
            ]
        } 
    ]
}

响应信息

参数 类型 说明
msg_id String 消息ID
return_code int 响应编码：0成功 1失败
return_msg String 响应说明
response_data 响应数据体[{......}]
id VARCHAR(32) 促销id
status VARCHAR(32) 状态 0 删除 1 正常
createTime VARCHAR(32) 创建时间 格式：yyyy-MM-dd HH:mm:ss
modifyTime VARCHAR(32) 修改时间 格式：yyyy-MM-dd HH:mm:ss
code VARCHAR(100) 促销方案编号
title VARCHAR(100) 促销名称
startTime VARCHAR(32) 开始日期 格式：yyyy-MM-dd
endTime VARCHAR(32) 结束日期 格式：yyyy-MM-dd
tradeType VARCHAR(32) 促销对象 1标准客户 2 经销商 3 终端门店
tradeRange VARCHAR(32) 销售范围 1指定客户范围 2指定具体客户
applyRangeType VARCHAR (32) 适用范围 0 不限 1 业务员代下单 2 客户自主下单
promotionType VARCHAR (32) 促销类型 1按数量 2按金额
calcUnitName VARCHAR(32) 商品统计单位名称
calcType VARCHAR(32) 促销规则 1满折 2满减
maxSaleAmount VARCHAR(32) 累计促销额度
saleAmount VARCHAR(32) 已用额度
productType VARCHAR(32) 商品范围 1按商品，2按商品类型
description VARCHAR(4000) 促销说明
fullMinusRule VARCHAR(32) 满减规则 0阶梯满减， 1循环满减（calcType=2）
tpmActivityId VARCHAR(32) TPM活动id
tpmActivityName VARCHAR(32) TPM活动名称
classIds VARCHAR(32) 商品类型id,多个用逗号隔开
promotionStatus VARCHAR(32) 促销状态 TODO 未开始 DOING 进行中 OVER 已过期 STOP 已终止
ownerDeptId VARCHAR(32) 所属部门id
ownerDeptName VARCHAR(100) 所属部门名称
ownerDeptCode VARCHAR(100) 所属部门编码
ownerDeptSourceCode VARCHAR(100) 所属部门第三方系统的唯一标识
customerDept[].id VARCHAR(32) 客户属性 部门id
customerDept[].code VARCHAR(100) 客户属性 部门编码
customerDept[].sourceCode VARCHAR(100) 客户属性 部门第三方系统唯一标识
customerDept[].name VARCHAR(100) 客户属性 部门名称
promotionCustomer[].cmName VARCHAR(32) 促销指定客户 名称
promotionCustomer[].cmCode VARCHAR(100) 促销指定客户 编码
promotionCustomer[].cmSourceCode VARCHAR(100) 促销指定客户 第三方编码
promotionCustomer[].cmId VARCHAR(100) 促销指定客户 id
customerLevel[].id VARCHAR(32) 客户属性 客户等级id
customerLevel[].sourceCode VARCHAR(100) 客户属性 客户等级第三方系统唯一标识
customerLevel[].name VARCHAR(100) 客户属性 客户等级名称
customerType[].id VARCHAR(32) 客户属性 客户类型id
customerType[].code VARCHAR(100) 客户属性 客户类型编码
customerType[].sourceCode VARCHAR(100) 客户属性 客户类型第三方系统唯一标识
customerType[].name VARCHAR(100) 客户属性 客户类型名称
customerGradation[].id VARCHAR(32) 客户属性 客户层次id
customerGradation[].code VARCHAR(100) 客户属性 客户层次编码
customerGradation[].sourceCode VARCHAR(100) 客户属性 客户层次第三方系统唯一标识
customerGradation[].name VARCHAR(100) 客户属性 客户层次名称
customerGradation[].parentId VARCHAR(32) 客户属性 客户层次上级id
customerGradation[].parentCode VARCHAR(100) 客户属性 客户层次上级编码
customerGradation[].parentSourceCode VARCHAR(100) 客户属性 客户层次上级第三方系统唯一标识
customerGradation[].parentName VARCHAR(100) 客户属性 客户层次上级名称
district[].id VARCHAR(32) 客户属性 销售区域id
district[].code VARCHAR(100) 客户属性 销售区域编码
district[].sourceCode VARCHAR(100) 客户属性 销售区域第三方系统唯一标识
district[].name VARCHAR(100) 客户属性 销售区域名称
districtLevel[].id VARCHAR(32) 客户属性 销售区域等级id
districtLevel[].code VARCHAR(100) 客户属性 销售区域等级编码
districtLevel[].name VARCHAR(100) 客户属性 销售区域等级名称
uperCustomer[].Id VARCHAR(32) 客户属性 上级客户id
uperCustomer[].code VARCHAR(100) 客户属性 上级客户编码
uperCustomer[].sourceCode VARCHAR(100) 客户属性 上级客户第三方系统唯一标识
uperCustomer[].name VARCHAR(100) 客户属性 上级客户名称
dealer[].id VARCHAR(32) 客户属性 经销商id
dealer[].code VARCHAR(100) 客户属性 经销商编码
dealer[].sourceCode VARCHAR(100) 客户属性 经销商第三方系统唯一标识
dealer[].name VARCHAR(100) 客户属性 经销商名称
tradingareaBig[].id VARCHAR(32) 客户属性 大商圈id
tradingareaBig[].name VARCHAR(100) 客户属性 大商圈名称
tradingareaNomal[].id VARCHAR(32) 客户属性 商圈id
tradingareaNomal[].name VARCHAR(100) 客户属性 商圈名称
kaSys VARCHAR(100) 客户属性 ka系统名称 多个逗号隔开
perScale VARCHAR(100) 客户属性 人员规模 多个逗号隔开
customerSource VARCHAR(100) 客户属性 来源名称 多个逗号隔开
trade VARCHAR(100) 客户属性 行业名称 多个逗号隔开
extField[].extKey VARCHAR(32) 客户属性 自定义字段编码
extField[].extName VARCHAR(100) 客户属性 自定义字段名称
extField[].extValue VARCHAR(100) 客户属性 自定义字段值 多个逗号隔开
promotionProductType[].classId VARCHAR(32) productType=2 商品类型id
promotionProductType[].className VARCHAR(100) productType=2 商品类型编码
promotionProductType[].sourceCode VARCHAR(100) productType=2 商品类型第三方系统唯一标识
promotionProduct[].pdId VARCHAR(32) productType=1 商品id
promotionProduct[].pdCode VARCHAR(100) productType=1 商品编码
promotionProduct[].pdSourceCode VARCHAR(100) productType=1 商品第三方系统唯一标识
promotionStep[].id VARCHAR(32) 坎级id
promotionStep[].stepLimit VARCHAR(32) 阶梯起始值（数量/金额）
promotionStep[].discountAmount VARCHAR(32) 满减金额 calcType=2
promotionStep[].discountRatio VARCHAR(32) 满折比例 calcType=1

← 商品特价促销接口 →