跳转至

分销服务

分销相关的API服务，包含分销主服务（聚合各子服务能力）以及其余核心接口。

子服务页面（完整接口文档）：

说明：为避免文档冗长，以下主服务文档隐藏了大部分“委托方法”（即简单转发到子服务的方法）。 如需查看完整子服务接口，请参考源码中的 kwaixiaodian.client.services.distribution.* 模块。

异步分销服务

kwaixiaodian.client.services.distribution.main.AsyncDistributionService(client: AsyncBaseClient)

异步分销服务

整合各个分销子服务，提供完整的分销功能接口。

参考 - 开发文档（限流）: docs/开发指南和规则协议/开发文档/API限流说明.md - 开发文档（授权）: docs/开发指南和规则协议/开发文档/APP授权说明.md - 规则协议（日志接入规范）: docs/开发指南和规则协议/规则协议/开放平台/开放平台日志接入规范.md - 错误处理: docs/error-handling.md

初始化分销服务

参数：

名称 类型 描述 默认
client AsyncBaseClient

基础客户端实例

 必需

方法：

名称 描述
get_kwaimoney_preheat_work_link

委托到CPS服务的获取快手货币预热工作链接方法
get_kwaimoney_requirement_cursor_list

委托到CPS服务的获取快手货币需求游标列表方法
get_selection_list

委托到CPS服务的获取精选列表方法
create_distribute_plan

创建分销计划
update_distribute_plan

更新分销计划
query_plan

查询分销计划
query_plan_commission

查询分销计划佣金
add_distribution_plan_promoter

添加分销计划推广者
delete_distribution_plan_promoter

删除分销计划推广者
update_promote

推广更新
add_item_selection_url

商品选品添加URL
add_item_shelf_url

商品货架添加URL
query_selection_item_detail

查询选品商品详情
offline_distribution_selection

分销精选下线
pick_distribution_selection

分销精选选品
create_distribution_activity_item_share

创建分销活动商品分享
get_distribution_distributor_order_list

获取分销商订单列表
get_distribution_public_category_list

获取分销公开分类列表
save_distribution_seller_sample_rule

保存分销卖家样本规则
test_distribution

分销测试

Functions

委托到CPS服务的获取快手货币预热工作链接方法

get_kwaimoney_requirement_cursor_list(*args, **kwargs) async

委托到CPS服务的获取快手货币需求游标列表方法

get_selection_list(*args, **kwargs) async

委托到CPS服务的获取精选列表方法

create_distribute_plan(access_token: str, plan_create_type: Optional[str] = None, normal_plan_param: Optional[Dict[str, Any]] = None, exclusive_plan_param: Optional[Dict[str, Any]] = None, orientation_plan_param: Optional[Dict[str, Any]] = None, uid: Optional[int] = None) -> DistributePlanCreateResponse async

创建分销计划

OpenAPI: open.distribution.plan.create (POST) Java: OpenDistributionPlanCreateRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPlanCreateRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
plan_create_type Optional[str]

计划创建类型（可选）。

 None
normal_plan_param Optional[Dict[str, Any]]

普通计划参数（可选）。

 None
exclusive_plan_param Optional[Dict[str, Any]]

独家计划参数（可选）。

 None
orientation_plan_param Optional[Dict[str, Any]]

定向计划参数（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributePlanCreateResponse DistributePlanCreateResponse

分销计划创建结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
update_distribute_plan(access_token: str, plan_id: Optional[int] = None, update_type: Optional[str] = None, update_plan_status_param: Optional[Dict[str, Any]] = None, update_normal_commission_param: Optional[Dict[str, Any]] = None, update_orientation_commission_param: Optional[Dict[str, Any]] = None, uid: Optional[int] = None) -> DistributePlanUpdateResponse async

更新分销计划

OpenAPI: open.distribution.plan.update (POST) Java: OpenDistributionPlanUpdateRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPlanUpdateRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
plan_id Optional[int]

计划ID（可选）。

 None
update_type Optional[str]

更新类型（可选）。

 None
update_plan_status_param Optional[Dict[str, Any]]

更新计划状态参数（可选）。

 None
update_normal_commission_param Optional[Dict[str, Any]]

更新普通佣金参数（可选）。

 None
update_orientation_commission_param Optional[Dict[str, Any]]

更新定向佣金参数（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributePlanUpdateResponse DistributePlanUpdateResponse

分销计划更新结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
query_plan(access_token: str, item_id: Optional[int] = None, uid: Optional[int] = None) -> PlanQueryResponse async

查询分销计划

OpenAPI: open.distribution.plan.query (GET) Java: OpenDistributionPlanQueryRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPlanQueryRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
item_id Optional[int]

商品ID（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
PlanQueryResponse PlanQueryResponse

分销计划信息。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
query_plan_commission(access_token: str, plan_id: int, pcursor: Optional[str] = None, uid: Optional[int] = None) -> PlanCommissionQueryResponse async

查询分销计划佣金

OpenAPI: open.distribution.plan.commission.query (GET) Java: OpenDistributionPlanCommissionQueryRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPlanCommissionQueryRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
plan_id int

计划ID。

 必需
pcursor Optional[str]

分页游标（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
PlanCommissionQueryResponse PlanCommissionQueryResponse

佣金明细或汇总数据。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
add_distribution_plan_promoter(access_token: str, plan_id: int, promoter_ids: List[int], uid: Optional[int] = None) -> DistributionPlanAddPromoterResponse async

添加分销计划推广者

OpenAPI: open.distribution.distribution.plan.add.promoter (GET) Java: OpenDistributionDistributionPlanAddPromoterRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionDistributionPlanAddPromoterRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
plan_id int

计划ID。

 必需
promoter_ids List[int]

推广者ID列表。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionPlanAddPromoterResponse DistributionPlanAddPromoterResponse

添加推广者的处理结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
delete_distribution_plan_promoter(access_token: str, plan_id: int, promoter_ids: List[int], uid: Optional[int] = None) -> DistributionPlanDeletePromoterResponse async

删除分销计划推广者

OpenAPI: open.distribution.distribution.plan.delete.promoter (GET) Java: OpenDistributionDistributionPlanDeletePromoterRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionDistributionPlanDeletePromoterRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
plan_id int

计划ID。

 必需
promoter_ids List[int]

推广者ID列表。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionPlanDeletePromoterResponse DistributionPlanDeletePromoterResponse

删除推广者的处理结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
update_promote(access_token: str, commission_id: List[int], status: int, uid: Optional[int] = None) -> PromoteUpdateResponse async

推广更新

OpenAPI: open.distribution.promote.update (POST) Java: OpenDistributionPromoteUpdateRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPromoteUpdateRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
commission_id List[int]

佣金ID列表。

 必需
status int

状态码。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
PromoteUpdateResponse PromoteUpdateResponse

推广更新处理结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
add_item_selection_url(access_token: str, selection_id: int, url: str, uid: Optional[int] = None) -> ItemSelectionAddUrlResponse async

商品选品添加URL

OpenAPI: open.distribution.item.selection.add.url (GET) Java: OpenDistributionItemSelectionAddUrlRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionItemSelectionAddUrlRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
selection_id int

选品ID。

 必需
url str

URL地址。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
ItemSelectionAddUrlResponse ItemSelectionAddUrlResponse

添加结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
add_item_shelf_url(access_token: str, shelf_id: int, url: str, uid: Optional[int] = None) -> ItemShelfAddUrlResponse async

商品货架添加URL

OpenAPI: open.distribution.item.shelf.add.url (GET) Java: OpenDistributionItemShelfAddUrlRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionItemShelfAddUrlRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
shelf_id int

货架ID。

 必需
url str

URL地址。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
ItemShelfAddUrlResponse ItemShelfAddUrlResponse

添加结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
query_selection_item_detail(access_token: str, selection_id: int, item_id: int, uid: Optional[int] = None) -> QuerySelectionItemDetailResponse async

查询选品商品详情

OpenAPI: open.distribution.query.selection.item.detail (GET) Java: OpenDistributionQuerySelectionItemDetailRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionQuerySelectionItemDetailRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
selection_id int

选品ID。

 必需
item_id int

商品ID。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
QuerySelectionItemDetailResponse QuerySelectionItemDetailResponse

选品商品详情数据。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
offline_distribution_selection(access_token: str, selection_id: int, uid: Optional[int] = None) -> DistributionSelectionOfflineResponse async

分销精选下线

OpenAPI: open.distribution.selection.offline (POST) Java: OpenDistributionSelectionOfflineRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionSelectionOfflineRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
selection_id int

精选ID。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionSelectionOfflineResponse DistributionSelectionOfflineResponse

下线操作结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
pick_distribution_selection(access_token: str, selection_id: int, item_ids: List[int], uid: Optional[int] = None) -> DistributionSelectionPickResponse async

分销精选选品

OpenAPI: open.distribution.selection.pick (POST) Java: OpenDistributionSelectionPickRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionSelectionPickRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
selection_id int

精选ID。

 必需
item_ids List[int]

商品ID列表。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionSelectionPickResponse DistributionSelectionPickResponse

选品操作结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
create_distribution_activity_item_share(access_token: str, activity_id: int, item_id: int, share_title: str, share_desc: Optional[str] = None, uid: Optional[int] = None) -> DistributionActivityItemShareCreateResponse async

创建分销活动商品分享

OpenAPI: open.distribution.activity.item.share.create (POST) Java: OpenDistributionActivityItemShareCreateRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionActivityItemShareCreateRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
activity_id int

活动ID。

 必需
item_id int

商品ID。

 必需
share_title str

分享标题。

 必需
share_desc Optional[str]

分享描述（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionActivityItemShareCreateResponse DistributionActivityItemShareCreateResponse

分享创建结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
get_distribution_distributor_order_list(access_token: str, distributor_id: int, begin_time: Optional[int] = None, end_time: Optional[int] = None, order_status: Optional[int] = None, page: Optional[int] = None, page_size: Optional[int] = None, uid: Optional[int] = None) -> DistributionDistributorOrderListResponse async

获取分销商订单列表

OpenAPI: open.distribution.distributor.order.list (GET) Java: OpenDistributionDistributorOrderListRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionDistributorOrderListRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
distributor_id int

分销商ID。

 必需
begin_time Optional[int]

开始时间（毫秒）（可选）。

 None
end_time Optional[int]

结束时间（毫秒）（可选）。

 None
order_status Optional[int]

订单状态（可选）。

 None
page Optional[int]

页码（可选）。

 None
page_size Optional[int]

页面大小（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionDistributorOrderListResponse DistributionDistributorOrderListResponse

订单分页数据。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
get_distribution_public_category_list(access_token: str, uid: Optional[int] = None) -> DistributionPublicCategoryListResponse async

获取分销公开分类列表

OpenAPI: open.distribution.public.category.list (GET) Java: OpenDistributionPublicCategoryListRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPublicCategoryListRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionPublicCategoryListResponse DistributionPublicCategoryListResponse

公开分类列表。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
save_distribution_seller_sample_rule(access_token: str, rule_name: str, rule_config: Dict[str, Any], uid: Optional[int] = None) -> DistributionSellerSampleRuleSaveResponse async

保存分销卖家样本规则

OpenAPI: open.distribution.seller.sample.rule.save (POST) Java: OpenDistributionSellerSampleRuleSaveRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionSellerSampleRuleSaveRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
rule_name str

规则名称。

 必需
rule_config Dict[str, Any]

规则配置。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionSellerSampleRuleSaveResponse DistributionSellerSampleRuleSaveResponse

保存结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
test_distribution(access_token: str, test_param: str, uid: Optional[int] = None) -> DistributionTestResponse async

分销测试

OpenAPI: open.distribution.test (GET) Java: OpenDistributionTestRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionTestRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
test_param str

测试参数。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionTestResponse DistributionTestResponse

测试调用结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。

同步分销服务

kwaixiaodian.client.services.distribution.main.SyncDistributionService(client: SyncBaseClient)

同步分销服务

整合各个分销子服务，提供完整的分销功能接口。

参考 - 开发文档（限流）: docs/开发指南和规则协议/开发文档/API限流说明.md - 开发文档（授权）: docs/开发指南和规则协议/开发文档/APP授权说明.md - 规则协议（日志接入规范）: docs/开发指南和规则协议/规则协议/开放平台/开放平台日志接入规范.md - 错误处理: docs/error-handling.md

初始化分销服务

参数：

名称 类型 描述 默认
client SyncBaseClient

同步基础客户端实例

 必需

方法：

名称 描述
get_kwaimoney_preheat_work_link

委托到CPS服务的获取快手货币预热工作链接方法
get_kwaimoney_requirement_cursor_list

委托到CPS服务的获取快手货币需求游标列表方法
get_selection_list

委托到CPS服务的获取精选列表方法
create_distribute_plan

创建分销计划
update_distribute_plan

更新分销计划
query_plan

查询分销计划
query_plan_commission

查询分销计划佣金
add_distribution_plan_promoter

添加分销计划推广者
delete_distribution_plan_promoter

删除分销计划推广者
update_promote

推广更新
add_item_selection_url

商品选品添加URL
add_item_shelf_url

商品货架添加URL
query_selection_item_detail

查询选品商品详情
offline_distribution_selection

分销精选下线
pick_distribution_selection

分销精选选品
create_distribution_activity_item_share

创建分销活动商品分享
get_distribution_distributor_order_list

获取分销商订单列表
get_distribution_public_category_list

获取分销公开分类列表
save_distribution_seller_sample_rule

保存分销卖家样本规则
test_distribution

分销测试

Functions

委托到CPS服务的获取快手货币预热工作链接方法

get_kwaimoney_requirement_cursor_list(*args, **kwargs)

委托到CPS服务的获取快手货币需求游标列表方法

get_selection_list(*args, **kwargs)

委托到CPS服务的获取精选列表方法

create_distribute_plan(access_token: str, plan_create_type: Optional[str] = None, normal_plan_param: Optional[Dict[str, Any]] = None, exclusive_plan_param: Optional[Dict[str, Any]] = None, orientation_plan_param: Optional[Dict[str, Any]] = None, uid: Optional[int] = None) -> DistributePlanCreateResponse

创建分销计划

OpenAPI: open.distribution.plan.create (POST) Java: OpenDistributionPlanCreateRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPlanCreateRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
plan_create_type Optional[str]

计划创建类型（可选）。

 None
normal_plan_param Optional[Dict[str, Any]]

普通计划参数（可选）。

 None
exclusive_plan_param Optional[Dict[str, Any]]

独家计划参数（可选）。

 None
orientation_plan_param Optional[Dict[str, Any]]

定向计划参数（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributePlanCreateResponse DistributePlanCreateResponse

分销计划创建结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
update_distribute_plan(access_token: str, plan_id: Optional[int] = None, update_type: Optional[str] = None, update_plan_status_param: Optional[Dict[str, Any]] = None, update_normal_commission_param: Optional[Dict[str, Any]] = None, update_orientation_commission_param: Optional[Dict[str, Any]] = None, uid: Optional[int] = None) -> DistributePlanUpdateResponse

更新分销计划

OpenAPI: open.distribution.plan.update (POST) Java: OpenDistributionPlanUpdateRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPlanUpdateRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
plan_id Optional[int]

计划ID（可选）。

 None
update_type Optional[str]

更新类型（可选）。

 None
update_plan_status_param Optional[Dict[str, Any]]

更新计划状态参数（可选）。

 None
update_normal_commission_param Optional[Dict[str, Any]]

更新普通佣金参数（可选）。

 None
update_orientation_commission_param Optional[Dict[str, Any]]

更新定向佣金参数（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributePlanUpdateResponse DistributePlanUpdateResponse

分销计划更新结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
query_plan(access_token: str, item_id: Optional[int] = None, uid: Optional[int] = None) -> PlanQueryResponse

查询分销计划

OpenAPI: open.distribution.plan.query (GET) Java: OpenDistributionPlanQueryRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPlanQueryRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
item_id Optional[int]

商品ID（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
PlanQueryResponse PlanQueryResponse

分销计划信息。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
query_plan_commission(access_token: str, plan_id: int, pcursor: Optional[str] = None, uid: Optional[int] = None) -> PlanCommissionQueryResponse

查询分销计划佣金

OpenAPI: open.distribution.plan.commission.query (GET) Java: OpenDistributionPlanCommissionQueryRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPlanCommissionQueryRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
plan_id int

计划ID。

 必需
pcursor Optional[str]

分页游标（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
PlanCommissionQueryResponse PlanCommissionQueryResponse

佣金明细或汇总数据。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
add_distribution_plan_promoter(access_token: str, plan_id: int, promoter_ids: List[int], uid: Optional[int] = None) -> DistributionPlanAddPromoterResponse

添加分销计划推广者

OpenAPI: open.distribution.distribution.plan.add.promoter (GET) Java: OpenDistributionDistributionPlanAddPromoterRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionDistributionPlanAddPromoterRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
plan_id int

计划ID。

 必需
promoter_ids List[int]

推广者ID列表。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionPlanAddPromoterResponse DistributionPlanAddPromoterResponse

添加推广者的处理结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
delete_distribution_plan_promoter(access_token: str, plan_id: int, promoter_ids: List[int], uid: Optional[int] = None) -> DistributionPlanDeletePromoterResponse

删除分销计划推广者

OpenAPI: open.distribution.distribution.plan.delete.promoter (GET) Java: OpenDistributionDistributionPlanDeletePromoterRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionDistributionPlanDeletePromoterRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
plan_id int

计划ID。

 必需
promoter_ids List[int]

推广者ID列表。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionPlanDeletePromoterResponse DistributionPlanDeletePromoterResponse

删除推广者的处理结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
update_promote(access_token: str, commission_id: List[int], status: int, uid: Optional[int] = None) -> PromoteUpdateResponse

推广更新

OpenAPI: open.distribution.promote.update (POST) Java: OpenDistributionPromoteUpdateRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPromoteUpdateRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
commission_id List[int]

佣金ID列表。

 必需
status int

状态码。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
PromoteUpdateResponse PromoteUpdateResponse

推广更新处理结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
add_item_selection_url(access_token: str, selection_id: int, url: str, uid: Optional[int] = None) -> ItemSelectionAddUrlResponse

商品选品添加URL

OpenAPI: open.distribution.item.selection.add.url (GET) Java: OpenDistributionItemSelectionAddUrlRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionItemSelectionAddUrlRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
selection_id int

选品ID。

 必需
url str

URL地址。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
ItemSelectionAddUrlResponse ItemSelectionAddUrlResponse

添加结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
add_item_shelf_url(access_token: str, shelf_id: int, url: str, uid: Optional[int] = None) -> ItemShelfAddUrlResponse

商品货架添加URL

OpenAPI: open.distribution.item.shelf.add.url (GET) Java: OpenDistributionItemShelfAddUrlRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionItemShelfAddUrlRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
shelf_id int

货架ID。

 必需
url str

URL地址。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
ItemShelfAddUrlResponse ItemShelfAddUrlResponse

添加结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
query_selection_item_detail(access_token: str, selection_id: int, item_id: int, uid: Optional[int] = None) -> QuerySelectionItemDetailResponse

查询选品商品详情

OpenAPI: open.distribution.query.selection.item.detail (GET) Java: OpenDistributionQuerySelectionItemDetailRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionQuerySelectionItemDetailRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
selection_id int

选品ID。

 必需
item_id int

商品ID。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
QuerySelectionItemDetailResponse QuerySelectionItemDetailResponse

选品商品详情数据。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
offline_distribution_selection(access_token: str, selection_id: int, uid: Optional[int] = None) -> DistributionSelectionOfflineResponse

分销精选下线

OpenAPI: open.distribution.selection.offline (POST) Java: OpenDistributionSelectionOfflineRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionSelectionOfflineRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
selection_id int

精选ID。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionSelectionOfflineResponse DistributionSelectionOfflineResponse

下线操作结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
pick_distribution_selection(access_token: str, selection_id: int, item_ids: List[int], uid: Optional[int] = None) -> DistributionSelectionPickResponse

分销精选选品

OpenAPI: open.distribution.selection.pick (POST) Java: OpenDistributionSelectionPickRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionSelectionPickRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
selection_id int

精选ID。

 必需
item_ids List[int]

商品ID列表。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionSelectionPickResponse DistributionSelectionPickResponse

选品操作结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
create_distribution_activity_item_share(access_token: str, activity_id: int, item_id: int, share_title: str, share_desc: Optional[str] = None, uid: Optional[int] = None) -> DistributionActivityItemShareCreateResponse

创建分销活动商品分享

OpenAPI: open.distribution.activity.item.share.create (POST) Java: OpenDistributionActivityItemShareCreateRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionActivityItemShareCreateRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
activity_id int

活动ID。

 必需
item_id int

商品ID。

 必需
share_title str

分享标题。

 必需
share_desc Optional[str]

分享描述（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionActivityItemShareCreateResponse DistributionActivityItemShareCreateResponse

分享创建结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
get_distribution_distributor_order_list(access_token: str, distributor_id: int, begin_time: Optional[int] = None, end_time: Optional[int] = None, order_status: Optional[int] = None, page: Optional[int] = None, page_size: Optional[int] = None, uid: Optional[int] = None) -> DistributionDistributorOrderListResponse

获取分销商订单列表

OpenAPI: open.distribution.distributor.order.list (GET) Java: OpenDistributionDistributorOrderListRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionDistributorOrderListRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
distributor_id int

分销商ID。

 必需
begin_time Optional[int]

开始时间（毫秒）（可选）。

 None
end_time Optional[int]

结束时间（毫秒）（可选）。

 None
order_status Optional[int]

订单状态（可选）。

 None
page Optional[int]

页码（可选）。

 None
page_size Optional[int]

页面大小（可选）。

 None
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionDistributorOrderListResponse DistributionDistributorOrderListResponse

订单分页数据。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
get_distribution_public_category_list(access_token: str, uid: Optional[int] = None) -> DistributionPublicCategoryListResponse

获取分销公开分类列表

OpenAPI: open.distribution.public.category.list (GET) Java: OpenDistributionPublicCategoryListRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionPublicCategoryListRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionPublicCategoryListResponse DistributionPublicCategoryListResponse

公开分类列表。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
save_distribution_seller_sample_rule(access_token: str, rule_name: str, rule_config: Dict[str, Any], uid: Optional[int] = None) -> DistributionSellerSampleRuleSaveResponse

保存分销卖家样本规则

OpenAPI: open.distribution.seller.sample.rule.save (POST) Java: OpenDistributionSellerSampleRuleSaveRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionSellerSampleRuleSaveRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
rule_name str

规则名称。

 必需
rule_config Dict[str, Any]

规则配置。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionSellerSampleRuleSaveResponse DistributionSellerSampleRuleSaveResponse

保存结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。
test_distribution(access_token: str, test_param: str, uid: Optional[int] = None) -> DistributionTestResponse

分销测试

OpenAPI: open.distribution.test (GET) Java: OpenDistributionTestRequest Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/distribution/OpenDistributionTestRequest.java

参数：

名称 类型 描述 默认
access_token str

访问令牌。

 必需
test_param str

测试参数。

 必需
uid Optional[int]

可选用户ID（最后一个可选参数）。

 None

返回：

名称 类型 描述
DistributionTestResponse DistributionTestResponse

测试调用结果。

引发：

类型 描述
KwaixiaodianAPIError

平台返回错误或解析失败。