跳转至

订单服务

订单管理相关的API服务,包括订单查询、发货、状态更新等功能。

异步订单服务

kwaixiaodian.client.services.order.AsyncOrderService(client: AsyncBaseClient)

异步订单服务(仅保留 Java 存在的 API)。

  • OpenAPI 范围:open.order.*, open.seller.order.*
  • Java 包:com.kuaishou.merchant.open.api.request.order...request
  • 平台规则参考:docs/开发指南和规则协议/

方法:

名称 描述
list

分页获取订单列表(游标)。

get

获取订单详情。

ship

发货(更新订单发货信息)。

update_remark

新增订单备注/旗标。

close

关闭订单。

update_logistics

更新订单物流信息。

get_fee_detail

获取订单费用明细。

update_sku

更换订单 SKU。

verify_token

核验订单 token。

address_update

更新订单收货地址。

address_audit_approve

审批通过地址修改。

address_audit_reject

驳回地址修改申请。

ks_seller_order_address_update

商家订单地址更新(KS 专用)。

decrypt_batch

批量解密订单敏感字段。

encrypt_batch

批量加密订单敏感字段。

desensitise_batch

批量脱敏订单敏感字段。

search_index_batch

批量搜索订单索引。

tag_flag

订单标签标记查询。

takerate_inquiry

订单佣金费率查询。

goods_split_deliver

拆分发货。

list_encrypt_param_test

订单列表加密参数测试。

append_goods_logistics

追加包裹物流。

buyer_order_list

买家订单列表。

get_seller_detail

商家订单详情。

seller_pcursor_list

商家订单游标列表。

query_kspay_promo_detail

KS 支付订单优惠详情。

get_external_order_relation

外部订单关系。

Functions

list(access_token: str, begin_time: int, end_time: int, page_size: int = 20, pcursor: Optional[str] = None, uid: Optional[int] = None) -> OrderListResponse async

分页获取订单列表(游标)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
begin_time int

开始时间(秒级时间戳)。

必需
end_time int

结束时间(秒级时间戳)。

必需
page_size int

每页数量。

20
pcursor Optional[str]

下一页游标。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderListResponse OrderListResponse

订单列表和下一页游标。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.cursor.list (GET) Java: OpenOrderCursorListRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderCursorListRequest.java

get(access_token: str, order_id: str, uid: Optional[int] = None) -> OrderGetResponse async

获取订单详情。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id str

订单 ID(字符串)。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderGetResponse OrderGetResponse

订单详情。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.detail (GET) Java: OpenOrderDetailRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderDetailRequest.java

ship(access_token: str, order_id: int, express_code: int, express_no: str, return_address_id: Optional[int] = None, quality_param: Optional[str] = None, serial_number_list: Optional[List[str]] = None, imei_list: Optional[List[str]] = None, uid: Optional[int] = None) -> OrderShipResponse async

发货(更新订单发货信息)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
express_code int

快递公司编码。

必需
express_no str

运单号。

必需
return_address_id Optional[int]

退货地址 ID(可选)。

None
quality_param Optional[str]

质检参数(可选)。

None
serial_number_list Optional[List[str]]

序列号列表(可选)。

None
imei_list Optional[List[str]]

IMEI 列表(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderShipResponse OrderShipResponse

发货结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.goods.deliver (POST) Java: OpenSellerOrderGoodsDeliverRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderGoodsDeliverRequest.java

update_remark(access_token: str, order_id: int, note: str, staff_id: Optional[int] = None, flag: Optional[int] = None, uid: Optional[int] = None) -> OrderUpdateRemarkResponse async

新增订单备注/旗标。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
note str

备注内容(最长 500 字)。

必需
staff_id Optional[int]

员工 ID(可选)。

None
flag Optional[int]

备注标记(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderUpdateRemarkResponse OrderUpdateRemarkResponse

备注/旗标更新结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.note.add (POST) Java: OpenSellerOrderNoteAddRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderNoteAddRequest.java

close(access_token: str, order_id: int, uid: Optional[int] = None) -> OrderCloseResponse async

关闭订单。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderCloseResponse OrderCloseResponse

订单关闭结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.close (POST) Java: OpenSellerOrderCloseRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderCloseRequest.java

update_logistics(access_token: str, order_id: int, express_code: int, express_no: str, logistics_id: Optional[int] = None, uid: Optional[int] = None) -> OrderLogisticsUpdateResponse async

更新订单物流信息。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
express_code int

快递公司编码。

必需
express_no str

运单号。

必需
logistics_id Optional[int]

物流 ID(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderLogisticsUpdateResponse OrderLogisticsUpdateResponse

物流更新结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.logistics.update (POST) Java: KsMerchantOrderLogisticsUpdateRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/KsMerchantOrderLogisticsUpdateRequest.java

get_fee_detail(access_token: str, order_id: str, uid: Optional[int] = None) -> OrderFeeDetailResponse async

获取订单费用明细。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id str

订单 ID(字符串)。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderFeeDetailResponse OrderFeeDetailResponse

费用明细列表及总金额。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.fee.detail (GET) Java: OpenSellerOrderFeeDetailRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderFeeDetailRequest.java

update_sku(access_token: str, order_id: int, item_id: int, old_sku_id: int, new_sku_id: int, uid: Optional[int] = None) -> OrderSkuUpdateResponse async

更换订单 SKU。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
item_id int

商品 ID。

必需
old_sku_id int

原 SKU ID。

必需
new_sku_id int

新 SKU ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderSkuUpdateResponse OrderSkuUpdateResponse

SKU 更换结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.sku.update (POST) Java: OpenSellerOrderSkuUpdateRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderSkuUpdateRequest.java

verify_token(access_token: str, token: str, uid: Optional[int] = None) -> OrderTokenVerifyResponse async

核验订单 token。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
token str

待核验的订单 token。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderTokenVerifyResponse OrderTokenVerifyResponse

令牌校验结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.token.verify (GET) Java: OpenSellerOrderTokenVerifyRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderTokenVerifyRequest.java

address_update(access_token: str, order_id: int, consignee: str, mobile: str, province_code: int, province: str, city_code: int, city: str, district_code: int, district: str, address: str, town_code: Optional[int] = None, town: Optional[str] = None, is_partial_update: Optional[bool] = False, uid: Optional[int] = None) -> OrderAddressUpdateResponse async

更新订单收货地址。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
consignee str

收货人姓名。

必需
mobile str

手机号码。

必需
province_code int

省份代码。

必需
province str

省份名称。

必需
city_code int

城市代码。

必需
city str

城市名称。

必需
district_code int

区县代码。

必需
district str

区县名称。

必需
address str

详细地址。

必需
town_code Optional[int]

乡镇代码(可选)。

None
town Optional[str]

乡镇名称(可选)。

None
is_partial_update Optional[bool]

是否部分更新(可选,默认 False)。

False
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderAddressUpdateResponse OrderAddressUpdateResponse

地址更新结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.address.update (POST) Java: OpenOrderAddressUpdateRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderAddressUpdateRequest.java

address_audit_approve(access_token: str, order_id: int, uid: Optional[int] = None) -> OrderAddressAuditResponse async

审批通过地址修改。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderAddressAuditResponse OrderAddressAuditResponse

审批结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.address.audit.approve (GET) Java: OpenOrderAddressAuditApproveRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderAddressAuditApproveRequest.java

address_audit_reject(access_token: str, order_id: int, uid: Optional[int] = None) -> OrderAddressAuditResponse async

驳回地址修改申请。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderAddressAuditResponse OrderAddressAuditResponse

审批结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.address.audit.reject (GET) Java: OpenOrderAddressAuditRejectRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderAddressAuditRejectRequest.java

ks_seller_order_address_update(access_token: str, order_id: int, consignee: str, mobile: str, province_code: int, province: str, city_code: int, city: str, district_code: int, district: str, address: str, uid: Optional[int] = None) -> KsSellerOrderAddressUpdateResponse async

商家订单地址更新(KS 专用)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
consignee str

收货人姓名。

必需
mobile str

手机号码。

必需
province_code int

省份代码。

必需
province str

省份名称。

必需
city_code int

城市代码。

必需
city str

城市名称。

必需
district_code int

区域代码。

必需
district str

区域名称。

必需
address str

详细地址。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
KsSellerOrderAddressUpdateResponse KsSellerOrderAddressUpdateResponse

KS 卖家订单地址更新结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.ks.seller.order.address.update (POST) Java: OpenOrderKsSellerOrderAddressUpdateRequest(KS 专用)

decrypt_batch(access_token: str, batch_decrypt_list: List[DecryptBaseMetaInfo], uid: Optional[int] = None) -> OrderDecryptBatchResponse async

批量解密订单敏感字段。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
batch_decrypt_list List[DecryptBaseMetaInfo]

批量解密请求列表。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderDecryptBatchResponse OrderDecryptBatchResponse

批量解密结果集合。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.decrypt.batch (POST) Java: OpenOrderDecryptBatchRequest(模型对齐)

encrypt_batch(access_token: str, batch_encrypt_list: List[EncryptBaseMetaInfo], uid: Optional[int] = None) -> OrderEncryptBatchResponse async

批量加密订单敏感字段。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
batch_encrypt_list List[EncryptBaseMetaInfo]

批量加密请求列表。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderEncryptBatchResponse OrderEncryptBatchResponse

批量加密结果集合。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.encrypt.batch (POST) Java: OpenOrderEncryptBatchRequest(模型对齐)

desensitise_batch(access_token: str, batch_desensitise_list: List[DesensitiseBaseMetaInfo], uid: Optional[int] = None) -> OrderDesensitiseBatchResponse async

批量脱敏订单敏感字段。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
batch_desensitise_list List[DesensitiseBaseMetaInfo]

批量脱敏请求列表。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderDesensitiseBatchResponse OrderDesensitiseBatchResponse

批量脱敏结果集合。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.desensitise.batch (POST) Java: OpenOrderDesensitiseBatchRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderDesensitiseBatchRequest.java

search_index_batch(access_token: str, index_param_list: List[IndexParamData], uid: Optional[int] = None) -> OrderSearchIndexBatchResponse async

批量搜索订单索引。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
index_param_list List[IndexParamData]

索引参数列表(明文与类型)。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderSearchIndexBatchResponse OrderSearchIndexBatchResponse

批量索引结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.search.index.batch (POST) Java: OpenOrderSearchIndexBatchRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderSearchIndexBatchRequest.java

tag_flag(access_token: str, order_view_status: Optional[int] = None, page_size: Optional[int] = None, sort: Optional[int] = None, query_type: Optional[int] = None, begin_time: Optional[int] = None, end_time: Optional[int] = None, cps_type: Optional[int] = None, cursor: Optional[str] = None, uid: Optional[int] = None) -> OrderTagFlagResponse async

订单标签标记查询。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_view_status Optional[int]

订单查看状态(可选)。

None
page_size Optional[int]

每页数量(可选)。

None
sort Optional[int]

排序方式(可选)。

None
query_type Optional[int]

查询类型(可选)。

None
begin_time Optional[int]

开始时间戳(可选)。

None
end_time Optional[int]

结束时间戳(可选)。

None
cps_type Optional[int]

CPS 类型(可选)。

None
cursor Optional[str]

游标(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderTagFlagResponse OrderTagFlagResponse

订单列表、是否有更多、下一游标。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.tag.flag (GET) Java: OpenOrderTagFlagRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderTagFlagRequest.java

takerate_inquiry(access_token: str, order_time: int, params: Optional[Dict[str, Any]] = None, uid: Optional[int] = None) -> OrderTakerateInquiryResponse async

订单佣金费率查询。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_time int

订单时间戳(秒)。

必需
params Optional[Dict[str, Any]]

附加参数映射(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderTakerateInquiryResponse OrderTakerateInquiryResponse

佣金费率及详情。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.takerate.inquiry (GET) Java: OpenOrderTakerateInquiryRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderTakerateInquiryRequest.java

goods_split_deliver(access_token: str, main_order_id: int, delivery_item_info_list: List[SplitDeliveryGoodsPackageItemDTO], delivery_status: List[SplitDeliveryGoodsStatusRequest], uid: Optional[int] = None) -> OrderGoodsSplitDeliverResponse async

拆分发货。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
main_order_id int

主订单 ID。

必需
delivery_item_info_list List[SplitDeliveryGoodsPackageItemDTO]

包裹与订单项发货信息列表。

必需
delivery_status List[SplitDeliveryGoodsStatusRequest]

发货状态列表。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderGoodsSplitDeliverResponse OrderGoodsSplitDeliverResponse

拆分发货处理结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.goods.split.deliver (POST) Java: OpenOrderGoodsSplitDeliverRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderGoodsSplitDeliverRequest.java

list_encrypt_param_test(access_token: str, order_view_status: Optional[int] = None, page_size: Optional[int] = None, sort: Optional[int] = None, query_type: Optional[int] = None, begin_time: Optional[int] = None, end_time: Optional[int] = None, cps_type: Optional[int] = None, cursor: Optional[str] = None, uid: Optional[int] = None) -> OrderListEncryptParamTestResponse async

订单列表加密参数测试。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_view_status Optional[int]

订单查看状态(可选)。

None
page_size Optional[int]

每页数量(可选)。

None
sort Optional[int]

排序方式(可选)。

None
query_type Optional[int]

查询类型(可选)。

None
begin_time Optional[int]

开始时间戳(可选)。

None
end_time Optional[int]

结束时间戳(可选)。

None
cps_type Optional[int]

CPS 类型(可选)。

None
cursor Optional[str]

游标(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderListEncryptParamTestResponse OrderListEncryptParamTestResponse

测试响应。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.list.encrypt.param.test (GET) Java: OpenOrderListEncryptParamTestRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderListEncryptParamTestRequest.java

append_goods_logistics(access_token: str, order_id: int, express_code: int, express_no: str, uid: Optional[int] = None) -> OrderGoodsLogisticsAppendResponse async

追加包裹物流。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
express_code int

快递公司编码。

必需
express_no str

运单号。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderGoodsLogisticsAppendResponse OrderGoodsLogisticsAppendResponse

追加包裹物流的处理结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.goods.logistics.append (POST) Java: OpenSellerOrderGoodsLogisticsAppendRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderGoodsLogisticsAppendRequest.java

buyer_order_list(access_token: str, buyer_open_id: str, cursor: Optional[str] = None, limit: Optional[int] = None, order_status: Optional[List[int]] = None, order_source_type: Optional[List[int]] = None, start_time: Optional[int] = None, end_time: Optional[int] = None, uid: Optional[int] = None) -> OrderBuyerOrderListResponse async

买家订单列表。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
buyer_open_id str

买家 openId。

必需
cursor Optional[str]

游标(可选)。

None
limit Optional[int]

返回条数限制(可选)。

None
order_status Optional[List[int]]

订单状态列表(可选)。

None
order_source_type Optional[List[int]]

订单来源类型列表(可选)。

None
start_time Optional[int]

开始时间(秒级时间戳,可选)。

None
end_time Optional[int]

结束时间(秒级时间戳,可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderBuyerOrderListResponse OrderBuyerOrderListResponse

买家订单列表与分页信息。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.buyer.order.list (GET) Java: OpenOrderBuyerOrderListRequest

get_seller_detail(access_token: str, order_id: int, uid: Optional[int] = None) -> SellerOrderDetailResponse async

商家订单详情。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
SellerOrderDetailResponse SellerOrderDetailResponse

商家订单详情。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.detail (GET) Java: SellerOrderDetailRequest

seller_pcursor_list(access_token: str, begin_time: int, end_time: int, type: Optional[int] = None, current_page: Optional[int] = None, page_size: Optional[int] = None, sort: Optional[int] = None, query_type: Optional[int] = None, cps_type: Optional[int] = None, pcursor: Optional[str] = None, uid: Optional[int] = None) -> SellerOrderPcursorListResponse async

商家订单游标列表。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
begin_time int

开始时间(秒级时间戳)。

必需
end_time int

结束时间(秒级时间戳)。

必需
type Optional[int]

订单类型(可选)。

None
current_page Optional[int]

当前页码(可选)。

None
page_size Optional[int]

每页数量(可选)。

None
sort Optional[int]

排序方式(可选)。

None
query_type Optional[int]

查询类型(可选)。

None
cps_type Optional[int]

CPS 类型(可选)。

None
pcursor Optional[str]

下一页游标(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
SellerOrderPcursorListResponse SellerOrderPcursorListResponse

商家订单游标列表。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.pcursor.list (GET) Java: KsMerchantOrderListRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/KsMerchantOrderListRequest.java

query_kspay_promo_detail(access_token: str, order_id: Optional[int] = None, query_source: Optional[str] = None, buyer_open_id: Optional[str] = None, seller_open_id: Optional[str] = None, uid: Optional[int] = None) -> QueryOrderKspayPromoDetailResponse async

KS 支付订单优惠详情。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id Optional[int]

订单 ID(可选)。

None
query_source Optional[str]

查询来源(可选)。

None
buyer_open_id Optional[str]

买家 openId(可选)。

None
seller_open_id Optional[str]

卖家 openId(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
QueryOrderKspayPromoDetailResponse QueryOrderKspayPromoDetailResponse

优惠详情结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.query.order.kspay.promo.detail (GET) Java: OpenQueryOrderKspayPromoDetailRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/kwaishop_pay/OpenQueryOrderKspayPromoDetailRequest.java

get_external_order_relation(access_token: str, order_id: int, uid: Optional[int] = None) -> ExternalOrderRelationResponse async

外部订单关系。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
ExternalOrderRelationResponse ExternalOrderRelationResponse

外部订单关系数据。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.external.order.relation (GET) Java: KsMerchantExternalOrderRelationRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/KsMerchantExternalOrderRelationRequest.java

同步订单服务

kwaixiaodian.client.services.order.SyncOrderService(client: SyncBaseClient)

同步订单服务(与异步版语义一致,保留 Java 存在的 API)。

方法:

名称 描述
list

分页获取订单列表(同步)。

get

获取订单详情(同步)。

ship

发货(同步)。

update_remark

新增订单备注/旗标(同步)。

close

关闭订单(同步)。

update_logistics

更新订单物流信息(同步)。

get_fee_detail

获取订单费用明细(同步)。

update_sku

更换订单 SKU(同步)。

verify_token

核验订单 token(同步)。

address_update

更新订单收货地址(同步)。

address_audit_approve

审批通过地址修改(同步)。

address_audit_reject

驳回地址修改申请(同步)。

ks_seller_order_address_update

商家订单地址更新(KS 专用,同步)。

decrypt_batch

批量解密订单敏感字段(同步)

encrypt_batch

批量加密订单敏感字段(同步)

desensitise_batch

批量脱敏订单敏感字段(同步)。

search_index_batch

批量搜索订单索引(同步)。

tag_flag

订单标签标记查询(同步)。

takerate_inquiry

订单佣金费率查询(同步)。

goods_split_deliver

一单多包裹拆分发货(同步)

list_encrypt_param_test

订单列表加密参数测试(同步)。

append_goods_logistics

追加包裹物流(同步)。

buyer_order_list

买家订单列表(同步)。

get_seller_detail

商家订单详情(同步)。

seller_pcursor_list

商家订单游标列表(同步)。

query_kspay_promo_detail

KS 支付订单优惠详情(同步)。

get_external_order_relation

外部订单关系(同步)。

Functions

list(access_token: str, begin_time: int, end_time: int, page_size: int = 20, pcursor: Optional[str] = None, uid: Optional[int] = None) -> OrderListResponse

分页获取订单列表(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
begin_time int

开始时间(秒级时间戳)。

必需
end_time int

结束时间(秒级时间戳)。

必需
page_size int

每页数量。

20
pcursor Optional[str]

下一页游标。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderListResponse OrderListResponse

订单列表和下一页游标。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.cursor.list (GET) Java: OpenOrderCursorListRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderCursorListRequest.java

get(access_token: str, order_id: str, uid: Optional[int] = None) -> OrderGetResponse

获取订单详情(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id str

订单 ID(字符串)。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderGetResponse OrderGetResponse

订单详情。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.detail (GET) Java: OpenOrderDetailRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderDetailRequest.java

ship(access_token: str, order_id: int, express_code: int, express_no: str, return_address_id: Optional[int] = None, quality_param: Optional[str] = None, serial_number_list: Optional[List[str]] = None, imei_list: Optional[List[str]] = None, uid: Optional[int] = None) -> OrderShipResponse

发货(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
express_code int

快递公司编码。

必需
express_no str

运单号。

必需
return_address_id Optional[int]

退货地址 ID(可选)。

None
quality_param Optional[str]

质检参数(可选)。

None
serial_number_list Optional[List[str]]

序列号列表(可选)。

None
imei_list Optional[List[str]]

IMEI 列表(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderShipResponse OrderShipResponse

发货结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.goods.deliver (POST) Java: OpenSellerOrderGoodsDeliverRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderGoodsDeliverRequest.java

update_remark(access_token: str, order_id: int, note: str, staff_id: Optional[int] = None, flag: Optional[int] = None, uid: Optional[int] = None) -> OrderUpdateRemarkResponse

新增订单备注/旗标(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
note str

备注内容(最长 500 字)。

必需
staff_id Optional[int]

员工 ID(可选)。

None
flag Optional[int]

备注标记(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderUpdateRemarkResponse OrderUpdateRemarkResponse

备注/旗标更新结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.note.add (POST) Java: OpenSellerOrderNoteAddRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderNoteAddRequest.java

close(access_token: str, order_id: int, uid: Optional[int] = None) -> OrderCloseResponse

关闭订单(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderCloseResponse OrderCloseResponse

订单关闭结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.close (POST) Java: OpenSellerOrderCloseRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderCloseRequest.java

update_logistics(access_token: str, order_id: int, express_code: int, express_no: str, logistics_id: Optional[int] = None, uid: Optional[int] = None) -> OrderLogisticsUpdateResponse

更新订单物流信息(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
express_code int

快递公司编码。

必需
express_no str

运单号。

必需
logistics_id Optional[int]

物流 ID(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderLogisticsUpdateResponse OrderLogisticsUpdateResponse

物流更新结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.logistics.update (POST) Java: KsMerchantOrderLogisticsUpdateRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/KsMerchantOrderLogisticsUpdateRequest.java

get_fee_detail(access_token: str, order_id: str, uid: Optional[int] = None) -> OrderFeeDetailResponse

获取订单费用明细(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id str

订单 ID(字符串)。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderFeeDetailResponse OrderFeeDetailResponse

费用明细列表及总金额。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.fee.detail (GET) Java: OpenSellerOrderFeeDetailRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderFeeDetailRequest.java

update_sku(access_token: str, order_id: int, item_id: int, old_sku_id: int, new_sku_id: int, uid: Optional[int] = None) -> OrderSkuUpdateResponse

更换订单 SKU(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
item_id int

商品 ID。

必需
old_sku_id int

原 SKU ID。

必需
new_sku_id int

新 SKU ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderSkuUpdateResponse OrderSkuUpdateResponse

SKU 更换结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.sku.update (POST) Java: OpenSellerOrderSkuUpdateRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderSkuUpdateRequest.java

verify_token(access_token: str, token: str, uid: Optional[int] = None) -> OrderTokenVerifyResponse

核验订单 token(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
token str

待核验的订单 token。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderTokenVerifyResponse OrderTokenVerifyResponse

令牌校验结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.token.verify (GET) Java: OpenSellerOrderTokenVerifyRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderTokenVerifyRequest.java

address_update(access_token: str, order_id: int, consignee: str, mobile: str, province_code: int, province: str, city_code: int, city: str, district_code: int, district: str, address: str, town_code: Optional[int] = None, town: Optional[str] = None, is_partial_update: Optional[bool] = False, uid: Optional[int] = None) -> OrderAddressUpdateResponse

更新订单收货地址(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
consignee str

收货人姓名。

必需
mobile str

手机号码。

必需
province_code int

省份代码。

必需
province str

省份名称。

必需
city_code int

城市代码。

必需
city str

城市名称。

必需
district_code int

区县代码。

必需
district str

区县名称。

必需
address str

详细地址。

必需
town_code Optional[int]

乡镇代码(可选)。

None
town Optional[str]

乡镇名称(可选)。

None
is_partial_update Optional[bool]

是否部分更新(可选,默认 False)。

False
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderAddressUpdateResponse OrderAddressUpdateResponse

地址更新结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.address.update (POST) Java: OpenOrderAddressUpdateRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderAddressUpdateRequest.java

address_audit_approve(access_token: str, order_id: int, uid: Optional[int] = None) -> OrderAddressAuditResponse

审批通过地址修改(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderAddressAuditResponse OrderAddressAuditResponse

审批结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.address.audit.approve (GET) Java: OpenOrderAddressAuditApproveRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderAddressAuditApproveRequest.java

address_audit_reject(access_token: str, order_id: int, uid: Optional[int] = None) -> OrderAddressAuditResponse

驳回地址修改申请(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderAddressAuditResponse OrderAddressAuditResponse

审批结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.address.audit.reject (GET) Java: OpenOrderAddressAuditRejectRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderAddressAuditRejectRequest.java

ks_seller_order_address_update(access_token: str, order_id: int, consignee: str, mobile: str, province_code: int, province: str, city_code: int, city: str, district_code: int, district: str, address: str, uid: Optional[int] = None) -> KsSellerOrderAddressUpdateResponse

商家订单地址更新(KS 专用,同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
consignee str

收货人姓名。

必需
mobile str

手机号码。

必需
province_code int

省份代码。

必需
province str

省份名称。

必需
city_code int

城市代码。

必需
city str

城市名称。

必需
district_code int

区域代码。

必需
district str

区域名称。

必需
address str

详细地址。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
KsSellerOrderAddressUpdateResponse KsSellerOrderAddressUpdateResponse

KS 卖家订单地址更新结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.ks.seller.order.address.update (POST) Java: OpenOrderKsSellerOrderAddressUpdateRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderKsSellerOrderAddressUpdateRequest.java

decrypt_batch(access_token: str, batch_decrypt_list: List[DecryptBaseMetaInfo], uid: Optional[int] = None) -> OrderDecryptBatchResponse

批量解密订单敏感字段(同步)

OpenAPI: open.order.decrypt.batch (POST) Java: com.kuaishou.merchant.open.api.request.order.OpenOrderDecryptBatchRequest (java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderDecryptBatchRequest.java)

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
batch_decrypt_list List[DecryptBaseMetaInfo]

批量解密请求列表(包含 bizId 与密文)。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderDecryptBatchResponse OrderDecryptBatchResponse

批量解密结果集合。

引发:

类型 描述
KwaixiaodianAPIError

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

encrypt_batch(access_token: str, batch_encrypt_list: List[EncryptBaseMetaInfo], uid: Optional[int] = None) -> OrderEncryptBatchResponse

批量加密订单敏感字段(同步)

OpenAPI: open.order.encrypt.batch (POST) Java: com.kuaishou.merchant.open.api.request.order.OpenOrderEncryptBatchRequest (java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderEncryptBatchRequest.java)

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
batch_encrypt_list List[EncryptBaseMetaInfo]

批量加密请求列表(包含 bizId 与明文)。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderEncryptBatchResponse OrderEncryptBatchResponse

批量加密结果集合。

引发:

类型 描述
KwaixiaodianAPIError

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

desensitise_batch(access_token: str, batch_desensitise_list: List[DesensitiseBaseMetaInfo], uid: Optional[int] = None) -> OrderDesensitiseBatchResponse

批量脱敏订单敏感字段(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
batch_desensitise_list List[DesensitiseBaseMetaInfo]

批量脱敏请求列表。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderDesensitiseBatchResponse OrderDesensitiseBatchResponse

批量脱敏结果集合。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.desensitise.batch (POST) Java: OpenOrderDesensitiseBatchRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderDesensitiseBatchRequest.java

search_index_batch(access_token: str, index_param_list: List[IndexParamData], uid: Optional[int] = None) -> OrderSearchIndexBatchResponse

批量搜索订单索引(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
index_param_list List[IndexParamData]

索引参数列表(明文与类型)。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderSearchIndexBatchResponse OrderSearchIndexBatchResponse

批量索引结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.search.index.batch (POST) Java: OpenOrderSearchIndexBatchRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderSearchIndexBatchRequest.java

tag_flag(access_token: str, order_view_status: Optional[int] = None, page_size: Optional[int] = None, sort: Optional[int] = None, query_type: Optional[int] = None, begin_time: Optional[int] = None, end_time: Optional[int] = None, cps_type: Optional[int] = None, cursor: Optional[str] = None, uid: Optional[int] = None) -> OrderTagFlagResponse

订单标签标记查询(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_view_status Optional[int]

订单查看状态(可选)。

None
page_size Optional[int]

每页数量(可选)。

None
sort Optional[int]

排序方式(可选)。

None
query_type Optional[int]

查询类型(可选)。

None
begin_time Optional[int]

开始时间戳(可选)。

None
end_time Optional[int]

结束时间戳(可选)。

None
cps_type Optional[int]

CPS 类型(可选)。

None
cursor Optional[str]

游标(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderTagFlagResponse OrderTagFlagResponse

订单列表、是否有更多、下一游标。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.tag.flag (GET) Java: OpenOrderTagFlagRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderTagFlagRequest.java

takerate_inquiry(access_token: str, order_time: int, params: Optional[Dict[str, Any]] = None, uid: Optional[int] = None) -> OrderTakerateInquiryResponse

订单佣金费率查询(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_time int

订单时间戳(秒)。

必需
params Optional[Dict[str, Any]]

附加参数映射(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderTakerateInquiryResponse OrderTakerateInquiryResponse

佣金费率及详情。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.takerate.inquiry (GET) Java: OpenOrderTakerateInquiryRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderTakerateInquiryRequest.java

goods_split_deliver(access_token: str, main_order_id: int, delivery_item_info_list: List[SplitDeliveryGoodsPackageItemDTO], delivery_status: List[SplitDeliveryGoodsStatusRequest], uid: Optional[int] = None) -> OrderGoodsSplitDeliverResponse

一单多包裹拆分发货(同步)

OpenAPI: open.order.goods.split.deliver (POST) Java: com.kuaishou.merchant.open.api.request.order.OpenOrderGoodsSplitDeliverRequest (java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderGoodsSplitDeliverRequest.java)

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
main_order_id int

主订单 ID。

必需
delivery_item_info_list List[SplitDeliveryGoodsPackageItemDTO]

拆分包裹的明细列表。

必需
delivery_status List[SplitDeliveryGoodsStatusRequest]

包裹对应的发货状态集合。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderGoodsSplitDeliverResponse OrderGoodsSplitDeliverResponse

拆分发货结果。

引发:

类型 描述
KwaixiaodianAPIError

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

list_encrypt_param_test(access_token: str, order_view_status: Optional[int] = None, page_size: Optional[int] = None, sort: Optional[int] = None, query_type: Optional[int] = None, begin_time: Optional[int] = None, end_time: Optional[int] = None, cps_type: Optional[int] = None, cursor: Optional[str] = None, uid: Optional[int] = None) -> OrderListEncryptParamTestResponse

订单列表加密参数测试(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_view_status Optional[int]

订单查看状态(可选)。

None
page_size Optional[int]

每页数量(可选)。

None
sort Optional[int]

排序方式(可选)。

None
query_type Optional[int]

查询类型(可选)。

None
begin_time Optional[int]

开始时间戳(可选)。

None
end_time Optional[int]

结束时间戳(可选)。

None
cps_type Optional[int]

CPS 类型(可选)。

None
cursor Optional[str]

游标(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderListEncryptParamTestResponse OrderListEncryptParamTestResponse

测试响应。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.list.encrypt.param.test (GET) Java: OpenOrderListEncryptParamTestRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderListEncryptParamTestRequest.java

append_goods_logistics(access_token: str, order_id: int, express_code: int, express_no: str, uid: Optional[int] = None) -> OrderGoodsLogisticsAppendResponse

追加包裹物流(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
express_code int

快递公司编码。

必需
express_no str

运单号。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderGoodsLogisticsAppendResponse OrderGoodsLogisticsAppendResponse

追加包裹物流结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.goods.logistics.append (POST) Java: OpenSellerOrderGoodsLogisticsAppendRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenSellerOrderGoodsLogisticsAppendRequest.java

buyer_order_list(access_token: str, buyer_open_id: str, cursor: Optional[str] = None, limit: Optional[int] = None, order_status: Optional[List[int]] = None, order_source_type: Optional[List[int]] = None, start_time: Optional[int] = None, end_time: Optional[int] = None, uid: Optional[int] = None) -> OrderBuyerOrderListResponse

买家订单列表(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
buyer_open_id str

买家 openId。

必需
cursor Optional[str]

游标(可选)。

None
limit Optional[int]

返回条数限制(可选)。

None
order_status Optional[List[int]]

订单状态列表(可选)。

None
order_source_type Optional[List[int]]

订单来源类型列表(可选)。

None
start_time Optional[int]

开始时间(秒级时间戳,可选)。

None
end_time Optional[int]

结束时间(秒级时间戳,可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
OrderBuyerOrderListResponse OrderBuyerOrderListResponse

买家订单列表与分页信息。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.order.buyer.order.list (GET) Java: com.kuaishou.merchant.open.api.request.order.OpenOrderBuyerOrderListRequest (java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/order/OpenOrderBuyerOrderListRequest.java)

get_seller_detail(access_token: str, order_id: int, uid: Optional[int] = None) -> SellerOrderDetailResponse

商家订单详情(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
SellerOrderDetailResponse SellerOrderDetailResponse

商家订单详情。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.detail (GET) Java: com.kuaishou.merchant.open.api.request.KsMerchantOrderDetailRequest (java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/KsMerchantOrderDetailRequest.java)

seller_pcursor_list(access_token: str, begin_time: int, end_time: int, type: Optional[int] = None, current_page: Optional[int] = None, page_size: Optional[int] = None, sort: Optional[int] = None, query_type: Optional[int] = None, cps_type: Optional[int] = None, pcursor: Optional[str] = None, uid: Optional[int] = None) -> SellerOrderPcursorListResponse

商家订单游标列表(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
begin_time int

开始时间(秒级时间戳)。

必需
end_time int

结束时间(秒级时间戳)。

必需
type Optional[int]

订单类型(可选)。

None
current_page Optional[int]

当前页码(可选)。

None
page_size Optional[int]

每页数量(可选)。

None
sort Optional[int]

排序方式(可选)。

None
query_type Optional[int]

查询类型(可选)。

None
cps_type Optional[int]

CPS 类型(可选)。

None
pcursor Optional[str]

下一页游标(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
SellerOrderPcursorListResponse SellerOrderPcursorListResponse

商家订单游标列表。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.seller.order.pcursor.list (GET) Java: KsMerchantOrderListRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/KsMerchantOrderListRequest.java

query_kspay_promo_detail(access_token: str, order_id: Optional[int] = None, query_source: Optional[str] = None, buyer_open_id: Optional[str] = None, seller_open_id: Optional[str] = None, uid: Optional[int] = None) -> QueryOrderKspayPromoDetailResponse

KS 支付订单优惠详情(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id Optional[int]

订单 ID(可选)。

None
query_source Optional[str]

查询来源(可选)。

None
buyer_open_id Optional[str]

买家 openId(可选)。

None
seller_open_id Optional[str]

卖家 openId(可选)。

None
uid Optional[int]

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

None

返回:

名称 类型 描述
QueryOrderKspayPromoDetailResponse QueryOrderKspayPromoDetailResponse

优惠详情结果。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.query.order.kspay.promo.detail (GET) Java: OpenQueryOrderKspayPromoDetailRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/kwaishop_pay/OpenQueryOrderKspayPromoDetailRequest.java

get_external_order_relation(access_token: str, order_id: int, uid: Optional[int] = None) -> ExternalOrderRelationResponse

外部订单关系(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
order_id int

订单 ID。

必需
uid Optional[int]

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

None

返回:

名称 类型 描述
ExternalOrderRelationResponse ExternalOrderRelationResponse

外部订单关系数据。

引发:

类型 描述
KwaixiaodianAPIError

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

OpenAPI: open.external.order.relation (GET) Java: KsMerchantExternalOrderRelationRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/KsMerchantExternalOrderRelationRequest.java

订单数据模型

kwaixiaodian.models.order

订单相关数据模型(严格对齐 Java SDK)

类:

名称 描述
MerchantLogisticsInfoView

Java: com.kuaishou.merchant.open.api.response.view.logistics.MerchantLogisticsInfoView

MerchantOrderProductInfoView

Java: com.kuaishou.merchant.open.api.response.view.order.MerchantOrderProductInfoView

MerchantOrderInfoView

Java: com.kuaishou.merchant.open.api.response.view.order.MerchantOrderInfoView

OrderItem

订单商品信息

Order

订单信息

OrderListRequest

订单游标列表请求(open.order.cursor.list, GET)

OrderListResponse

订单列表响应

OrderGetRequest

订单详情查询请求(open.order.detail, GET)

OrderGetResponse

订单详情响应

SellerOrderDetailRequest

商家订单详情(open.seller.order.detail, GET)

SellerOrderDetailResponse

商家订单详情响应(对齐 Java MerchantOrderInfoView)

SellerOrderPcursorListRequest

商家订单游标列表(open.seller.order.pcursor.list, GET)

MerchantOrderListData

Java: KsMerchantOrderListResponse.MerchantOrderListData(字段对齐)

SellerOrderPcursorListResponse

商家订单游标列表响应(类型化)

QueryOrderKspayPromoDetailRequest

KS支付订单优惠详情(open.query.order.kspay.promo.detail, GET)

OrderBaseInfo

Java: com.kuaishou.merchant.open.api.domain.kwaishop_pay.OrderBaseInfo

OrderKspayPromoDetail

Java: com.kuaishou.merchant.open.api.domain.kwaishop_pay.OrderKspayPromoDetail

OrderKspayPromoData

Java: com.kuaishou.merchant.open.api.domain.kwaishop_pay.OrderKspayPromoData

QueryOrderKspayPromoDetailResponse

KS支付订单优惠详情响应(类型化)

ExternalOrderRelationRequest

外部订单关系查询(open.external.order.relation, GET)

ExternalJdOrderData

Java: KsMerchantExternalJdOrderData(代表性字段)

ExternalOrderRelationData

Java: KsMerchantExternalOrderRelationData(仅建模已知字段)

ExternalOrderRelationResponse

外部订单关系查询响应(类型化)

OrderShipRequest

订单发货请求

OrderShipResponse

订单发货响应

OrderUpdateRemarkRequest

新增商家订单备注请求

OrderUpdateRemarkResponse

更新订单备注响应

OrderCloseRequest

订单关闭请求

OrderCloseResponse

订单关闭响应

OrderAddressUpdateRequest

订单地址更新请求

OrderAddressUpdateResponse

订单地址更新响应

OrderAddressAuditRequest

订单地址审核请求基类

OrderAddressAuditApproveRequest

订单地址审核通过请求

OrderAddressAuditRejectRequest

订单地址审核拒绝请求

OrderAddressAuditResponse

订单地址审核响应

OrderLogisticsUpdateRequest

订单物流更新请求

OrderLogisticsUpdateResponse

订单物流更新响应

OrderGoodsLogisticsAppendRequest

追加包裹物流(open.seller.order.goods.logistics.append)

OrderGoodsLogisticsAppendResponse

追加包裹物流响应

SplitDeliveryGoodsOrderItemDTO

拆分发货订单项信息(Java: SplitDeliveryGoodsOrderItemDTO)

SplitDeliveryGoodsPackageItemDTO

拆分发货包裹项(Java: SplitDeliveryGoodsPackageItemDTO)

SplitDeliveryGoodsStatusRequest

拆分发货状态请求(Java: SplitDeliveryGoodsStatusRequest)

OrderGoodsSplitDeliverRequest

一单多包裹发货(open.order.goods.split.deliver)

OrderGoodsSplitDeliverResponse

一单多包裹发货响应

OrderBuyerOrderListRequest

买家订单列表(open.order.buyer.order.list, GET)

OrderBuyerOrderListResponse

买家订单列表响应(保持通用结构)

OrderFeeDetail

订单费用明细

OrderFeeDetailRequest

订单费用明细请求

OrderFeeDetailResponse

订单费用明细响应

OrderSkuUpdateRequest

订单SKU更新请求

OrderSkuUpdateResponse

订单SKU更新响应

OrderTokenVerifyRequest

订单令牌验证请求(对齐Java,仅需token)

OrderTokenVerifyResponse

订单令牌验证响应

DecryptBaseMetaInfo

解密基础元信息

OrderDecryptBatchRequest

订单批量解密请求

OrderDecryptBatchResponse

订单批量解密响应

EncryptBaseMetaInfo

加密基础元信息

OrderEncryptBatchRequest

订单批量加密请求

OrderEncryptBatchResponse

订单批量加密响应

DesensitiseBaseMetaInfo

脱敏基础元信息

OrderDesensitiseBatchRequest

订单批量脱敏请求

OrderDesensitiseBatchResponse

订单批量脱敏响应

KsSellerOrderAddressUpdateRequest

KS卖家订单地址更新请求

KsSellerOrderAddressUpdateResponse

KS卖家订单地址更新响应

IndexParamData

索引参数数据

OrderSearchIndexBatchRequest

订单批量搜索索引请求

OrderSearchIndexBatchResponse

订单批量搜索索引响应

OrderTagFlagRequest

订单标签标记请求

OrderTagFlagResponse

订单标签标记响应

OrderTakerateInquiryRequest

订单佣金费率查询请求

OrderTakerateInquiryResponse

订单佣金费率查询响应

OrderListEncryptParamTestRequest

订单列表加密参数测试请求

OrderListEncryptParamTestResponse

订单列表加密参数测试响应

Classes

MerchantLogisticsInfoView

Bases: BaseModel

Java: com.kuaishou.merchant.open.api.response.view.logistics.MerchantLogisticsInfoView

仅建模已在 Java 中出现的字段名,通过 alias 与 Java 对齐。

MerchantOrderProductInfoView

Bases: BaseModel

Java: com.kuaishou.merchant.open.api.response.view.order.MerchantOrderProductInfoView

精简映射(代表性字段),满足类型化校验与示例需要。

MerchantOrderInfoView

Bases: BaseModel

Java: com.kuaishou.merchant.open.api.response.view.order.MerchantOrderInfoView

精简映射(代表性字段),通过 alias 与 Java 对齐。

OrderItem

Bases: BaseModel

订单商品信息

属性:

名称 类型 描述
unit_yuan float

单价(元)

total_yuan float

总价(元)

Attributes
unit_yuan: float property

单价(元)

total_yuan: float property

总价(元)

Order

Bases: BaseModel

订单信息

属性:

名称 类型 描述
total_yuan float

订单总金额(元)

pay_yuan float

实付金额(元)

is_paid bool

是否已支付

is_delivered bool

是否已发货

Attributes
total_yuan: float property

订单总金额(元)

pay_yuan: float property

实付金额(元)

is_paid: bool property

是否已支付

is_delivered: bool property

是否已发货

OrderListRequest

Bases: BaseRequest

订单游标列表请求(open.order.cursor.list, GET)

OrderListResponse

Bases: BaseResponse[List[Order]]

订单列表响应

OrderGetRequest

Bases: BaseRequest

订单详情查询请求(open.order.detail, GET)

OrderGetResponse

Bases: BaseResponse[Order]

订单详情响应

SellerOrderDetailRequest

Bases: BaseRequest

商家订单详情(open.seller.order.detail, GET)

SellerOrderDetailResponse

Bases: BaseResponse[MerchantOrderInfoView]

商家订单详情响应(对齐 Java MerchantOrderInfoView)

SellerOrderPcursorListRequest

Bases: BaseRequest

商家订单游标列表(open.seller.order.pcursor.list, GET)

MerchantOrderListData

Bases: BaseModel

Java: KsMerchantOrderListResponse.MerchantOrderListData(字段对齐)

SellerOrderPcursorListResponse

Bases: BaseResponse[MerchantOrderListData]

商家订单游标列表响应(类型化)

QueryOrderKspayPromoDetailRequest

Bases: BaseRequest

KS支付订单优惠详情(open.query.order.kspay.promo.detail, GET)

OrderBaseInfo

Bases: BaseModel

Java: com.kuaishou.merchant.open.api.domain.kwaishop_pay.OrderBaseInfo

OrderKspayPromoDetail

Bases: BaseModel

Java: com.kuaishou.merchant.open.api.domain.kwaishop_pay.OrderKspayPromoDetail

OrderKspayPromoData

Bases: BaseModel

Java: com.kuaishou.merchant.open.api.domain.kwaishop_pay.OrderKspayPromoData

QueryOrderKspayPromoDetailResponse

Bases: BaseResponse[OrderKspayPromoData]

KS支付订单优惠详情响应(类型化)

ExternalOrderRelationRequest

Bases: BaseRequest

外部订单关系查询(open.external.order.relation, GET)

ExternalJdOrderData

Bases: BaseModel

Java: KsMerchantExternalJdOrderData(代表性字段)

ExternalOrderRelationData

Bases: BaseModel

Java: KsMerchantExternalOrderRelationData(仅建模已知字段)

ExternalOrderRelationResponse

Bases: BaseResponse[ExternalOrderRelationData]

外部订单关系查询响应(类型化)

OrderShipRequest

Bases: BaseRequest

订单发货请求

对应 Java: OpenSellerOrderGoodsDeliverRequest -> open.seller.order.goods.deliver

OrderShipResponse

Bases: BaseResponse[Dict[str, Any]]

订单发货响应

OrderUpdateRemarkRequest

Bases: BaseRequest

新增商家订单备注请求

对应 Java: OpenSellerOrderNoteAddRequest -> open.seller.order.note.add

OrderUpdateRemarkResponse

Bases: BaseResponse[Dict[str, Any]]

更新订单备注响应

OrderCloseRequest

Bases: BaseRequest

订单关闭请求

OrderCloseResponse

Bases: BaseResponse[Dict[str, Any]]

订单关闭响应

OrderAddressUpdateRequest

Bases: BaseRequest

订单地址更新请求

OrderAddressUpdateResponse

Bases: BaseResponse[Dict[str, Any]]

订单地址更新响应

OrderAddressAuditRequest

Bases: BaseRequest

订单地址审核请求基类

OrderAddressAuditApproveRequest

Bases: OrderAddressAuditRequest

订单地址审核通过请求

OrderAddressAuditRejectRequest

Bases: OrderAddressAuditRequest

订单地址审核拒绝请求

OrderAddressAuditResponse

Bases: BaseResponse[Dict[str, Any]]

订单地址审核响应

OrderLogisticsUpdateRequest

Bases: BaseRequest

订单物流更新请求

OrderLogisticsUpdateResponse

Bases: BaseResponse[Dict[str, Any]]

订单物流更新响应

OrderGoodsLogisticsAppendRequest

Bases: BaseRequest

追加包裹物流(open.seller.order.goods.logistics.append)

OrderGoodsLogisticsAppendResponse

Bases: BaseResponse[Dict[str, Any]]

追加包裹物流响应

SplitDeliveryGoodsOrderItemDTO

Bases: BaseModel

拆分发货订单项信息(Java: SplitDeliveryGoodsOrderItemDTO)

SplitDeliveryGoodsPackageItemDTO

Bases: BaseModel

拆分发货包裹项(Java: SplitDeliveryGoodsPackageItemDTO)

SplitDeliveryGoodsStatusRequest

Bases: BaseModel

拆分发货状态请求(Java: SplitDeliveryGoodsStatusRequest)

OrderGoodsSplitDeliverRequest

Bases: BaseRequest

一单多包裹发货(open.order.goods.split.deliver)

OrderGoodsSplitDeliverResponse

Bases: BaseResponse[Dict[str, Any]]

一单多包裹发货响应

OrderBuyerOrderListRequest

Bases: BaseRequest

买家订单列表(open.order.buyer.order.list, GET)

OrderBuyerOrderListResponse

Bases: BaseResponse[Dict[str, Any]]

买家订单列表响应(保持通用结构)

OrderFeeDetail

Bases: BaseModel

订单费用明细

属性:

名称 类型 描述
amount_yuan float

费用金额(元)

Attributes
amount_yuan: float property

费用金额(元)

OrderFeeDetailRequest

Bases: BaseRequest

订单费用明细请求

OrderFeeDetailResponse

Bases: BaseResponse[List[OrderFeeDetail]]

订单费用明细响应

属性:

名称 类型 描述
total_fee_yuan Optional[float]

总费用(元)

Attributes
total_fee_yuan: Optional[float] property

总费用(元)

OrderSkuUpdateRequest

Bases: BaseRequest

订单SKU更新请求

OrderSkuUpdateResponse

Bases: BaseResponse[Dict[str, Any]]

订单SKU更新响应

OrderTokenVerifyRequest

Bases: BaseRequest

订单令牌验证请求(对齐Java,仅需token)

OrderTokenVerifyResponse

Bases: BaseResponse[Dict[str, Any]]

订单令牌验证响应

DecryptBaseMetaInfo

Bases: BaseModel

解密基础元信息

OrderDecryptBatchRequest

Bases: BaseRequest

订单批量解密请求

OrderDecryptBatchResponse

Bases: BaseResponse[Dict[str, Any]]

订单批量解密响应

EncryptBaseMetaInfo

Bases: BaseModel

加密基础元信息

OrderEncryptBatchRequest

Bases: BaseRequest

订单批量加密请求

OrderEncryptBatchResponse

Bases: BaseResponse[Dict[str, Any]]

订单批量加密响应

DesensitiseBaseMetaInfo

Bases: BaseModel

脱敏基础元信息

OrderDesensitiseBatchRequest

Bases: BaseRequest

订单批量脱敏请求

OrderDesensitiseBatchResponse

Bases: BaseResponse[Dict[str, Any]]

订单批量脱敏响应

KsSellerOrderAddressUpdateRequest

Bases: BaseRequest

KS卖家订单地址更新请求

KsSellerOrderAddressUpdateResponse

Bases: BaseResponse[Dict[str, Any]]

KS卖家订单地址更新响应

IndexParamData

Bases: BaseModel

索引参数数据

OrderSearchIndexBatchRequest

Bases: BaseRequest

订单批量搜索索引请求

OrderSearchIndexBatchResponse

Bases: BaseResponse[Dict[str, Any]]

订单批量搜索索引响应

OrderTagFlagRequest

Bases: BaseRequest

订单标签标记请求

OrderTagFlagResponse

Bases: BaseResponse[Dict[str, Any]]

订单标签标记响应

OrderTakerateInquiryRequest

Bases: BaseRequest

订单佣金费率查询请求

OrderTakerateInquiryResponse

Bases: BaseResponse[Dict[str, Any]]

订单佣金费率查询响应

OrderListEncryptParamTestRequest

Bases: BaseRequest

订单列表加密参数测试请求

OrderListEncryptParamTestResponse

Bases: BaseResponse[Dict[str, Any]]

订单列表加密参数测试响应