商品服务
商品管理相关的API服务,包括商品CRUD、库存管理、规格管理等功能。
异步商品服务
kwaixiaodian.client.services.item.AsyncItemService(client: AsyncBaseClient)
商品服务
提供商品创建、更新、查询、库存与媒体管理等功能。
说明
- Source of truth: 仅以 java_sdk_reference/ 与 docs/ 为准,不做接口猜测。
- 异常:底层 execute 在开放平台返回非 0 错误码或解析失败时抛出
KwaixiaodianAPIError;网络异常会抛出 KwaixiaodianNetworkError。
- uid 必须保持为最后一个可选参数;本类与同步版在参数顺序与含义上保持一致。
初始化商品服务
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
client
|
AsyncBaseClient
|
基础客户端实例 |
必需 |
方法:
Functions
list(access_token: str, kwai_item_id: Optional[int] = None, rel_item_id: Optional[int] = None, item_status: Optional[int] = None, item_type: Optional[int] = None, page_number: int = 1, page_size: int = 20, on_offline_status: Optional[int] = None, uid: Optional[int] = None) -> ItemListResponse
async
获取商品列表
OpenAPI: open.item.list.get (GET)
Java: OpenItemListGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemListGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
kwai_item_id
|
Optional[int]
|
快手商品ID(可选)。 |
None
|
rel_item_id
|
Optional[int]
|
关联商品ID(可选)。 |
None
|
item_status
|
Optional[int]
|
商品状态(可选)。 |
None
|
item_type
|
Optional[int]
|
商品类型(可选)。 |
None
|
page_number
|
int
|
页码,默认 1。 |
1
|
page_size
|
int
|
页大小,默认 20。 |
20
|
on_offline_status
|
Optional[int]
|
上下线状态(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemListResponse |
ItemListResponse
|
商品列表与分页信息。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
See Also
docs/开发指南和规则协议/开发文档/API限流说明.md
get(access_token: str, item_id: int, uid: Optional[int] = None) -> ItemGetResponse
async
获取商品详情
OpenAPI: open.item.get (GET)
Java: OpenItemGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
item_id
|
int
|
商品ID( |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemGetResponse |
ItemGetResponse
|
商品详情。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_categories(access_token: str, uid: Optional[int] = None) -> ItemCategoryResponse
async
获取商品分类
OpenAPI: open.item.category (GET)
Java: OpenItemCategoryRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemCategoryRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemCategoryResponse |
ItemCategoryResponse
|
商品分类列表。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_category_config(access_token: str, category_id: Optional[int] = None, uid: Optional[int] = None) -> ItemCategoryConfigResponse
async
获取分类配置
OpenAPI: open.item.category.config (GET)
Java: OpenItemCategoryConfigRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemCategoryConfigRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
Optional[int]
|
分类ID(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemCategoryConfigResponse |
ItemCategoryConfigResponse
|
类目配置集合。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_optional_categories(access_token: str, uid: Optional[int] = None) -> ItemOptionalCategoryResponse
async
获取可选分类
OpenAPI: open.item.category.optional.get (GET)
Java: OpenItemCategoryOptionalGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemCategoryOptionalGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemOptionalCategoryResponse |
ItemOptionalCategoryResponse
|
可选类目列表。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_suggested_categories(access_token: str, item_title: Optional[str] = None, image_urls: Optional[List[str]] = None, item_desc: Optional[str] = None, uid: Optional[int] = None) -> ItemSuggestedCategoryResponse
async
获取推荐分类
OpenAPI: open.item.category.suggested.get (GET)
Java: OpenItemCategorySuggestedGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemCategorySuggestedGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
item_title
|
Optional[str]
|
商品标题(可选)。 |
None
|
image_urls
|
Optional[List[str]]
|
商品图片URL列表(可选)。 |
None
|
item_desc
|
Optional[str]
|
商品描述(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSuggestedCategoryResponse |
ItemSuggestedCategoryResponse
|
推荐类目集合。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_category_prop_standard(access_token: str, leaf_category_id: int, uid: Optional[int] = None) -> ItemCategoryPropStandardResponse
async
获取分类属性标准
OpenAPI: open.item.category.prop.standard.get (POST)
Java: OpenItemCategoryPropStandardGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemCategoryPropStandardGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
leaf_category_id
|
int
|
叶子类目ID。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemCategoryPropStandardResponse |
ItemCategoryPropStandardResponse
|
属性标准列表。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
search_category_prop_values(access_token: str, category_id: int, prop_id: int, prop_value: Optional[str] = None, cursor: Optional[int] = None, limit: Optional[int] = None, uid: Optional[int] = None) -> ItemCategoryPropValueSearchResponse
async
搜索分类属性值
OpenAPI: open.item.category.prop.value.search (GET)
Java: OpenItemCategoryPropValueSearchRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemCategoryPropValueSearchRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
int
|
分类ID。 |
必需 |
prop_id
|
int
|
属性ID。 |
必需 |
prop_value
|
Optional[str]
|
属性值搜索关键字(可选)。 |
None
|
cursor
|
Optional[int]
|
分页游标(可选)。 |
None
|
limit
|
Optional[int]
|
条数限制(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemCategoryPropValueSearchResponse |
ItemCategoryPropValueSearchResponse
|
属性值分页结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
check_category_standard(access_token: str, leaf_category_id: int, uid: Optional[int] = None) -> ItemCategoryStandardCheckResponse
async
检查分类标准
OpenAPI: open.item.category.standard.check (GET)
Java: OpenItemCategoryStandardCheckRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemCategoryStandardCheckRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
leaf_category_id
|
int
|
叶子类目ID。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemCategoryStandardCheckResponse |
ItemCategoryStandardCheckResponse
|
标准检查结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
search_category_standard(access_token: str, standard_id: Optional[int] = None, leaf_category_id: Optional[int] = None, standard_key_prop_list: Optional[List[Dict[str, Any]]] = None, uid: Optional[int] = None) -> ItemCategoryStandardSearchResponse
async
搜索分类标准
OpenAPI: open.item.category.standard.search (POST)
Java: OpenItemCategoryStandardSearchRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemCategoryStandardSearchRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
standard_id
|
Optional[int]
|
标准ID(可选)。 |
None
|
leaf_category_id
|
Optional[int]
|
叶子类目ID(可选)。 |
None
|
standard_key_prop_list
|
Optional[List[Dict[str, Any]]]
|
关键属性列表(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemCategoryStandardSearchResponse |
ItemCategoryStandardSearchResponse
|
标准信息数据。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_brand_list(access_token: str, cursor: Optional[int] = None, category_id: Optional[int] = None, prop_id: Optional[int] = None, prop_value: Optional[str] = None, uid: Optional[int] = None) -> ItemBrandListResponse
async
获取品牌列表
OpenAPI: open.item.brand.list.get (POST)
Java: OpenItemBrandListGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemBrandListGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
cursor
|
Optional[int]
|
游标(可选)。 |
None
|
category_id
|
Optional[int]
|
类目ID(可选)。 |
None
|
prop_id
|
Optional[int]
|
属性ID(可选)。 |
None
|
prop_value
|
Optional[str]
|
属性值(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemBrandListResponse |
ItemBrandListResponse
|
品牌分页数据。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_qualification_config(access_token: str, category_id: int, uid: Optional[int] = None) -> ItemQualificationConfigResponse
async
获取资质配置
OpenAPI: open.item.qualification.collection.config (POST)
Java: OpenItemQualificationCollectionConfigRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemQualificationCollectionConfigRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
int
|
分类ID。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemQualificationConfigResponse |
ItemQualificationConfigResponse
|
资质配置集合。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_saleprop_rule(access_token: str, category_id: int, spu_id: Optional[int] = None, item_id: Optional[int] = None, uid: Optional[int] = None) -> ItemSalePropRuleResponse
async
获取销售属性规则
OpenAPI: open.item.saleprop.rule (POST)
Java: OpenItemSalepropRuleRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSalepropRuleRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
int
|
类目ID。 |
必需 |
spu_id
|
Optional[int]
|
SPU ID(可选)。 |
None
|
item_id
|
Optional[int]
|
商品ID(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSalePropRuleResponse |
ItemSalePropRuleResponse
|
销售属性规则配置。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_sku_list(access_token: str, kwai_item_id: int, rel_sku_id: Optional[int] = None, sku_status: Optional[int] = None, uid: Optional[int] = None) -> ItemSkuListResponse
async
获取SKU列表
OpenAPI: open.item.sku.list.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSkuListGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSkuListGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
kwai_item_id
|
int
|
快手商品ID |
必需 |
rel_sku_id
|
Optional[int]
|
关联SKU ID(可选) |
None
|
sku_status
|
Optional[int]
|
SKU状态(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSkuListResponse |
ItemSkuListResponse
|
SKU 列表 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
update_sku_price(access_token: str, item_id: int, sku_id: int, price: int, uid: Optional[int] = None) -> ItemSkuPriceUpdateResponse
async
更新SKU价格
OpenAPI: open.item.sku.price.update (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSkuPriceUpdateRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSkuPriceUpdateRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
sku_id
|
int
|
SKU ID |
必需 |
price
|
int
|
新价格(分) |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSkuPriceUpdateResponse |
ItemSkuPriceUpdateResponse
|
价格更新结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
add_sku_goods_relation(access_token: str, item_id: int, relations: List[SkuGoodsRelationParam], uid: Optional[int] = None) -> ItemSkuGoodsRelationModifyResponse
async
添加SKU商品关系
OpenAPI: open.item.sku.goods.relation.add (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSkuGoodsRelationAddRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSkuGoodsRelationAddRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
relations
|
List[SkuGoodsRelationParam]
|
SKU 与三方货品关系列表 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSkuGoodsRelationModifyResponse |
ItemSkuGoodsRelationModifyResponse
|
修改结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
update_sku_goods_relation(access_token: str, item_id: int, relations: List[SkuGoodsRelationParam], uid: Optional[int] = None) -> ItemSkuGoodsRelationModifyResponse
async
更新SKU商品关系
OpenAPI: open.item.sku.goods.relation.update (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSkuGoodsRelationUpdateRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSkuGoodsRelationUpdateRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
relations
|
List[SkuGoodsRelationParam]
|
SKU 与三方货品关系列表 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSkuGoodsRelationModifyResponse |
ItemSkuGoodsRelationModifyResponse
|
修改结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
get_sku_goods_relation(access_token: str, sku_ids: List[int], uid: Optional[int] = None) -> ItemSkuGoodsRelationResponse
async
获取SKU商品关系
OpenAPI: open.item.sku.goods.relation.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSkuGoodsRelationGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSkuGoodsRelationGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
sku_ids
|
List[int]
|
SKU ID 列表 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSkuGoodsRelationResponse |
ItemSkuGoodsRelationResponse
|
关系数据 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
delete_sku_goods_relation(access_token: str, item_id: int, relations: List[SkuGoodsRelationParam], update_item_stock_model: Optional[bool] = None, uid: Optional[int] = None) -> ItemSkuGoodsRelationModifyResponse
async
删除SKU商品关系
OpenAPI: open.item.sku.goods.relation.delete (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSkuGoodsRelationDeleteRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSkuGoodsRelationDeleteRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
relations
|
List[SkuGoodsRelationParam]
|
SKU 与三方货品关系列表 |
必需 |
update_item_stock_model
|
Optional[bool]
|
是否更新商品库存模型(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSkuGoodsRelationModifyResponse |
ItemSkuGoodsRelationModifyResponse
|
修改结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
manage_stock(access_token: str, sku_stock_infos: List[SkuStockInfo], seq_no: Optional[str] = None, item_id: Optional[int] = None, category_id: Optional[int] = None, support_negative_stock: Optional[bool] = None, uid: Optional[int] = None) -> ItemStockManageResponse
async
库存管理
OpenAPI: open.stock.manage (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenStockManageRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenStockManageRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
sku_stock_infos
|
List[SkuStockInfo]
|
SKU 库存操作列表 |
必需 |
seq_no
|
Optional[str]
|
幂等序列号(可选) |
None
|
item_id
|
Optional[int]
|
商品ID(可选) |
None
|
category_id
|
Optional[int]
|
类目ID(可选) |
None
|
support_negative_stock
|
Optional[bool]
|
是否支持负库存(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemStockManageResponse |
ItemStockManageResponse
|
操作结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
upload_image(access_token: str, upload_type: int, img_url: Optional[str] = None, img_bytes: Optional[bytes] = None, uid: Optional[int] = None) -> ItemImageUploadResponse
async
商品图片上传
OpenAPI: open.item.image.upload (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemImageUploadRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemImageUploadRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
upload_type
|
int
|
上传类型(1: URL, 2: 文件) |
必需 |
img_url
|
Optional[str]
|
图片URL(URL上传时使用) |
None
|
img_bytes
|
Optional[bytes]
|
图片字节数据(文件上传时使用) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemImageUploadResponse |
ItemImageUploadResponse
|
图片上传结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
# URL上传
result = await item_service.upload_image(
access_token="your_token",
upload_type=1,
img_url="https://example.com/image.jpg"
)
# 文件上传
with open("image.jpg", "rb") as f:
img_bytes = f.read()
result = await item_service.upload_image(
access_token="your_token",
upload_type=2,
img_bytes=img_bytes
)
issue_upload_token(access_token: str, material_upload_type: int, file_name: str, file_length: int, uid: Optional[int] = None) -> ItemMaterialUploadTokenIssueResponse
async
素材上传 token 签发
OpenAPI: open.item.material.upload.token.issue (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemMaterialUploadTokenIssueRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemMaterialUploadTokenIssueRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
material_upload_type
|
int
|
素材上传类型 |
必需 |
file_name
|
str
|
文件名 |
必需 |
file_length
|
int
|
文件长度 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemMaterialUploadTokenIssueResponse |
ItemMaterialUploadTokenIssueResponse
|
签发结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
get_video_list(access_token: str, video_type: Optional[int] = None, aspect_ratio: Optional[int] = None, audit_status: Optional[int] = None, create_time_start: Optional[int] = None, create_time_end: Optional[int] = None, page_index: Optional[int] = None, page_size: Optional[int] = None, uid: Optional[int] = None) -> ItemVideoListResponse
async
获取视频列表
OpenAPI: open.item.video.list (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemVideoListRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemVideoListRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
video_type
|
Optional[int]
|
视频类型(可选) |
None
|
aspect_ratio
|
Optional[int]
|
视频宽高比(可选) |
None
|
audit_status
|
Optional[int]
|
审核状态(可选) |
None
|
create_time_start
|
Optional[int]
|
创建开始时间(毫秒,可选) |
None
|
create_time_end
|
Optional[int]
|
创建结束时间(毫秒,可选) |
None
|
page_index
|
Optional[int]
|
页码(可选) |
None
|
page_size
|
Optional[int]
|
页面大小(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemVideoListResponse |
ItemVideoListResponse
|
视频分页列表 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
delete_video(access_token: str, video_ids: List[str], video_type: Optional[int] = None, uid: Optional[int] = None) -> ItemVideoDeleteResponse
async
删除视频
OpenAPI: open.item.video.delete (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemVideoDeleteRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemVideoDeleteRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
video_ids
|
List[str]
|
视频ID列表 |
必需 |
video_type
|
Optional[int]
|
视频类型(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemVideoDeleteResponse |
ItemVideoDeleteResponse
|
删除结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
edit_autopass(access_token: str, item_id: int, purchase_limit: Optional[bool] = None, limit_count: Optional[int] = None, item_remark: Optional[str] = None, sku_list: Optional[List[OpenApiAutoPassSkuDTO]] = None, service_rule: Optional[ServiceRule] = None, express_template_id: Optional[int] = None, sale_time_flag: Optional[bool] = None, time_of_sale: Optional[int] = None, pay_way: Optional[int] = None, uid: Optional[int] = None) -> ItemAutopassEditResponse
async
商品自动通过编辑
OpenAPI: open.item.autopass.edit (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemAutopassEditRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemAutopassEditRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
purchase_limit
|
Optional[bool]
|
购买限制 |
None
|
limit_count
|
Optional[int]
|
限制数量 |
None
|
item_remark
|
Optional[str]
|
商品备注 |
None
|
sku_list
|
Optional[List[OpenApiAutoPassSkuDTO]]
|
SKU列表 |
None
|
service_rule
|
Optional[ServiceRule]
|
服务规则 |
None
|
express_template_id
|
Optional[int]
|
快递模板ID |
None
|
sale_time_flag
|
Optional[bool]
|
销售时间标志 |
None
|
time_of_sale
|
Optional[int]
|
销售时间 |
None
|
pay_way
|
Optional[int]
|
支付方式 |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemAutopassEditResponse |
ItemAutopassEditResponse
|
编辑结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
update_detail_images(access_token: str, kwai_item_id: int, detail_image_urls: List[str], uid: Optional[int] = None) -> ItemDetailImagesUpdateResponse
async
更新商品详情图片
OpenAPI: open.item.detail.images.update (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemDetailImagesUpdateRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemDetailImagesUpdateRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
kwai_item_id
|
int
|
快手商品ID |
必需 |
detail_image_urls
|
List[str]
|
详情图片URL列表 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemDetailImagesUpdateResponse |
ItemDetailImagesUpdateResponse
|
更新结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
get_detail_page_link(access_token: str, item_id: int, type: int, item_product_client_info: Optional[Dict[str, Any]] = None, uid: Optional[int] = None) -> ItemDetailPageLinkResponse
async
获取商品详情页链接
OpenAPI: open.item.detail.page.link (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemDetailPageLinkRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemDetailPageLinkRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
type
|
int
|
类型 |
必需 |
item_product_client_info
|
Optional[Dict[str, Any]]
|
商品客户端信息 |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemDetailPageLinkResponse |
ItemDetailPageLinkResponse
|
详情页链接 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
get_diagnosis(access_token: str, item_id: int, uid: Optional[int] = None) -> ItemDiagnosisGetResponse
async
获取商品诊断信息
OpenAPI: open.item.diagnosis.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemDiagnosisGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemDiagnosisGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemDiagnosisGetResponse |
ItemDiagnosisGetResponse
|
诊断信息 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
apply_main_pic_video(access_token: str, item_id: int, video_id: str, video_type: int, uid: Optional[int] = None) -> ItemMainPicVideoApplyResponse
async
申请商品主图视频
OpenAPI: open.item.main.pic.video.apply (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemMainPicVideoApplyRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemMainPicVideoApplyRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
video_id
|
str
|
视频ID |
必需 |
video_type
|
int
|
视频类型 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemMainPicVideoApplyResponse |
ItemMainPicVideoApplyResponse
|
申请结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
delete_main_pic_video(access_token: str, item_id: int, uid: Optional[int] = None) -> ItemMainPicVideoDeleteResponse
async
删除商品主图视频
OpenAPI: open.item.main.pic.video.delete (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemMainPicVideoDeleteRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemMainPicVideoDeleteRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemMainPicVideoDeleteResponse |
ItemMainPicVideoDeleteResponse
|
删除结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
update_shelf_status(access_token: str, kwai_item_id: int, shelf_status: int, uid: Optional[int] = None) -> ItemShelfStatusUpdateResponse
async
更新商品上下架状态
OpenAPI: open.item.shelf.status.update (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemShelfStatusUpdateRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemShelfStatusUpdateRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
kwai_item_id
|
int
|
快手商品ID |
必需 |
shelf_status
|
int
|
上架状态 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemShelfStatusUpdateResponse |
ItemShelfStatusUpdateResponse
|
更新结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
precheck_new_item(access_token: str, leaf_category_id: int, uid: Optional[int] = None) -> ItemNewPrecheckResponse
async
新建商品预检
OpenAPI: open.item.new.precheck (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemNewPrecheckRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemNewPrecheckRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
leaf_category_id
|
int
|
叶子类目ID |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemNewPrecheckResponse |
ItemNewPrecheckResponse
|
预检结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
示例:
new(access_token: str, title: Optional[str] = None, rel_item_id: Optional[int] = None, category_id: Optional[int] = None, image_urls: Optional[List[str]] = None, sku_list: Optional[List[OpenApiAddSkuDTO]] = None, purchase_limit: Optional[bool] = None, limit_count: Optional[int] = None, item_prop_values: Optional[List[AddItemPropValue]] = None, details: Optional[str] = None, detail_image_urls: Optional[List[str]] = None, stock_partner: Optional[bool] = None, item_remark: Optional[str] = None, service_rule: Optional[ServiceRule] = None, express_template_id: Optional[int] = None, sale_time_flag: Optional[bool] = None, time_of_sale: Optional[int] = None, pay_way: Optional[int] = None, multiple_stock: Optional[bool] = None, poi_ids: Optional[List[int]] = None, white_base_image_url: Optional[str] = None, transparent_image_url: Optional[str] = None, short_title: Optional[str] = None, selling_point: Optional[str] = None, instructions: Optional[str] = None, save_shelf_item_qualification_data: Optional[List[QualificationDataDTO]] = None, off_shore_mode: Optional[int] = None, spu_id: Optional[int] = None, item_video_id: Optional[str] = None, three_quarters_image_urls: Optional[List[str]] = None, item_video: Optional[ItemVideoProto] = None, size_chart_template_id: Optional[int] = None, uid: Optional[int] = None) -> ItemNewResponse
async
新建商品
OpenAPI: open.item.new (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemNewRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemNewRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
title
|
Optional[str]
|
商品标题(可选) |
None
|
rel_item_id
|
Optional[int]
|
关联商品ID(可选) |
None
|
category_id
|
Optional[int]
|
分类ID(可选) |
None
|
image_urls
|
Optional[List[str]]
|
图片URL列表(可选) |
None
|
sku_list
|
Optional[List[OpenApiAddSkuDTO]]
|
SKU 列表(可选) |
None
|
purchase_limit
|
Optional[bool]
|
购买限制(可选) |
None
|
limit_count
|
Optional[int]
|
限制数量(可选) |
None
|
item_prop_values
|
Optional[List[AddItemPropValue]]
|
属性列表(可选) |
None
|
details
|
Optional[str]
|
详情描述(可选) |
None
|
detail_image_urls
|
Optional[List[str]]
|
详情图片(可选) |
None
|
stock_partner
|
Optional[bool]
|
库存合作(可选) |
None
|
item_remark
|
Optional[str]
|
备注(可选) |
None
|
service_rule
|
Optional[ServiceRule]
|
服务规则(可选) |
None
|
express_template_id
|
Optional[int]
|
运费模板ID(可选) |
None
|
sale_time_flag
|
Optional[bool]
|
定时上架标记(可选) |
None
|
time_of_sale
|
Optional[int]
|
上架时间戳(可选) |
None
|
pay_way
|
Optional[int]
|
支付方式(可选) |
None
|
multiple_stock
|
Optional[bool]
|
多库存开关(可选) |
None
|
poi_ids
|
Optional[List[int]]
|
门店ID列表(可选) |
None
|
white_base_image_url
|
Optional[str]
|
白底图(可选) |
None
|
transparent_image_url
|
Optional[str]
|
透明图(可选) |
None
|
short_title
|
Optional[str]
|
短标题(可选) |
None
|
selling_point
|
Optional[str]
|
卖点(可选) |
None
|
instructions
|
Optional[str]
|
使用说明(可选) |
None
|
save_shelf_item_qualification_data
|
Optional[List[QualificationDataDTO]]
|
资质数据(可选) |
None
|
off_shore_mode
|
Optional[int]
|
跨境模式(可选) |
None
|
spu_id
|
Optional[int]
|
SPU ID(可选) |
None
|
item_video_id
|
Optional[str]
|
视频ID(可选) |
None
|
three_quarters_image_urls
|
Optional[List[str]]
|
3/4图(可选) |
None
|
item_video
|
Optional[ItemVideoProto]
|
视频对象(可选) |
None
|
size_chart_template_id
|
Optional[int]
|
尺码表模板ID(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemNewResponse |
ItemNewResponse
|
新建结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
edit(access_token: str, item_id: int, title: Optional[str] = None, category_id: Optional[int] = None, image_urls: Optional[List[str]] = None, sku_list: Optional[List[OpenApiUpdateSkuDTO]] = None, item_video_id: Optional[str] = None, purchase_limit: Optional[bool] = None, limit_count: Optional[int] = None, item_prop_values: Optional[List[ItemPropValue]] = None, details: Optional[str] = None, detail_image_urls: Optional[List[str]] = None, update_detail_image_urls: Optional[bool] = None, item_remark: Optional[str] = None, service_rule: Optional[ServiceRule] = None, express_template_id: Optional[int] = None, sale_time_flag: Optional[bool] = None, time_of_sale: Optional[int] = None, pay_way: Optional[int] = None, update_item_prop_values: Optional[bool] = None, poi_ids: Optional[List[int]] = None, white_base_image_url: Optional[str] = None, transparent_image_url: Optional[str] = None, short_title: Optional[str] = None, selling_point: Optional[str] = None, instructions: Optional[str] = None, save_shelf_item_qualification_data: Optional[List[QualificationDataDTO]] = None, update_item_qualification: Optional[bool] = None, spu_id: Optional[int] = None, update_three_quarters_image_urls: Optional[bool] = None, three_quarters_image_urls: Optional[List[str]] = None, item_video: Optional[ItemVideoProto] = None, size_chart_template_id: Optional[int] = None, uid: Optional[int] = None) -> ItemEditResponse
async
编辑商品
OpenAPI: open.item.edit (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemEditRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemEditRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
title
|
Optional[str]
|
商品标题(可选) |
None
|
category_id
|
Optional[int]
|
分类ID(可选) |
None
|
image_urls
|
Optional[List[str]]
|
图片URL列表(可选) |
None
|
sku_list
|
Optional[List[OpenApiUpdateSkuDTO]]
|
SKU 列表(可选) |
None
|
item_video_id
|
Optional[str]
|
视频ID(可选) |
None
|
purchase_limit
|
Optional[bool]
|
购买限制(可选) |
None
|
limit_count
|
Optional[int]
|
限制数量(可选) |
None
|
item_prop_values
|
Optional[List[ItemPropValue]]
|
属性列表(可选) |
None
|
details
|
Optional[str]
|
详情描述(可选) |
None
|
detail_image_urls
|
Optional[List[str]]
|
详情图片(可选) |
None
|
update_detail_image_urls
|
Optional[bool]
|
是否更新详情图(可选) |
None
|
item_remark
|
Optional[str]
|
备注(可选) |
None
|
service_rule
|
Optional[ServiceRule]
|
服务规则(可选) |
None
|
express_template_id
|
Optional[int]
|
运费模板ID(可选) |
None
|
sale_time_flag
|
Optional[bool]
|
定时上架标记(可选) |
None
|
time_of_sale
|
Optional[int]
|
上架时间戳(可选) |
None
|
pay_way
|
Optional[int]
|
支付方式(可选) |
None
|
update_item_prop_values
|
Optional[bool]
|
是否更新属性(可选) |
None
|
poi_ids
|
Optional[List[int]]
|
门店ID列表(可选) |
None
|
white_base_image_url
|
Optional[str]
|
白底图(可选) |
None
|
transparent_image_url
|
Optional[str]
|
透明图(可选) |
None
|
short_title
|
Optional[str]
|
短标题(可选) |
None
|
selling_point
|
Optional[str]
|
卖点(可选) |
None
|
instructions
|
Optional[str]
|
使用说明(可选) |
None
|
save_shelf_item_qualification_data
|
Optional[List[QualificationDataDTO]]
|
资质数据(可选) |
None
|
update_item_qualification
|
Optional[bool]
|
是否更新资质(可选) |
None
|
spu_id
|
Optional[int]
|
SPU ID(可选) |
None
|
update_three_quarters_image_urls
|
Optional[bool]
|
是否更新3/4图(可选) |
None
|
three_quarters_image_urls
|
Optional[List[str]]
|
3/4图(可选) |
None
|
item_video
|
Optional[ItemVideoProto]
|
视频对象(可选) |
None
|
size_chart_template_id
|
Optional[int]
|
尺码表模板ID(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemEditResponse |
ItemEditResponse
|
编辑结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
get_size_chart_group_list(access_token: str, uid: Optional[int] = None) -> ItemSizeChartGroupListGetResponse
async
获取尺码表分组列表
OpenAPI: open.item.size.chart.group.list.get (GET)
Java: OpenItemSizeChartGroupListGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartGroupListGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartGroupListGetResponse |
ItemSizeChartGroupListGetResponse
|
尺码表分组列表。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
add_size_chart_template(access_token: str, size_chart: AddSizeChartParam, uid: Optional[int] = None) -> ItemSizeChartTemplateAddResponse
async
添加尺码表模板
OpenAPI: open.item.size.chart.template.add (POST)
Java: OpenItemSizeChartTemplateAddRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateAddRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
size_chart
|
AddSizeChartParam
|
尺码表模板数据。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateAddResponse |
ItemSizeChartTemplateAddResponse
|
添加结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
delete_size_chart_template(access_token: str, size_chart_id: int, uid: Optional[int] = None) -> ItemSizeChartTemplateDeleteResponse
async
删除尺码表模板
OpenAPI: open.item.size.chart.template.delete (GET)
Java: OpenItemSizeChartTemplateDeleteRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateDeleteRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
size_chart_id
|
int
|
尺码表模板ID。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateDeleteResponse |
ItemSizeChartTemplateDeleteResponse
|
删除结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
edit_size_chart_template(access_token: str, size_chart: SizeChartParam, uid: Optional[int] = None) -> ItemSizeChartTemplateEditResponse
async
编辑尺码表模板
OpenAPI: open.item.size.chart.template.edit (GET)
Java: OpenItemSizeChartTemplateEditRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateEditRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
size_chart
|
SizeChartParam
|
尺码表模板数据。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateEditResponse |
ItemSizeChartTemplateEditResponse
|
编辑结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_size_chart_template(access_token: str, size_chart_id: int, uid: Optional[int] = None) -> ItemSizeChartTemplateGetResponse
async
获取尺码表模板
OpenAPI: open.item.size.chart.template.get (GET)
Java: OpenItemSizeChartTemplateGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
size_chart_id
|
int
|
尺码表模板ID。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateGetResponse |
ItemSizeChartTemplateGetResponse
|
模板详情。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_size_chart_template_list(access_token: str, template_type_prop_value_id: Optional[int] = None, page_num: Optional[int] = 1, page_size: Optional[int] = 20, uid: Optional[int] = None) -> ItemSizeChartTemplateListGetResponse
async
获取尺码表模板列表
OpenAPI: open.item.size.chart.template.list.get (GET)
Java: OpenItemSizeChartTemplateListGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateListGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
template_type_prop_value_id
|
Optional[int]
|
模板类型属性值ID(可选)。 |
None
|
page_num
|
Optional[int]
|
页码(可选)。 |
1
|
page_size
|
Optional[int]
|
页面大小(可选)。 |
20
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateListGetResponse |
ItemSizeChartTemplateListGetResponse
|
模板分页数据。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_size_chart_template_meta(access_token: str, category_id: int, uid: Optional[int] = None) -> ItemSizeChartTemplateMetaGetResponse
async
获取尺码表模板元数据
OpenAPI: open.item.size.chart.template.meta.get (GET)
Java: OpenItemSizeChartTemplateMetaGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateMetaGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
int
|
类目ID。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateMetaGetResponse |
ItemSizeChartTemplateMetaGetResponse
|
元数据内容。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_deleted_items(access_token: str, item_id: Optional[int] = None, uid: Optional[int] = None) -> ItemDeletedGetResponse
async
获取已删除商品
OpenAPI: open.item.deleted.get (GET)
Java: OpenItemDeletedGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemDeletedGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
item_id
|
Optional[int]
|
商品ID(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemDeletedGetResponse |
ItemDeletedGetResponse
|
已删除商品数据。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_material_detail(access_token: str, material_id: int, material_upload_type: Optional[int] = None, uid: Optional[int] = None) -> ItemMaterialDetailGetResponse
async
获取素材详情
OpenAPI: open.item.material.detail.get (GET)
Java: OpenItemMaterialDetailGetRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemMaterialDetailGetRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
material_id
|
int
|
素材ID。 |
必需 |
material_upload_type
|
Optional[int]
|
素材上传类型(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemMaterialDetailGetResponse |
ItemMaterialDetailGetResponse
|
素材详情。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
verify_upload_token(access_token: str, token: str, material_upload_type: Optional[int] = None, uid: Optional[int] = None) -> ItemMaterialUploadTokenVerifyResponse
async
验证上传令牌
OpenAPI: open.item.material.upload.token.verify (POST)
Java: OpenItemMaterialUploadTokenVerifyRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemMaterialUploadTokenVerifyRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
token
|
str
|
上传令牌。 |
必需 |
material_upload_type
|
Optional[int]
|
素材上传类型(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemMaterialUploadTokenVerifyResponse |
ItemMaterialUploadTokenVerifyResponse
|
验证结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
apply_item_standard(access_token: str, category_id: int, key_prop_list: Optional[List[KeyPropOpenApiDTO]] = None, spu_prop_list: Optional[List[SPUPropOpenApiDTO]] = None, standard_images: Optional[List[str]] = None, uid: Optional[int] = None) -> ItemStandardApplyResponse
async
申请商品标准
OpenAPI: open.item.standard.apply (POST)
Java: OpenItemStandardApplyRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemStandardApplyRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
int
|
类目ID。 |
必需 |
key_prop_list
|
Optional[List[KeyPropOpenApiDTO]]
|
关键属性列表(可选)。 |
None
|
spu_prop_list
|
Optional[List[SPUPropOpenApiDTO]]
|
SPU属性列表(可选)。 |
None
|
standard_images
|
Optional[List[str]]
|
标准图片URL列表(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemStandardApplyResponse |
ItemStandardApplyResponse
|
申请结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
query_standard_apply(access_token: str, category_id: Optional[List[int]] = None, standard_status: Optional[int] = None, standard_name: Optional[str] = None, apply_type: Optional[int] = None, standard_audit_status: Optional[int] = None, limit: Optional[int] = None, cursor: Optional[int] = None, uid: Optional[int] = None) -> ItemStandardApplyQueryResponse
async
查询标准申请状态
OpenAPI: open.item.standard.apply.query (GET)
Java: OpenItemStandardApplyQueryRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemStandardApplyQueryRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
Optional[List[int]]
|
类目ID列表(可选)。 |
None
|
standard_status
|
Optional[int]
|
标准状态(可选)。 |
None
|
standard_name
|
Optional[str]
|
标准名称(可选)。 |
None
|
apply_type
|
Optional[int]
|
申请类型(可选)。 |
None
|
standard_audit_status
|
Optional[int]
|
标准审核状态(可选)。 |
None
|
limit
|
Optional[int]
|
限制数量(可选)。 |
None
|
cursor
|
Optional[int]
|
游标(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemStandardApplyQueryResponse |
ItemStandardApplyQueryResponse
|
申请状态数据。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
correct_item_standard(access_token: str, category_id: int, standard_id: int, key_prop_list: Optional[List[KeyPropOpenApiDTO]] = None, spu_prop_list: Optional[List[SPUPropOpenApiDTO]] = None, modify_reason: Optional[str] = None, modify_image_url: Optional[str] = None, standard_images: Optional[List[str]] = None, uid: Optional[int] = None) -> ItemStandardCorrectResponse
async
纠正商品标准
OpenAPI: open.item.standard.correct (POST)
Java: OpenItemStandardCorrectRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemStandardCorrectRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
int
|
类目ID。 |
必需 |
standard_id
|
int
|
标准ID。 |
必需 |
key_prop_list
|
Optional[List[KeyPropOpenApiDTO]]
|
关键属性列表(可选)。 |
None
|
spu_prop_list
|
Optional[List[SPUPropOpenApiDTO]]
|
SPU属性列表(可选)。 |
None
|
modify_reason
|
Optional[str]
|
修改原因(可选)。 |
None
|
modify_image_url
|
Optional[str]
|
修改图片URL(可选)。 |
None
|
standard_images
|
Optional[List[str]]
|
标准图片URL列表(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemStandardCorrectResponse |
ItemStandardCorrectResponse
|
提交纠正结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
edit_video_caption(access_token: str, video_id: str, caption: str, video_type: Optional[int] = None, uid: Optional[int] = None) -> ItemVideoCaptionEditResponse
async
编辑视频字幕
OpenAPI: open.item.video.caption.edit (POST)
Java: OpenItemVideoCaptionEditRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemVideoCaptionEditRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
video_id
|
str
|
视频ID。 |
必需 |
caption
|
str
|
字幕内容。 |
必需 |
video_type
|
Optional[int]
|
视频类型(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemVideoCaptionEditResponse |
ItemVideoCaptionEditResponse
|
编辑提交结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_video_count(access_token: str, video_type: Optional[int] = None, aspect_ratio: Optional[int] = None, audit_status: Optional[int] = None, create_time_start: Optional[int] = None, create_time_end: Optional[int] = None, uid: Optional[int] = None) -> ItemVideoCountResponse
async
获取视频数量
OpenAPI: open.item.video.count (POST)
Java: OpenItemVideoCountRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemVideoCountRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
video_type
|
Optional[int]
|
视频类型(可选)。 |
None
|
aspect_ratio
|
Optional[int]
|
视频宽高比(可选)。 |
None
|
audit_status
|
Optional[int]
|
审核状态(可选)。 |
None
|
create_time_start
|
Optional[int]
|
创建开始时间(毫秒,可选)。 |
None
|
create_time_end
|
Optional[int]
|
创建结束时间(毫秒,可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemVideoCountResponse |
ItemVideoCountResponse
|
数量聚合结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_video_info(access_token: str, video_id: str, video_type: Optional[int] = None, uid: Optional[int] = None) -> ItemVideoInfoResponse
async
获取视频信息
OpenAPI: open.item.video.info (GET)
Java: OpenItemVideoInfoRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemVideoInfoRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
video_id
|
str
|
视频ID。 |
必需 |
video_type
|
Optional[int]
|
视频类型(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemVideoInfoResponse |
ItemVideoInfoResponse
|
视频详情。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
delete(access_token: str, item_id: int, uid: Optional[int] = None) -> ItemDeleteResponse
async
删除商品
OpenAPI: open.item.delete (POST)
Java: OpenItemDeleteRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemDeleteRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
item_id
|
int
|
商品ID( |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemDeleteResponse |
ItemDeleteResponse
|
删除结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
update_stock(access_token: str, item_id: int, sku_id: int, stock: int, change_type: Optional[int] = None, uid: Optional[int] = None) -> ItemUpdateStockResponse
async
更新商品SKU库存
OpenAPI: open.item.sku.stock.update (POST)
Java: OpenItemSkuStockUpdateRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSkuStockUpdateRequest.java
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
item_id
|
int
|
商品ID。 |
必需 |
sku_id
|
int
|
SKU ID。 |
必需 |
stock
|
int
|
库存数量。 |
必需 |
change_type
|
Optional[int]
|
变更类型(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemUpdateStockResponse |
ItemUpdateStockResponse
|
库存更新结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
同步商品服务
kwaixiaodian.client.services.item.SyncItemService(client: SyncBaseClient)
同步商品服务
提供商品创建、更新、查询、库存管理等功能的同步版本。
初始化商品服务
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
client
|
SyncBaseClient
|
同步基础客户端实例 |
必需 |
方法:
Functions
list(access_token: str, kwai_item_id: Optional[int] = None, rel_item_id: Optional[int] = None, item_status: Optional[int] = None, item_type: Optional[int] = None, page_number: int = 1, page_size: int = 20, on_offline_status: Optional[int] = None, uid: Optional[int] = None) -> ItemListResponse
获取商品列表(同步)
OpenAPI: open.item.list.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemListGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemListGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
kwai_item_id
|
Optional[int]
|
快手商品ID(可选) |
None
|
rel_item_id
|
Optional[int]
|
关联商品ID(可选) |
None
|
item_status
|
Optional[int]
|
商品状态(可选) |
None
|
item_type
|
Optional[int]
|
商品类型(可选) |
None
|
page_number
|
int
|
页码,默认 1 |
1
|
page_size
|
int
|
页大小,默认 20 |
20
|
on_offline_status
|
Optional[int]
|
上下线状态(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemListResponse |
ItemListResponse
|
商品列表 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
get(access_token: str, item_id: int, uid: Optional[int] = None) -> ItemGetResponse
获取商品详情(同步)
OpenAPI: open.item.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID(kwaiItemId) |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemGetResponse |
ItemGetResponse
|
商品详情 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
get_saleprop_rule(access_token: str, category_id: int, spu_id: Optional[int] = None, item_id: Optional[int] = None, uid: Optional[int] = None) -> ItemSalePropRuleResponse
获取销售属性规则(同步)
OpenAPI: open.item.saleprop.rule (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSalepropRuleRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSalepropRuleRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
category_id
|
int
|
类目ID |
必需 |
spu_id
|
Optional[int]
|
SPU ID(可选) |
None
|
item_id
|
Optional[int]
|
商品ID(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSalePropRuleResponse |
ItemSalePropRuleResponse
|
规则配置 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
update_stock(access_token: str, item_id: int, sku_id: int, stock: int, change_type: Optional[int] = None, uid: Optional[int] = None) -> ItemUpdateStockResponse
更新商品SKU库存(同步)
OpenAPI: open.item.sku.stock.update (POST)
Java: OpenItemSkuStockUpdateRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSkuStockUpdateRequest.java
delete(access_token: str, item_id: int, uid: Optional[int] = None) -> ItemDeleteResponse
删除商品(同步)
OpenAPI: open.item.delete (POST)
Java: OpenItemDeleteRequest
Path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemDeleteRequest.java
upload_image(access_token: str, upload_type: int, img_url: Optional[str] = None, img_bytes: Optional[bytes] = None, uid: Optional[int] = None) -> ItemImageUploadResponse
商品图片上传(同步)
OpenAPI: open.item.image.upload (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemImageUploadRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemImageUploadRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
upload_type
|
int
|
上传类型(1: URL, 2: 文件) |
必需 |
img_url
|
Optional[str]
|
图片URL(URL上传时使用) |
None
|
img_bytes
|
Optional[bytes]
|
图片字节数据(文件上传时使用) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemImageUploadResponse |
ItemImageUploadResponse
|
图片上传结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
issue_upload_token(access_token: str, material_upload_type: int, file_name: str, file_length: int, uid: Optional[int] = None) -> ItemMaterialUploadTokenIssueResponse
素材上传 token 签发(同步)
OpenAPI: open.item.material.upload.token.issue (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemMaterialUploadTokenIssueRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemMaterialUploadTokenIssueRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
material_upload_type
|
int
|
素材上传类型 |
必需 |
file_name
|
str
|
文件名 |
必需 |
file_length
|
int
|
文件长度 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemMaterialUploadTokenIssueResponse |
ItemMaterialUploadTokenIssueResponse
|
签发结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
get_video_list(access_token: str, video_type: Optional[int] = None, aspect_ratio: Optional[int] = None, audit_status: Optional[int] = None, create_time_start: Optional[int] = None, create_time_end: Optional[int] = None, page_index: Optional[int] = None, page_size: Optional[int] = None, uid: Optional[int] = None) -> ItemVideoListResponse
获取视频列表(同步)
OpenAPI: open.item.video.list (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemVideoListRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemVideoListRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
video_type
|
Optional[int]
|
视频类型(可选) |
None
|
aspect_ratio
|
Optional[int]
|
视频宽高比(可选) |
None
|
audit_status
|
Optional[int]
|
审核状态(可选) |
None
|
create_time_start
|
Optional[int]
|
创建开始时间(毫秒,可选) |
None
|
create_time_end
|
Optional[int]
|
创建结束时间(毫秒,可选) |
None
|
page_index
|
Optional[int]
|
页码(可选) |
None
|
page_size
|
Optional[int]
|
页面大小(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemVideoListResponse |
ItemVideoListResponse
|
视频分页列表 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
delete_video(access_token: str, video_ids: List[str], video_type: Optional[int] = None, uid: Optional[int] = None) -> ItemVideoDeleteResponse
删除视频(同步)
OpenAPI: open.item.video.delete (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemVideoDeleteRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemVideoDeleteRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
video_ids
|
List[str]
|
视频ID列表 |
必需 |
video_type
|
Optional[int]
|
视频类型(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemVideoDeleteResponse |
ItemVideoDeleteResponse
|
删除结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
edit_autopass(access_token: str, item_id: int, purchase_limit: Optional[bool] = None, limit_count: Optional[int] = None, item_remark: Optional[str] = None, sku_list: Optional[List[OpenApiAutoPassSkuDTO]] = None, service_rule: Optional[ServiceRule] = None, express_template_id: Optional[int] = None, sale_time_flag: Optional[bool] = None, time_of_sale: Optional[int] = None, pay_way: Optional[int] = None, uid: Optional[int] = None) -> ItemAutopassEditResponse
商品自动通过编辑(同步)
OpenAPI: open.item.autopass.edit (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemAutopassEditRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemAutopassEditRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
purchase_limit
|
Optional[bool]
|
购买限制(可选) |
None
|
limit_count
|
Optional[int]
|
限制数量(可选) |
None
|
item_remark
|
Optional[str]
|
商品备注(可选) |
None
|
sku_list
|
Optional[List[OpenApiAutoPassSkuDTO]]
|
SKU 列表(可选) |
None
|
service_rule
|
Optional[ServiceRule]
|
服务规则(可选) |
None
|
express_template_id
|
Optional[int]
|
运费模板ID(可选) |
None
|
sale_time_flag
|
Optional[bool]
|
定时上架标记(可选) |
None
|
time_of_sale
|
Optional[int]
|
上架时间戳(可选) |
None
|
pay_way
|
Optional[int]
|
支付方式(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemAutopassEditResponse |
ItemAutopassEditResponse
|
编辑结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
update_detail_images(access_token: str, kwai_item_id: int, detail_image_urls: List[str], uid: Optional[int] = None) -> ItemDetailImagesUpdateResponse
更新商品详情图片(同步)
OpenAPI: open.item.detail.images.update (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemDetailImagesUpdateRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemDetailImagesUpdateRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
kwai_item_id
|
int
|
快手商品ID |
必需 |
detail_image_urls
|
List[str]
|
详情图片URL列表 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemDetailImagesUpdateResponse |
ItemDetailImagesUpdateResponse
|
更新结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
get_detail_page_link(access_token: str, item_id: int, type: int, item_product_client_info: Optional[Dict[str, Any]] = None, uid: Optional[int] = None) -> ItemDetailPageLinkResponse
获取商品详情页链接(同步)
OpenAPI: open.item.detail.page.link (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemDetailPageLinkRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemDetailPageLinkRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
type
|
int
|
链接类型 |
必需 |
item_product_client_info
|
Optional[Dict[str, Any]]
|
客户端信息(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemDetailPageLinkResponse |
ItemDetailPageLinkResponse
|
详情链接 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
get_diagnosis(access_token: str, item_id: int, uid: Optional[int] = None) -> ItemDiagnosisGetResponse
获取商品诊断信息(同步)
OpenAPI: open.item.diagnosis.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemDiagnosisGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemDiagnosisGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemDiagnosisGetResponse |
ItemDiagnosisGetResponse
|
诊断详情 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
apply_main_pic_video(access_token: str, item_id: int, video_id: str, video_type: int, uid: Optional[int] = None) -> ItemMainPicVideoApplyResponse
申请商品主图视频(同步)
OpenAPI: open.item.main.pic.video.apply (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemMainPicVideoApplyRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemMainPicVideoApplyRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
video_id
|
str
|
视频ID |
必需 |
video_type
|
int
|
视频类型 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemMainPicVideoApplyResponse |
ItemMainPicVideoApplyResponse
|
申请结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
delete_main_pic_video(access_token: str, item_id: int, uid: Optional[int] = None) -> ItemMainPicVideoDeleteResponse
删除商品主图视频(同步)
OpenAPI: open.item.main.pic.video.delete (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemMainPicVideoDeleteRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemMainPicVideoDeleteRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemMainPicVideoDeleteResponse |
ItemMainPicVideoDeleteResponse
|
删除结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
update_shelf_status(access_token: str, kwai_item_id: int, shelf_status: int, uid: Optional[int] = None) -> ItemShelfStatusUpdateResponse
更新商品上下架状态(同步)
OpenAPI: open.item.shelf.status.update (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemShelfStatusUpdateRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemShelfStatusUpdateRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
kwai_item_id
|
int
|
快手商品ID |
必需 |
shelf_status
|
int
|
上下架状态 |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemShelfStatusUpdateResponse |
ItemShelfStatusUpdateResponse
|
更新结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
precheck_new_item(access_token: str, leaf_category_id: int, uid: Optional[int] = None) -> ItemNewPrecheckResponse
新建商品预检(同步)
OpenAPI: open.item.new.precheck (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemNewPrecheckRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemNewPrecheckRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
leaf_category_id
|
int
|
叶子类目ID |
必需 |
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemNewPrecheckResponse |
ItemNewPrecheckResponse
|
预检结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
new(access_token: str, title: Optional[str] = None, rel_item_id: Optional[int] = None, category_id: Optional[int] = None, image_urls: Optional[List[str]] = None, sku_list: Optional[List[OpenApiAddSkuDTO]] = None, purchase_limit: Optional[bool] = None, limit_count: Optional[int] = None, item_prop_values: Optional[List[AddItemPropValue]] = None, details: Optional[str] = None, detail_image_urls: Optional[List[str]] = None, stock_partner: Optional[bool] = None, item_remark: Optional[str] = None, service_rule: Optional[ServiceRule] = None, express_template_id: Optional[int] = None, sale_time_flag: Optional[bool] = None, time_of_sale: Optional[int] = None, pay_way: Optional[int] = None, multiple_stock: Optional[bool] = None, poi_ids: Optional[List[int]] = None, white_base_image_url: Optional[str] = None, transparent_image_url: Optional[str] = None, short_title: Optional[str] = None, selling_point: Optional[str] = None, instructions: Optional[str] = None, save_shelf_item_qualification_data: Optional[List[QualificationDataDTO]] = None, off_shore_mode: Optional[int] = None, spu_id: Optional[int] = None, item_video_id: Optional[str] = None, three_quarters_image_urls: Optional[List[str]] = None, item_video: Optional[ItemVideoProto] = None, size_chart_template_id: Optional[int] = None, uid: Optional[int] = None) -> ItemNewResponse
新建商品(同步)
OpenAPI: open.item.new (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemNewRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemNewRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
title
|
Optional[str]
|
商品标题(可选) |
None
|
rel_item_id
|
Optional[int]
|
关联商品ID(可选) |
None
|
category_id
|
Optional[int]
|
分类ID(可选) |
None
|
image_urls
|
Optional[List[str]]
|
图片URL列表(可选) |
None
|
sku_list
|
Optional[List[OpenApiAddSkuDTO]]
|
SKU 列表(可选) |
None
|
purchase_limit
|
Optional[bool]
|
购买限制(可选) |
None
|
limit_count
|
Optional[int]
|
限制数量(可选) |
None
|
item_prop_values
|
Optional[List[AddItemPropValue]]
|
属性列表(可选) |
None
|
details
|
Optional[str]
|
详情描述(可选) |
None
|
detail_image_urls
|
Optional[List[str]]
|
详情图片(可选) |
None
|
stock_partner
|
Optional[bool]
|
库存合作(可选) |
None
|
item_remark
|
Optional[str]
|
备注(可选) |
None
|
service_rule
|
Optional[ServiceRule]
|
服务规则(可选) |
None
|
express_template_id
|
Optional[int]
|
运费模板ID(可选) |
None
|
sale_time_flag
|
Optional[bool]
|
定时上架标记(可选) |
None
|
time_of_sale
|
Optional[int]
|
上架时间戳(可选) |
None
|
pay_way
|
Optional[int]
|
支付方式(可选) |
None
|
multiple_stock
|
Optional[bool]
|
多库存开关(可选) |
None
|
poi_ids
|
Optional[List[int]]
|
门店ID列表(可选) |
None
|
white_base_image_url
|
Optional[str]
|
白底图(可选) |
None
|
transparent_image_url
|
Optional[str]
|
透明图(可选) |
None
|
short_title
|
Optional[str]
|
短标题(可选) |
None
|
selling_point
|
Optional[str]
|
卖点(可选) |
None
|
instructions
|
Optional[str]
|
使用说明(可选) |
None
|
save_shelf_item_qualification_data
|
Optional[List[QualificationDataDTO]]
|
资质数据(可选) |
None
|
off_shore_mode
|
Optional[int]
|
跨境模式(可选) |
None
|
spu_id
|
Optional[int]
|
SPU ID(可选) |
None
|
item_video_id
|
Optional[str]
|
视频ID(可选) |
None
|
three_quarters_image_urls
|
Optional[List[str]]
|
3/4图(可选) |
None
|
item_video
|
Optional[ItemVideoProto]
|
视频对象(可选) |
None
|
size_chart_template_id
|
Optional[int]
|
尺码表模板ID(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemNewResponse |
ItemNewResponse
|
新建结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
edit(access_token: str, item_id: int, title: Optional[str] = None, category_id: Optional[int] = None, image_urls: Optional[List[str]] = None, sku_list: Optional[List[OpenApiUpdateSkuDTO]] = None, item_video_id: Optional[str] = None, purchase_limit: Optional[bool] = None, limit_count: Optional[int] = None, item_prop_values: Optional[List[ItemPropValue]] = None, details: Optional[str] = None, detail_image_urls: Optional[List[str]] = None, update_detail_image_urls: Optional[bool] = None, item_remark: Optional[str] = None, service_rule: Optional[ServiceRule] = None, express_template_id: Optional[int] = None, sale_time_flag: Optional[bool] = None, time_of_sale: Optional[int] = None, pay_way: Optional[int] = None, update_item_prop_values: Optional[bool] = None, poi_ids: Optional[List[int]] = None, white_base_image_url: Optional[str] = None, transparent_image_url: Optional[str] = None, short_title: Optional[str] = None, selling_point: Optional[str] = None, instructions: Optional[str] = None, save_shelf_item_qualification_data: Optional[List[QualificationDataDTO]] = None, update_item_qualification: Optional[bool] = None, spu_id: Optional[int] = None, update_three_quarters_image_urls: Optional[bool] = None, three_quarters_image_urls: Optional[List[str]] = None, item_video: Optional[ItemVideoProto] = None, size_chart_template_id: Optional[int] = None, uid: Optional[int] = None) -> ItemEditResponse
编辑商品(同步)
OpenAPI: open.item.edit (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemEditRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemEditRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌 |
必需 |
item_id
|
int
|
商品ID |
必需 |
title
|
Optional[str]
|
商品标题(可选) |
None
|
category_id
|
Optional[int]
|
分类ID(可选) |
None
|
image_urls
|
Optional[List[str]]
|
图片URL列表(可选) |
None
|
sku_list
|
Optional[List[OpenApiUpdateSkuDTO]]
|
SKU 列表(可选) |
None
|
item_video_id
|
Optional[str]
|
视频ID(可选) |
None
|
purchase_limit
|
Optional[bool]
|
购买限制(可选) |
None
|
limit_count
|
Optional[int]
|
限制数量(可选) |
None
|
item_prop_values
|
Optional[List[ItemPropValue]]
|
属性列表(可选) |
None
|
details
|
Optional[str]
|
详情描述(可选) |
None
|
detail_image_urls
|
Optional[List[str]]
|
详情图片(可选) |
None
|
update_detail_image_urls
|
Optional[bool]
|
是否更新详情图(可选) |
None
|
item_remark
|
Optional[str]
|
备注(可选) |
None
|
service_rule
|
Optional[ServiceRule]
|
服务规则(可选) |
None
|
express_template_id
|
Optional[int]
|
运费模板ID(可选) |
None
|
sale_time_flag
|
Optional[bool]
|
定时上架标记(可选) |
None
|
time_of_sale
|
Optional[int]
|
上架时间戳(可选) |
None
|
pay_way
|
Optional[int]
|
支付方式(可选) |
None
|
update_item_prop_values
|
Optional[bool]
|
是否更新属性(可选) |
None
|
poi_ids
|
Optional[List[int]]
|
门店ID列表(可选) |
None
|
white_base_image_url
|
Optional[str]
|
白底图(可选) |
None
|
transparent_image_url
|
Optional[str]
|
透明图(可选) |
None
|
short_title
|
Optional[str]
|
短标题(可选) |
None
|
selling_point
|
Optional[str]
|
卖点(可选) |
None
|
instructions
|
Optional[str]
|
使用说明(可选) |
None
|
save_shelf_item_qualification_data
|
Optional[List[QualificationDataDTO]]
|
资质数据(可选) |
None
|
update_item_qualification
|
Optional[bool]
|
是否更新资质(可选) |
None
|
spu_id
|
Optional[int]
|
SPU ID(可选) |
None
|
update_three_quarters_image_urls
|
Optional[bool]
|
是否更新3/4图(可选) |
None
|
three_quarters_image_urls
|
Optional[List[str]]
|
3/4图(可选) |
None
|
item_video
|
Optional[ItemVideoProto]
|
视频对象(可选) |
None
|
size_chart_template_id
|
Optional[int]
|
尺码表模板ID(可选) |
None
|
uid
|
Optional[int]
|
用户ID(可选) |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemEditResponse |
ItemEditResponse
|
编辑结果 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
当开放平台返回错误码或解析失败时抛出 |
get_size_chart_group_list(access_token: str, uid: Optional[int] = None) -> ItemSizeChartGroupListGetResponse
获取尺码表分组列表(同步)
OpenAPI: open.item.size.chart.group.list.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSizeChartGroupListGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartGroupListGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartGroupListGetResponse |
ItemSizeChartGroupListGetResponse
|
尺码表分组列表。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
add_size_chart_template(access_token: str, size_chart: AddSizeChartParam, uid: Optional[int] = None) -> ItemSizeChartTemplateAddResponse
添加尺码表模板(同步)
OpenAPI: open.item.size.chart.template.add (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSizeChartTemplateAddRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateAddRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
size_chart
|
AddSizeChartParam
|
尺码表模板数据。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateAddResponse |
ItemSizeChartTemplateAddResponse
|
添加结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
delete_size_chart_template(access_token: str, size_chart_id: int, uid: Optional[int] = None) -> ItemSizeChartTemplateDeleteResponse
删除尺码表模板(同步)
OpenAPI: open.item.size.chart.template.delete (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSizeChartTemplateDeleteRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateDeleteRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
size_chart_id
|
int
|
尺码表模板ID。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateDeleteResponse |
ItemSizeChartTemplateDeleteResponse
|
删除结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
edit_size_chart_template(access_token: str, size_chart: SizeChartParam, uid: Optional[int] = None) -> ItemSizeChartTemplateEditResponse
编辑尺码表模板(同步)
OpenAPI: open.item.size.chart.template.edit (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSizeChartTemplateEditRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateEditRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
size_chart
|
SizeChartParam
|
尺码表模板数据。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateEditResponse |
ItemSizeChartTemplateEditResponse
|
编辑结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_size_chart_template(access_token: str, size_chart_id: int, uid: Optional[int] = None) -> ItemSizeChartTemplateGetResponse
获取尺码表模板(同步)
OpenAPI: open.item.size.chart.template.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSizeChartTemplateGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
size_chart_id
|
int
|
尺码表模板ID。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateGetResponse |
ItemSizeChartTemplateGetResponse
|
模板详情。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_size_chart_template_list(access_token: str, template_type_prop_value_id: Optional[int] = None, page_num: Optional[int] = 1, page_size: Optional[int] = 20, uid: Optional[int] = None) -> ItemSizeChartTemplateListGetResponse
获取尺码表模板列表(同步)
OpenAPI: open.item.size.chart.template.list.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSizeChartTemplateListGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateListGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
template_type_prop_value_id
|
Optional[int]
|
模板类型属性值ID(可选)。 |
None
|
page_num
|
Optional[int]
|
页码(可选,默认 1)。 |
1
|
page_size
|
Optional[int]
|
页面大小(可选,默认 20)。 |
20
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateListGetResponse |
ItemSizeChartTemplateListGetResponse
|
模板分页数据。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_size_chart_template_meta(access_token: str, category_id: int, uid: Optional[int] = None) -> ItemSizeChartTemplateMetaGetResponse
获取尺码表模板元数据(同步)
OpenAPI: open.item.size.chart.template.meta.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemSizeChartTemplateMetaGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemSizeChartTemplateMetaGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
int
|
类目ID。 |
必需 |
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemSizeChartTemplateMetaGetResponse |
ItemSizeChartTemplateMetaGetResponse
|
元数据内容。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_deleted_items(access_token: str, item_id: Optional[int] = None, uid: Optional[int] = None) -> ItemDeletedGetResponse
获取已删除商品(同步)
OpenAPI: open.item.deleted.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemDeletedGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemDeletedGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
item_id
|
Optional[int]
|
商品ID(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemDeletedGetResponse |
ItemDeletedGetResponse
|
已删除商品数据。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_material_detail(access_token: str, material_id: int, material_upload_type: Optional[int] = None, uid: Optional[int] = None) -> ItemMaterialDetailGetResponse
获取素材详情(同步)
OpenAPI: open.item.material.detail.get (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemMaterialDetailGetRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemMaterialDetailGetRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
material_id
|
int
|
素材ID。 |
必需 |
material_upload_type
|
Optional[int]
|
素材上传类型(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemMaterialDetailGetResponse |
ItemMaterialDetailGetResponse
|
素材详情。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
verify_upload_token(access_token: str, token: str, material_upload_type: Optional[int] = None, uid: Optional[int] = None) -> ItemMaterialUploadTokenVerifyResponse
验证上传令牌(同步)
OpenAPI: open.item.material.upload.token.verify (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemMaterialUploadTokenVerifyRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemMaterialUploadTokenVerifyRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
token
|
str
|
上传令牌。 |
必需 |
material_upload_type
|
Optional[int]
|
素材上传类型(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemMaterialUploadTokenVerifyResponse |
ItemMaterialUploadTokenVerifyResponse
|
验证结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
apply_item_standard(access_token: str, category_id: int, key_prop_list: Optional[List[KeyPropOpenApiDTO]] = None, spu_prop_list: Optional[List[SPUPropOpenApiDTO]] = None, standard_images: Optional[List[str]] = None, uid: Optional[int] = None) -> ItemStandardApplyResponse
申请商品标准(同步)
OpenAPI: open.item.standard.apply (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemStandardApplyRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemStandardApplyRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
int
|
类目ID。 |
必需 |
key_prop_list
|
Optional[List[KeyPropOpenApiDTO]]
|
关键属性列表(可选)。 |
None
|
spu_prop_list
|
Optional[List[SPUPropOpenApiDTO]]
|
SPU属性列表(可选)。 |
None
|
standard_images
|
Optional[List[str]]
|
标准图片URL列表(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemStandardApplyResponse |
ItemStandardApplyResponse
|
申请结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
query_standard_apply(access_token: str, category_id: Optional[List[int]] = None, standard_status: Optional[int] = None, standard_name: Optional[str] = None, apply_type: Optional[int] = None, standard_audit_status: Optional[int] = None, limit: Optional[int] = None, cursor: Optional[int] = None, uid: Optional[int] = None) -> ItemStandardApplyQueryResponse
查询标准申请状态(同步)
OpenAPI: open.item.standard.apply.query (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemStandardApplyQueryRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemStandardApplyQueryRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
Optional[List[int]]
|
类目ID列表(可选)。 |
None
|
standard_status
|
Optional[int]
|
标准状态(可选)。 |
None
|
standard_name
|
Optional[str]
|
标准名称(可选)。 |
None
|
apply_type
|
Optional[int]
|
申请类型(可选)。 |
None
|
standard_audit_status
|
Optional[int]
|
标准审核状态(可选)。 |
None
|
limit
|
Optional[int]
|
限制数量(可选)。 |
None
|
cursor
|
Optional[int]
|
游标(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemStandardApplyQueryResponse |
ItemStandardApplyQueryResponse
|
申请状态数据。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
correct_item_standard(access_token: str, category_id: int, standard_id: int, key_prop_list: Optional[List[KeyPropOpenApiDTO]] = None, spu_prop_list: Optional[List[SPUPropOpenApiDTO]] = None, modify_reason: Optional[str] = None, modify_image_url: Optional[str] = None, standard_images: Optional[List[str]] = None, uid: Optional[int] = None) -> ItemStandardCorrectResponse
纠正商品标准(同步)
OpenAPI: open.item.standard.correct (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemStandardCorrectRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemStandardCorrectRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
category_id
|
int
|
类目ID。 |
必需 |
standard_id
|
int
|
标准ID。 |
必需 |
key_prop_list
|
Optional[List[KeyPropOpenApiDTO]]
|
关键属性列表(可选)。 |
None
|
spu_prop_list
|
Optional[List[SPUPropOpenApiDTO]]
|
SPU属性列表(可选)。 |
None
|
modify_reason
|
Optional[str]
|
修改原因(可选)。 |
None
|
modify_image_url
|
Optional[str]
|
修改图片URL(可选)。 |
None
|
standard_images
|
Optional[List[str]]
|
标准图片URL列表(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemStandardCorrectResponse |
ItemStandardCorrectResponse
|
提交纠正结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
edit_video_caption(access_token: str, video_id: str, caption: str, video_type: Optional[int] = None, uid: Optional[int] = None) -> ItemVideoCaptionEditResponse
编辑视频字幕(同步)
OpenAPI: open.item.video.caption.edit (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemVideoCaptionEditRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemVideoCaptionEditRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
video_id
|
str
|
视频ID。 |
必需 |
caption
|
str
|
字幕内容。 |
必需 |
video_type
|
Optional[int]
|
视频类型(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemVideoCaptionEditResponse |
ItemVideoCaptionEditResponse
|
编辑提交结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_video_count(access_token: str, video_type: Optional[int] = None, aspect_ratio: Optional[int] = None, audit_status: Optional[int] = None, create_time_start: Optional[int] = None, create_time_end: Optional[int] = None, uid: Optional[int] = None) -> ItemVideoCountResponse
获取视频数量(同步)
OpenAPI: open.item.video.count (POST)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemVideoCountRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemVideoCountRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
video_type
|
Optional[int]
|
视频类型(可选)。 |
None
|
aspect_ratio
|
Optional[int]
|
视频宽高比(可选)。 |
None
|
audit_status
|
Optional[int]
|
审核状态(可选)。 |
None
|
create_time_start
|
Optional[int]
|
创建开始时间(毫秒,可选)。 |
None
|
create_time_end
|
Optional[int]
|
创建结束时间(毫秒,可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemVideoCountResponse |
ItemVideoCountResponse
|
数量聚合结果。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
get_video_info(access_token: str, video_id: str, video_type: Optional[int] = None, uid: Optional[int] = None) -> ItemVideoInfoResponse
获取视频信息(同步)
OpenAPI: open.item.video.info (GET)
Java: com.kuaishou.merchant.open.api.request.item.OpenItemVideoInfoRequest
(java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/item/OpenItemVideoInfoRequest.java)
参数:
| 名称 | 类型 | 描述 | 默认 |
|---|---|---|---|
access_token
|
str
|
访问令牌。 |
必需 |
video_id
|
str
|
视频ID。 |
必需 |
video_type
|
Optional[int]
|
视频类型(可选)。 |
None
|
uid
|
Optional[int]
|
可选用户ID(最后一个可选参数)。 |
None
|
返回:
| 名称 | 类型 | 描述 |
|---|---|---|
ItemVideoInfoResponse |
ItemVideoInfoResponse
|
视频详情。 |
引发:
| 类型 | 描述 |
|---|---|
KwaixiaodianAPIError
|
平台返回错误或响应解析失败。 |
商品数据模型
kwaixiaodian.models.item
商品相关数据模型
类:
Classes
ItemSpec
ItemSku
Bases: BaseModel
商品SKU
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
price_yuan |
float
|
价格(元) |
original_price_yuan |
Optional[float]
|
原价(元) |
spec_text |
str
|
规格文本描述 |
Attributes
price_yuan: float
property
价格(元)
original_price_yuan: Optional[float]
property
原价(元)
spec_text: str
property
规格文本描述
ItemCategory
Item
Bases: BaseModel
商品信息
属性:
| 名称 | 类型 | 描述 |
|---|---|---|
price_yuan |
float
|
价格(元) |
original_price_yuan |
Optional[float]
|
原价(元) |
is_multi_sku |
bool
|
是否多SKU商品 |
is_in_stock |
bool
|
是否有库存 |
Attributes
price_yuan: float
property
价格(元)
original_price_yuan: Optional[float]
property
原价(元)
is_multi_sku: bool
property
是否多SKU商品
is_in_stock: bool
property
是否有库存