跳转至

物流服务

快手小店物流管理API,提供全方位的物流处理功能。支持物流模板管理、快递公司查询、运费计算、物流轨迹跟踪、发货管理等核心功能,帮助商家高效管理订单物流配送。

异步物流服务

kwaixiaodian.client.services.logistics.AsyncLogisticsService(client: AsyncBaseClient)

异步物流服务。

提供地址管理、快递模板、电子面单、物流轨迹回调等能力,严格对齐 Java SDK。

初始化物流服务

参数:

名称 类型 描述 默认
client AsyncBaseClient

基础客户端实例

必需

方法:

名称 描述
template_list

获取快递模板列表。

template_create

创建快递模板。

template_update

更新快递模板(仅提供需要修改的字段)。

district_list

获取地区列表。

seller_address_create

创建商家地址。

seller_address_list

获取商家地址列表。

seller_address_get

获取商家地址详情。

seller_address_update

更新商家地址。

seller_address_delete

删除商家地址。

express_subscribe_query

查询快递订阅状态。

express_ebill_get

获取电子面单信息。

express_ebill_cancel

取消电子面单。

express_ebill_update

更新电子面单信息(仅填写需要更新的字段)。

express_ebill_append

电子面单追加包裹

express_reachable_query

查询快递可达性(open.express.reachable.query, POST)

express_standard_template_list

获取标准模板列表

express_custom_template_query

查询自定义模板列表

express_printer_element_query

查询打印元素(open.express.printer.element.query, GET)

logistics_trace_notify

物流轨迹通知回调(open.logistics.trace.notify, POST)

template_detail

获取快递模板详情

Functions

template_list(access_token: str, offset: Optional[int] = None, limit: Optional[int] = None, search_used: Optional[bool] = None) -> ExpressTemplateListResponse async

获取快递模板列表。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
offset Optional[int]

分页偏移量。

None
limit Optional[int]

返回条数。

None
search_used Optional[bool]

是否只查询使用中的模板。

None

返回:

名称 类型 描述
ExpressTemplateListResponse ExpressTemplateListResponse

模板列表。

OpenAPI
  • method: open.logistics.express.template.list
  • http: GET
Java
  • class: OpenLogisticsExpressTemplateListRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenLogisticsExpressTemplateListRequest.java
template_create(access_token: str, send_province_name: str, send_district_code: int, send_time: int, send_city_name: str, cal_type: int, name: str, source_type: int, send_province_code: int, send_city_code: int, config: str, send_district_name: str, uid: Optional[int] = None) -> ExpressTemplateAddResponse async

创建快递模板。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
send_province_name str

发货省份名称。

必需
send_district_code int

发货区县行政编码。

必需
send_time int

发货时效配置(分钟)。

必需
send_city_name str

发货城市名称。

必需
cal_type int

计费类型。

必需
name str

模板名称。

必需
source_type int

来源类型。

必需
send_province_code int

发货省份行政编码。

必需
send_city_code int

发货城市行政编码。

必需
config str

模板配置(JSON 字符串)。

必需
send_district_name str

发货区县名称。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressTemplateAddResponse ExpressTemplateAddResponse

创建结果。

OpenAPI
  • method: open.logistics.express.template.add
  • http: POST
Java
  • class: OpenLogisticsExpressTemplateAddRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenLogisticsExpressTemplateAddRequest.java
template_update(access_token: str, template_id: int, send_province_name: Optional[str] = None, send_district_code: Optional[int] = None, send_time: Optional[int] = None, send_city_name: Optional[str] = None, cal_type: Optional[int] = None, name: Optional[str] = None, source_type: Optional[int] = None, send_province_code: Optional[int] = None, send_city_code: Optional[int] = None, config: Optional[str] = None, send_district_name: Optional[str] = None, uid: Optional[int] = None) -> ExpressTemplateUpdateResponse async

更新快递模板(仅提供需要修改的字段)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
template_id int

模板 ID。

必需
send_province_name Optional[str]

发货省份名称。

None
send_district_code Optional[int]

发货区县行政编码。

None
send_time Optional[int]

发货时效配置(分钟)。

None
send_city_name Optional[str]

发货城市名称。

None
cal_type Optional[int]

计费类型。

None
name Optional[str]

模板名称。

None
source_type Optional[int]

来源类型。

None
send_province_code Optional[int]

发货省份行政编码。

None
send_city_code Optional[int]

发货城市行政编码。

None
config Optional[str]

模板配置(JSON 字符串)。

None
send_district_name Optional[str]

发货区县名称。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressTemplateUpdateResponse ExpressTemplateUpdateResponse

更新结果。

OpenAPI
  • method: open.logistics.express.template.update
  • http: POST
Java
  • class: OpenLogisticsExpressTemplateUpdateRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenLogisticsExpressTemplateUpdateRequest.java
district_list(access_token: str, district_version: Optional[str] = None, uid: Optional[int] = None) -> DistrictListResponse async

获取地区列表。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
district_version Optional[str]

地区版本(可选)。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
DistrictListResponse DistrictListResponse

地区列表。

OpenAPI
  • method: open.address.district.list
  • http: GET
Java
  • class: OpenAddressDistrictListRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressDistrictListRequest.java
seller_address_create(access_token: str, base_info: BaseAddressInfo, default_address: Optional[bool] = None, address_type: Optional[int] = None, uid: Optional[int] = None) -> SellerAddressCreateResponse async

创建商家地址。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
base_info BaseAddressInfo

地址基本信息(参考 Java BaseAddressInfo)。

必需
default_address Optional[bool]

是否设为默认地址。

None
address_type Optional[int]

地址类型(平台定义)。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
SellerAddressCreateResponse SellerAddressCreateResponse

创建结果。

OpenAPI
  • method: open.address.seller.create
  • http: GET
Java
  • class: OpenAddressSellerCreateRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressSellerCreateRequest.java
seller_address_list(access_token: str, address_type: Optional[int] = None, uid: Optional[int] = None) -> SellerAddressListResponse async

获取商家地址列表。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
address_type Optional[int]

地址类型(可选)。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
SellerAddressListResponse SellerAddressListResponse

地址列表。

OpenAPI
  • method: open.address.seller.list
  • http: GET
Java
  • class: OpenAddressSellerListRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressSellerListRequest.java
seller_address_get(access_token: str, address_id: int, uid: Optional[int] = None) -> SellerAddressGetResponse async

获取商家地址详情。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
address_id int

地址 ID。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
SellerAddressGetResponse SellerAddressGetResponse

地址详情。

OpenAPI
  • method: open.address.seller.get
  • http: GET
Java
  • class: OpenAddressSellerGetRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressSellerGetRequest.java
seller_address_update(access_token: str, address_id: int, base_info: BaseAddressInfo, default_address: Optional[bool] = None, uid: Optional[int] = None) -> SellerAddressUpdateResponse async

更新商家地址。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
address_id int

地址 ID。

必需
base_info BaseAddressInfo

地址基本信息(Java BaseAddressInfo)。

必需
default_address Optional[bool]

是否设为默认地址。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
SellerAddressUpdateResponse SellerAddressUpdateResponse

更新结果。

OpenAPI
  • method: open.address.seller.update
  • http: GET
Java
  • class: OpenAddressSellerUpdateRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressSellerUpdateRequest.java
seller_address_delete(access_token: str, address_id: int, uid: Optional[int] = None) -> SellerAddressDeleteResponse async

删除商家地址。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
address_id int

地址 ID。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
SellerAddressDeleteResponse SellerAddressDeleteResponse

删除结果。

OpenAPI
  • method: open.address.seller.delete
  • http: GET
Java
  • class: OpenAddressSellerDeleteRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressSellerDeleteRequest.java
express_subscribe_query(access_token: str, express_company_code: str, uid: Optional[int] = None) -> ExpressSubscribeQueryResponse async

查询快递订阅状态。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
express_company_code str

快递公司编码。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressSubscribeQueryResponse ExpressSubscribeQueryResponse

订阅状态结果。

OpenAPI
  • method: open.express.subscribe.query
  • http: GET/POST 以平台为准(Java SDK 为 AccessToken Request,详情见参考)。
Java
  • class: OpenExpressSubscribeQueryRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressSubscribeQueryRequest.java
express_ebill_get(access_token: str, get_ebill_order_request: List[GetEbillOrderRequest], uid: Optional[int] = None) -> ExpressEbillGetResponse async

获取电子面单信息。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
get_ebill_order_request List[GetEbillOrderRequest]

电子面单下单请求项列表。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressEbillGetResponse ExpressEbillGetResponse

面单信息列表。

OpenAPI
  • method: open.express.ebill.get
  • http: POST
Java
  • class: OpenExpressEbillGetRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressEbillGetRequest.java
express_ebill_cancel(access_token: str, express_company_code: str, waybill_code: str, uid: Optional[int] = None) -> ExpressEbillCancelResponse async

取消电子面单。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
express_company_code str

快递公司编码。

必需
waybill_code str

运单号。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressEbillCancelResponse ExpressEbillCancelResponse

取消结果。

OpenAPI
  • method: open.express.ebill.cancel
  • http: GET
Java
  • class: OpenExpressEbillCancelRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressEbillCancelRequest.java
express_ebill_update(access_token: str, goods_description: Optional[str] = None, packaging_description: Optional[str] = None, total_package_length: Optional[float] = None, item_list: Optional[List[ItemDTO]] = None, ext_data: Optional[str] = None, receiver_contract: Optional[Contract] = None, sender_contract: Optional[Contract] = None, express_company_code: Optional[str] = None, total_package_width: Optional[float] = None, total_package_weight: Optional[float] = None, trade_order_remark: Optional[str] = None, total_package_volume: Optional[float] = None, total_package_height: Optional[float] = None, receiver_address: Optional[AddressDTO] = None, waybill_code: Optional[str] = None, uid: Optional[int] = None) -> ExpressEbillUpdateResponse async

更新电子面单信息(仅填写需要更新的字段)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
goods_description Optional[str]

货品描述。

None
packaging_description Optional[str]

包装描述。

None
total_package_length Optional[float]

包裹总长(cm)。

None
item_list Optional[List[ItemDTO]]

货品列表。

None
ext_data Optional[str]

扩展数据。

None
receiver_contract Optional[Contract]

收件人信息。

None
sender_contract Optional[Contract]

寄件人信息。

None
express_company_code Optional[str]

快递公司编码。

None
total_package_width Optional[float]

包裹总宽(cm)。

None
total_package_weight Optional[float]

包裹总重(kg)。

None
trade_order_remark Optional[str]

交易备注。

None
total_package_volume Optional[float]

包裹总体积。

None
total_package_height Optional[float]

包裹总高(cm)。

None
receiver_address Optional[AddressDTO]

收件地址。

None
waybill_code Optional[str]

运单号。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressEbillUpdateResponse ExpressEbillUpdateResponse

更新结果。

OpenAPI
  • method: open.express.ebill.update
  • http: POST
Java
  • class: OpenExpressEbillUpdateRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressEbillUpdateRequest.java
express_ebill_append(access_token: str, parent_waybill_code: str, express_company_code: str, add_package_quantity: int, uid: Optional[int] = None) -> ExpressEbillAppendResponse async

电子面单追加包裹

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
parent_waybill_code str

主运单号

必需
express_company_code str

快递公司编码

必需
add_package_quantity int

追加包裹数量(>=1)

必需
uid Optional[int]

可选用户ID

None

返回:

类型 描述
ExpressEbillAppendResponse

电子面单追加包裹响应

express_reachable_query(access_token: str, reachable_requests: List[QueryRoutingReachableRequest], uid: Optional[int] = None) -> ExpressReachableQueryResponse async

查询快递可达性(open.express.reachable.query, POST)

express_standard_template_list(access_token: str, express_company_code: Optional[str] = None, uid: Optional[int] = None) -> ExpressStandardTemplateListResponse async

获取标准模板列表

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
express_company_code Optional[str]

快递公司编码

None
uid Optional[int]

可选用户ID

None

返回:

类型 描述
ExpressStandardTemplateListResponse

获取标准模板列表响应

express_custom_template_query(access_token: str, standard_template_code: Optional[str] = None, type: Optional[int] = None, uid: Optional[int] = None) -> ExpressCustomTemplateQueryResponse async

查询自定义模板列表

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
standard_template_code Optional[str]

标准模板编码

None
type Optional[int]

模板类型

None
uid Optional[int]

可选用户ID

None

返回:

类型 描述
ExpressCustomTemplateQueryResponse

查询自定义模板列表响应

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

查询打印元素(open.express.printer.element.query, GET)

logistics_trace_notify(access_token: str, traces: List[TraceNotifyDetailDTO], uid: Optional[int] = None) -> LogisticsTraceNotifyResponse async

物流轨迹通知回调(open.logistics.trace.notify, POST)

template_detail(access_token: str, template_id: int) -> ExpressTemplateDetailResponse async

获取快递模板详情

参数:

名称 类型 描述 默认
access_token str

访问令牌

必需
template_id int

模板ID

必需

返回:

类型 描述
ExpressTemplateDetailResponse

快递模板详情查询响应

同步物流服务

kwaixiaodian.client.services.logistics.SyncLogisticsService(client: SyncBaseClient)

同步物流服务(与异步版语义一致,OpenAPI 与 Java 参考相同)。

初始化物流服务

参数:

名称 类型 描述 默认
client SyncBaseClient

同步基础客户端实例

必需

方法:

名称 描述
template_list

获取快递模板列表(同步)。

template_create

创建快递模板(同步)。

template_update

更新快递模板(同步)。仅提供需要修改的字段。

district_list

获取地区列表(同步)。

seller_address_create

创建商家地址(同步)。

seller_address_list

获取商家地址列表(同步)。

seller_address_get

获取商家地址详情(同步)。

seller_address_update

更新商家地址(同步)。

seller_address_delete

删除商家地址(同步)。

express_subscribe_query

查询快递订阅状态(同步)。

express_ebill_get

获取电子面单信息(同步)。

express_ebill_cancel

取消电子面单(同步)。

express_ebill_update

更新电子面单信息(同步)。仅填写需要更新的字段。

express_ebill_append

电子面单追加包裹(同步)。

express_reachable_query

查询快递可达性(同步)。

express_standard_template_list

获取标准模板列表(同步)。

express_custom_template_query

查询自定义模板列表(同步)。

logistics_trace_notify

物流轨迹通知回调(同步)。

template_detail

获取快递模板详情(同步)。

Functions

template_list(access_token: str, offset: Optional[int] = None, limit: Optional[int] = None, search_used: Optional[bool] = None) -> ExpressTemplateListResponse

获取快递模板列表(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
offset Optional[int]

分页偏移量。

None
limit Optional[int]

返回条数。

None
search_used Optional[bool]

是否仅查询使用中的模板。

None

返回:

名称 类型 描述
ExpressTemplateListResponse ExpressTemplateListResponse

模板列表。

OpenAPI
  • method: open.logistics.express.template.list
  • http: GET
Java
  • class: OpenLogisticsExpressTemplateListRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenLogisticsExpressTemplateListRequest.java
template_create(access_token: str, send_province_name: str, send_district_code: int, send_time: int, send_city_name: str, cal_type: int, name: str, source_type: int, send_province_code: int, send_city_code: int, config: str, send_district_name: str, uid: Optional[int] = None) -> ExpressTemplateAddResponse

创建快递模板(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
send_province_name str

发货省份名称。

必需
send_district_code int

发货区县行政编码。

必需
send_time int

发货时效配置(分钟)。

必需
send_city_name str

发货城市名称。

必需
cal_type int

计费类型。

必需
name str

模板名称。

必需
source_type int

来源类型。

必需
send_province_code int

发货省份行政编码。

必需
send_city_code int

发货城市行政编码。

必需
config str

模板配置(JSON 字符串)。

必需
send_district_name str

发货区县名称。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressTemplateAddResponse ExpressTemplateAddResponse

创建结果。

OpenAPI
  • method: open.logistics.express.template.add
  • http: POST
Java
  • class: OpenLogisticsExpressTemplateAddRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenLogisticsExpressTemplateAddRequest.java
template_update(access_token: str, template_id: int, send_province_name: Optional[str] = None, send_district_code: Optional[int] = None, send_time: Optional[int] = None, send_city_name: Optional[str] = None, cal_type: Optional[int] = None, name: Optional[str] = None, source_type: Optional[int] = None, send_province_code: Optional[int] = None, send_city_code: Optional[int] = None, config: Optional[str] = None, send_district_name: Optional[str] = None, uid: Optional[int] = None) -> ExpressTemplateUpdateResponse

更新快递模板(同步)。仅提供需要修改的字段。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
template_id int

模板 ID。

必需
send_province_name Optional[str]

发货省份名称。

None
send_district_code Optional[int]

发货区县行政编码。

None
send_time Optional[int]

发货时效配置(分钟)。

None
send_city_name Optional[str]

发货城市名称。

None
cal_type Optional[int]

计费类型。

None
name Optional[str]

模板名称。

None
source_type Optional[int]

来源类型。

None
send_province_code Optional[int]

发货省份行政编码。

None
send_city_code Optional[int]

发货城市行政编码。

None
config Optional[str]

模板配置(JSON 字符串)。

None
send_district_name Optional[str]

发货区县名称。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressTemplateUpdateResponse ExpressTemplateUpdateResponse

更新结果。

OpenAPI
  • method: open.logistics.express.template.update
  • http: POST
Java
  • class: OpenLogisticsExpressTemplateUpdateRequest
  • path: java_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenLogisticsExpressTemplateUpdateRequest.java
district_list(access_token: str, district_version: Optional[str] = None, uid: Optional[int] = None) -> DistrictListResponse

获取地区列表(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
district_version Optional[str]

地区版本(可选)。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
DistrictListResponse DistrictListResponse

地区列表。

OpenAPI: open.address.district.list (GET) Java: OpenAddressDistrictListRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressDistrictListRequest.java

seller_address_create(access_token: str, base_info: BaseAddressInfo, default_address: Optional[bool] = None, address_type: Optional[int] = None, uid: Optional[int] = None) -> SellerAddressCreateResponse

创建商家地址(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
base_info BaseAddressInfo

地址基本信息(Java: BaseAddressInfo)。

必需
default_address Optional[bool]

是否设为默认地址。

None
address_type Optional[int]

地址类型(平台定义)。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
SellerAddressCreateResponse SellerAddressCreateResponse

创建结果。

OpenAPI: open.address.seller.create (GET) Java: OpenAddressSellerCreateRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressSellerCreateRequest.java

seller_address_list(access_token: str, address_type: Optional[int] = None, uid: Optional[int] = None) -> SellerAddressListResponse

获取商家地址列表(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
address_type Optional[int]

地址类型(可选)。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
SellerAddressListResponse SellerAddressListResponse

地址列表。

OpenAPI: open.address.seller.list (GET) Java: OpenAddressSellerListRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressSellerListRequest.java

seller_address_get(access_token: str, address_id: int, uid: Optional[int] = None) -> SellerAddressGetResponse

获取商家地址详情(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
address_id int

地址 ID。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
SellerAddressGetResponse SellerAddressGetResponse

地址详情。

OpenAPI: open.address.seller.get (GET) Java: OpenAddressSellerGetRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressSellerGetRequest.java

seller_address_update(access_token: str, address_id: int, base_info: BaseAddressInfo, default_address: Optional[bool] = None, uid: Optional[int] = None) -> SellerAddressUpdateResponse

更新商家地址(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
address_id int

地址 ID。

必需
base_info BaseAddressInfo

地址基本信息(Java: BaseAddressInfo)。

必需
default_address Optional[bool]

是否设为默认地址。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
SellerAddressUpdateResponse SellerAddressUpdateResponse

更新结果。

OpenAPI: open.address.seller.update (GET) Java: OpenAddressSellerUpdateRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressSellerUpdateRequest.java

seller_address_delete(access_token: str, address_id: int, uid: Optional[int] = None) -> SellerAddressDeleteResponse

删除商家地址(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
address_id int

地址 ID。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
SellerAddressDeleteResponse SellerAddressDeleteResponse

删除结果。

OpenAPI: open.address.seller.delete (GET) Java: OpenAddressSellerDeleteRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenAddressSellerDeleteRequest.java

express_subscribe_query(access_token: str, express_company_code: str, uid: Optional[int] = None) -> ExpressSubscribeQueryResponse

查询快递订阅状态(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
express_company_code str

快递公司编码。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressSubscribeQueryResponse ExpressSubscribeQueryResponse

订阅状态结果。

OpenAPI: open.express.subscribe.query Java: OpenExpressSubscribeQueryRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressSubscribeQueryRequest.java

express_ebill_get(access_token: str, get_ebill_order_request: List[GetEbillOrderRequest], uid: Optional[int] = None) -> ExpressEbillGetResponse

获取电子面单信息(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
get_ebill_order_request List[GetEbillOrderRequest]

电子面单下单请求项列表。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressEbillGetResponse ExpressEbillGetResponse

面单信息列表。

OpenAPI: open.express.ebill.get (POST) Java: OpenExpressEbillGetRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressEbillGetRequest.java

express_ebill_cancel(access_token: str, express_company_code: str, waybill_code: str, uid: Optional[int] = None) -> ExpressEbillCancelResponse

取消电子面单(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
express_company_code str

快递公司编码。

必需
waybill_code str

运单号。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressEbillCancelResponse ExpressEbillCancelResponse

取消结果。

OpenAPI: open.express.ebill.cancel (GET) Java: OpenExpressEbillCancelRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressEbillCancelRequest.java

express_ebill_update(access_token: str, goods_description: Optional[str] = None, packaging_description: Optional[str] = None, total_package_length: Optional[float] = None, item_list: Optional[List[ItemDTO]] = None, ext_data: Optional[str] = None, receiver_contract: Optional[Contract] = None, sender_contract: Optional[Contract] = None, express_company_code: Optional[str] = None, total_package_width: Optional[float] = None, total_package_weight: Optional[float] = None, trade_order_remark: Optional[str] = None, total_package_volume: Optional[float] = None, total_package_height: Optional[float] = None, receiver_address: Optional[AddressDTO] = None, waybill_code: Optional[str] = None, uid: Optional[int] = None) -> ExpressEbillUpdateResponse

更新电子面单信息(同步)。仅填写需要更新的字段。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
goods_description Optional[str]

货品描述。

None
packaging_description Optional[str]

包装描述。

None
total_package_length Optional[float]

包裹总长(cm)。

None
item_list Optional[List[ItemDTO]]

货品列表。

None
ext_data Optional[str]

扩展数据。

None
receiver_contract Optional[Contract]

收件人信息。

None
sender_contract Optional[Contract]

寄件人信息。

None
express_company_code Optional[str]

快递公司编码。

None
total_package_width Optional[float]

包裹总宽(cm)。

None
total_package_weight Optional[float]

包裹总重(kg)。

None
trade_order_remark Optional[str]

交易备注。

None
total_package_volume Optional[float]

包裹总体积。

None
total_package_height Optional[float]

包裹总高(cm)。

None
receiver_address Optional[AddressDTO]

收件地址。

None
waybill_code Optional[str]

运单号。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressEbillUpdateResponse ExpressEbillUpdateResponse

更新结果。

OpenAPI: open.express.ebill.update (POST) Java: OpenExpressEbillUpdateRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressEbillUpdateRequest.java

express_ebill_append(access_token: str, parent_waybill_code: str, express_company_code: str, add_package_quantity: int, uid: Optional[int] = None) -> ExpressEbillAppendResponse

电子面单追加包裹(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
parent_waybill_code str

主运单号。

必需
express_company_code str

快递公司编码。

必需
add_package_quantity int

追加包裹数量(>= 1)。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressEbillAppendResponse ExpressEbillAppendResponse

追加结果。

OpenAPI: open.express.ebill.append (POST) Java: OpenExpressEbillAppendRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressEbillAppendRequest.java

express_reachable_query(access_token: str, reachable_requests: List[QueryRoutingReachableRequest], uid: Optional[int] = None) -> ExpressReachableQueryResponse

查询快递可达性(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
reachable_requests List[QueryRoutingReachableRequest]

批量可达性查询请求列表。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressReachableQueryResponse ExpressReachableQueryResponse

可达性结果列表。

OpenAPI: open.express.reachable.query Java: OpenExpressReachableQueryRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressReachableQueryRequest.java

express_standard_template_list(access_token: str, express_company_code: Optional[str] = None, uid: Optional[int] = None) -> ExpressStandardTemplateListResponse

获取标准模板列表(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
express_company_code Optional[str]

快递公司编码(可选)。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressStandardTemplateListResponse ExpressStandardTemplateListResponse

标准模板列表。

OpenAPI: open.express.standard.template.list.get (POST) Java: OpenExpressStandardTemplateListGetRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressStandardTemplateListGetRequest.java

express_custom_template_query(access_token: str, standard_template_code: Optional[str] = None, type: Optional[int] = None, uid: Optional[int] = None) -> ExpressCustomTemplateQueryResponse

查询自定义模板列表(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
standard_template_code Optional[str]

标准模板编码。

None
type Optional[int]

模板类型(平台定义)。

None
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
ExpressCustomTemplateQueryResponse ExpressCustomTemplateQueryResponse

自定义模板列表。

OpenAPI: open.express.custom.tempate.list.query (GET) Java: OpenExpressCustomTempateListQueryRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/express/OpenExpressCustomTempateListQueryRequest.java

logistics_trace_notify(access_token: str, traces: List[TraceNotifyDetailDTO], uid: Optional[int] = None) -> LogisticsTraceNotifyResponse

物流轨迹通知回调(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
traces List[TraceNotifyDetailDTO]

轨迹明细列表。

必需
uid Optional[int]

可选用户 ID。

None

返回:

名称 类型 描述
LogisticsTraceNotifyResponse LogisticsTraceNotifyResponse

回调结果。

OpenAPI: open.logistics.trace.notify (POST) Java: OpenLogisticsTraceNotifyRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenLogisticsTraceNotifyRequest.java

template_detail(access_token: str, template_id: int) -> ExpressTemplateDetailResponse

获取快递模板详情(同步)。

参数:

名称 类型 描述 默认
access_token str

访问令牌。

必需
template_id int

模板 ID。

必需

返回:

名称 类型 描述
ExpressTemplateDetailResponse ExpressTemplateDetailResponse

模板详情。

OpenAPI: open.logistics.express.template.detail (GET) Java: OpenLogisticsExpressTemplateDetailRequestjava_sdk_reference/decompiled_source/com/kuaishou/merchant/open/api/request/logistics/OpenLogisticsExpressTemplateDetailRequest.java

物流数据模型

kwaixiaodian.models.logistics

物流相关数据模型(严格对齐 Java SDK)

类:

名称 描述
LogisticsCompany

物流公司信息

TrackingEvent

物流跟踪事件

TrackingInfo

物流跟踪信息

FreightRule

运费计算规则

FreightTemplate

运费模板

FreightCalculation

运费计算结果

District

地区信息

SellerAddress

商家地址信息

DistrictListRequest

地区列表查询请求(open.address.district.list, GET)

DistrictListResponse

地区列表响应

BaseAddressInfo

基础地址信息(Java: BaseAddressInfo)

SellerAddressCreateRequest

创建商家地址请求(open.address.seller.create, GET)

SellerAddressCreateResponse

创建商家地址响应

SellerAddressListRequest

商家地址列表查询请求(open.address.seller.list, GET)

SellerAddressListResponse

商家地址列表响应

SellerAddressGetRequest

商家地址详情查询请求(open.address.seller.get, GET)

SellerAddressGetResponse

商家地址详情响应

SellerAddressUpdateRequest

更新商家地址请求(open.address.seller.update, GET)

SellerAddressUpdateResponse

更新商家地址响应

SellerAddressDeleteRequest

删除商家地址请求(open.address.seller.delete, GET)

SellerAddressDeleteResponse

删除商家地址响应

ExpressSubscribeQueryRequest

查询快递订阅状态请求(open.express.subscribe.query, POST)

ExpressSubscribeQueryResponse

查询快递订阅状态响应

ExpressEbillGetRequest

获取电子面单信息请求(open.express.ebill.get, POST)

ExpressEbillGetResponse

获取电子面单信息响应

ExpressEbillCancelRequest

取消电子面单请求(open.express.ebill.cancel, POST)

ExpressEbillCancelResponse

取消电子面单响应

ExpressEbillUpdateRequest

更新电子面单信息请求(open.express.ebill.update, POST)

ExpressEbillUpdateResponse

更新电子面单信息响应

ExpressEbillAppendRequest

电子面单追加包裹请求(open.express.ebill.append, POST)

ExpressEbillAppendResponse

电子面单追加包裹响应

ExpressReachable

快递可达性信息

AddressDTO

地址数据(Java: AddressDTO)

ExpressServiceDTO

快递服务项(Java: ExpressServiceDTO)

Contract

联系人信息(Java: Contract)

ItemDTO

货品信息(Java: ItemDTO)

WarehouseDTO

仓库信息(Java: WarehouseDTO)

GetEbillOrderRequest

电子面单下单请求项(Java: GetEbillOrderRequest)

QueryRoutingReachableRequest

可达性请求项(Java: QueryRoutingReachableRequest)

ExpressReachableQueryRequest

查询快递可达性请求(open.express.reachable.query, POST)

ExpressReachableQueryResponse

查询快递可达性响应

ExpressStandardTemplate

标准快递模板(字段对齐 Java)

ExpressStandardTemplateListRequest

获取标准模板列表请求(open.express.standard.template.list.get, POST)

ExpressStandardTemplateListResponse

获取标准模板列表响应

ExpressCustomTemplate

自定义快递模板(字段对齐 Java)

ExpressCustomTemplateQueryRequest

查询自定义模板列表请求(open.express.custom.tempate.list.query, GET)

ExpressCustomTemplateQueryResponse

查询自定义模板列表响应

ExpressPrinterElementQueryRequest

打印元素查询请求(open.express.printer.element.query, GET)

ExpressPrinterElementQueryResponse

打印元素查询响应

ExtendField

扩展字段(Java: ExtendField)

TraceInfoDTO

轨迹信息(Java: TraceInfoDTO)

TraceNotifyDetailDTO

轨迹通知明细(Java: TraceNotifyDetailDTO)

LogisticsTraceNotifyRequest

物流轨迹通知回调请求(open.logistics.trace.notify, POST)

LogisticsTraceNotifyResponse

物流轨迹通知回调响应

ExpressTemplateAddParam

快递模板添加参数

ExpressTemplateAddRequest

快递模板添加请求

ExpressTemplateAddResponse

快递模板添加响应

ExpressTemplateDetailParam

快递模板详情查询参数

ExpressTemplateDetailRequest

快递模板详情查询请求

ExpressTemplateDetailResponse

快递模板详情查询响应

ExpressTemplateListParam

快递模板列表查询参数(对齐 Java: offset/limit/searchUsed)

ExpressTemplateListRequest

快递模板列表查询请求

ExpressTemplateListResponse

快递模板列表查询响应

ExpressTemplateUpdateParam

快递模板更新参数

ExpressTemplateUpdateRequest

快递模板更新请求

ExpressTemplateUpdateResponse

快递模板更新响应

Classes

LogisticsCompany

Bases: BaseModel

物流公司信息

TrackingEvent

Bases: BaseModel

物流跟踪事件

TrackingInfo

Bases: BaseModel

物流跟踪信息

FreightRule

Bases: BaseModel

运费计算规则

属性:

名称 类型 描述
first_price_yuan Optional[float]

首重价格(元)

additional_price_yuan Optional[float]

续重价格(元)

free_threshold_yuan Optional[float]

包邮门槛(元)

Attributes
first_price_yuan: Optional[float] property

首重价格(元)

additional_price_yuan: Optional[float] property

续重价格(元)

free_threshold_yuan: Optional[float] property

包邮门槛(元)

FreightTemplate

Bases: BaseModel

运费模板

FreightCalculation

Bases: BaseModel

运费计算结果

属性:

名称 类型 描述
freight_yuan float

运费(元)

Attributes
freight_yuan: float property

运费(元)

District

Bases: BaseModel

地区信息

SellerAddress

Bases: BaseModel

商家地址信息

属性:

名称 类型 描述
full_address str

完整地址

Attributes
full_address: str property

完整地址

DistrictListRequest

Bases: BaseRequest

地区列表查询请求(open.address.district.list, GET)

DistrictListResponse

Bases: BaseResponse[List[District]]

地区列表响应

BaseAddressInfo

Bases: BaseModel

基础地址信息(Java: BaseAddressInfo)

SellerAddressCreateRequest

Bases: BaseRequest

创建商家地址请求(open.address.seller.create, GET)

SellerAddressCreateResponse

Bases: BaseResponse[Dict[str, Any]]

创建商家地址响应

SellerAddressListRequest

Bases: BaseRequest

商家地址列表查询请求(open.address.seller.list, GET)

SellerAddressListResponse

Bases: BaseResponse[List[SellerAddress]]

商家地址列表响应

SellerAddressGetRequest

Bases: BaseRequest

商家地址详情查询请求(open.address.seller.get, GET)

SellerAddressGetResponse

Bases: BaseResponse[SellerAddress]

商家地址详情响应

SellerAddressUpdateRequest

Bases: BaseRequest

更新商家地址请求(open.address.seller.update, GET)

SellerAddressUpdateResponse

Bases: BaseResponse[Dict[str, Any]]

更新商家地址响应

SellerAddressDeleteRequest

Bases: BaseRequest

删除商家地址请求(open.address.seller.delete, GET)

SellerAddressDeleteResponse

Bases: BaseResponse[Dict[str, Any]]

删除商家地址响应

ExpressSubscribeQueryRequest

Bases: BaseRequest

查询快递订阅状态请求(open.express.subscribe.query, POST)

ExpressSubscribeQueryResponse

Bases: BaseResponse[Dict[str, Any]]

查询快递订阅状态响应

ExpressEbillGetRequest

Bases: BaseRequest

获取电子面单信息请求(open.express.ebill.get, POST)

ExpressEbillGetResponse

Bases: BaseResponse[Dict[str, Any]]

获取电子面单信息响应

ExpressEbillCancelRequest

Bases: BaseRequest

取消电子面单请求(open.express.ebill.cancel, POST)

ExpressEbillCancelResponse

Bases: BaseResponse[Dict[str, Any]]

取消电子面单响应

ExpressEbillUpdateRequest

Bases: BaseRequest

更新电子面单信息请求(open.express.ebill.update, POST)

ExpressEbillUpdateResponse

Bases: BaseResponse[Dict[str, Any]]

更新电子面单信息响应

ExpressEbillAppendRequest

Bases: BaseRequest

电子面单追加包裹请求(open.express.ebill.append, POST)

ExpressEbillAppendResponse

Bases: BaseResponse[Dict[str, Any]]

电子面单追加包裹响应

ExpressReachable

Bases: BaseModel

快递可达性信息

AddressDTO

Bases: BaseModel

地址数据(Java: AddressDTO)

ExpressServiceDTO

Bases: BaseModel

快递服务项(Java: ExpressServiceDTO)

Contract

Bases: BaseModel

联系人信息(Java: Contract)

ItemDTO

Bases: BaseModel

货品信息(Java: ItemDTO)

WarehouseDTO

Bases: BaseModel

仓库信息(Java: WarehouseDTO)

GetEbillOrderRequest

Bases: BaseModel

电子面单下单请求项(Java: GetEbillOrderRequest)

QueryRoutingReachableRequest

Bases: BaseModel

可达性请求项(Java: QueryRoutingReachableRequest)

ExpressReachableQueryRequest

Bases: BaseRequest

查询快递可达性请求(open.express.reachable.query, POST)

ExpressReachableQueryResponse

Bases: BaseResponse[ExpressReachable]

查询快递可达性响应

ExpressStandardTemplate

Bases: BaseModel

标准快递模板(字段对齐 Java)

ExpressStandardTemplateListRequest

Bases: BaseRequest

获取标准模板列表请求(open.express.standard.template.list.get, POST)

ExpressStandardTemplateListResponse

Bases: BaseResponse[List[ExpressStandardTemplate]]

获取标准模板列表响应

ExpressCustomTemplate

Bases: BaseModel

自定义快递模板(字段对齐 Java)

ExpressCustomTemplateQueryRequest

Bases: BaseRequest

查询自定义模板列表请求(open.express.custom.tempate.list.query, GET)

ExpressCustomTemplateQueryResponse

Bases: BaseResponse[List[ExpressCustomTemplate]]

查询自定义模板列表响应

ExpressPrinterElementQueryRequest

Bases: BaseRequest

打印元素查询请求(open.express.printer.element.query, GET)

ExpressPrinterElementQueryResponse

Bases: BaseResponse[Dict[str, Any]]

打印元素查询响应

ExtendField

Bases: BaseModel

扩展字段(Java: ExtendField)

TraceInfoDTO

Bases: BaseModel

轨迹信息(Java: TraceInfoDTO)

TraceNotifyDetailDTO

Bases: BaseModel

轨迹通知明细(Java: TraceNotifyDetailDTO)

LogisticsTraceNotifyRequest

Bases: BaseRequest

物流轨迹通知回调请求(open.logistics.trace.notify, POST)

LogisticsTraceNotifyResponse

Bases: BaseResponse[Dict[str, Any]]

物流轨迹通知回调响应

ExpressTemplateAddParam

Bases: BaseModel

快递模板添加参数

ExpressTemplateAddRequest

Bases: BaseRequest

快递模板添加请求 API: open.logistics.express.template.add (POST)

ExpressTemplateAddResponse

Bases: BaseResponse[Dict[str, Any]]

快递模板添加响应

ExpressTemplateDetailParam

Bases: BaseModel

快递模板详情查询参数

ExpressTemplateDetailRequest

Bases: BaseRequest

快递模板详情查询请求 API: open.logistics.express.template.detail (GET)

ExpressTemplateDetailResponse

Bases: BaseResponse[Dict[str, Any]]

快递模板详情查询响应

ExpressTemplateListParam

Bases: BaseModel

快递模板列表查询参数(对齐 Java: offset/limit/searchUsed)

ExpressTemplateListRequest

Bases: BaseRequest

快递模板列表查询请求 API: open.logistics.express.template.list (GET)

ExpressTemplateListResponse

Bases: BaseResponse[Dict[str, Any]]

快递模板列表查询响应

ExpressTemplateUpdateParam

Bases: BaseModel

快递模板更新参数

ExpressTemplateUpdateRequest

Bases: BaseRequest

快递模板更新请求 API: open.logistics.express.template.update (POST)

ExpressTemplateUpdateResponse

Bases: BaseResponse[Dict[str, Any]]

快递模板更新响应