订单状态流转说明
订单状态流转图
图片加载失败
订单状态说明
●支持跨状态传递,如:APPRIOVED (申请已通过) 可直接跳转至 MISSION_FAIL (任务完成失败) 。
●不要求首次同步订单状态必须为 APPRIOVED (申请已通过) 。
●订单状态发生变更后,需要及时同步最新状态。
●当前场景定义的订单状态(中文和英文名)如下:
状态中文名
状态英文名
是否发送服务消息
申请已通过
APPRIOVED
是
申请未通过
UNAPPRIOVE
是
押金待支付
WAIT_PAY
是
押金已冻结
FROZEN
是
押金已解冻
UNFROZEN
是
领养已结束
FINISHED
是
任务待完成
MISSION_TO_BE_COMPLETE
是
任务已完成
MISSION_COMPLETED
是
任务完成失败
MISSION_FAIL
是
状态机流转
订单状态机流转如下(左侧表示起始状态,右侧表示允许的后置状态)。
当前状态
允许的后置状态
APPRIOVED(申请已通过)
所有订单状态
UNAPPRIOVE(申请未通过)
所有订单状态
WAIT_PAY(押金待支付)
MISSION_TO_BE_COMPLETE/任务待完成、 WAIT_PAY/押金待支付、 FROZEN/押金已冻结、 MISSION_FAIL/任务完成失败、 MISSION_COMPLETED/任务已完成、 UNFROZEN/押金已解冻、 FINISHED/领养已结束
FROZEN(押金已冻结)
MISSION_TO_BE_COMPLETE/任务待完成、 FROZEN/押金已冻结、 MISSION_FAIL/任务完成失败、 MISSION_COMPLETED/任务已完成、 UNFROZEN/押金已解冻、 FINISHED/领养已结束
UNFROZEN(押金已解冻)
MISSION_TO_BE_COMPLETE/任务待完成、 MISSION_FAIL/任务完成失败、 MISSION_COMPLETED/任务已完成、 UNFROZEN/押金已解冻、 FINISHED/领养已结束
FINISHED(领养已结束)
MISSION_TO_BE_COMPLETE/任务待完成、 MISSION_FAIL/任务完成失败、 MISSION_COMPLETED/任务已完成、 UNFROZEN/押金已解冻、 FINISHED/领养已结束
MISSION_TO_BE_COMPLETE(任务待完成)
MISSION_TO_BE_COMPLETE/任务待完成、 WAIT_PAY/押金待支付、 FROZEN/押金已冻结、 MISSION_FAIL/任务完成失败、 MISSION_COMPLETED/任务已完成、 UNFROZEN/押金已解冻、 FINISHED/领养已结束
MISSION_COMPLETED(任务已完成)
MISSION_TO_BE_COMPLETE/任务待完成、 WAIT_PAY/押金待支付、 FROZEN/押金已冻结、 MISSION_FAIL/任务完成失败、 MISSION_COMPLETED/任务已完成、 UNFROZEN/押金已解冻、 FINISHED/领养已结束
MISSION_FAIL(任务完成失败)
MISSION_TO_BE_COMPLETE/任务待完成、 WAIT_PAY/押金待支付、 FROZEN/押金已冻结、 MISSION_FAIL/任务完成失败、 MISSION_COMPLETED/任务已完成、 UNFROZEN/押金已解冻、 FINISHED/领养已结束
申请已通过 (APPRIOVED)
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-申请已通过 (APPRIOVED)时需传入的商品信息及扩展字段参数信息。
接口参数 bizContent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
String
是
否
否
外部订单号。由商家自定义。 注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
String
是
否
否
支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 openid配置申请
。
order_type
String
是
否
否
订单类型。固定为SERVICE_ORDER(服务订单)。
order_create_time
String
是
否
是
订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-MM-dd HH:mm:ss。
order_modified_time
String
是
是
否
订单修改时间,时间格式为 yyyy-MM-dd HH:mm:ss.SSS,订单状态或内容发生变更时需要同步更新该时间。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time较晚的同步会被最终存储,order_modified_time相同的两次同步会被幂等处理。
service_code
String
否
否
否
服务code:传入小程序后台提报的服务id,将订单与服务关联。service_code 通过 alipay.open.app.service.apply(服务提报申请)接口提报服务后获取。
source_app
String
否
否
否
订单来源,默认Alipay(支付宝小程序),钉钉来源Dingtalk,其他来源枚举值定义联系支付宝订单中心添加。
trade_no
String
否
否
否
支付宝交易号。注意:若该状态传递了trade_no,则同步该订单的后续状态时都需要传递trade_no。 此字段关联支付宝账单详情卡片,建议回传真实有效交易号。
amount
Price
选填,建议传入 (当支付宝交易号trade_no或pay_amount为必传时须传入amount)
是
否
订单总金额。精确到小数点后两位,单位为元。
pay_amount
Price
选填,建议传入该参数
否
否
实际支付金额。精确到小数点后两位。单位为元。
discount_amount
Price
否
否
否
优惠金额。传入 discount_info_list 时必填。单位为元。
item_order_list
ItemOrderInfo
是
否
否
商品信息列表。详情可查看下文 商品信息列表。
ext_info
OrderExtInfo
是
是
否
订单扩展字段。详情可查看下文 订单扩展字段。
开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
L ext_key
String
是
否
否
订单状态 key。固定为 merchant_order_status。
L ext_value
String
是
是
否
订单状态, 例: APPRIOVED。
L ext_key
String
是
否
否
订单类型 key。固定为 merchant_biz_type。
L ext_value
String
是
否
否
订单类型 value。本业务场景为: PET_ADOPTION。
L ext_key
String
是
否
是
订单详情地址 key。固定为merchant_order_link_page,一笔订单同步过程中需要保持一致。
L ext_value
String
是
否
是
商户小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。
L ext_key
String
是
否
否
商家小程序 APPID key。固定为 tiny_app_id。
L ext_value
String
是
否
否
商家小程序 APPID value。传入订单归属的小程序 APPID。
L ext_key
String
是
否
否
订单业务场景相关的信息 key。固定为 business_info。
L ext_value
JSONString
是
是
否
订单业务信息详情 value。入参详情可查看下文 业务信息参数。
业务信息参数(business_info) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
end_time
String
是
否
是
字段名称:领养结束时间。 字段说明:领养结束的时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
cash
String
否
否
否
字段名称:押金金额。 字段说明:本场领养收取的押金金额。
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
String
是
否
是
商品名称。建议商品名称格式为:{商家名称}+{商品名称}。
+ ext_info
OrderExtInfo
是
否
否
商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。
L ext_key
String
是
否
否
商品图片 key。固定为 image_material_id。
L ext_value
String
是
否
否
商品图片 value。需传入 上传商品文件 获取的 material_id。
L ext_key
String
否
否
否
商品描述 key。固定为 goodsDesc。
L ext_value
String
否
否
否
商品描述 value。
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-申请未通过 (UNAPPRIOVE)时需传入的商品信息及扩展字段参数信息。
接口参数 bizContent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
String
是
否
否
外部订单号。由商家自定义。 注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
String
是
否
否
支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 openid配置申请
。
order_type
String
是
否
否
订单类型。固定为SERVICE_ORDER(服务订单)。
order_create_time
String
是
否
是
订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-MM-dd HH:mm:ss。
order_modified_time
String
是
是
否
订单修改时间,时间格式为 yyyy-MM-dd HH:mm:ss.SSS,订单状态或内容发生变更时需要同步更新该时间。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time较晚的同步会被最终存储,order_modified_time相同的两次同步会被幂等处理。
service_code
String
否
否
否
服务code:传入小程序后台提报的服务id,将订单与服务关联。service_code 通过 alipay.open.app.service.apply(服务提报申请)接口提报服务后获取。
source_app
String
否
否
否
订单来源,默认Alipay(支付宝小程序),钉钉来源Dingtalk,其他来源枚举值定义联系支付宝订单中心添加。
trade_no
String
否
否
否
支付宝交易号。注意:若该状态传递了trade_no,则同步该订单的后续状态时都需要传递trade_no。 此字段关联支付宝账单详情卡片,建议回传真实有效交易号。
amount
Price
选填,建议传入 (当支付宝交易号trade_no或pay_amount为必传时须传入amount)
是
否
订单总金额。精确到小数点后两位,单位为元。
pay_amount
Price
选填,建议传入该参数
否
否
实际支付金额。精确到小数点后两位。单位为元。
discount_amount
Price
否
否
否
优惠金额。传入 discount_info_list 时必填。单位为元。
item_order_list
ItemOrderInfo
是
否
否
商品信息列表。详情可查看下文 商品信息列表。
ext_info
OrderExtInfo
是
是
否
订单扩展字段。详情可查看下文 订单扩展字段。
开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
L ext_key
String
是
否
否
订单状态 key。固定为 merchant_order_status。
L ext_value
String
是
是
否
订单状态, 例: UNAPPRIOVE
L ext_key
String
是
否
否
订单类型 key。固定为 merchant_biz_type。
L ext_value
String
是
否
否
订单类型 value。本业务场景为: PET_ADOPTION。
L ext_key
String
是
否
是
订单详情地址 key。固定为merchant_order_link_page,一笔订单同步过程中需要保持一致。
L ext_value
String
是
否
是
商户小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。
L ext_key
String
是
否
否
商家小程序 APPID key。固定为 tiny_app_id。
L ext_value
String
是
否
否
商家小程序 APPID value。传入订单归属的小程序 APPID。
L ext_key
String
是
否
否
订单业务场景相关的信息 key。固定为 business_info。
L ext_value
JSONString
是
是
否
订单业务信息详情 value。入参详情可查看下文 业务信息参数。
业务信息参数(business_info) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
end_time
String
否
否
否
字段名称:领养结束时间。 字段说明:领养结束的时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
cash
String
否
否
否
字段名称:押金金额。 字段说明:本场领养收取的押金金额。
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
String
是
否
是
商品名称。建议商品名称格式为:{商家名称}+{商品名称}。
+ ext_info
OrderExtInfo
是
否
否
商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。
L ext_key
String
是
否
否
商品图片 key。固定为 image_material_id。
L ext_value
String
是
否
否
商品图片 value。需传入 上传商品文件 获取的 material_id。
L ext_key
String
否
否
否
商品描述 key。固定为 goodsDesc。
L ext_value
String
否
否
否
商品描述 value。
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-押金待支付 (WAIT_PAY)时需传入的商品信息及扩展字段参数信息。
接口参数 bizContent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
String
是
否
否
外部订单号。由商家自定义。 注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
String
是
否
否
支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 openid配置申请
。
order_type
String
是
否
否
订单类型。固定为SERVICE_ORDER(服务订单)。
order_create_time
String
是
否
是
订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-MM-dd HH:mm:ss。
order_modified_time
String
是
是
否
订单修改时间,时间格式为 yyyy-MM-dd HH:mm:ss.SSS,订单状态或内容发生变更时需要同步更新该时间。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time较晚的同步会被最终存储,order_modified_time相同的两次同步会被幂等处理。
service_code
String
否
否
否
服务code:传入小程序后台提报的服务id,将订单与服务关联。service_code 通过 alipay.open.app.service.apply(服务提报申请)接口提报服务后获取。
source_app
String
否
否
否
订单来源,默认Alipay(支付宝小程序),钉钉来源Dingtalk,其他来源枚举值定义联系支付宝订单中心添加。
trade_no
String
否
否
否
支付宝交易号。注意:若该状态传递了trade_no,则同步该订单的后续状态时都需要传递trade_no。 此字段关联支付宝账单详情卡片,建议回传真实有效交易号。
amount
Price
选填,建议传入 (当支付宝交易号trade_no或pay_amount为必传时须传入amount)
是
否
订单总金额。精确到小数点后两位,单位为元。
pay_amount
Price
选填,建议传入该参数
否
否
实际支付金额。精确到小数点后两位。单位为元。
discount_amount
Price
否
否
否
优惠金额。传入 discount_info_list 时必填。单位为元。
item_order_list
ItemOrderInfo
是
否
否
商品信息列表。详情可查看下文 商品信息列表。
ext_info
OrderExtInfo
是
是
否
订单扩展字段。详情可查看下文 订单扩展字段。
开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
L ext_key
String
是
否
否
订单状态 key。固定为 merchant_order_status
L ext_value
String
是
是
否
订单状态, 例: WAIT_PAY
L ext_key
String
是
否
否
订单类型 key。固定为 merchant_biz_type。
L ext_value
String
是
否
否
订单类型 value。本业务场景为: PET_ADOPTION
L ext_key
String
是
否
是
订单详情地址 key。固定为merchant_order_link_page,一笔订单同步过程中需要保持一致。
L ext_value
String
是
否
是
商户小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。
L ext_key
String
是
否
否
商家小程序 APPID key。固定为 tiny_app_id。
L ext_value
String
是
否
否
商家小程序 APPID value。传入订单归属的小程序 APPID。
L ext_key
String
是
否
否
订单业务场景相关的信息 key。固定为 business_info。
L ext_value
JSONString
是
是
否
订单业务信息详情 value。入参详情可查看下文 业务信息参数。
业务信息参数(business_info) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
due_to_time
String
否
否
否
字段名称:押金到期时间。 字段说明:押金冻结的到期时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
end_time
String
否
否
否
字段名称:领养结束时间。 字段说明:领养结束的时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
cash
String
是
否
是
字段名称:押金金额。 字段说明:本场领养收取的押金金额。
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
String
是
否
是
商品名称。建议商品名称格式为:{商家名称}+{商品名称}。
+ ext_info
OrderExtInfo
是
否
否
商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。
L ext_key
String
是
否
否
商品图片 key。固定为 image_material_id。
L ext_value
String
是
否
否
商品图片 value。需传入 上传商品文件 获取的 material_id。
L ext_key
String
否
否
否
商品描述 key。固定为 goodsDesc。
L ext_value
String
否
否
否
商品描述 value。
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-押金已冻结 (FROZEN)时需传入的商品信息及扩展字段参数信息。
接口参数 bizContent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
String
是
否
否
外部订单号。由商家自定义。 注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
String
是
否
否
支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 openid配置申请
。
order_type
String
是
否
否
订单类型。固定为SERVICE_ORDER(服务订单)。
order_create_time
String
是
否
否
订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-MM-dd HH:mm:ss。
order_modified_time
String
是
是
否
订单修改时间,时间格式为 yyyy-MM-dd HH:mm:ss.SSS,订单状态或内容发生变更时需要同步更新该时间。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time较晚的同步会被最终存储,order_modified_time相同的两次同步会被幂等处理。
service_code
String
否
否
否
服务code:传入小程序后台提报的服务id,将订单与服务关联。service_code 通过 alipay.open.app.service.apply(服务提报申请)接口提报服务后获取。
source_app
String
否
否
否
订单来源,默认Alipay(支付宝小程序),钉钉来源Dingtalk,其他来源枚举值定义联系支付宝订单中心添加。
trade_no
String
否
否
否
支付宝交易号。注意:若该状态传递了trade_no,则同步该订单的后续状态时都需要传递trade_no。 此字段关联支付宝账单详情卡片,建议回传真实有效交易号。
amount
Price
选填,建议传入 (当支付宝交易号trade_no或pay_amount为必传时须传入amount)
是
否
订单总金额。精确到小数点后两位,单位为元。
pay_amount
Price
选填,建议传入该参数
否
否
实际支付金额。精确到小数点后两位。单位为元。
discount_amount
Price
否
否
否
优惠金额。传入 discount_info_list 时必填。单位为元。
item_order_list
ItemOrderInfo
是
否
否
商品信息列表。详情可查看下文 商品信息列表。
ext_info
OrderExtInfo
是
是
否
订单扩展字段。详情可查看下文 订单扩展字段。
开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
L ext_key
String
是
否
否
订单状态 key。固定为 merchant_order_status。
L ext_value
String
是
是
否
订单状态, 例: FROZEN。
L ext_key
String
是
否
否
订单类型 key。固定为 merchant_biz_type。
L ext_value
String
是
否
否
订单类型 value。本业务场景为: PET_ADOPTION。
L ext_key
String
是
否
是
订单详情地址 key。固定为merchant_order_link_page,一笔订单同步过程中需要保持一致。
L ext_value
String
是
否
是
商户小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。
L ext_key
String
是
否
否
商家小程序 APPID key。固定为 tiny_app_id。
L ext_value
String
是
否
否
商家小程序 APPID value。传入订单归属的小程序 APPID。
L ext_key
String
是
否
否
订单业务场景相关的信息 key。固定为 business_info。
L ext_value
JSONString
是
是
否
订单业务信息详情 value。入参详情可查看下文 业务信息参数。
业务信息参数(business_info) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
due_to_time
String
是
否
是
字段名称:押金到期时间。 字段说明:押金冻结的到期时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
end_time
String
否
否
否
字段名称:领养结束时间。 字段说明:领养结束的时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
cash
String
是
否
是
字段名称:押金金额。 字段说明:本场领养收取的押金金额。
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
String
是
否
是
商品名称。建议商品名称格式为:{商家名称}+{商品名称}。
+ ext_info
OrderExtInfo
是
否
否
商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。
L ext_key
String
是
否
否
商品图片 key。固定为 image_material_id。
L ext_value
String
是
否
否
商品图片 value。需传入 上传商品文件 获取的 material_id。
L ext_key
String
否
否
否
商品描述 key。固定为 goodsDesc。
L ext_value
String
否
否
否
商品描述 value。
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-押金已解冻 (UNFROZEN)时需传入的商品信息及扩展字段参数信息。
接口参数 bizContent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
String
是
否
否
外部订单号。由商家自定义。 注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
String
是
否
否
支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 openid配置申请
。
order_type
String
是
否
否
订单类型。固定为SERVICE_ORDER(服务订单)。
order_create_time
String
是
否
否
订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-MM-dd HH:mm:ss。
order_modified_time
String
是
是
否
订单修改时间,时间格式为 yyyy-MM-dd HH:mm:ss.SSS,订单状态或内容发生变更时需要同步更新该时间。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time较晚的同步会被最终存储,order_modified_time相同的两次同步会被幂等处理。
service_code
String
否
否
否
服务code:传入小程序后台提报的服务id,将订单与服务关联。service_code 通过 alipay.open.app.service.apply(服务提报申请)接口提报服务后获取。
source_app
String
否
否
否
订单来源,默认Alipay(支付宝小程序),钉钉来源Dingtalk,其他来源枚举值定义联系支付宝订单中心添加。
trade_no
String
否
否
否
支付宝交易号。注意:若该状态传递了trade_no,则同步该订单的后续状态时都需要传递trade_no。 此字段关联支付宝账单详情卡片,建议回传真实有效交易号。
amount
Price
选填,建议传入 (当支付宝交易号trade_no或pay_amount为必传时须传入amount)
是
否
订单总金额。精确到小数点后两位,单位为元。
pay_amount
Price
选填,建议传入该参数
否
否
实际支付金额。精确到小数点后两位。单位为元。
discount_amount
Price
否
否
否
优惠金额。传入 discount_info_list 时必填。单位为元。
item_order_list
ItemOrderInfo
是
否
否
商品信息列表。详情可查看下文 商品信息列表。
ext_info
OrderExtInfo
是
是
否
订单扩展字段。详情可查看下文 订单扩展字段。
开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
L ext_key
String
是
否
否
订单状态 key。固定为 merchant_order_status。
L ext_value
String
是
是
否
订单状态, 例: UNFROZEN。
L ext_key
String
是
否
否
订单类型 key。固定为 merchant_biz_type。
L ext_value
String
是
否
否
订单类型 value。本业务场景为: PET_ADOPTION。
L ext_key
String
是
否
是
订单详情地址 key。固定为merchant_order_link_page,一笔订单同步过程中需要保持一致。
L ext_value
String
是
否
是
商户小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。
L ext_key
String
是
否
否
商家小程序 APPID key。固定为 tiny_app_id。
L ext_value
String
是
否
否
商家小程序 APPID value。传入订单归属的小程序 APPID。
L ext_key
String
是
否
否
订单业务场景相关的信息 key。固定为 business_info。
L ext_value
JSONString
是
是
否
订单业务信息详情 value。入参详情可查看下文 业务信息参数。
业务信息参数(business_info) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
due_to_time
String
是
否
是
字段名称:押金到期时间。 字段说明:押金冻结的到期时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
end_time
String
否
否
否
字段名称:领养结束时间。 字段说明:领养结束的时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
balance
String
是
否
是
字段名称:剩余押金金额。 字段说明:剩下的押金金额。
thaw_amount
String
是
否
是
字段名称:押金解冻金额。 字段说明:解冻金额。
cash
String
否
否
否
字段名称:押金金额。 字段说明:本场领养收取的押金金额。
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
String
是
否
是
商品名称。建议商品名称格式为:{商家名称}+{商品名称}
+ ext_info
OrderExtInfo
是
否
否
商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。
L ext_key
String
是
否
否
商品图片 key。固定为 image_material_id。
L ext_value
String
是
否
否
商品图片 value。需传入 上传商品文件 获取的 material_id。
L ext_key
String
否
否
否
商品描述 key。固定为 goodsDesc。
L ext_value
String
否
否
否
商品描述 value。
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-领养已结束 (FINISHED)时需传入的商品信息及扩展字段参数信息。
接口参数 bizContent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
String
是
否
否
外部订单号。由商家自定义。 注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
String
是
否
否
支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 openid配置申请
。
order_type
String
是
否
否
订单类型。固定为SERVICE_ORDER(服务订单)。
order_create_time
String
是
否
是
订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-MM-dd HH:mm:ss。
order_modified_time
String
是
是
否
订单修改时间,时间格式为 yyyy-MM-dd HH:mm:ss.SSS,订单状态或内容发生变更时需要同步更新该时间。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time较晚的同步会被最终存储,order_modified_time相同的两次同步会被幂等处理。
service_code
String
否
否
否
服务code:传入小程序后台提报的服务id,将订单与服务关联。service_code 通过 alipay.open.app.service.apply(服务提报申请)接口提报服务后获取。
source_app
String
否
否
否
订单来源,默认Alipay(支付宝小程序),钉钉来源Dingtalk,其他来源枚举值定义联系支付宝订单中心添加。
trade_no
String
否
否
否
支付宝交易号。注意:若该状态传递了trade_no,则同步该订单的后续状态时都需要传递trade_no。 此字段关联支付宝账单详情卡片,建议回传真实有效交易号。
amount
Price
选填,建议传入 (当支付宝交易号trade_no或pay_amount为必传时须传入amount)
是
否
订单总金额。精确到小数点后两位,单位为元。
pay_amount
Price
选填,建议传入该参数
否
否
实际支付金额。精确到小数点后两位。单位为元。
discount_amount
Price
否
否
否
优惠金额。传入 discount_info_list 时必填。单位为元。
item_order_list
ItemOrderInfo
是
否
否
商品信息列表。详情可查看下文 商品信息列表。
ext_info
OrderExtInfo
是
是
否
订单扩展字段。详情可查看下文 订单扩展字段。
开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
L ext_key
String
是
否
否
订单状态 key。固定为 merchant_order_status。
L ext_value
String
是
是
否
订单状态, 例: FINISHED。
L ext_key
String
是
否
否
订单类型 key。固定为 merchant_biz_type。
L ext_value
String
是
否
否
订单类型 value。本业务场景为: PET_ADOPTION
L ext_key
String
是
否
是
订单详情地址 key。固定为merchant_order_link_page,一笔订单同步过程中需要保持一致。
L ext_value
String
是
否
是
商户小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。
L ext_key
String
是
否
否
商家小程序 APPID key。固定为 tiny_app_id。
L ext_value
String
是
否
否
商家小程序 APPID value。传入订单归属的小程序 APPID。
L ext_key
String
是
否
否
订单业务场景相关的信息 key。固定为 business_info。
L ext_value
JSONString
是
是
否
订单业务信息详情 value。入参详情可查看下文 业务信息参数。
业务信息参数(business_info) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
due_to_time
String
否
否
否
字段名称:押金到期时间。 字段说明:押金冻结的到期时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
end_time
String
是
否
是
字段名称:领养结束时间。 字段说明:领养结束的时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
cash
String
否
否
否
字段名称:押金金额。 字段说明:本场领养收取的押金金额。
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
String
是
否
是
商品名称。建议商品名称格式为:{商家名称}+{商品名称}。
+ ext_info
OrderExtInfo
是
否
否
商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。
L ext_key
String
是
否
否
商品图片 key。固定为 image_material_id。
L ext_value
String
是
否
否
商品图片 value。需传入 上传商品文件 获取的 material_id。
L ext_key
String
否
否
否
商品描述 key。固定为 goodsDesc。
L ext_value
String
否
否
否
商品描述 value。
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-任务待完成 (MISSION_TO_BE_COMPLETE)时需传入的商品信息及扩展字段参数信息。
接口参数 bizContent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
String
是
否
否
外部订单号。由商家自定义。 注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
String
是
否
否
支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 openid配置申请
。
order_type
String
是
否
否
订单类型。固定为SERVICE_ORDER(服务订单)。
order_create_time
String
是
否
是
订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-MM-dd HH:mm:ss。
order_modified_time
String
是
是
否
订单修改时间,时间格式为 yyyy-MM-dd HH:mm:ss.SSS,订单状态或内容发生变更时需要同步更新该时间。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time较晚的同步会被最终存储,order_modified_time相同的两次同步会被幂等处理。
service_code
String
否
否
否
服务code:传入小程序后台提报的服务id,将订单与服务关联。service_code 通过 alipay.open.app.service.apply(服务提报申请)接口提报服务后获取。
source_app
String
否
否
否
订单来源,默认Alipay(支付宝小程序),钉钉来源Dingtalk,其他来源枚举值定义联系支付宝订单中心添加。
trade_no
String
否
否
否
支付宝交易号。注意:若该状态传递了trade_no,则同步该订单的后续状态时都需要传递trade_no。 此字段关联支付宝账单详情卡片,建议回传真实有效交易号。
amount
Price
选填,建议传入 (当支付宝交易号trade_no或pay_amount为必传时须传入amount)
是
否
订单总金额。精确到小数点后两位,单位为元。
pay_amount
Price
选填,建议传入该参数
否
否
实际支付金额。精确到小数点后两位。单位为元。
discount_amount
Price
否
否
否
优惠金额。传入 discount_info_list 时必填。单位为元。
item_order_list
ItemOrderInfo
是
否
否
商品信息列表。详情可查看下文 商品信息列表。
ext_info
OrderExtInfo
是
是
否
订单扩展字段。详情可查看下文 订单扩展字段。
开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
L ext_key
String
是
否
否
订单状态 key。固定为 merchant_order_status
L ext_value
String
是
是
否
订单状态, 例: MISSION_TO_BE_COMPLETE
L ext_key
String
是
否
否
订单类型 key。固定为 merchant_biz_type。
L ext_value
String
是
否
否
订单类型 value。本业务场景为: PET_ADOPTION
L ext_key
String
是
否
是
订单详情地址 key。固定为merchant_order_link_page,一笔订单同步过程中需要保持一致。
L ext_value
String
是
否
是
商户小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。
L ext_key
String
是
否
否
商家小程序 APPID key。固定为 tiny_app_id。
L ext_value
String
是
否
否
商家小程序 APPID value。传入订单归属的小程序 APPID。
L ext_key
String
是
否
否
订单业务场景相关的信息 key。固定为 business_info。
L ext_value
JSONString
是
是
否
订单业务信息详情 value。入参详情可查看下文 业务信息参数。
业务信息参数(business_info) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
due_to_time
String
否
否
否
字段名称:押金到期时间。 字段说明:押金冻结的到期时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
end_time
String
否
否
是
字段名称:领养结束时间。 字段说明:领养结束的时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
balance
String
否
否
否
字段名称:剩余押金金额。 字段说明:剩下的押金金额。
thaw_amount
String
否
否
否
字段名称:押金解冻金额。 字段说明:解冻金额。
cash
String
否
否
否
字段名称:押金金额。 字段说明:本场领养收取的押金金额。
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
String
是
否
是
商品名称。建议商品名称格式为:{商家名称}+{商品名称}。
+ ext_info
OrderExtInfo
是
否
否
商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。
L ext_key
String
是
否
否
商品图片 key。固定为 image_material_id。
L ext_value
String
是
否
否
商品图片 value。需传入 上传商品文件 获取的 material_id。
L ext_key
String
否
否
否
商品描述 key。固定为 goodsDesc。
L ext_value
String
否
否
否
商品描述 value。
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-任务已完成 (MISSION_COMPLETED)时需传入的商品信息及扩展字段参数信息。
接口参数 bizContent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
String
是
否
否
外部订单号。由商家自定义。 注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
String
是
否
否
支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 openid配置申请
。
order_type
String
是
否
否
订单类型。固定为SERVICE_ORDER(服务订单)。
order_create_time
String
是
否
是
订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-MM-dd HH:mm:ss。
order_modified_time
String
是
是
否
订单修改时间,时间格式为 yyyy-MM-dd HH:mm:ss.SSS,订单状态或内容发生变更时需要同步更新该时间。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time较晚的同步会被最终存储,order_modified_time相同的两次同步会被幂等处理。
service_code
String
否
否
否
服务code:传入小程序后台提报的服务id,将订单与服务关联。service_code 通过 alipay.open.app.service.apply(服务提报申请)接口提报服务后获取。
source_app
String
否
否
否
订单来源,默认Alipay(支付宝小程序),钉钉来源Dingtalk,其他来源枚举值定义联系支付宝订单中心添加。
trade_no
String
否
否
否
支付宝交易号。注意:若该状态传递了trade_no,则同步该订单的后续状态时都需要传递trade_no。 此字段关联支付宝账单详情卡片,建议回传真实有效交易号。
amount
Price
选填,建议传入 (当支付宝交易号trade_no或pay_amount为必传时须传入amount)
是
否
订单总金额。精确到小数点后两位,单位为元。
pay_amount
Price
选填,建议传入该参数
否
否
实际支付金额。精确到小数点后两位。单位为元。
discount_amount
Price
否
否
否
优惠金额。传入 discount_info_list 时必填。单位为元。
item_order_list
ItemOrderInfo
是
否
否
商品信息列表。详情可查看下文 商品信息列表。
ext_info
OrderExtInfo
是
是
否
订单扩展字段。详情可查看下文 订单扩展字段。
开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
L ext_key
String
是
否
否
订单状态 key。固定为 merchant_order_status。
L ext_value
String
是
是
否
订单状态, 例: MISSION_COMPLETED。
L ext_key
String
是
否
否
订单类型 key。固定为 merchant_biz_type。
L ext_value
String
是
否
否
订单类型 value。本业务场景为: PET_ADOPTION。
L ext_key
String
是
否
是
订单详情地址 key。固定为merchant_order_link_page,一笔订单同步过程中需要保持一致。
L ext_value
String
是
否
是
商户小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。
L ext_key
String
是
否
否
商家小程序 APPID key。固定为 tiny_app_id。
L ext_value
String
是
否
否
商家小程序 APPID value。传入订单归属的小程序 APPID。
L ext_key
String
是
否
否
订单业务场景相关的信息 key。固定为 business_info。
L ext_value
JSONString
是
是
否
订单业务信息详情 value。入参详情可查看下文 业务信息参数。
业务信息参数(business_info) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
due_to_time
String
否
否
否
字段名称:押金到期时间。 字段说明:押金冻结的到期时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
end_time
String
否
否
是
字段名称:领养结束时间。 字段说明:领养结束的时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
balance
String
否
否
否
字段名称:剩余押金金额。 字段说明:剩下的押金金额。
thaw_amount
String
否
否
否
字段名称:押金解冻金额。 字段说明:解冻金额。
cash
String
否
否
否
字段名称:押金金额。 字段说明:本场领养收取的押金金额。
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
String
是
否
是
商品名称。建议商品名称格式为:{商家名称}+{商品名称}。
+ ext_info
OrderExtInfo
是
否
否
商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。
L ext_key
String
是
否
否
商品图片 key。固定为 image_material_id。
L ext_value
String
是
否
否
商品图片 value。需传入 上传商品文件 获取的 material_id。
L ext_key
String
否
否
否
商品描述 key。固定为 goodsDesc。
L ext_value
String
否
否
否
商品描述 value。
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-任务完成失败 (MISSION_FAIL)时需传入的商品信息及扩展字段参数信息。
接口参数 bizContent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
String
是
否
否
外部订单号。由商家自定义。 注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
String
是
否
否
支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-openid配置管理 已启用。无该配置项,可查看 openid配置申请
。
order_type
String
是
否
否
订单类型。固定为SERVICE_ORDER(服务订单)。
order_create_time
String
是
否
是
订单创建时间,即该笔订单真实的创建时间。时间格式为 yyyy-MM-dd HH:mm:ss。
order_modified_time
String
是
是
否
订单修改时间,时间格式为 yyyy-MM-dd HH:mm:ss.SSS,订单状态或内容发生变更时需要同步更新该时间。用于订单状态或数据变化较快的顺序控制,防止乱序。order_modified_time较晚的同步会被最终存储,order_modified_time相同的两次同步会被幂等处理。
service_code
String
否
否
否
服务code:传入小程序后台提报的服务id,将订单与服务关联。service_code 通过 alipay.open.app.service.apply(服务提报申请)接口提报服务后获取。
source_app
String
否
否
否
订单来源,默认Alipay(支付宝小程序),钉钉来源Dingtalk,其他来源枚举值定义联系支付宝订单中心添加。
trade_no
String
否
否
否
支付宝交易号。注意:若该状态传递了trade_no,则同步该订单的后续状态时都需要传递trade_no。 此字段关联支付宝账单详情卡片,建议回传真实有效交易号。
amount
Price
选填,建议传入 (当支付宝交易号trade_no或pay_amount为必传时须传入amount)
是
否
订单总金额。精确到小数点后两位,单位为元。
pay_amount
Price
选填,建议传入该参数
否
否
实际支付金额。精确到小数点后两位。单位为元。
discount_amount
Price
否
否
否
优惠金额。传入 discount_info_list 时必填。单位为元。
item_order_list
ItemOrderInfo
是
否
否
商品信息列表。详情可查看下文 商品信息列表。
ext_info
OrderExtInfo
是
是
否
订单扩展字段。详情可查看下文 订单扩展字段。
开发者需通过订单扩展字段(ext_info)更新订单状态,订单业务信息,订单类型等数据,入参为 ext_key(对应参数的key)、ext_value(对应参数的value) 配合使用。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
L ext_key
String
是
否
否
订单状态 key。固定为 merchant_order_status。
L ext_value
String
是
是
否
订单状态, 例: MISSION_FAIL。
L ext_key
String
是
否
否
订单类型 key。固定为 merchant_biz_type。
L ext_value
String
是
否
否
订单类型 value。本业务场景为: PET_ADOPTION。
L ext_key
String
是
否
是
订单详情地址 key。固定为merchant_order_link_page,一笔订单同步过程中需要保持一致。
L ext_value
String
是
否
是
商户小程序对应的订单详情页路径地址 value。仅需传入小程序页面路径即可。
L ext_key
String
是
否
否
商家小程序 APPID key。固定为 tiny_app_id。
L ext_value
String
是
否
否
商家小程序 APPID value。传入订单归属的小程序 APPID。
L ext_key
String
是
否
否
订单业务场景相关的信息 key。固定为 business_info。
L ext_value
JSONString
是
是
否
订单业务信息详情 value。入参详情可查看下文 业务信息参数。
业务信息参数(business_info) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
due_to_time
String
否
否
否
字段名称:押金到期时间。 字段说明:押金冻结的到期时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
end_time
String
否
否
是
字段名称:领养结束时间。 字段说明:领养结束的时间点,时间格式为 yyyy-MM-dd HH:mm:ss。
balance
String
否
否
否
字段名称:剩余押金金额。 字段说明:剩下的押金金额。
thaw_amount
String
否
否
否
字段名称:押金解冻金额。 字段说明:解冻金额。
cash
String
否
否
否
字段名称:押金金额。 字段说明:本场领养收取的押金金额。
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
String
是
否
是
商品名称。建议商品名称格式为:{商家名称}+{商品名称}。
+ ext_info
OrderExtInfo
是
否
否
商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。
L ext_key
String
是
否
否
商品图片 key。固定为 image_material_id。
L ext_value
String
是
否
否
商品图片 value。需传入 上传商品文件 获取的 material_id。
L ext_key
String
否
否
否
商品描述 key。固定为 goodsDesc。
L ext_value
String
否
否
否
商品描述 value。