# 商品买赠促销新增修改

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


{
    "name": "主品达到满赠数量,送固定数量赠品", 
    "code": "cuxiao-1117",
    "desc": "满10赠1份赠品",
    "startDate": "2019-07-01",
    "endDate": "2020-07-31",
    "tradeType": "3",
    "cusRangeType": "2",
    "applyRangeType": "0",
    "overType":"1",
    "estimateSalesAmount": "10000",
    "promotionType": "0",
    "isMustInclude": "1",
    "calcMode": "0",
    "promotionMode":"1",
    "calcType": "1",
    "giftMode": "1",
    "unitName": "箱",
    "promotionSend": "0",
    "giftType": "3",
    "giftChooseNum":"1", 
    "deptName": "零售部",
    "typeName": "南京,建邺",
    "customerLevelName": "A,B",
    "ladderGift": "0",
    "products": [{
        "code": "102",
        "mustInclude": "1",
        "mustNum": "2"
        },
        {
        "code": "103",
         "mustInclude": "1",
         "mustNum": "3"
    }],
    "gifts": [{
        "code": "wq_guozhi_001",
        "unitName": "瓶",
        "price":"7",
        "num": "1"
        },{
        "code": "wq_guozhi_002",
        "unitName": "瓶",
        "price":"7",
        "num": "2"
    }],
    "step": [{
        "calcLimit": "10",
        "num":"2",
        "seq":"1",
        "mustIncludeTotalNum":"2",
        "gifts": [{
                "code": "wq_guozhi_001",
                "unitName": "瓶",
                "price":"7",
                "num": "1"
                },{
                "code": "wq_guozhi_002",
                "unitName": "瓶",
                "price":"7",
                "num": "2"
            }]
    }],
    "additionPromotions":[
        {
            "promotionMode":"1",
            "giftMode": "1",
            "giftType": "3",
            "giftChooseNum":"1", 
            "products": [
                {
                    "id": "",
                    "code": "102"
                },
                {
                    "id": "",
                    "code": "103"
                }
            ],
            "gifts": [{
                "code": "wq_guozhi_001",
                "unitName": "瓶",
                "price":"7",
                "num": "1"
                },{
                "code": "wq_guozhi_002",
                "unitName": "瓶",
                "price":"7",
                "num": "2"
            }],
            "step": [{
                "calcLimit": "10",
                "num":"2",
                "seq":"1"
            }]
        }
    ]
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
name VARCHAR(100) 促销方案名称
code VARCHAR(100) 促销方案编号,新增操作时code不能为空。促销方案编号、促销方案第三方编码、促销id不能同时为空。promotionId、sourceCode、code如果同时存在,优先级依次降低
sourceCode VARCHAR(100) 促销方案第三方编码。促销方案编号、促销方案第三方编码、促销id不能同时为空。promotionId、sourceCode、code如果同时存在,优先级依次降低
promotionId VARCHAR(32) 促销id。促销方案编号、促销方案第三方编码、促销id不能同时为空。promotionId、sourceCode、code如果同时存在,优先级依次降低
desc VARCHAR(4000) 促销说明
startDate VARCHAR(32) 开始日期。格式:yyyy-MM-dd
endDate VARCHAR(32) 结束日期。格式:yyyy-MM-dd
tradeType VARCHAR(32) 促销对象。1:标准客户,2:经销商,3:终端门店
cusRangeType VARCHAR (32) 客户范围。2:按客户属性设置范围,1: 指定具体客户
applyRangeType VARCHAR (32) 适用范围,默认值为0。0:不限,1:业务员代下单,2:客户自主下单
overType VARCHAR(32) 叠加促销。1:是,不传:否。若promotionType为1,则本参数不传
estimateSalesAmount VARCHAR(100) 预计销售额
promotionType VARCHAR(32) 促销类型。0:按数量,1:按金额
isMustInclude VARCHAR(32) 是否必含。0:无必含,2:必含任一,1:必含全部。若calcType为3或6或7,则本参数不得传1或2
calcMode VARCHAR(32) 启用坎级。1:启用,空或者其他:不启用
promotionMode VARCHAR(32) 主品范围。1:商品,2:商品类型,3:同价码
calcType VARCHAR(32) 促销子类型。1:主品达到满赠数量送固定数量赠品,2:主品达到满赠金额送固定数量赠品,3:主品达到满赠数量按主品的数量比例送赠品,4:主品达到满赠数量送固定金额的赠品,5:主品达到满赠金额送固定金额的赠品,6:主品达到满赠数量按主品的数量比例送赠品,7:主品达到满赠金额按主品的金额比。如果promotionType传值为0,则calcType只能传1/2/3;如果promotionType传值为1,则calcType只能传4/5/6/7。如果promotionMode传值为2,则calcType只能传1/2
promotionSend VARCHAR(32) 满送规则。0:满X送Y,1:每满X送Y。若calcType为1或2或4或5,则本参数必传
giftMode VARCHAR(32) 赠品范围。1:按商品,2:按同价码,3:不限商品。如果promotionType传值为0,calcType传值为1或2,则giftMode只能传1;如果promotionType传值为0,calcType传值为3,则giftMode只能传1/2,不能传3
giftType VARCHAR(32) 赠品赠送方式。1:赠送全部,2:任一赠品,3:任选其几。如果calcType传值为1或2,则本参数必传
giftChooseNum VARCHAR(32) 赠品种数。若giftType为3,则本参数必填
unitName VARCHAR(32) 单位名称。如果calcType传值为1/3/4/6,则本参数必传;如果isMustInclude传值为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) 客户属性-上级客户id,多个值用“,”分隔
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,多个值用“,”分隔。cusRangeType为1时,cmId、cmSourceCode、 cmCode、cmName不能同时为空,如果同时存在,优先级依次降低
cmCode VARCHAR(4000) 指定客户-经销商编码,多个值用“,”分隔。cusRangeType为1时,cmId、cmSourceCode、 cmCode、cmName不能同时为空,如果同时存在,优先级依次降低
cmName VARCHAR(4000) 指定客户-经销商名称,多个值用“,”分隔。cusRangeType为1时,cmId、cmSourceCode、 cmCode、cmName不能同时为空,如果同时存在,优先级依次降低
cmSourceCode VARCHAR(4000) 指定客户-经销商第三方系统的唯一标识,多个值用“,”分隔。cusRangeType为1时,cmId、cmSourceCode、 cmCode、cmName不能同时为空,如果同时存在,优先级依次降低
mustAllAddition VARCHAR(32) 附加促销案同时满足。1:是,0:否。默认值为0
ladderGift VARCHAR(32) 是否启用不同坎级维护不同赠品。1:是,0:否。默认值为0
tpmActivityId VARCHAR(32) TPM活动方案ID(ID,编码,名称任选其一)
tpmActivityCode VARCHAR(100) TPM活动方案编码(ID,编码,名称任选其一)
tpmActivityName VARCHAR(100) TPM活动方案名称(ID,编码,名称任选其一)
products List 列表
products.id VARCHAR(32) 主品id。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
products.code VARCHAR(100) 主品编码。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
products.sourceCode VARCHAR (100) 主品第三方系统的唯一标识。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
products.mustInclude VARCHAR (32) 是否必含。0:非必含,1 必含
products.mustNum VARCHAR(32) 必含数量
products.priceCode VARCHAR(32) 主品同价码。如果promotionMode传值为3,则本参数必填
products.typeName VARCHAR(32) 商品类型名称。如果promotionMode传值为2,则typeName和typeSourceCode必填一个,同时存在时优先级依次降低
products.typeSourceCode VARCHAR(32) 商品类型第三方系统的唯一标识。如果promotionMode传值为2,则typeName和typeSourceCode必填一个,同时存在时优先级依次降低
gifts List 列表
gifts.id VARCHAR(32) 赠品id。不启用坎级促销使用此字段。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
gifts.code VARCHAR(100) 赠品编码。不启用坎级促销使用此字段。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
gifts.sourceCode VARCHAR (100) 赠品第三方系统的唯一标识。不启用坎级促销使用此字段。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
gifts.unitId VARCHAR(32) 赠品单位id。不启用坎级促销使用此字段。如果calcType传值为1/2,unitId和unitName不能同时为空
gifts.unitName VARCHAR(100) 赠品单位名称。不启用坎级促销使用此字段。如果calcType传值为1/2,unitId和unitName不能同时为空
gifts.price VARCHAR (32) 价格。不启用坎级促销使用此字段。整数位不大于7位
gifts.num VARCHAR(32) 数量。不启用坎级促销使用此字段。如果calcType传值为1/2,则本参数必填
gifts.priceCode VARCHAR (32) 同价码。不启用坎级促销使用此字段。如果giftMode传值为2,则本参数必填
step List 列表
step.calcLimit VARCHAR(32) 坎级-满送数量。该值必须是大于0的整数
step.num VARCHAR(32) 坎级-赠品赠送数量或比例。数量为非零整数,如果是赠品赠送比例则该值在1-100之间,支持小数
step.seq VARCHAR(32) 坎级-排序。当坎级促销时,step.seq和stepProduct.seq保持一致,默认从1开始
step.mustIncludeTotalNum VARCHAR(32) 坎级-必含总数量。当isMustInclude = 2时传此参数
step.gifts list
step.gifts.id VARCHAR(32) 启用坎级促销使用此字段,赠品id。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
step.gifts.code VARCHAR(100) 启用坎级促销使用此字段,赠品编码。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
step.gifts.sourceCode VARCHAR (100) 赠品第三方系统的唯一标识。启用坎级促销使用此字段。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
step.gifts.unitId VARCHAR(32) 赠品单位id。启用坎级促销使用此字段。如果calcType传值为1/2,unitId和unitName不能同时为空
step.gifts.unitName VARCHAR(100) 赠品单位名称。启用坎级促销时使用此字段。如果calcType传值为1/2,unitId和unitName不能同时为空
step.gifts.price VARCHAR (32) 价格。启用坎级促销时使用此字段。整数位不能大于7位
step.gifts.num VARCHAR(32) 数量。启用坎级促销时使用此字段。如果calcType传值为1/2,则本参数必填
step.gifts.priceCode VARCHAR (32) 同价码。启用坎级促销时使用此字段。如果giftMode传值为2,则本参数必填
stepProduct List 列表
stepProduct.id VARCHAR(32) 坎级-主品id。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
stepProduct.code VARCHAR(100) 坎级-主品编码。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
stepProduct.sourceCode VARCHAR (100) 坎级-主品第三方系统的唯一标识。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
stepProduct.mustNum VARCHAR(32) 坎级-必含数量
stepProduct.seq VARCHAR(32) 坎级-排序。当坎级促销时,stepProduct.seq和step.seq保持一致,默认从1开始
stepProduct.priceCode VARCHAR (32) 同价码
stepProduct.typeName VARCHAR(32) 商品类型名称。如果promotionMode传值为2并且是必含类型时,typeName和typeSourceCode必填一个,同时存在时优先级依次降低
stepProduct.typeSourceCode VARCHAR(32) 商品类型第三方系统的唯一标识。如果promotionMode传值为2并且是必含类型时,typeName和typeSourceCode必填一个,同时存在时优先级依次降低
additionPromotions List 列表
additionPromotions
.promotionMode
VARCHAR(32) 主品范围。1:商品,3:同价码
additionPromotions
.giftMode
VARCHAR(32) 赠品范围。1:按商品,2:按同价码,3:不限商品。如果主促销promotionType传值为0,calcType传值为1/2,则giftMode只能传1;如果主促销promotionType传值为0,calcType传值为3,则giftMode只能传值1/2,不能传3
additionPromotions
.giftType
VARCHAR(32) 赠品赠送方式。1:赠送全部,2:任一赠品,3:任选其几。如果calcType传值为1/2,则本参数必填
additionPromotions
.giftChooseNum
VARCHAR(32) 赠品种数。如果giftType传值为3,则本参数必传
additionPromotions
.products
List 主品相关信息列表
additionPromotions
.products.id
VARCHAR(32) 主品id。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
additionPromotions
.products.code
VARCHAR(100) 主品编码。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
additionPromotions
.products.sourceCode
VARCHAR (100) 主品第三方系统的唯一标识。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
additionPromotions
.products.priceCode
VARCHAR(32) 主品同价码,若promotionMode传值为3,则本参数必填
additionPromotions
.gifts
List 赠品相关详细列表
additionPromotions
.gifts.id
VARCHAR(32) 赠品id。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
additionPromotions
.gifts.code
VARCHAR(100) 赠品编码。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
additionPromotions
.gifts.sourceCode
VARCHAR (100) 赠品第三方系统的唯一标识。id、source_code、code不能同时为空,如果同时存在,优先级依次降低
additionPromotions
.gifts.unitId
VARCHAR(32) 赠品单位id。如果主促销calcType传1/2,则unitId和unitName不能同时为空
additionPromotions
.gifts.unitName
VARCHAR(100) 赠品单位名称。如果主促销calcType传1/2,则unitId和unitName不能同时为空
additionPromotions
.gifts.price
VARCHAR (32) 价格。整数位不大于7位
additionPromotions
.gifts.num
VARCHAR(32) 数量。如果主促销calcType传值为1/2,则本参数必填
additionPromotions
.gifts.priceCode
VARCHAR (32) 同价码。如果giftMode传值为2,则本参数必填
additionPromotions
.step
List 坎级相关信息列表
additionPromotions
.step.calcLimit
VARCHAR(32) 坎级-满送数量。该值必须是大于0的整数
additionPromotions
.step.num
VARCHAR(32) 坎级-赠品赠送数量或比例。如果是赠品赠送数量,则该值为非零整数;如果是赠品赠送比例则该值在1-100之间,支持小数
additionPromotions
.step.seq
VARCHAR(32) 坎级-排序。默认从1开始

响应示例:

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

参数说明:

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

# 商品买赠促销终止

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

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

参数说明:

参数 类型 必填 说明
promotionId VARCHAR(32) 买赠促销id。promotionId、code、sourceCode不能同时为空。当promotionId、sourceCode、code同时存在时,优先级依次是promotionId、sourceCode、code
code VARCHAR(100) 买赠促销编号。promotionId、code、sourceCode不能同时为空。当promotionId、sourceCode、code同时存在时,优先级依次是promotionId、sourceCode、code
sourceCode VARCHAR(100) 促销方案第三方编码。promotionId、code、sourceCode不能同时为空。当promotionId、sourceCode、code同时存在时,优先级依次是promotionId、sourceCode、code

响应示例:

{
    "msg_id": "PRD00001",
    "return_code": 100605,
    "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/approvalPromotion/{ openid }/{ timestamp }/{ digest }/{ msg_id } 在线调试
请求示例:

{
    "verifyType":"1",
    "promotionId": "4946850940792367567",
    "code": "",
    "sourceCode": "",
    "approverId":"7383973919713831055",
    "approverCode":"",
    "approverSourceCode":"",
    "reason":""
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
verifyType VARCHAR(32) 操作类型:1:审批通过;0:审批打回。默认1
promotionId VARCHAR(32) 买赠促销id。promotionId、code、sourceCode不能同时为空,同时存在时,优先级依次是promotionId、sourceCode、code
code VARCHAR(100) 买赠促销编号。promotionId、code、sourceCode不能同时为空,同时存在时,优先级依次是promotionId、sourceCode、code
sourceCode VARCHAR(100) 促销方案第三方编码。promotionId、code、sourceCode不能同时为空,同时存在时,优先级依次是promotionId、sourceCode、code
approverId VARCHAR(32) 审批人id。approverId、approverCode、approverSourceCode不能同时为空,同时存在时,优先级依次是approverId、approverSourceCode、approverCode
approverCode VARCHAR(100) 审批人账号。approverId、approverCode、approverSourceCode不能同时为空,同时存在时,优先级依次是approverId、approverSourceCode、approverCode
approverSourceCode VARCHAR(100) 审批人第三方编码。approverId、approverCode、approverSourceCode不能同时为空,同时存在时,优先级依次是approverId、approverSourceCode、approverCode
reason VARCHAR(1000) 审批意见

响应示例:

{
    "msg_id": "PRD00001",
    "return_code": 100605,
    "return_msg": ""
}

参数说明:

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

# 按具体客户设置的促销案移除客户

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

{
    "promotionId": "5932650281301050831",
    "cmId": "8590918626089497578"
}
说明: 本示例仅供参考,具体以参数说明为准。

参数说明:

参数 类型 必填 说明
promotionId VARCHAR(32) 买赠促销id。promotionId、sourceCode、code不能同时为空,如果同时存在,优先级依次降低
code VARCHAR(100) 买赠促销编号。promotionId、sourceCode、code不能同时为空,如果同时存在,优先级依次降低
sourceCode VARCHAR(100) 促销方案第三方编码。promotionId、sourceCode、code不能同时为空,如果同时存在,优先级依次降低
cmId VARCHAR(2000) 指定客户-经销商id,多个值用“,”分隔。cmId、cmSourceCode、cmCode、cmName不能同时为空,如果同时存在,优先级依次降低
cmCode VARCHAR(4000) 指定客户-经销商编码,多个值用“,”分隔。cmId、cmSourceCode、cmCode、cmName不能同时为空,如果同时存在,优先级依次降低
cmName VARCHAR(4000) 指定客户-经销商名称,多个值用“,”分隔。cmId、cmSourceCode、cmCode、cmName不能同时为空,如果同时存在,优先级依次降低
cmSourceCode VARCHAR(4000) 指定客户-经销商第三方系统的唯一标识,多个值用“,”分隔。cmId、cmSourceCode、cmCode、cmName不能同时为空,如果同时存在,优先级依次降低

响应示例:

{
    "msg_id": "PRD00001",
    "return_code": 100605,
    "return_msg": "买赠促销ID、编号不能同时为空!"
}

参数说明:

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

# 查询买赠促销接口

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


{
    "promotionId":"8513121636572377191",
    "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为空时不分页

响应示例:

{
    "return_code": "0", 
    "return_msg": "响应信息",
    "msg_id": "{ msg_id }",  
    "response_data": "<<DATA>>"
}

数据DATA示例:

[
    {
       "id":"8513121636572377191",
       "status":"1",
       "code":"base02",
       "sourceCode":"",
       "name":"base02",
       "desc":"base02",
       "createTime":"2021-03-30 14:53:17",
       "modifyTime":"2021-04-01 09:25:28",
       "startDate":"2021-04-03",
       "endDate":"2021-04-03",
       "promotionStatus":"TODO",
       "tradeType":"3",
       "cusRangeType":"2",
       "applyRangeType":"0",
       "overType":"",
       "estimateSalesAmount":"",
       "promotionType":"0",
       "isMustInclude":"0",
       "calcMode":"0",
       "calcType":"1",
       "promotionMode":"1",
       "promotionSend":"0",
       "giftMode":"1",
       "giftType":"1",
       "giftChooseNum":null,
       "unitName":"箱",
       "tpmActivityId": "00",
       "tpmActivityName": "",
       "customerDept":[
           {
               "sourceCode":null,
               "code":"",
               "name":"领导层",
               "id":"6831472257980005622"
           }
       ],
       "dealer":[
           {
               "sourceCode":null,
               "code":"CUS000002",
               "name":"直营经销商",
               "id":"8078723553496786531"
           }
       ],
       "district":[
           {
               "sourceCode":null,
               "code":null,
               "name":"北京",
               "id":"21"
           }
       ],
       "districtLevel":[
           {
               "code":"01",
               "name":"商圈等级01",
               "id":"7262791226267413030"
           }
       ],
       "extField":[
           {
               "extKey":"exdf_315220",
               "extName":"NPOS客户",
               "extValue":"否"
           }
       ],
       "ownerDeptCode":"",
       "ownerDeptId":"6831472257980005622",
       "ownerDeptName":"领导层",
       "ownerDeptSourceCode":"",
       "trade":"",
       "perScale":"",
       "kaSys":"乐购,麦德龙",
       "promotionCustomer":[],
       "promotionProduct":[
           {
               "pdCode":"10002",
               "priceCode":null,
               "pdSourceCode":null,
               "mustNum":0,
               "mustInclude":"0",
               "pdId":"7407531258183844770"
           }
       ],
       "promotionProductType":[],
       "promotionStep":[
           {
               "calcGiftRatio":null,
               "giftCount":"1",
               "calcGiftAmount":null,
               "calcLimit":"2",
               "promotionGift":[
                   {
                       "pdCode":"12428312",
                       "priceCode":null,
                       "unitName":"EA",
                       "pdSourceCode":null,
                       "price":1,
                       "num":1,
                       "unitId":9169148270007998246,
                       "pdId":"6764860176378859575"
                   }
                ]
           }
       ],
       "tradingareaBig":[
           {
               "name":"大商圈01",
               "id":"6272513770095625958"
           }
       ],
       "tradingareaNomal":[
           {
               "name":"商圈01",
               "id":"8967982663644204305"
           }
       ],
       "uperCustomer":[],
       "hasAddition":"0",
       "mustAllAddition":"0",
       "additionPromotions":[]
    }
]

参数说明:

参数 类型 必填 说明
id VARCHAR(32) 促销id
status VARCHAR(32) 状态。0:删除,1:正常
code VARCHAR(100) 促销方案编号
sourceCode VARCHAR(100) 促销方案第三方编码
name VARCHAR(100) 促销方案名称
desc VARCHAR(4000) 促销说明
creatorCode VARCHAR(32) 创建人编码
creatorName VARCHAR(32) 创建人名称
createTime VARCHAR(32) 创建时间。格式:yyyy-MM-dd HH:mm:ss
modifyTime VARCHAR(32) 修改时间。格式:yyyy-MM-dd HH:mm:ss
startDate VARCHAR(32) 开始日期。格式:yyyy-MM-dd
endDate VARCHAR(32) 结束日期。格式:yyyy-MM-dd
promotionStatus VARCHAR(32) 促销状态。TODO:未开始,DOING:进行中,OVER:已过期,STOP:已终止
approvalStatus VARCHAR(32) 审批状态。0:待审批,1:已审批,2:已打回
approvalReason VARCHAR(32) 审批原因
approvalTime VARCHAR(32) 审批时间。格式:yyyy-MM-dd HH:mm:ss
approverCode VARCHAR(32) 审批人编码
approverName VARCHAR(32) 审批人名称
tradeType VARCHAR(32) 促销对象。1:标准客户,2:经销商,3:终端门店
cusRangeType VARCHAR (32) 客户范围。2:按客户属性设置范围,1:指定具体客户
applyRangeType VARCHAR (32) 适用范围。0:不限,1:业务员代下单,2:客户自主下单
overType VARCHAR(32) 叠加促销。1:是,其他:否
estimateSalesAmount VARCHAR(100) 预计销售额
promotionType VARCHAR(32) 促销类型。0:按数量 1:按金额
isMustInclude VARCHAR(32) 是否必含。0:无必含 2:必含任一 1:必含全部
calcMode VARCHAR(32) 启用坎级。1 启用 空或者其他 不启用
promotionMode VARCHAR(32) 主品范围。1:商品 2:商品类型 3:同价码
calcType VARCHAR(32) 促销子类型。1:主品达到满赠数量送固定数量赠品,2:主品达到满赠金额送固定数量赠品,3:主品达到满赠数量按主品的数量比例送赠品,4:主品达到满赠数量送固定金额的赠品,5:主品达到满赠金额送固定金额的赠品,6:主品达到满赠数量按主品的数量比例送赠品,7:主品达到满赠金额按主品的金额比
promotionSend VARCHAR(32) 满送规则。0:满X送Y,1:每满X送Y
giftMode VARCHAR(32) 赠品范围。1:按商品,2:按同价码,3:不限商品
giftType VARCHAR(32) 赠品赠送方式。1:赠送全部,2:任一赠品,3:任选其几
giftChooseNum VARCHAR(32) 赠品种数
unitName VARCHAR(32) 单位名称
tpmActivityId VARCHAR(32) TPM活动方案ID
tpmActivityName VARCHAR(200) TPM活动方案名称
ownerDeptId VARCHAR(32) 所属部门id
ownerDeptName VARCHAR(100) 所属部门名称
ownerDeptCode VARCHAR(100) 所属部门编码
ownerDeptSourceCode VARCHAR(100) 所属部门第三方系统的唯一标识
hasAddition VARCHAR(32) 是否有附加促销
mustAllAddition VARCHAR(32) 附加促销案同时满足。1:是,0:否
ladderGift VARCHAR(32) 是否启用坎级促销。1:是,0:否
customerDept List 客户属性-中部门信息列表
customerDept.id VARCHAR(32) 客户属性-部门id
customerDept.code VARCHAR(100) 客户属性-部门编码
customerDept.sourceCode VARCHAR(100) 客户属性-部门第三方系统唯一标识
customerDept.name VARCHAR(100) 客户属性-部门名称
customerLevel.id VARCHAR(32) 客户属性-客户等级id
customerLevel List 客户属性-中客户等级信息列表
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 List 客户属性-中客户层次信息列表
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 List 客户属性-中销售区域信息列表
district.id VARCHAR(32) 客户属性-销售区域id
district.code VARCHAR(100) 客户属性-销售区域编码
district.sourceCode VARCHAR(100) 客户属性-销售区域第三方系统唯一标识
district.name VARCHAR(100) 客户属性-销售区域名称
districtLevel List 客户属性-中销售区域等级列表
districtLevel.id VARCHAR(32) 客户属性-销售区域等级id
districtLevel.code VARCHAR(100) 客户属性-销售区域等级编码
districtLevel.name VARCHAR(100) 客户属性-销售区域等级名称
uperCustomer List 客户属性-中上级客户列表
uperCustomer.Id VARCHAR(32) 客户属性-上级客户id
uperCustomer.code VARCHAR(100) 客户属性-上级客户编码
uperCustomer.sourceCode VARCHAR(100) 客户属性-上级客户第三方系统唯一标识
uperCustomer.name VARCHAR(100) 客户属性-上级客户名称
dealer List 客户属性-中经销商信息列表
dealer.id VARCHAR(32) 客户属性-经销商id
dealer.code VARCHAR(100) 客户属性-经销商编码
dealer.sourceCode VARCHAR(100) 客户属性-经销商第三方系统唯一标识
dealer.name VARCHAR(100) 客户属性-经销商名称
tradingareaBig List 客户属性-中大商圈列表
tradingareaBig.id VARCHAR(32) 客户属性-大商圈id
tradingareaBig.name VARCHAR(100) 客户属性-大商圈名称
tradingareaNomal List 客户属性-中商圈列表
tradingareaNomal.id VARCHAR(32) 客户属性-商圈id
tradingareaNomal.name VARCHAR(100) 客户属性-商圈名称
kaSys VARCHAR(100) 客户属性-ka系统名称,多个值用“,”隔开
perScale VARCHAR(100) 客户属性-人员规模,多个值用“,”隔开
customerSource VARCHAR(100) 客户属性-来源名称,多个值用“,”隔开
trade VARCHAR(100) 客户属性-行业名称,多个值用“,”隔开
extField List 客户属性-中自定义字段列表
extField.extKey VARCHAR(32) 客户属性-自定义字段编码
extField.extName VARCHAR(100) 客户属性-自定义字段名称
extField.extValue VARCHAR(100) 客户属性-自定义字段值,多个值用“,”隔开
promotionCustomer List 指定具体客户信息列表
promotionCustomer.cmId VARCHAR(32) 指定具体客户-客户id
promotionCustomer.cmCode VARCHAR(100) 指定具体客户-客户编码
promotionCustomer.cmSourceCode VARCHAR(100) 指定具体客户-客户第三方系统唯一标识
promotionCustomer.cmName VARCHAR(100) 指定具体客户-客户名称
promotionProduct List 主品列表
promotionProduct.pdId VARCHAR(32) 主品-商品id。如果promotionMode=1,则返回该字段
promotionProduct.pdCode VARCHAR(100) 主品-商品编码。如果promotionMode=1,则返回该字段
promotionProduct.pdSourceCode VARCHAR(100) 主品-商品第三方系统唯一标识。如果promotionMode=1,则返回该字段
promotionProduct.priceCode VARCHAR(100) 主品-商品同价码。如果promotionMode=3,则返回该字段
promotionProduct.mustInclude VARCHAR(100) 主品-是否必含。0:非必含,1:必含
promotionProduct.mustNum VARCHAR(100) 主品-必含数量
promotionProductType List 商品类型列表
promotionProductType.classId VARCHAR(32) 主品-商品类型id。如果promotionMode=2,则返回该字段
promotionProductType.className VARCHAR(100) 主品-商品类型编码。如果promotionMode=2,则返回该字段
promotionProductType.sourceCode VARCHAR(100) 主品-商品类型第三方系统唯一标识。如果promotionMode=2,则返回该字段
promotionGift List 赠品信息列表
promotionGift.pdId VARCHAR(32) 赠品-商品id。如果ladderGift=0,则返回该字段
promotionGift.pdCode VARCHAR(100) 赠品-商品编码。如果ladderGift=0,则返回该字段
promotionGift.pdSourceCode VARCHAR(100) 赠品-商品第三方系统唯一标识。如果ladderGift=0,则返回该字段
promotionGift.priceCode VARCHAR(100) 赠品-商品同价码。如果ladderGift=0,则返回该字段
promotionGift.unitId VARCHAR(32) 赠品-单位id。如果ladderGift=0,则返回该字段
promotionGift.unitName VARCHAR(100) 赠品-单位名称。如果ladderGift=0,则返回该字段
promotionGift.price VARCHAR(100) 赠品-单价。如果ladderGift=0,则返回该字段
promotionGift.num VARCHAR(100) 赠品-数量。如果ladderGift=0,则返回该字段
promotionStep List 坎级相关信息列表
promotionStep.stepLimit VARCHAR(100) 坎级-满送数量
promotionStep.giftCount VARCHAR(100) 坎级-赠品赠送数量
promotionStep.giftRatio VARCHAR(100) 坎级-赠品赠送比例
promotionStep.giftAmount VARCHAR(100) 坎级-赠品赠送金额
promotionStep
.stepProduct
List 坎级中商品相关信息列表
promotionStep
.stepProduct
.stepDetailId
VARCHAR(100) 坎级-必含id
promotionStep
.stepProduct
.pdId
VARCHAR(32) 坎级-必含商品id
promotionStep
.stepProduct
.pdCode
VARCHAR(100) 坎级-必含商品编码
promotionStep
.stepProduct
.pdSourceCode
VARCHAR(100) 坎级-必含商品第三方唯一标识
promotionStep
.stepProduct
.priceCode
VARCHAR(100) 坎级-必含商品同价码
promotionStep
.stepProduct
.class_id
VARCHAR(32) 坎级-必含商品类型id
promotionStep
.stepProduct
.className
VARCHAR(100) 坎级-必含商品类型名称
promotionStep
.stepProduct
.mustNum
VARCHAR(100) 坎级-必含数量
promotionStep
.promotionGift
List 坎级中赠品相关信息列表
promotionStep
.promotionGift
.pdId
VARCHAR(32) 坎级-赠品-商品id。如果ladderGift=1,则返回该字段
promotionStep
.promotionGift
.pdCode
VARCHAR(100) 坎级-赠品-商品编码。如果ladderGift=1,则返回该字段
promotionStep
.promotionGift
.pdSourceCode
VARCHAR(100) 坎级-赠品-商品第三方系统唯一标识。如果ladderGift=1,则返回该字段
promotionStep
.promotionGift
.priceCode
VARCHAR(100) 坎级-赠品-商品同价码。如果ladderGift=1,则返回该字段
promotionStep
.promotionGift
.unitId
VARCHAR(32) 坎级-赠品-单位id。如果ladderGift=1,则返回该字段
promotionStep
.promotionGift
.unitName
VARCHAR(100) 坎级-赠品-单位名称。如果ladderGift=1,则返回该字段
promotionStep
.promotionGift
.price
VARCHAR(100) 坎级-赠品-单价。如果ladderGift=1,则返回该字段
promotionStep
.promotionGift
.num
VARCHAR(100) 坎级-赠品-数量。如果ladderGift=1,则返回该字段
additionPromotions List 列表
additionPromotions
.promotionMode
VARCHAR(32) 主品范围。1:商品,3:同价码
additionPromotions
.giftMode
VARCHAR(32) 赠品范围。1:按商品,2:按同价码,3:不限商品
additionPromotions
.giftType
VARCHAR(32) 赠品赠送方式。1:赠送全部,2:任一赠品,3:任选其几
additionPromotions
.giftChooseNum
VARCHAR(32) 赠品种数
additionPromotions
.description
VARCHAR(100) 促销描述
additionPromotions
.sequ
VARCHAR(100) 顺序号
additionPromotions
.promotionProduct
List 列表
additionPromotions
.promotionProduct
.pdId
VARCHAR(32) 主品-商品id。当promotionMode=1时返回
additionPromotions
.promotionProduct
.pdCode
VARCHAR(100) 主品-商品编码。当promotionMode=1时返回
additionPromotions
.promotionProduct
.pdSourceCode
VARCHAR(100) 主品-商品第三方系统唯一标识。当promotionMode=1时返回
additionPromotions
.promotionProduct
.priceCode
VARCHAR(100) 主品-商品同价码。当promotionMode=3时返回
additionPromotions
.promotionStep
List 列表
additionPromotions
.promotionStep
.stepLimit
VARCHAR(100) 坎级-满送数量
additionPromotions
.promotionStep
.giftCount
VARCHAR(100) 坎级-赠品赠送数量
additionPromotions
.promotionStep
.giftRatio
VARCHAR(100) 坎级-赠品赠送比例
additionPromotions
.promotionStep
.giftAmount
VARCHAR(100) 坎级-赠品赠送金额
additionPromotions
.promotionStep
.promotionGift
List 列表
additionPromotions
.promotionStep
.promotionGift
.pdId
VARCHAR(32) 坎级-赠品-商品id
additionPromotions
.promotionStep
.promotionGift
.pdCode
VARCHAR(100) 坎级-赠品-商品编码
additionPromotions
.promotionStep
.promotionGift
.pdSourceCode
VARCHAR(100) 坎级-赠品-商品第三方系统唯一标识
additionPromotions
.promotionStep
.promotionGift
.priceCode
VARCHAR(100) 坎级-赠品-商品同价码
additionPromotions
.promotionStep
.promotionGift
.unitId
VARCHAR(32) 坎级-赠品-单位id
additionPromotions
.promotionStep
.promotionGift
.unitName
VARCHAR(100) 坎级-赠品-单位名称
additionPromotions
.promotionStep
.promotionGift
.price
VARCHAR(100) 坎级-赠品-单价
additionPromotions
.promotionStep
.promotionGift
.num
VARCHAR(100) 坎级-赠品-数量