跳转至

店铺服务

快手小店店铺管理API,提供全方位的店铺运营功能。支持店铺信息管理、店铺装修、营业时间设置、店铺分类管理、店铺统计数据查询等核心功能,帮助商家全面管理店铺运营。

异步店铺服务

kwaixiaodian.client.services.shop.AsyncShopService(client: AsyncBaseClient)

异步店铺管理服务(严格对齐 Java SDK 与文档)。

提供以下能力: - open.shop.info.get 店铺信息 - open.score.shop.get 店铺评分 - open.score.master.get 主评分 - open.shop.brand.batch.add 品牌批量新增 - open.shop.brand.page.get 品牌分页查询 - open.shop.enterprise.qualificaiton.exist 企业资质是否存在 - open.shop.invite.settle.oneStepSettle 一步式结算入驻 - open.shop.invite.settle.queryCanOneStepSettle 是否可一步式结算 - open.shop.invite.settle.queryCategoryList 入驻类目列表 - open.shop.invite.settle.queryIndustryCertificateByCategory 行业证书要求 - open.shop.invite.settle.querySettleContracts 结算合同 - open.shop.invite.settle.querySettleStatus 结算状态 - open.shop.poi.getPoiDetailByOuterPoi 外部POI详情

初始化店铺服务

参数:

名称 类型 描述 默认
client AsyncBaseClient

异步基础客户端实例

必需

方法:

名称 描述
info

获取店铺信息。

shop_score_get

获取店铺评分。

master_score_get

获取主评分信息。

brand_batch_add

批量添加品牌。

brand_page_get

分页获取品牌列表。

enterprise_qualification_exist

检查企业资质是否存在。

invite_settle_one_step

一步式结算入驻。

query_can_one_step_settle

查询是否可一步式结算。

query_category_list

查询入驻类目列表。

query_industry_certificate_by_category

根据类目查询行业证书要求。

query_settle_contracts

查询结算合同。

query_settle_status

查询结算状态。

poi_get_detail_by_outer_poi

根据外部 POI ID 获取详情。

Functions

info(access_token: str, uid: Optional[int] = None) -> ShopInfoResponse async

获取店铺信息。

OpenAPI: open.shop.info.get (GET) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInfoGetRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInfoGetRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
ShopInfoResponse

店铺信息响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

shop_score_get(access_token: str, uid: Optional[int] = None) -> ShopScoreGetResponse async

获取店铺评分。

OpenAPI: open.score.shop.get (GET) Java: com.kuaishou.merchant.open.api.request.shop.OpenScoreShopGetRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenScoreShopGetRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
ShopScoreGetResponse

店铺评分响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

master_score_get(access_token: str, uid: Optional[int] = None) -> MasterScoreGetResponse async

获取主评分信息。

OpenAPI: open.score.master.get (GET) Java: com.kuaishou.merchant.open.api.request.shop.OpenScoreMasterGetRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenScoreMasterGetRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
MasterScoreGetResponse

主评分信息响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

brand_batch_add(access_token: str, brand_list: List[Dict[str, Any]], uid: Optional[int] = None) -> BrandBatchAddResponse async

批量添加品牌。

OpenAPI: open.shop.brand.batch.add (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopBrandBatchAddRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopBrandBatchAddRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
brand_list List[Dict[str, Any]]

品牌信息列表

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
BrandBatchAddResponse

批量添加品牌响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

brand_page_get(access_token: str, page_num: int = 1, page_size: int = 20, uid: Optional[int] = None) -> BrandPageGetResponse async

分页获取品牌列表。

OpenAPI: open.shop.brand.page.get (GET) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopBrandPageGetRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopBrandPageGetRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
page_num int

页码

1
page_size int

页面大小

20
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
BrandPageGetResponse

品牌分页查询响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

enterprise_qualification_exist(access_token: str, meta_data_info: Dict[str, Any], uid: Optional[int] = None) -> EnterpriseQualificationExistResponse async

检查企业资质是否存在。

OpenAPI: open.shop.enterprise.qualificaiton.exist (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopEnterpriseQualificaitonExistRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopEnterpriseQualificaitonExistRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
meta_data_info Dict[str, Any]

元数据信息字典

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
EnterpriseQualificationExistResponse

企业资质存在性响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

invite_settle_one_step(access_token: str, invite_type: Optional[int] = None, oversea_enterprise_info: Optional[Dict[str, Any]] = None, business_base_info: Optional[Dict[str, Any]] = None, brand_request: Optional[Dict[str, Any]] = None, industry_qualification_request: Optional[Dict[str, Any]] = None, mainland_enterprise_info: Optional[Dict[str, Any]] = None, shop_request: Optional[Dict[str, Any]] = None, uid: Optional[int] = None) -> InviteSettleOneStepResponse async

一步式结算入驻。

OpenAPI: open.shop.invite.settle.oneStepSettle (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleOnestepsettleRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleOnestepsettleRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
invite_type Optional[int]

邀请类型

None
oversea_enterprise_info Optional[Dict[str, Any]]

海外企业信息

None
business_base_info Optional[Dict[str, Any]]

业务基础信息

None
brand_request Optional[Dict[str, Any]]

品牌请求信息

None
industry_qualification_request Optional[Dict[str, Any]]

行业资质请求信息

None
mainland_enterprise_info Optional[Dict[str, Any]]

内地企业信息

None
shop_request Optional[Dict[str, Any]]

店铺请求信息

None
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
InviteSettleOneStepResponse

一步式结算入驻响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

query_can_one_step_settle(access_token: str, uid: Optional[int] = None) -> QueryCanOneStepSettleResponse async

查询是否可一步式结算。

OpenAPI: open.shop.invite.settle.queryCanOneStepSettle (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleQuerycanonestepsettleRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleQuerycanonestepsettleRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
QueryCanOneStepSettleResponse

是否可一步式结算响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

query_category_list(access_token: str, invite_type: Optional[int] = None, uid: Optional[int] = None) -> QueryCategoryListResponse async

查询入驻类目列表。

OpenAPI: open.shop.invite.settle.queryCategoryList (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleQuerycategorylistRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleQuerycategorylistRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
invite_type Optional[int]

邀请类型

None
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
QueryCategoryListResponse

入驻类目列表响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

query_industry_certificate_by_category(access_token: str, category_ids: List[int], invite_type: Optional[int] = None, oversea: Optional[bool] = None, uid: Optional[int] = None) -> QueryIndustryCertificateByCategoryResponse async

根据类目查询行业证书要求。

OpenAPI: open.shop.invite.settle.queryIndustryCertificateByCategory (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleQueryindustrycertificatebycategoryRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleQueryindustrycertificatebycategoryRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
category_ids List[int]

类目ID列表

必需
invite_type Optional[int]

邀请类型

None
oversea Optional[bool]

是否海外

None
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
QueryIndustryCertificateByCategoryResponse

行业证书要求响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

query_settle_contracts(access_token: str, invite_type: Optional[int] = None, uid: Optional[int] = None) -> QuerySettleContractsResponse async

查询结算合同。

OpenAPI: open.shop.invite.settle.querySettleContracts (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleQuerysettlecontractsRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleQuerysettlecontractsRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
invite_type Optional[int]

邀请类型

None
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
QuerySettleContractsResponse

结算合同响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

query_settle_status(access_token: str, uid: Optional[int] = None) -> QuerySettleStatusResponse async

查询结算状态。

OpenAPI: open.shop.invite.settle.querySettleStatus (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleQuerysettlestatusRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleQuerysettlestatusRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
QuerySettleStatusResponse

结算状态响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

poi_get_detail_by_outer_poi(access_token: str, outer_poi_id: str, source: Optional[int] = None, uid: Optional[int] = None) -> POIGetDetailByOuterPOIResponse async

根据外部 POI ID 获取详情。

OpenAPI: open.shop.poi.getPoiDetailByOuterPoi (GET) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopPoiGetpoidetailbyouterpoiRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopPoiGetpoidetailbyouterpoiRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
outer_poi_id str

外部POI ID

必需
source Optional[int]

来源编号

None
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
POIGetDetailByOuterPOIResponse

POI 详情响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

同步店铺服务

kwaixiaodian.client.services.shop.SyncShopService(client: SyncBaseClient)

同步店铺管理服务(严格对齐 Java SDK 与文档)。

初始化店铺服务

参数:

名称 类型 描述 默认
client SyncBaseClient

同步基础客户端实例

必需

方法:

名称 描述
info

获取店铺信息(同步)。

shop_score_get

获取店铺评分(同步)。

master_score_get

获取主评分信息(同步)。

brand_batch_add

批量添加品牌(同步)。

brand_page_get

分页获取品牌列表(同步)。

enterprise_qualification_exist

检查企业资质是否存在(同步)。

invite_settle_one_step

一步式结算入驻(同步)。

query_can_one_step_settle

查询是否可一步式结算(同步)。

query_category_list

查询入驻类目列表(同步)。

query_industry_certificate_by_category

根据类目查询行业证书要求(同步)。

query_settle_contracts

查询结算合同(同步)。

query_settle_status

查询结算状态(同步)。

poi_get_detail_by_outer_poi

根据外部 POI ID 获取详情(同步)。

Functions

info(access_token: str, uid: Optional[int] = None) -> ShopInfoResponse

获取店铺信息(同步)。

OpenAPI: open.shop.info.get (GET) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInfoGetRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInfoGetRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
ShopInfoResponse

店铺信息响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

shop_score_get(access_token: str, uid: Optional[int] = None) -> ShopScoreGetResponse

获取店铺评分(同步)。

OpenAPI: open.score.shop.get (GET) Java: com.kuaishou.merchant.open.api.request.shop.OpenScoreShopGetRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenScoreShopGetRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
ShopScoreGetResponse

店铺评分响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

master_score_get(access_token: str, uid: Optional[int] = None) -> MasterScoreGetResponse

获取主评分信息(同步)。

OpenAPI: open.score.master.get (GET) Java: com.kuaishou.merchant.open.api.request.shop.OpenScoreMasterGetRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenScoreMasterGetRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
MasterScoreGetResponse

主评分信息响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

brand_batch_add(access_token: str, brand_list: List[Dict[str, Any]], uid: Optional[int] = None) -> BrandBatchAddResponse

批量添加品牌(同步)。

OpenAPI: open.shop.brand.batch.add (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopBrandBatchAddRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopBrandBatchAddRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
brand_list List[Dict[str, Any]]

品牌信息列表

必需
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
BrandBatchAddResponse

批量添加品牌响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

brand_page_get(access_token: str, page_num: int = 1, page_size: int = 20, uid: Optional[int] = None) -> BrandPageGetResponse

分页获取品牌列表(同步)。

OpenAPI: open.shop.brand.page.get (GET) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopBrandPageGetRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopBrandPageGetRequest.java

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
page_num int

页码

1
page_size int

页面大小

20
uid Optional[int]

可选用户ID(最后一个可选参数)

None

返回:

类型 描述
BrandPageGetResponse

品牌分页查询响应对象

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

enterprise_qualification_exist(access_token: str, meta_data_info: Dict[str, Any], uid: Optional[int] = None) -> EnterpriseQualificationExistResponse

检查企业资质是否存在(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
meta_data_info Dict[str, Any]

元数据信息字典

必需
uid Optional[int]

可选用户ID

None

返回:

类型 描述
EnterpriseQualificationExistResponse

企业资质存在性响应对象

OpenAPI: open.shop.enterprise.qualificaiton.exist (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopEnterpriseQualificaitonExistRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopEnterpriseQualificaitonExistRequest.java

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

invite_settle_one_step(access_token: str, invite_type: Optional[int] = None, oversea_enterprise_info: Optional[Dict[str, Any]] = None, business_base_info: Optional[Dict[str, Any]] = None, brand_request: Optional[Dict[str, Any]] = None, industry_qualification_request: Optional[Dict[str, Any]] = None, mainland_enterprise_info: Optional[Dict[str, Any]] = None, shop_request: Optional[Dict[str, Any]] = None, uid: Optional[int] = None) -> InviteSettleOneStepResponse

一步式结算入驻(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
invite_type Optional[int]

邀请类型

None
oversea_enterprise_info Optional[Dict[str, Any]]

海外企业信息

None
business_base_info Optional[Dict[str, Any]]

业务基础信息

None
brand_request Optional[Dict[str, Any]]

品牌请求信息

None
industry_qualification_request Optional[Dict[str, Any]]

行业资质请求信息

None
mainland_enterprise_info Optional[Dict[str, Any]]

内地企业信息

None
shop_request Optional[Dict[str, Any]]

店铺请求信息

None
uid Optional[int]

可选用户ID

None

返回:

类型 描述
InviteSettleOneStepResponse

一步式结算入驻响应对象

OpenAPI: open.shop.invite.settle.oneStepSettle (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleOnestepsettleRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleOnestepsettleRequest.java

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

query_can_one_step_settle(access_token: str, uid: Optional[int] = None) -> QueryCanOneStepSettleResponse

查询是否可一步式结算(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID

None

返回:

类型 描述
QueryCanOneStepSettleResponse

是否可一步式结算响应对象

OpenAPI: open.shop.invite.settle.queryCanOneStepSettle (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleQuerycanonestepsettleRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleQuerycanonestepsettleRequest.java

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

query_category_list(access_token: str, invite_type: Optional[int] = None, uid: Optional[int] = None) -> QueryCategoryListResponse

查询入驻类目列表(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
invite_type Optional[int]

邀请类型

None
uid Optional[int]

可选用户ID

None

返回:

类型 描述
QueryCategoryListResponse

入驻类目列表响应对象

OpenAPI: open.shop.invite.settle.queryCategoryList (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleQuerycategorylistRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleQuerycategorylistRequest.java

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

query_industry_certificate_by_category(access_token: str, category_ids: List[int], invite_type: Optional[int] = None, oversea: Optional[bool] = None, uid: Optional[int] = None) -> QueryIndustryCertificateByCategoryResponse

根据类目查询行业证书要求(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
category_ids List[int]

类目ID列表

必需
invite_type Optional[int]

邀请类型

None
oversea Optional[bool]

是否海外

None
uid Optional[int]

可选用户ID

None

返回:

类型 描述
QueryIndustryCertificateByCategoryResponse

行业证书要求响应对象

OpenAPI: open.shop.invite.settle.queryIndustryCertificateByCategory (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleQueryindustrycertificatebycategoryRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleQueryindustrycertificatebycategoryRequest.java

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

query_settle_contracts(access_token: str, invite_type: Optional[int] = None, uid: Optional[int] = None) -> QuerySettleContractsResponse

查询结算合同(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID

None

返回:

类型 描述
QuerySettleContractsResponse

结算合同响应对象

OpenAPI: open.shop.invite.settle.querySettleContracts (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleQuerysettlecontractsRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleQuerysettlecontractsRequest.java

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

query_settle_status(access_token: str, uid: Optional[int] = None) -> QuerySettleStatusResponse

查询结算状态(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
uid Optional[int]

可选用户ID

None

返回:

类型 描述
QuerySettleStatusResponse

结算状态响应对象

OpenAPI: open.shop.invite.settle.querySettleStatus (POST) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopInviteSettleQuerysettlestatusRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopInviteSettleQuerysettlestatusRequest.java

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

poi_get_detail_by_outer_poi(access_token: str, outer_poi_id: str, source: Optional[int] = None, uid: Optional[int] = None) -> POIGetDetailByOuterPOIResponse

根据外部 POI ID 获取详情(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
outer_poi_id str

外部POI ID

必需
uid Optional[int]

可选用户ID

None

返回:

类型 描述
POIGetDetailByOuterPOIResponse

POI 详情响应对象

OpenAPI: open.shop.poi.getPoiDetailByOuterPoi (GET) Java: com.kuaishou.merchant.open.api.request.shop.OpenShopPoiGetpoidetailbyouterpoiRequest Java Source: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/shop/OpenShopPoiGetpoidetailbyouterpoiRequest.java

引发:

类型 描述
KwaixiaodianAPIError

API 调用失败或返回错误

店铺数据模型

kwaixiaodian.models.shop

店铺相关数据模型(严格对齐 Java 参考)

类:

名称 描述
ShopInfo

店铺信息

ShopInfoRequest

获取店铺信息请求

ShopInfoResponse

获取店铺信息响应

ShopScore

店铺评分信息

MasterScore

主评分信息

ShopScoreGetRequest

获取店铺评分请求

ShopScoreGetResponse

获取店铺评分响应

MasterScoreGetRequest

获取主评分信息请求

MasterScoreGetResponse

获取主评分信息响应

ShopBrand

店铺品牌信息

BrandBatchAddRequest

批量添加品牌请求

BrandBatchAddResponse

批量添加品牌响应

BrandPageGetRequest

分页获取品牌列表请求

BrandPageGetResponse

分页获取品牌列表响应

EnterpriseQualification

企业资质信息

EnterpriseQualificationExistRequest

检查企业资质是否存在请求

EnterpriseQualificationExistResponse

检查企业资质是否存在响应

SettleContract

结算合同信息

SettleCategory

入驻类目信息

InviteSettleOneStepRequest

一步式结算入驻请求

InviteSettleOneStepResponse

一步式结算入驻响应

QueryCanOneStepSettleRequest

查询是否可一步式结算请求

QueryCanOneStepSettleResponse

查询是否可一步式结算响应

QueryCategoryListRequest

查询入驻类目列表请求

QueryCategoryListResponse

查询入驻类目列表响应

QueryIndustryCertificateByCategoryRequest

根据类目查询行业证书要求请求

QueryIndustryCertificateByCategoryResponse

根据类目查询行业证书要求响应

QuerySettleContractsRequest

查询结算合同请求

QuerySettleContractsResponse

查询结算合同响应

QuerySettleStatusRequest

查询结算状态请求

QuerySettleStatusResponse

查询结算状态响应

POIDetail

POI详情信息

POIGetDetailByOuterPOIRequest

根据外部POI ID获取详情请求

POIGetDetailByOuterPOIResponse

根据外部POI ID获取详情响应

Classes

ShopInfo

Bases: BaseModel

店铺信息

ShopInfoRequest

Bases: BaseRequest

获取店铺信息请求

ShopInfoResponse

Bases: BaseResponse[ShopInfo]

获取店铺信息响应

ShopScore

Bases: BaseModel

店铺评分信息

属性:

名称 类型 描述
good_rate Optional[float]

好评率

Attributes
good_rate: Optional[float] property

好评率

MasterScore

Bases: BaseModel

主评分信息

ShopScoreGetRequest

Bases: BaseRequest

获取店铺评分请求

ShopScoreGetResponse

Bases: BaseResponse[ShopScore]

获取店铺评分响应

MasterScoreGetRequest

Bases: BaseRequest

获取主评分信息请求

MasterScoreGetResponse

Bases: BaseResponse[MasterScore]

获取主评分信息响应

ShopBrand

Bases: BaseModel

店铺品牌信息

BrandBatchAddRequest

Bases: BaseRequest

批量添加品牌请求

BrandBatchAddResponse

Bases: BaseResponse[Dict[str, Any]]

批量添加品牌响应

BrandPageGetRequest

Bases: BaseRequest

分页获取品牌列表请求

BrandPageGetResponse

Bases: BaseResponse[List[ShopBrand]]

分页获取品牌列表响应

EnterpriseQualification

Bases: BaseModel

企业资质信息

EnterpriseQualificationExistRequest

Bases: BaseRequest

检查企业资质是否存在请求

EnterpriseQualificationExistResponse

Bases: BaseResponse[Dict[str, Any]]

检查企业资质是否存在响应

SettleContract

Bases: BaseModel

结算合同信息

SettleCategory

Bases: BaseModel

入驻类目信息

InviteSettleOneStepRequest

Bases: BaseRequest

一步式结算入驻请求

InviteSettleOneStepResponse

Bases: BaseResponse[Dict[str, Any]]

一步式结算入驻响应

QueryCanOneStepSettleRequest

Bases: BaseRequest

查询是否可一步式结算请求

QueryCanOneStepSettleResponse

Bases: BaseResponse[Dict[str, Any]]

查询是否可一步式结算响应

QueryCategoryListRequest

Bases: BaseRequest

查询入驻类目列表请求

QueryCategoryListResponse

Bases: BaseResponse[List[SettleCategory]]

查询入驻类目列表响应

QueryIndustryCertificateByCategoryRequest

Bases: BaseRequest

根据类目查询行业证书要求请求

QueryIndustryCertificateByCategoryResponse

Bases: BaseResponse[List[Dict[str, Any]]]

根据类目查询行业证书要求响应

QuerySettleContractsRequest

Bases: BaseRequest

查询结算合同请求

QuerySettleContractsResponse

Bases: BaseResponse[List[SettleContract]]

查询结算合同响应

QuerySettleStatusRequest

Bases: BaseRequest

查询结算状态请求

QuerySettleStatusResponse

Bases: BaseResponse[Dict[str, Any]]

查询结算状态响应

POIDetail

Bases: BaseModel

POI详情信息

POIGetDetailByOuterPOIRequest

Bases: BaseRequest

根据外部POI ID获取详情请求

POIGetDetailByOuterPOIResponse

Bases: BaseResponse[POIDetail]

根据外部POI ID获取详情响应