开发者社区
社区提问意见反馈
开发者钉组织
扫描二维码
加入支付宝开发者钉组织
文档中心
开发文档(v3版) 
支付
私域
小程序产品
权限集列表
搜索关键词
搜索直达
收藏
消息
小程序码
小程序服务
订单中心
接入指南
各行业订单同步/查询详情
餐饮
零售批发
商业生活
交通出行
车主生活
教育培训
医疗卫生
酒旅景区
生活缴费
公共管理和社会组织
休闲娱乐
物流运输
网络通讯
api 列表
相关资料
小程序开发管理
生物核身
交易组件
小程序商品
支付有礼
小游戏
公域
营销
资金
会员
信用
安全
广告
小程序云
其他
api文档 > 私域 > 小程序产品 > 权限集列表 > 订单中心 >  > 各行业订单同步/查询详情 >  > 电商实物商品购买(kx_shopping)
收藏
订阅更新
我的文档
设置

商家需通过 alipay.merchant.order.sync(订单数据同步接口) 订单扩展字段 ext_info#merchant_order_status 参数更新订单状态,具体状态说明如下。

电商实物商品购买(kx_shopping).png

订单状态说明

  • 支持跨状态传递,如:create (创单成功) 可直接跳转至 signed (已签收) 。
  • 不要求首次同步订单状态必须为 create (创单成功) 。
  • 订单状态发生变更后,需要及时同步最新状态。
  • 当前场景定义的订单状态(中文和英文名)如下:

状态中文名

状态英文名

是否为有效订单核心状态

是否发送服务消息

是否发送push

创单成功

create

待支付

wait_pay

已关闭

closed

退款中

refunding

已退款

refunded

已完成

finished

支付完成

paid

已发货

in_delivery

部分退款

refund_part

部分退货

return_part

待发货

to_send_goods

部分发货

partial_delivery

已签收

signed

","id":"tn0ke","rows":14,"cols":5}" id="tn0ke">

状态中文名

状态英文名

是否为有效订单核心状态

是否发送服务消息

是否发送push

创单成功

create

待支付

wait_pay

已关闭

closed

退款中

refunding

已退款

refunded

已完成

finished

支付完成

paid

已发货

in_delivery

部分退款

refund_part

部分退货

return_part

待发货

to_send_goods

部分发货

partial_delivery

已签收

signed

注意:不同订单状态,仅 是否发送服务消息 时,用户才能在消息列表(支付宝凯发k8官方网娱乐官方首页服务提醒入口进入或凯发k8官方网娱乐官方首页底部消息tab进入)查看服务订单消息提醒。

状态机流转

订单状态机流转如下(左侧表示起始状态,右侧表示允许的后置状态)

当前状态

允许的后置状态

create(创单成功)

closed/已关闭、 to_send_goods/待发货、 return_part/部分退货、 create/创单成功、 wait_pay/待支付、 refund_part/部分退款、 partial_delivery/部分发货、 finished/已完成、 in_delivery/已发货、 refunded/已退款、 paid/支付完成、 signed/已签收、 refunding/退款中

wait_pay(待支付)

closed/已关闭、 to_send_goods/待发货、 return_part/部分退货、 create/创单成功、 wait_pay/待支付、 refund_part/部分退款、 partial_delivery/部分发货、 finished/已完成、 in_delivery/已发货、 refunded/已退款、 paid/支付完成、 signed/已签收、 refunding/退款中

closed(已关闭)

closed/已关闭、 finished/已完成、 refunded/已退款、 refunding/退款中

refunding(退款中)

closed/已关闭、 refund_part/部分退款、 finished/已完成、 refunded/已退款、 return_part/部分退货、 refunding/退款中

refunded(已退款)

closed/已关闭、 finished/已完成、 refunded/已退款

finished(已完成)

closed/已关闭、 refund_part/部分退款、 finished/已完成、 refunded/已退款

paid(支付完成)

refund_part/部分退款、 to_send_goods/待发货、 in_delivery/已发货、 partial_delivery/部分发货、 finished/已完成、 refunded/已退款、 paid/支付完成、 return_part/部分退货、 signed/已签收、 refunding/退款中

in_delivery(已发货)

refund_part/部分退款、 in_delivery/已发货、 finished/已完成、 refunded/已退款、 return_part/部分退货、 signed/已签收、 refunding/退款中

refund_part(部分退款)

refund_part/部分退款、 finished/已完成、 refunded/已退款、 return_part/部分退货

return_part(部分退货)

refund_part/部分退款、 finished/已完成、 refunded/已退款、 return_part/部分退货

to_send_goods(待发货)

refund_part/部分退款、 to_send_goods/待发货、 in_delivery/已发货、 partial_delivery/部分发货、 finished/已完成、 refunded/已退款、 paid/支付完成、 return_part/部分退货、 signed/已签收、 refunding/退款中

partial_delivery(部分发货)

refund_part/部分退款、 to_send_goods/待发货、 partial_delivery/部分发货、 in_delivery/已发货、 finished/已完成、 refunded/已退款、 paid/支付完成、 return_part/部分退货、 signed/已签收、 refunding/退款中

signed(已签收)

refund_part/部分退款、 finished/已完成、 refunded/已退款、 return_part/部分退货、 signed/已签收

","id":"ktlon","rows":14,"cols":2}" id="ktlon">

当前状态

允许的后置状态

create(创单成功)

closed/已关闭、 to_send_goods/待发货、 return_part/部分退货、 create/创单成功、 wait_pay/待支付、 refund_part/部分退款、 partial_delivery/部分发货、 finished/已完成、 in_delivery/已发货、 refunded/已退款、 paid/支付完成、 signed/已签收、 refunding/退款中

wait_pay(待支付)

closed/已关闭、 to_send_goods/待发货、 return_part/部分退货、 create/创单成功、 wait_pay/待支付、 refund_part/部分退款、 partial_delivery/部分发货、 finished/已完成、 in_delivery/已发货、 refunded/已退款、 paid/支付完成、 signed/已签收、 refunding/退款中

closed(已关闭)

closed/已关闭、 finished/已完成、 refunded/已退款、 refunding/退款中

refunding(退款中)

closed/已关闭、 refund_part/部分退款、 finished/已完成、 refunded/已退款、 return_part/部分退货、 refunding/退款中

refunded(已退款)

closed/已关闭、 finished/已完成、 refunded/已退款

finished(已完成)

closed/已关闭、 refund_part/部分退款、 finished/已完成、 refunded/已退款

paid(支付完成)

refund_part/部分退款、 to_send_goods/待发货、 in_delivery/已发货、 partial_delivery/部分发货、 finished/已完成、 refunded/已退款、 paid/支付完成、 return_part/部分退货、 signed/已签收、 refunding/退款中

in_delivery(已发货)

refund_part/部分退款、 in_delivery/已发货、 finished/已完成、 refunded/已退款、 return_part/部分退货、 signed/已签收、 refunding/退款中

refund_part(部分退款)

refund_part/部分退款、 finished/已完成、 refunded/已退款、 return_part/部分退货

return_part(部分退货)

refund_part/部分退款、 finished/已完成、 refunded/已退款、 return_part/部分退货

to_send_goods(待发货)

refund_part/部分退款、 to_send_goods/待发货、 in_delivery/已发货、 partial_delivery/部分发货、 finished/已完成、 refunded/已退款、 paid/支付完成、 return_part/部分退货、 signed/已签收、 refunding/退款中

partial_delivery(部分发货)

refund_part/部分退款、 to_send_goods/待发货、 partial_delivery/部分发货、 in_delivery/已发货、 finished/已完成、 refunded/已退款、 paid/支付完成、 return_part/部分退货、 signed/已签收、 refunding/退款中

signed(已签收)

refund_part/部分退款、 finished/已完成、 refunded/已退款、 return_part/部分退货、 signed/已签收

创单成功 (create)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-创单成功 (create)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.202",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"create"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400563307278696",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"alzas","rows":17,"cols":6,"hideborder":false}" id="alzas">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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_shopping

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。入参详情见下文 业务信息参数

","id":"iwbrx","rows":11,"cols":6}" id="iwbrx">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"fypy2","rows":13,"cols":6}" id="fypy2">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"dcwvd","rows":29,"cols":6,"hideborder":false}" id="dcwvd">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"avrsv","rows":4,"cols":6,"hideborder":false}" id="avrsv">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"qsdpa","rows":4,"cols":6}" id="qsdpa">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

待支付 (wait_pay)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-待支付 (wait_pay)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.205",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"wait_pay"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400117364052166",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"dwlsa","rows":17,"cols":6,"hideborder":false}" id="dwlsa">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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_shopping

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。入参详情见下文 业务信息参数

","id":"xowez","rows":11,"cols":6}" id="xowez">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"0oa6g","rows":13,"cols":6}" id="0oa6g">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"j6jjm","rows":29,"cols":6,"hideborder":false}" id="j6jjm">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"0r5l8","rows":4,"cols":6,"hideborder":false}" id="0r5l8">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"h6aal","rows":4,"cols":6}" id="h6aal">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

已关闭 (closed)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-已关闭 (closed)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.208",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"closed"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400156629464986",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"gu3fx","rows":17,"cols":6,"hideborder":false}" id="gu3fx">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: closed

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"3ztw0","rows":11,"cols":6}" id="3ztw0">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

l ext_key

string

订单状态 key。固定为 merchant_order_status

l ext_value

string

订单状态, 例: closed

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"nvabx","rows":13,"cols":6}" id="nvabx">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"g44ws","rows":29,"cols":6,"hideborder":false}" id="g44ws">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"cytxz","rows":4,"cols":6,"hideborder":false}" id="cytxz">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"izxwg","rows":4,"cols":6}" id="izxwg">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

退款中 (refunding)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-退款中 (refunding)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.210",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"refunding"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400728552917737",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"rh98j","rows":17,"cols":6,"hideborder":false}" id="rh98j">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: refunding

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"xmahx","rows":11,"cols":6}" id="xmahx">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

l ext_key

string

订单状态 key。固定为 merchant_order_status

l ext_value

string

订单状态, 例: refunding

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"uqmfy","rows":13,"cols":6}" id="uqmfy">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"izev9","rows":29,"cols":6,"hideborder":false}" id="izev9">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"foxcl","rows":4,"cols":6,"hideborder":false}" id="foxcl">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"t7ckf","rows":4,"cols":6}" id="t7ckf">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

已退款 (refunded)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-已退款 (refunded)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.212",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"refunded"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400537823999387",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"9v9wu","rows":17,"cols":6,"hideborder":false}" id="9v9wu">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: refunded

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"p4jaj","rows":11,"cols":6}" id="p4jaj">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

l ext_key

string

订单状态 key。固定为 merchant_order_status

l ext_value

string

订单状态, 例: refunded

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"sp74n","rows":13,"cols":6}" id="sp74n">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"kelqv","rows":29,"cols":6,"hideborder":false}" id="kelqv">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"es2wb","rows":4,"cols":6,"hideborder":false}" id="es2wb">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"ua5rh","rows":4,"cols":6}" id="ua5rh">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

已完成 (finished)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-已完成 (finished)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.214",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"finished"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400795379927156",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"cpmgt","rows":17,"cols":6,"hideborder":false}" id="cpmgt">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: finished

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"bzkmc","rows":11,"cols":6}" id="bzkmc">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"ojko1","rows":13,"cols":6}" id="ojko1">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"mkysc","rows":29,"cols":6,"hideborder":false}" id="mkysc">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"ahunn","rows":4,"cols":6,"hideborder":false}" id="ahunn">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"djtjk","rows":4,"cols":6}" id="djtjk">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

支付完成 (paid)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-支付完成 (paid)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.217",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"paid"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400131706489565",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"lj2v3","rows":17,"cols":6,"hideborder":false}" id="lj2v3">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: paid

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"apaz1","rows":11,"cols":6}" id="apaz1">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

l ext_key

string

订单状态 key。固定为 merchant_order_status

l ext_value

string

订单状态, 例: paid

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"fbeic","rows":13,"cols":6}" id="fbeic">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"o3bb6","rows":29,"cols":6,"hideborder":false}" id="o3bb6">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"nsvpo","rows":4,"cols":6,"hideborder":false}" id="nsvpo">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"1bizk","rows":4,"cols":6}" id="1bizk">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

已发货 (in_delivery)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-已发货 (in_delivery)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.219",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"in_delivery"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400243706167231",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"icze2","rows":17,"cols":6,"hideborder":false}" id="icze2">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: in_delivery

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"gg2f8","rows":11,"cols":6}" id="gg2f8">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

l ext_key

string

订单状态 key。固定为 merchant_order_status

l ext_value

string

订单状态, 例: in_delivery

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"bpakw","rows":13,"cols":6}" id="bpakw">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"42fgq","rows":29,"cols":6,"hideborder":false}" id="42fgq">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"1nnlg","rows":4,"cols":6,"hideborder":false}" id="1nnlg">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"oxydt","rows":4,"cols":6}" id="oxydt">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

部分退款 (refund_part)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-部分退款 (refund_part)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.221",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"refund_part"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400597230600016",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"oqapy","rows":17,"cols":6,"hideborder":false}" id="oqapy">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: refund_part

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"ysolg","rows":11,"cols":6}" id="ysolg">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

l ext_key

string

订单状态 key。固定为 merchant_order_status

l ext_value

string

订单状态, 例: refund_part

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"q1ayv","rows":13,"cols":6}" id="q1ayv">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"r98lo","rows":29,"cols":6,"hideborder":false}" id="r98lo">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"4swvq","rows":4,"cols":6,"hideborder":false}" id="4swvq">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"aaqh5","rows":4,"cols":6}" id="aaqh5">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

部分退货 (return_part)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-部分退货 (return_part)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.224",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"return_part"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400346516308912",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"qk04v","rows":17,"cols":6,"hideborder":false}" id="qk04v">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: return_part

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"ic8aw","rows":11,"cols":6}" id="ic8aw">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

l ext_key

string

订单状态 key。固定为 merchant_order_status

l ext_value

string

订单状态, 例: return_part

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"q2edj","rows":13,"cols":6}" id="q2edj">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"qzn8p","rows":29,"cols":6,"hideborder":false}" id="qzn8p">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"57slb","rows":4,"cols":6,"hideborder":false}" id="57slb">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"sthhl","rows":4,"cols":6}" id="sthhl">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

待发货 (to_send_goods)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-待发货 (to_send_goods)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.225",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"to_send_goods"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400342577927771",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"xzo8y","rows":17,"cols":6,"hideborder":false}" id="xzo8y">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: to_send_goods

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"hzo4b","rows":11,"cols":6}" id="hzo4b">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

l ext_key

string

订单状态 key。固定为 merchant_order_status

l ext_value

string

订单状态, 例: to_send_goods

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"jwy77","rows":13,"cols":6}" id="jwy77">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"8iy6w","rows":29,"cols":6,"hideborder":false}" id="8iy6w">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"j5qt7","rows":4,"cols":6,"hideborder":false}" id="j5qt7">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"fsfhm","rows":4,"cols":6}" id="fsfhm">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

部分发货 (partial_delivery)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-部分发货 (partial_delivery)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.228",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"partial_delivery"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400320615626857",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"sezou","rows":17,"cols":6,"hideborder":false}" id="sezou">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: partial_delivery

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"sn8vt","rows":11,"cols":6}" id="sn8vt">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

l ext_key

string

订单状态 key。固定为 merchant_order_status

l ext_value

string

订单状态, 例: partial_delivery

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"kuo9d","rows":13,"cols":6}" id="kuo9d">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"cojrk","rows":29,"cols":6,"hideborder":false}" id="cojrk">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"llhqt","rows":4,"cols":6,"hideborder":false}" id="llhqt">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"yfwby","rows":4,"cols":6}" id="yfwby">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

已签收 (signed)

本文详细介绍通过接口 alipay.merchant.order.sync 同步订单状态-已签收 (signed)时需传入的商品信息及扩展字段参数信息。

接口参数 示例

{
 "shop_info":{
 "ext_info":[
 {
 "ext_key":"org_no",
 "ext_value":"1112"
 }
 ]
 },
 "amount":1.55,
 "order_modified_time":"2024-04-01 16:04:00.229",
 "discount_amount":"10.00",
 "pay_amount":1.55,
 "ext_info":[
 {
 "ext_key":"business_info",
 "ext_value":"{\"medical_trade_type\":\"自费订单: self_pay 医保支付订单: medical_insurance\",\"channel_app_id\":\"xxxx\",\"platform_code\":\"支付宝分配给平台的唯一标识\",\"trade_in\":\"y\",\"isv_id\":\"208888888888888\",\"refund_note\":\"因xxxxxx\",\"alipay_point_amount\":\"200个\",\"medical_trade_no\":\"自费:支付宝交易号,支付宝收单系统生成的订单号 医保直连:支付宝交易号,支付宝收单系统生成的订单号 医保间连:行业侧医保订单号(indi开头)\",\"refund_amount\":\"1000\",\"alipay_member_level\":\"支付宝铂金会员\",\"come_again\":\"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854\",\"product_category\":\"感冒\"}"
 },
 {
 "ext_key":"merchant_biz_type",
 "ext_value":"kx_shopping"
 },
 {
 "ext_key":"merchant_order_status",
 "ext_value":"signed"
 },
 {
 "ext_key":"merchant_order_link_page",
 "ext_value":"/pages/order/orderdetail/orderdetail?orderid=202108310xxxxxxx"
 },
 {
 "ext_key":"tiny_app_id",
 "ext_value":"2021000155639062"
 }
 ],
 "buyer_id":"2088202905xxxxxx","buyer_open_id":"074a1cctg1lelxke4xqc0zgndid0nxi95b5lsnpazwyoco5",
 "out_biz_no":"20240401160400331115630772",
 "logistics_info_list":[
 {
 "phone_no":"1234",
 "tracking_no":"ems1234567891012",
 "logistics_code":"best"
 }
 ],
 "order_create_time":"2024-04-01 16:04:00",
 "item_order_list":[
 {
 "quantity":"1",
 "item_id":"a12346",
 "item_name":"商品的名称",
 "sku_id":"245542227793809408",
 "unit_price":"1.55",
 "ext_info":[
 {
 "ext_key":"standard_id",
 "ext_value":"1111"
 },
 {
 "ext_key":"image_material_id",
 "ext_value":"2019082600502200000000566463"
 },
 {
 "ext_key":"platform_sku_id",
 "ext_value":"c1234"
 },
 {
 "ext_key":"voucher_no",
 "ext_value":"20221126999991q7p"
 },
 {
 "ext_key":"merchant_item_link_page",
 "ext_value":"alipays://platformapi/startapp?appid=2021002126602599page=/pages/order-details/order-details?ticketorderid=20210376854"
 },
 {
 "ext_key":"hdimageid",
 "ext_value":"12345697"
 },
 {
 "ext_key":"item_category",
 "ext_value":"h2345235"
 },
 {
 "ext_key":"platform_type",
 "ext_value":"service_goods"
 },
 {
 "ext_key":"subject_type",
 "ext_value":"code_69"
 },
 {
 "ext_key":"voucher_id",
 "ext_value":"1234567"
 },
 {
 "ext_key":"platform_item_id",
 "ext_value":"b123"
 }
 ]
 }
 ],
 "source_app":"alipay",
 "service_code":"2021030221000907068818",
 "trade_no":"2021041222001483141400960202",
 "order_type":"service_order"
}

参数说明

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

shop_info

ordershopinfo

门店信息。详见下文: 门店信息

item_order_list

itemorderinfo

商品信息列表。详见下文: 商品信息列表

ext_info

orderextinfo

订单扩展字段。详见下文 订单扩展字段。

","id":"z5oat","rows":17,"cols":6,"hideborder":false}" id="z5oat">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

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相同的两次同步会被幂等处理。

category_id

string

支付宝标准服务类目code,本模板支持类目code:c000003408,c000003270,c000003390,c000003488,c000003497,c000003538,c000003543,c000003550,c000003547,c000003561,c000003567,c000003569

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)

订单总金额:某笔交易订单优惠前的总金额,单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

pay_amount

price

选填,建议传入该参数

用户应付金额 :用户最终结算时需要支付金额(不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】

注意事项

service_order且不涉及金额可不传入该字段,其他场景必传

discount_amount

price

商户总计优惠金额:代表商户侧给予用户的总计优惠金额 (不包含选择支付宝付款时,支付宝给予的优惠减免金额),单位为【元】。

logistics_info_list

string

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

订单状态, 例: signed

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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。入参详情见下文 业务信息参数

","id":"rmujp","rows":11,"cols":6}" id="rmujp">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

l ext_key

string

订单状态 key。固定为 merchant_order_status

l ext_value

string

订单状态, 例: signed

l ext_key

string

订单类型 key。固定为 merchant_biz_type。

l ext_value

string

订单类型 value。本业务场景为: kx_shopping

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) 的各项入参详情如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

","id":"flu8o","rows":13,"cols":6}" id="flu8o">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

medical_trade_type

string

支付资金类型

channel_app_id

string

宿主appid

come_again

string

字段名称:再来一单
字段说明:商户再来一单的链接

isv_id

string

字段名称:服务商id
字段说明:政策服务商的 pid。

refund_amount

string

退款金额

trade_in

string

字段名称:以旧换新
字段说明:以旧换新的标识,如果是以旧换新商品,带回y

refund_note

string

退款说明

medical_trade_no

string

医药交易单号

alipay_member_level

string

支付宝会员等级

platform_code

string

平台编码

alipay_point_amount

string

字段名称:支付宝会员积分数
字段说明:alipay_point_amount

product_category

string

字段名称:订单主类目
字段说明:商品类目

商品信息列表

开发者需通过商品信息列表字段(item_order_list)传入商品图片、商品详情页等信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

+ ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

","id":"x36tf","rows":29,"cols":6,"hideborder":false}" id="x36tf">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

item_name

string

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

item_id

string

商家侧商品 spu 编码。

quantity

number

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

sku_id

string

商家侧商品 sku id

unit_price

price

商品单价。精确到小数点后两位。单位为元

注意:与quantity成对出现,若传了unit_price,则需要将quantity传入

ext_info

orderextinfo

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

l ext_key

string

standard_id key,固定为 standard_id

l ext_value

string

standard_id value
字段说明:商品标品id

l ext_key

string

商品图片 key。固定为 image_material_id。

l ext_value

string

商品图片 value。需传入 上传商品文件

获取的 material_id

l ext_key

string

platform_sku_id key,固定为 platform_sku_id

l ext_value

string

platform_sku_id value
字段说明:平台侧如商品库的商品单品信息

l ext_key

string

voucher_no key,固定为 voucher_no

l ext_value

string

voucher_no value
字段说明:支付宝支付劵返回的唯一值,使用支付劵的订单场景必填,如年画、福气店等。

l ext_key

string

商品详情页 key。固定为 merchant_item_link_page。

l ext_value

string

商品详情页 value。仅需传入小程序页面地址,支付宝会自动根据该笔交易对应的 appid 来拼接商品详情页跳转链接。

l ext_key

string

hdimageid key,固定为 hdimageid

l ext_value

string

hdimageid value
字段说明:五福年画商品必传id

l ext_key

string

item_category key,固定为 item_category

l ext_value

string

item_category value
字段说明:商品类目

l ext_key

string

platform_type key,固定为 platform_type

l ext_value

string

platform_type value
字段说明:平台类别,枚举值:如商品库service_goods、

l ext_key

string

subject_type key,固定为 subject_type

l ext_value

string

subject_type value
字段说明:商品标品类型

l ext_key

string

voucher_id key,固定为 voucher_id

l ext_value

string

voucher_id value
字段说明:支付宝劵平台返还的唯一值,使用在会员频道的权益商品场景。支付宝会员频道订单必填。

l ext_key

string

platform_item_id key,固定为 platform_item_id

l ext_value

string

platform_item_id value
字段说明:平台侧如商品库的商品品类

物流信息

若商家想在订单中展示物流信息,可通过物流信息(logistics_info_list)同步。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

","id":"fo6jy","rows":4,"cols":6,"hideborder":false}" id="fo6jy">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

phone_no

string

字段名称:手机号后四位
字段说明:当物流公司为顺丰时必传

logistics_code

string

字段名称:物流公司

字段说明:物流公司编码,详情可查看 。

tracking_no

string

物流单号

门店信息

若商家想在订单中展示自身门店信息,可通过门店信息(shop_info)同步店铺信息。参数说明如下:

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

+ ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

","id":"mis9n","rows":4,"cols":6}" id="mis9n">

参数

参数类型

是否必填

能否更新

是否消息使用字段

参数说明

ext_info

orderextinfo

扩展参数。该参数用于传入额外信息。

l ext_key

string

org_no key,固定为 org_no

l ext_value

string

org_no value
字段说明:定点医疗机构编码

凯发k8官方网娱乐官方 copyright © 2022 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图