开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
支付产品
私域产品
小程序产品
权限集列表
搜索关键词
搜索直达
收藏
消息
小程序码
小程序服务
订单中心
接入指南
各行业订单同步/查询详情
餐饮
零售批发
商业生活
交通出行
车主生活
教育培训
医疗卫生
酒旅景区
生活缴费
公共管理和社会组织
休闲娱乐
物流运输
网络通讯
api 列表
相关资料
小程序开发管理
生物核身
交易组件
小程序商品
支付有礼
商家粉丝群
营销产品
资金产品
会员产品
信用产品
广告产品
开发 > 服务端 > 私域产品 > 小程序产品 > 权限集列表 > 订单中心 >  >  >  > 零售到家(kx_take_out)
收藏
订阅更新
我的文档
设置
接入检测
即可查看检测结果)
若有未通过的接入检测项,接口将无法调通
商家需通过 alipay.merchant.order.sync(订单数据同步接口) 订单扩展字段 ext_info#merchant_order_status 参数更新订单状态,零售到家专用状态如下。
订单状态流转说明
零售到家.png

订单状态说明
支持跨状态传递,如:create (下单成功) 可直接跳转至 closed (已取消) 。
不要求首次同步订单状态必须为 create (下单成功) 。
订单状态发生变更后,需要及时同步最新状态。
当前场景定义的订单状态(中文和英文名)如下:
注意:不同订单状态,仅是 否发送服务消息 时,用户才能在 消息列表(支付宝凯发k8官方网娱乐官方首页服务提醒入口进入或凯发k8官方网娱乐官方首页底部消息 tab 进入)查看服务订单消息提醒。
状态中文名
状态英文名
是否为有效订单核心状态
是否发送服务消息
是否发送push
下单成功
create



待支付
wait_pay



待接单
pending



已接单
order_taken



待配送
to_be_delivered



配送中
in_delivery



已送达
delivered



已取消
closed



状态机流转
订单状态机流转如下(左侧表示起始状态,右侧表示允许的后置状态)
当前状态
允许的后置状态
create(下单成功)
in_delivery/配送中、 create/下单成功、 delivered/已送达、 pending/待接单、 to_be_delivered/待配送、 closed/已取消、 order_taken/已接单、 wait_pay/待支付
wait_pay(待支付)
in_delivery/配送中、 delivered/已送达、 pending/待接单、 to_be_delivered/待配送、 closed/已取消、 order_taken/已接单、 wait_pay/待支付
pending(待接单)
in_delivery/配送中、 delivered/已送达、 pending/待接单、 to_be_delivered/待配送、 closed/已取消、 order_taken/已接单
order_taken(已接单)
in_delivery/配送中、 delivered/已送达、 to_be_delivered/待配送、 closed/已取消、 order_taken/已接单
to_be_delivered(待配送)
in_delivery/配送中、 delivered/已送达、 to_be_delivered/待配送、 closed/已取消
in_delivery(配送中)
in_delivery/配送中、 delivered/已送达、 closed/已取消
delivered(已送达)
delivered/已送达
closed(已取消)
closed/已取消
不同状态参数使用说明
下单成功 (create)
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-下单成功 (create)时需传入的商品信息及扩展字段参数信息。
接口参数 bizcontent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
string



外部订单号。由商家自定义。
注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
string



支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-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 相同的两次同步会被幂等处理。
category_id
string



支付宝标准服务类目code。本模板支持类目code:c000003395
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  时必填。单位为元
shop_info
ordershopinfo



门店信息。详见下文 门店信息
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



订单状态,例:create
l ext_key
string



订单类型 key。固定为 merchant_biz_type
l ext_value
string



订单类型 value。本业务场景为:kx_take_out
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) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
distribution_end_time
string



字段名称:预计配送结束时间。 字段说明:时间格式为 yyyy-mm-dd hh:mm:ss。
rider_position
string



字段名称:骑手位置。 字段说明:单位为 米。-1 代表字段值无效。
distributor_information
string



配送商信息
delivery_clerk
string



配送员电话
come_again
string



字段名称:再来一单。 字段说明:小程序再来一单的链接。
delivery_start_time
string



字段名称:预计送达开始时间。
字段说明:时间格式为 yyyy-mm-dd hh:mm:ss。
isv_id
string



字段名称:服务商 id 字段说明:政策服务商额 pid
merchant_name
string



字段名称:订单归属商家名称。 字段说明:用于标识统一收银小程序订单的归属二级商户。
delivery_end_time
string



字段名称:预计送达结束时间。
字段说明:时间格式为 yyyy-mm-dd hh:mm:ss。
take_out_order_type
string



字段名称:订单类型 字段说明:订单类型。
预约单:reservation。
实时单:instant。
distribution_start_time
string



字段名称:预计配送开始时间
字段说明:时间格式为 yyyy-mm-dd hh:mm:ss。
take_out_mode
string



字段名称:配送模式。
字段说明:
no_rider_mode:非骑手模式。
rider_mode:骑手模式。
商品信息列表
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
string



商品名称。建议商品名称格式为:{商家名称} {商品名称}
quantity
number



商品数量。支持两位小数点。
注意:与 unit_price 成对出现,若传了quantity,则需要将 unit_price 传入。
unit_price
price



商品单价。精确到小数点后两位。单位为 
注意:与 quantity 成对出现,若传了 unit_price,则需要将 quantity 传入。
unit
string



字段名称:商品规格。
字段说明:份、件、斤、kg,默认为份。
ext_info
orderextinfo



商品扩展参数。该参数用于传入用户购买商品图片及商家商品详情页地址等信息。
l ext_key
string



商品图片 key。固定为 image_material_id
l ext_value
string



商品图片 value。需传入 上传商品文件 获取的 material_id
l ext_key
string



商品详情页 key。固定为 merchant_item_link_page
l ext_value
string



商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。
门店信息
若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
merchant_shop_id
string



商家侧门店 id
address
string



门店地址
shop_url
string



字段名称:门店url。 字段说明:门店的小程序链接。
alipay_shop_id
string



蚂蚁侧门店 id
name
string



门店名称
shop_phone
string



字段名称:门店凯发k8官方网娱乐官方的联系方式。 字段说明:门店的凯发k8官方网娱乐官方的联系方式。
待支付 (wait_pay)
本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-待支付(wait_pay)时需传入的商品信息及扩展字段参数信息。
接口参数 bizcontent 示例
参数说明
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
out_biz_no
string



外部订单号。由商家自定义。
注意:同一笔订单更新状态时,需与首次同步入参一致。
buyer_id(buyer_open_id)
string



支付宝用户唯一标识。新商户建议使用open_id替代该字段。对于新商户,user_id字段未来计划逐步回收,存量商户可继续使用。如使用open_id,请确认 应用-开发配置-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 相同的两次同步会被幂等处理。
category_id
string



支付宝标准服务类目code。本模板支持类目code:c000003395
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  时必填。单位为元
shop_info
ordershopinfo



门店信息。详见下文 门店信息
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。本业务场景为:kx_take_out
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) 的各项入参详情如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
distribution_end_time
string



字段名称:预计配送结束时间。 字段说明:时间格式为 yyyy-mm-dd hh:mm:ss。
rider_position
string



字段名称:骑手位置。 字段说明:单位为 米。-1 代表字段值无效。
distributor_information
string



配送商信息
delivery_clerk
string



配送员电话
come_again
string



字段名称:再来一单。 字段说明:小程序再来一单的链接。
delivery_start_time
string



字段名称:预计送达开始时间。
字段说明:时间格式为 yyyy-mm-dd hh:mm:ss。
isv_id
string



字段名称:服务商 id 字段说明:政策服务商额 pid
merchant_name
string



字段名称:订单归属商家名称。 字段说明:用于标识统一收银小程序订单的归属二级商户。
delivery_end_time
string



字段名称:预计送达结束时间。
字段说明:时间格式为 yyyy-mm-dd hh:mm:ss。
take_out_order_type
string



字段名称:订单类型 字段说明:订单类型。
预约单:reservation。
实时单:instant。
distribution_start_time
string



字段名称:预计配送开始时间
字段说明:时间格式为 yyyy-mm-dd hh:mm:ss。
take_out_mode
string



字段名称:配送模式。
字段说明:
no_rider_mode:非骑手模式。
rider_mode:骑手模式。
商品信息列表
开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:
参数
参数类型
是否必填
能否更新
是否消息使用字段
参数说明
item_name
string



商品名称。建议商品名称格式为:{商家名称} {商品名称}
quantity
number



商品数量。支持两位小数点。
注意:与 unit_price 成对出现,若传了quantity,则需要将 unit_price 传入。
unit_price
price



商品单价。精确到小数点后两位。单位为 
注意:与 quantity 成对出现,若传了 unit_price,则需要将 quantity 传入。
unit
</