API开放平台

TIP

# 新增客户配额

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

{
    "name": "指定范围全部配额",
    "start_date": "2020-06-28",
    "end_date": "2020-06-28",
    "trade_type": "1",
    "cus_range_type": "2",
    "dept_id": "7233365496260253510,8233198284131411873",
    "customer_level_id": "8715900737400193117,7287736961434231483",
    "district_id": "2,3,4",
    "products": [
          {
            "id": "9043401268045478811",
            "unit_name": "箱",
            "unit_id": "6362931419429812568",
            "num": "200"
        }
    ]
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
name VARCHAR(100) 是 配额名称
start_date VARCHAR(32) 是 开始日期。格式：yyyy-MM-dd
end_date VARCHAR(32) 是 结束日期。格式：yyyy-MM-dd
trade_type VARCHAR(32) 是 客户对象。1：全部，2：经销商，3：终端门店。若cus_range_type传2，则本参数必填
cus_range_type VARCHAR (32) 是 客户范围。2：按客户属性设置范围，1：指定具体客户
dept_id VARCHAR(32) 否 客户属性-部门id，多个值用“,”分隔
dept_name VARCHAR(100) 否 客户属性-部门名称，多个值用“,”分隔
dept_code VARCHAR(100) 否 客户属性-部门编码，多个值用“,”分隔
dept_source_code VARCHAR(100) 否 客户属性-部门第三方系统的唯一标识，多个值用“,”分隔
customer_level_id VARCHAR(32) 否 客户属性-客户级别id，多个值用“,”分隔
customer_level_source_code VARCHAR(100) 否 客户属性-客户级别第三方系统的唯一标识，多个值用“,”分隔
customer_level_name VARCHAR(100) 否 客户属性-客户级别名称，多个值用“,”分隔
type_id VARCHAR(32) 否 客户属性-类型id，多个值用“,”分隔
type_code VARCHAR(100) 否 客户属性-类型编码，多个值用“,”分隔
type_name VARCHAR(100) 否 客户属性-类型名称，多个值用“,”分隔
type_source_code VARCHAR(100) 否 客户属性-类型第三方系统的唯一标识，多个值用“,”分隔
district_id VARCHAR(32) 否 客户属性-销售区域id，多个值用“,”分隔
district_code VARCHAR(100) 否 客户属性-销售区域编码，多个值用“,”分隔
district_name VARCHAR(100) 否 客户属性-销售区域名称，多个值用“,”分隔
district_source_code VARCHAR(100) 否 客户属性-销售区域第三方系统的唯一标识，多个值用“,”分隔
cm_id VARCHAR(32) 否 指定客户-经销商id。若cus_range_type为1，cm_id、cm_code、cm_name、cm_source_code不能同时为空
cm_code VARCHAR(32) 否 指定客户-经销商编码。若cus_range_type为1，cm_id、cm_code、cm_name、cm_source_code不能同时为空
cm_name VARCHAR(32) 否 指定客户-经销商名称。若cus_range_type为1，cm_id、cm_code、cm_name、cm_source_code不能同时为空
cm_source_code VARCHAR(32) 否 指定客户-经销商第三方系统的唯一标识。若cus_range_type为1，cm_id、cm_code、cm_name、cm_source_code不能同时为空
products List 列表
products.id VARCHAR(32) 否 商品id。id、code、source_code不能同时为空
products.code VARCHAR(100) 否 商品编码。id、code、source_code不能同时为空
products.source_code VARCHAR (100) 否 商品第三方系统的唯一标识。id、code、source_code不能同时为空
products.unit_name VARCHAR (32) 否 商品单位名称。unit_name和unit_id不能同时为空
products.unit_id VARCHAR(32) 否 商品单位id。unit_name和unit_id不能同时为空
products.num VARCHAR(32) 是 数量

响应示例：

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

数据DATA示例:

[
    {
       "id":"5932650281301050831"
    }
]

参数说明：

参数 类型 说明
id String 配额id

# 修改客户配额

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

{
    "quota_id": "5932650281301050831",
    "products": [
          {
            "id": "9043401268045478811",
            "num": "200"
        }
    ]
}
说明： 本示例仅供参考，具体以参数说明为准。该接口仅支持按商品设置的客户配额，不支持商品组。

参数说明：

参数 类型 必填 说明
quota_id VARCHAR(32) 是 配额id
products List 列表
products.id VARCHAR(32) 否 商品id。id、code、source_code不能同时为空
products.code VARCHAR(100) 否 商品编码。id、code、source_code不能同时为空
products.source_code VARCHAR (100) 否 商品第三方系统的唯一标识。id、code、source_code不能同时为空
products.num VARCHAR(32) 是 传入修改后的配额总量。单位对应为新增时配额行的单位。

响应示例：

{
    "msg_id": "X000001",
    "return_code": 0,
    "return_msg": ""
}

参数说明：

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

# 查询共享配额

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

{
    "id": "6225324992642325132",
    "name":"测试配额",
    "start_date": "2020-09-21",
    "end_date": "2020-10-21",
    "page_length": 1000,
    "page_number": 1
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
id VARCHAR(32) 否 客户配额id
name VARCHAR(32) 否 配额名称，模糊匹配
start_date VARCHAR(32) 否 开始日期。格式：yyyy-MM-dd
end_date VARCHAR(32) 否 结束日期。格式：yyyy-MM-dd
page_length int 否 分页每页记录条数，默认1000
page_number int 否 分页第几页，默认第1页

响应示例：

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

数据DATA示例:

[
    {
        "end_date": "2020-10-21 23:59:59",
        "name": "测试配额",
        "cus_range_type": "2",
        "customer_level": "8715900737400193117,7287736961434231483,8783574560179216331",
        "trade_type": "1",
        "id": "6225324992642325132",
        "district_id": "5880045821365020046,5151941004870826006",
        "dept_id": "8951924987151419703",
        "start_date": "2020-09-21 00:00:00",
        "type_id":"",
        "prods": [{
            "unit_name": "箱",
            "leave_num": "1.0",
            "use_num": "0.0",
            "pd_id": "6965466323694544792",
            "base_unit_num": "1.0",
            "ratio": 1.00000000
        }, {
            "unit_name": "瓶",
            "leave_num": "1.0",
            "use_num": "0.0",
            "pd_id": "5073938100193484331",
            "base_unit_num": "1.0",
            "ratio": 1.00000000
        }]
    }
]

参数说明：

参数 类型 说明
end_date TIMESTAMP 结束日期
name VARCHAR(32) 配额名称
cus_range_type VARCHAR(1) 客户范围。2：按客户属性设置范围，1：指定具体客户
trade_type VARCHAR(1) 客户对象。1：全部，2：经销商，3：终端门店
id VARCHAR(32) 配额id
district_id VARCHAR(32) 客户属性-销售区域id，多个值用“,”分隔
dept_id VARCHAR(32) 客户属性-部门id，多个值用“,”分隔
type_id VARCHAR(32) 客户属性-类型id，多个值用“,”分隔
customer_level VARCHAR(32) 客户属性-客户级别id，多个值用“,”分隔
prods List 列表
prods.unit_name VARCHAR(32) 录入单位名称
prods.leave_num VARCHAR(32) 基本单位可用配额
prods.use_num VARCHAR(32) 基本单位已用配额
prods.pd_id VARCHAR(32) 商品id
prods.base_unit_num VARCHAR(32) 基本单位配额总量
prods.ratio VARCHAR(32) 单位换算率

# 查询客户配额（限量）-按商品

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

{
    "cm_code": "CUS000002",
    "cm_id":"6225324992642325132",
    "start_date": "2020-09-21",
    "end_date": "2020-10-21",
    "page_number": 1,
    "page_length": 100
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 客户ID
cm_code VARCHAR(100) 否 客户编码，模糊匹配
start_date VARCHAR(32) 否 开始日期。格式：yyyy-MM-dd
end_date VARCHAR(32) 否 结束日期。格式：yyyy-MM-dd
page_number INT 否 页码默认1，每页默认1000条
page_length INT 否 每页记录条数，默认最大是1000条，可以根据业务数据的大小自行优化调整

响应示例：

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

数据DATA示例:

[
    {
      "end_date": "2021-11-30",
      "cm_code": "CUS000002",
      "cm_id": "8078723553496786531",
      "cm_name": "老杜的直营经销商",
      "id": "8877331564457593316",
      "start_date": "2021-10-18",
      "prods": [
        {
          "input_unit_name": "箱",
          "base_use_num": "96.00000000",
          "pd_name": "美年达1.5L",
          "input_unit": "5803442770927807830",
          "pd_id": "7143944694665909984",
          "pd_code": "baiyin_meinianda_015",
          "base_unit_num": "12000.00000000",
          "base_leave_num": "11904.00000000",
          "ratio": "12.00000000"
        },
        {
          "input_unit_name": "箱",
          "base_use_num": "206.00000000",
          "pd_name": "美年达1.8L",
          "input_unit": "7436738431149470274",
          "pd_id": "6594438290133846973",
          "pd_code": "baiyin_meinianda_0100",
          "base_unit_num": "12000.00000000",
          "base_leave_num": "11794.00000000",
          "ratio": "12.00000000"
        }
      ]
    }
]

参数说明：

参数 类型 说明
id VARCHAR(32) 配额ID
cm_id VARCHAR(32) 客户ID
cm_code VARCHAR(100) 客户编码
cm_name VARCHAR(100) 客户名称
start_date VARCHAR(32) 开始日期。格式：yyyy-MM-dd
end_date VARCHAR(32) 结束日期。格式：yyyy-MM-dd
prods List 商品集合
prods.pd_id VARCHAR(32) 商品ID
prods.pd_code VARCHAR(100) 商品编码
prods.pd_name VARCHAR(100) 商品名称
prods.input_unit VARCHAR(32) 录入单位ID
prods.input_unit_name VARCHAR(32) 录入单位名称
prods.base_leave_num VARCHAR(32) 基本单位可用配额
prods.base_use_num VARCHAR(32) 基本单位已用配额
prods.base_unit_num VARCHAR(32) 基本单位配额总量
prods.ratio VARCHAR(32) 单位换算率

# 查询客户配额（限量）-按商品组

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

{
    "cm_code": "USER001",
    "cm_id":"8078723553496786531",
    "start_date": "2020-09-21",
    "end_date": "2020-10-21",
    "page_number": 1,
    "page_length": 100
}
说明： 本示例仅供参考，具体以参数说明为准。

参数说明：

参数 类型 必填 说明
cm_id VARCHAR(32) 否 客户ID
cm_code VARCHAR(100) 否 客户编码，模糊匹配
start_date VARCHAR(32) 否 开始日期。格式：yyyy-MM-dd
end_date VARCHAR(32) 否 结束日期。格式：yyyy-MM-dd
page_number INT 否 页码默认1，每页默认1000条
page_length INT 否 每页记录条数，默认最大是1000条，可以根据业务数据的大小自行优化调整

响应示例：

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

数据DATA示例:

[
    {
      "end_date": "2022-02-18",
      "cm_code": "CUS010057",
      "start_date": "2022-01-29",
      "cm_id": "8261138874684328070",
      "cm_name": "经销商698",
      "set_type": "3",
      "id": 5182948809562810579,
      "pd_group": [
        {
          "prods": [
            {
              "pd_name": "徐福记鸡蛋味磨堡蛋糕开袋有礼袋装@4(5x190g) CN",
              "pd_id": "5649247804170269808",
              "pd_code": "12429127"
            },
            {
              "pd_name": "徐福记芝麻味磨堡蛋糕开袋有礼袋装@4(5x190g) CN",
              "pd_id": "6909802553692176330",
              "pd_code": "12429143"
            },
            {
              "pd_name": "奇欧比混合味皇冠巧伯礼桶巧克力代可可脂巧克力制品桶装@12x400gN1 CN",
              "pd_id": "5305586956782193565",
              "pd_code": "12429342"
            }
          ],
          "num": "1.00000000",
          "leave_num": "1.00000000",
          "id": "6286824530802957326",
          "use_num": "0.00000000"
        },
        {
          "prods": [
            {
              "pd_name": "徐福记沙琪玛蛋黄味礼箱装@4x1.258kg CN",
              "pd_id": "5519612291868405998",
              "pd_code": "12434809"
            },
            {
              "pd_name": "徐福记沙琪玛蛋黄味礼箱装@8x1.258kg CN",
              "pd_id": "6836469404668823760",
              "pd_code": "12434810"
            },
            {
              "pd_name": "徐福记混合口味颐和园综合礼盒@6x502gN1 CN",
              "pd_id": "5410301540946856948",
              "pd_code": "12437461"
            }
          ],
          "num": "1.00000000",
          "leave_num": "1.00000000",
          "id": "7260339783336677243",
          "use_num": "0.00000000"
        }
      ],
      "type_group": [
        {
              "types": [
                {
                  "type_name": "东东测试",
                  "type_id": "7457495518661131674"
                },
                {
                  "type_name": "科技",
                  "type_id": "5516029438444450722"
                }
              ],
              "num": "1.00000000",
              "leave_num": "1.00000000",
              "id": "7238401400236745981",
              "use_num": "0.00000000"
            }
      ]
    }
]

参数说明：

参数 类型 说明
id VARCHAR(32) 配额ID
cm_id VARCHAR(32) 客户ID
cm_code VARCHAR(100) 客户编码
cm_name VARCHAR(100) 客户名称
start_date VARCHAR(32) 开始日期。格式：yyyy-MM-dd
end_date VARCHAR(32) 结束日期。格式：yyyy-MM-dd
set_type VARCHAR(1) 2商品组（类型） 3、商品组（商品）
pd_group List 商品组（商品）集合 set_type=3
pd_group.num VARCHAR(32) 配额总量
pd_group.use_num VARCHAR(32) 已用配额
pd_group.leave_num VARCHAR(32) 可用配额
pd_group.prods List 商品集合
pd_group.prods.pd_id VARCHAR(32) 商品ID
pd_group.prods.pd_code VARCHAR(100) 商品编码
pd_group.prods.pd_name VARCHAR(100) 商品名称
type_group List 商品组（类型）集合 set_type=2
pd_group.num VARCHAR(32) 配额总量
pd_group.use_num VARCHAR(32) 已用配额
pd_group.leave_num VARCHAR(32) 可用配额
pd_group.types List 商品类型集合
pd_group.types.type_id VARCHAR(32) 商品类型ID
pd_group.types.type_name VARCHAR(100) 商品类型名称

← 抽取下游商贸版数据 →