API开放平台

TIP

查询商品可售范围条件设置
清除指定范围的可售商品设置
新增/删除指定范围的可售商品
清除指定客户的可售商品设置
新增/修改指定客户的可售商品
查询客户可售商品规则接口
查询指定客户可售商品规则接口

# 查询商品可售范围条件设置

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

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
无

响应示例：

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

数据DATA示例:

[
    {
         "sale_ranges":
         [
            {
                "filter_code":"dept_id",
                "filter_name":"部门"
            },
            {
                "filter_code":"business_id",
                "filter_name":"销售区域类型"
            },
            {
                "filter_code":"customer_level",
                "filter_name":"客户级别"
            },
            {
                "filter_code":"district_level",
                "filter_name":"销售区域"
            },
            {
                "filter_code":"type_id",
                "filter_name":"客户类型"
            },
            {
                "filter_code":"tradingarea_big",
                "filter_name":"大商圈"
            },
            {
                "filter_code":"tradingarea_nomal",
                "filter_name":"商圈"
            },
            {
                "filter_code":"city_level",
                "filter_name":"城市等级"
            }
          ]
    }
]

参数说明：

参数	类型	必填	说明
sale_ranges	List	是	企业设置的可售范围条件列表
sale_ranges.filter_code	VARCHAR(32)	是	企业设置的可售范围条件编码
sale_ranges.filter_name	VARCHAR(100)	是	企业设置的可售范围条件名称

# 清除指定范围的可售商品设置

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


{
    "type_id": "4785910927580508975",
    "type_code": "4785910927580508975",
    "type_name": "4785910927580508975",
    "district_level_id": "1",
    "district_level_code": "1",
    "district_level_name": "1"
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
dept_id	VARCHAR(32)	否	部门
dept_code	VARCHAR(100)	否	部门编码
dept_name	VARCHAR(32)	否	部门名称
business_id	VARCHAR(32)	否	销售区域类型id
business_code	VARCHAR(100)	否	销售区域类型编码
business_name	VARCHAR(32)	否	销售区域类型名称
customer_level_id	VARCHAR(32)	否	客户级别id
customer_level_code	VARCHAR(100)	否	客户级别编码
customer_level_name	VARCHAR(32)	否	客户级别名称
district_level_id	VARCHAR(32)	否	销售区域id
district_level_code	VARCHAR(100)	否	销售区域编码
district_level_name	VARCHAR(32)	否	销售区域名称
type_id	VARCHAR(32)	否	客户类型id
type_code	VARCHAR(100)	否	客户类型编码
type_name	VARCHAR(32)	否	客户类型名称
tradingarea_big_id	VARCHAR(32)	否	大商圈id
tradingarea_big_code	VARCHAR(100)	否	大商圈编码
tradingarea_big_name	VARCHAR(32)	否	大商圈名称
tradingarea_nomal_id	VARCHAR(32)	否	商圈id
tradingarea_nomal_code	VARCHAR(100)	否	商圈编码
tradingarea_nomal_name	VARCHAR(32)	否	商圈名称
kasys_id	VARCHAR(32)	否	连锁品牌id
kasys_name	VARCHAR(100)	否	连锁品牌名称
city_level_id	VARCHAR(32)	否	城市等级id
city_level_name	VARCHAR(100)	否	城市等级名称

响应示例：

{
    "msg_id": "PRD00001",
    "return_code": "1",
    "return_msg": "删除成功！"
}

异常示例：

{
    "msg_id": "PRD00001",
    "return_code": "0",
    "return_msg": "没有当前指定范围！"
}

参数说明：

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

# 新增/删除指定范围的可售商品

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

{
    "opt_type":"0",
    "type_id":"4785910927580508975",
    "type_code":"4785910927580508975",
    "type_name":"4785910927580508975",
    "district_level_id":"1",
    "district_level_code":"1",
    "district_level_name":"1",
    "sale_products":[
        {
            "product_id":"6831390366898028953",
            "product_code":"6831390366898028953",
            "is_must_sale":"0",
            "is_new":"0"
        },
        {
            "product_id":"6831390366898028953",
            "product_code":"6831390366898028953",
            "is_must_sale":"0",
            "is_new":"0"
        }
    ]
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
opt_type	VARCHAR(1)	是	操作类型。0：记录不存在新增，记录存在修改；1：删除当商品不存在此可售记录删除
dept_id	VARCHAR(32)	否	部门
dept_code	VARCHAR(100)	否	部门编码
dept_name	VARCHAR(32)	否	部门名称
business_id	VARCHAR(32)	否	销售区域类型id
business_code	VARCHAR(100)	否	销售区域类型编码
business_name	VARCHAR(32)	否	销售区域类型名称
customer_level_id	VARCHAR(32)	否	客户级别id
customer_level_code	VARCHAR(100)	否	客户级别编码
customer_level_name	VARCHAR(32)	否	客户级别名称
district_level_id	VARCHAR(32)	否	销售区域id
district_level_code	VARCHAR(100)	否	销售区域编码
district_level_name	VARCHAR(32)	否	销售区域名称
type_id	VARCHAR(32)	否	客户类型id
type_code	VARCHAR(100)	否	客户类型编码
type_name	VARCHAR(32)	否	客户类型名称
tradingarea_big_id	VARCHAR(32)	否	大商圈id
tradingarea_big_code	VARCHAR(100)	否	大商圈编码
tradingarea_big_name	VARCHAR(32)	否	大商圈名称
tradingarea_nomal_id	VARCHAR(32)	否	商圈id
tradingarea_nomal_code	VARCHAR(100)	否	商圈编码
tradingarea_nomal_name	VARCHAR(32)	否	商圈名称
kasys_id	VARCHAR(32)	否	连锁品牌id
kasys_name	VARCHAR(100)	否	连锁品牌名称
city_level_id	VARCHAR(32)	否	城市等级id
city_level_name	VARCHAR(100)	否	城市等级名称
sale_products	List		列表
sale_products.product_id	VARCHAR(32)	否	勤策商品id。product_id、product_code传一个
sale_products.product_code	VARCHAR(32)	否	商品编码。 product_id、product_code传一个
sale_products.is_must_sale	String	是	是否必售。0：否，1：是
sale_products.is_new	String	是	是否新品。0：否，1：是

响应示例：

{
    "msg_id": "PRD00001",
    "return_code":"0",
    "return_msg":"删除成功！"
}

异常示例：

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

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
cm_id	VARCHAR(32)	否	客户id。cm_id、cm_cod、cm_name、cm_source_code不能同时为空
cm_code	VARCHAR(100)	否	客户编码。cm_id、cm_cod、cm_name、cm_source_code不能同时为空
cm_name	VARCHAR(100)	否	客户名称。cm_id、cm_cod、cm_name、cm_source_code不能同时为空
cm_source_code	VARCHAR(100)	否	客户第三方系统的唯一标识。cm_id、cm_cod、cm_name、cm_source_code不能同时为空

响应示例：

{
    "msg_id": "PRD00001",
    "return_code": "1",
    "return_msg": "删除成功！"
}

异常示例：

{
    "msg_id": "PRD00001",
    "return_code": "0",
    "return_msg": "当前客户没有可售范围！"
}

参数说明：

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

# 新增/修改指定客户的可售商品

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

{
    "cm_name": "3栋副食店KH1Q1008051A",
    "opt_type":"0",
    "sale_products":[
        {
            "product_id":"6831390366898028953",
            "is_must_sale":"0",
            "is_new":"0"
        },
        {
            "product_id":"6831390366898028953",
            "is_must_sale":"0",
            "is_new":"0"
        }
    ]
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
opt_type	VARCHAR(1)	否	操作类型。0：记录不存在新增，记录存在修改；1：删除当商品不存在此可售记录删除，默认0
cm_id	VARCHAR(32)	否	客户id。cm_id、cm_code、cm_name、cm_source_code不能同时为空
cm_code	VARCHAR(100)	否	客户编码。cm_id、cm_code、cm_name、cm_source_code不能同时为空
cm_name	VARCHAR(100)	否	客户名称。cm_id、cm_code、cm_name、cm_source_code不能同时为空
cm_source_code	VARCHAR(100)	否	客户第三方系统的唯一标识。cm_id、cm_code、cm_name、cm_source_code不能同时为空
sale_products	List	否	列表
sale_products.product_id	VARCHAR(32)	否	勤策商品id
sale_products.product_code	VARCHAR(100)	否	商品编码
sale_products.product_source_code	VARCHAR(100)	否	商品第三方系统的唯一标识
sale_products.is_must_sale	String	否	是否必售。1：是，其他或者不传默认0
sale_products.is_new	String	否	是否新品。1：是，其他或者不传默认0

响应示例：

{
    "msg_id": "PRD00001",
    "return_code":"0",
    "return_msg":"保存成功！"
}

异常示例：

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

{
	"page_number":1,
	"page_length":1000,
	"start_create_date":"2018-08-11 00:00:00",
	"end_create_date":"2018-08-13 00:00:00",
	"start_modify_date":"2018-08-11 00:00:00",
	"end_modify_date":"2018-08-13 00:00:00"
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
page_number	INT	是	页码默认1，每页默认1000条
page_length	INT	否	每页记录条数，默认最大是1000条，可以根据业务数据的大小自行优化调整
start_create_date	VARCHAR(32)	否	创建时间开始。格式：yyyy-MM-dd HH:mm:ss
end_create_date	VARCHAR(32)	否	创建时间结束。格式：yyyy-MM-dd HH:mm:ss
start_modify_date	VARCHAR(32)	否	修改时间开始。格式：yyyy-MM-dd HH:mm:ss
end_modify_date	VARCHAR(32)	否	修改时间结束。格式：yyyy-MM-dd HH:mm:ss

响应示例：

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

数据DATA示例:

[
    {
        "create_time":"2018-08-11 15:49:39",
        "id":8931837644917765665,
        "modify_time":"2018-08-11 15:50:16",
        "must_sale_num":"0",
        "new_num":"0",
        "sale_range_id":8931837644917765665,
        "salesRangeCusFields":[
            {
                "filter_code":"type_id",
                "filter_name":"客户类型",
                "id":6184347277682374425,
                "selected_code":"",
                "selected_id":"7968458325024557719",
                "selected_name":"单点批发"
            },
            {
                "filter_code":"tradingarea_nomal",
                "filter_name":"商圈",
                "id":6260455080631727311,
                "selected_code":"",
                "selected_id":"8702964406382546046",
                "selected_name":"商圈1"
            },
            {
                "filter_code":"tradingarea_big",
                "filter_name":"大商圈",
                "id":9069169946530505707,
                "selected_code":"",
                "selected_id":"8915396741599168227",
                "selected_name":"大商圈1"
            },
            {
                "filter_code":"district_level",
                "filter_name":"销售区域",
                "id":6608042176664733990,
                "selected_code":"",
                "selected_id":"1",
                "selected_name":"百事"
            },
            {
                "filter_code":"dept_id",
                "filter_name":"部门",
                "id":9001396946987509361,
                "selected_code":"12qqq 12qqq",
                "selected_id":"5954366674468213302",
                "selected_name":"12qqq"
            },
            {
                "filter_code":"customer_level",
                "filter_name":"客户级别",
                "id":8806079279039106451,
                "selected_code":"",
                "selected_id":"8715900737400193117",
                "selected_name":"A"
            },
            {
                "filter_code":"business_id",
                "filter_name":"销售区域类型",
                "id":5093726624218126261,
                "selected_code":"D1",
                "selected_id":"6607275807085210917",
                "selected_name":"区域一级"
            }
        ],
        "salesRangeProducts":[
            {
                "id":7012029134273647459,
                "is_must_sale":"0",
                "is_new":"0",
                "product_code":"10003",
                "product_id":"7409269227144953294",
                "product_name":"冰红茶"
            },
            {
                "id":7726747662619089912,
                "is_must_sale":"0",
                "is_new":"0",
                "product_code":"10005",
                "product_id":"4892238857644646947",
                "product_name":"红牛2"
            },
            {
                "id":6273951810870222744,
                "is_must_sale":"0",
                "is_new":"0",
                "product_code":"10003",
                "product_id":"7409269227144953294",
                "product_name":"冰红茶"
            },
            {
                "id":5423778557109808420,
                "is_must_sale":"0",
                "is_new":"0",
                "product_code":"10005",
                "product_id":"4892238857644646947",
                "product_name":"红牛2"
            },
            {
                "id":6932219754808624768,
                "is_must_sale":"0",
                "is_new":"0",
                "product_code":"10004",
                "product_id":"8886153687546478293",
                "product_name":"冰绿茶"
            },
            {
                "id":7636454392684308314,
                "is_must_sale":"0",
                "is_new":"0",
                "product_code":"10006",
                "product_id":"8821042479510943327",
                "product_name":"鲜橙多"
            }
        ],
        "sku_num":"4",
        "status":"1"
    }
]

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	规则id
status	VARCHAR(1)	是	0：已删除，1：正常
create_time	VARCHAR(32)	是	创建时间。格式：yyyy-MM-dd HH:mm:ss
modify_time	VARCHAR(32)	否	修改时间。格式：yyyy-MM-dd HH:mm:ss
salesRangeCusFields	List		列表
salesRangeCusFields.id	VARCHAR(32)	是	id
salesRangeCusFields.filter_code	VARCHAR(32)	是	范围类型编码
salesRangeCusFields.filter_name	VARCHAR(32)	是	范围类型编码名称
salesRangeCusFields.selected_id	text	是	选择的范围类型对应的id（勤策id）
salesRangeCusFields.selected_code	text	否	选择的范围类型对应的code（勤策code）
salesRangeCusFields.selected_name	text	是	选择的范围类型对应的名称
salesRangeProducts	List		列表
salesRangeProducts.id	VARCHAR(32)	是	id
salesRangeProducts.product_id	VARCHAR(32)	是	商品id
salesRangeProducts.product_code	VARCHAR(100)	是	商品code
salesRangeProducts.product_name	VARCHAR(100)	是	商品名称
salesRangeProducts.is_must_sale	VARCHAR(1)	是	是否是必售类型。1：是，0：不是
salesRangeProducts.is_new	VARCHAR(1)	是	是否是新品。1：是，0：不是

# 查询指定客户可售商品规则接口

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

{
	"page_number":1,
	"page_length":1000,
	"start_create_date":"2018-08-11 00:00:00",
	"end_create_date":"2018-08-13 00:00:00",
	"start_modify_date":"2018-08-11 00:00:00",
	"end_modify_date":"2018-08-13 00:00:00"
}

说明：本示例仅供参考，具体以参数说明为准。

参数说明：

参数	类型	必填	说明
page_number	INT	是	页码默认1，每页默认1000条
page_length	INT	否	每页记录条数，默认最大是1000条，可以根据业务数据的大小自行优化调整
start_create_date	VARCHAR(32)	否	创建时间开始。格式：yyyy-MM-dd HH:mm:ss
end_create_date	VARCHAR(32)	否	创建时间结束。格式：yyyy-MM-dd HH:mm:ss
start_modify_date	VARCHAR(32)	否	修改时间开始。格式：yyyy-MM-dd HH:mm:ss
end_modify_date	VARCHAR(32)	否	修改时间结束。格式：yyyy-MM-dd HH:mm:ss
cm_id	VARCHAR(32)	否	客户id。cm_id、cm_code、cm_name、cm_source_code同时存在时优先级依次递减
cm_code	VARCHAR(100)	否	客户编码。cm_id、cm_code、cm_name、cm_source_code同时存在时优先级依次递减
cm_name	VARCHAR(100)	否	客户名称。cm_id、cm_code、cm_name、cm_source_code同时存在时优先级依次递减
cm_source_code	VARCHAR(100)	否	客户第三方系统的唯一标识。cm_id、cm_code、cm_name、cm_source_code同时存在时优先级依次递减

响应示例：

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

数据DATA示例:

[
    {
        "create_time":"2018-11-30 15:26:01",
        "id":9027759415563698664,
        "modify_time":"2018-11-30 15:26:25",
        "must_sale_num":"0",
        "new_num":"0",
        "sale_range_id":9027759415563698664,
        "salesRangeCusFields":"",
        "salesRangeCuss":[
            {
                "cm_code":"CUS00000006",
                "cm_id":"5300173088207827217",
                "cm_name":"0011",
                "id":8943860421295367749
            }
        ],
        "salesRangeProducts":[
            {
                "id":8597238343034968358,
                "is_must_sale":"0",
                "is_new":"0",
                "product_code":"gg1",
                "product_id":"8767618269212739907",
                "product_name":"吴玉朋测试商品1",
                "supply_id": "-1",
                "supply_name": ""
            },
            {
                "id":6638947252995118822,
                "is_must_sale":"0",
                "is_new":"0",
                "product_code":"bbbbbb",
                "product_id":"8373727014019352452",
                "product_name":"44444",
                "supply_id": "-1",
                "supply_name": ""
            }
        ],
        "sku_num":"53",
        "status":"0"
    },
    {
        "create_time":"2018-11-30 15:26:11",
        "id":7134981969607683061,
        "modify_time":"",
        "must_sale_num":"0",
        "new_num":"0",
        "sale_range_id":7134981969607683061,
        "salesRangeCusFields":"",
        "salesRangeCuss":[
            {
                "cm_code":"CUS00000041",
                "cm_id":"6602287084437569921",
                "cm_name":"1017测试图片3",
                "id":6301606084119096279
            }
        ],
        "salesRangeProducts":[
            {
                "id":9152209221613959467,
                "is_must_sale":"0",
                "is_new":"0",
                "product_code":"10013",
                "product_id":"7489464564558832148",
                "product_name":"茉莉花茶2",
                "supply_id": "-1",
                "supply_name": ""
            },
            {
                "id":8450149111019872409,
                "is_must_sale":"0",
                "is_new":"0",
                "product_code":"10002",
                "product_id":"7407531258183844770",
                "product_name":"雪碧",
                "supply_id": "-1",
                "supply_name": ""
            }
        ],
        "sku_num":"2",
        "status":"1"
        }
]

参数说明：

参数	类型	必填	说明
id	VARCHAR(32)	是	规则id
status	VARCHAR(1)	是	0：已删除，1：正常
create_time	VARCHAR(32)	是	创建时间。格式：yyyy-MM-dd HH:mm:ss
modify_time	VARCHAR(32)	否	修改时间。格式：yyyy-MM-dd HH:mm:ss
salesRangeCuss	List		此处只返回指定的那一个客户的相关信息
salesRangeCuss.id	VARCHAR(32)	是	id
salesRangeCuss.cm_id	VARCHAR(32)	是	客户id
salesRangeCuss.cm_code	VARCHAR(32)	是	客户code
salesRangeCuss.cm_name	VARCHAR(100)	是	客户name
salesRangeProducts	List
salesRangeProducts.id	VARCHAR(32)	是	id
salesRangeProducts.product_id	VARCHAR(32)	是	商品id
salesRangeProducts.product_code	VARCHAR(100)	是	商品code
salesRangeProducts.product_name	VARCHAR(100)	是	商品名称
salesRangeProducts.is_must_sale	VARCHAR(1)	是	是否是必售类型。1：是，0：不是
salesRangeProducts.is_new	VARCHAR(1)	是	是否是新品。1：是，0：不是
salesRangeProducts.supply_id	VARCHAR(32)	是	上级供货商id：-1代表全部可售
salesRangeProducts.supply_name	VARCHAR(100)	否	上级供货商name

← 商品信息接口商品价格方案接口 →