订单数据同步接口

商户可以调用此接口同步交易对应的订单数据

{ "distribute_result": [ { "not_distribute_reason": "小程序id不存在", "scene_code": "SERVICE_MSG", "scene_name": "订单消息" } ], "order_id": "2019052300502300190500000000102188", "order_status": "PAID", "record_id": "2019103000502300270200000001268074", "sync_suggestions": [ { "message": "建议回传蚂蚁门店ID，以便在场景中更好的分发", "type": "SHOP_ID_INVALID" } ] }

请求参数

Body 参数application/json

buyer_info

object (UserInfomation)

可选

cert_no

string

证件号

可选

cert_type

string

证件类型。

可选

ext_info

array[object (OrderExtInfo) {2}]

扩展信息

可选

mobile

string

手机号

可选

name

string

姓名

可选

open_id

string

用户open_id

可选

user_id

string

支付宝uid

可选

shop_info

object (OrderShopInfo)

可选

address

string

店铺地址

可选

alipay_shop_id

string

可选

蚂蚁门店shop_id

ext_info

array[object (OrderExtInfo) {2}]

可选

门店其他业务属性，不同业务场景KEY枚举值不同，使用前请参考产品文档

merchant_shop_id

string

可选

商户门店id 支持英文、数字的组合

merchant_shop_link_page

string

店铺详情链接地址

可选

name

string

店铺名称

可选

phone_num

string

可选

联系电话-支持固话或手机号仅支持数字、+、-

type

string

可选

仅当alipay_shop_id字段值为非标准蚂蚁门店时使用，其他场景无需传入

ticket_info

object (TicketInfo)

可选

address

string

店铺地址

可选

示例值:

上海市南泉北路447号

resv_type

string

可选

凭证预约类型，一般不需要传入。可选值为INSTANT/RESERVATION，其中INSTANT代表是实时凭证，RESERVATION代表是预约凭证，不传入默认为实时凭证。区别在于预约凭证一般不是当场可取，而是用户下单后的很多天之后才可以凭借凭证提取

示例值:

RESERVATION

shop

string

可选

凭证可核销门店/货品自提门店，如果自提门店与购买门店不一致，可传入该字段提示用户自提门店

示例值:

杭州面馆西溪路店

ticket_no

string

可选

单据号不同类型下单据号含义不同。若类型为MEAL_NUM，则ticket_no表示取餐号；若类型为PICKUP_CODE，则ticket_no表示取件码；其他类型查看小程序订单产品文档

示例值:

A0001

type

string

可选

凭证类型具体类型查看产品文档

示例值:

MEAL_NUM

end_time

string

截止时间

可选

示例值:

{}

time

string

可选

时间，如果传入了end_time则该字段必传不同类型下的地址含义不同。若type为MEAL_NUM，time则代表取餐时间；若type为PICKUP_CODE，address则代表取件时间。其他类型查看小程序订单产品文档

示例值:

{}

amount

string

订单金额

可选

示例值:

12.34

buyer_id

string

买家userId

可选

示例值:

2088102165400195

buyer_open_id

string

用户open_id

可选

示例值:

074a1CcTG1LelxKe4xQC0zgNdId0nxi95b5lsNpazWYoCo5

category_id

string

标准服务类目

可选

示例值:

C000003191

discount_amount

string

优惠金额

可选

示例值:

2.44

discount_info_list

array[object (DiscountInfoData) {5}]

订单优惠信息

可选

discount_amount

string

优惠金额

可选

示例值:

2.44

discount_name

string

优惠名称

可选

示例值:

商家红包

discount_page_link

string

优惠跳转链接地址

可选

示例值:

https://www.alipay.com/

discount_quantity

integer

优惠数量

可选

示例值:

external_discount_id

string

外部优惠id

可选

示例值:

discount001

ext_info

array[object (OrderExtInfo) {2}]

可选

扩展信息，请参见小程序订单中心

ext_key

string

键值

可选

ext_value

string

值

可选

item_order_list

array[object (ItemOrderInfo) {9}]

商品信息列表

可选

ext_info

array[object (OrderExtInfo) {2}]

可选

扩展信息，请参见产品文档。小程序订单助手业务中，扩展参数必须传递素材id；其他业务场景参见对应的产品文档。

item_id

string

商品ID

可选

示例值:

2019073100702219000000100000

item_name

string

商品名称

可选

示例值:

苹果

quantity

integer

可选

商品数量（单位：自拟）

示例值:

sku_id

string

商品 sku id

可选

示例值:

2018111300502205000000176601

status

string

商品状态枚举

可选

示例值:

PAID

status_desc

string

可选

商品状态描述，默认无需传入，如需使用请联系业务负责人

示例值:

已付款

unit

string

商品规格

可选

示例值:

斤

unit_price

string

可选

商品单价（单位：元）。小程序订单助手业务中，为必传；其他业务场景参见对应的产品文档。

示例值:

13.18

journey_order_list

array[object (OrderJourneyInfo) {13}]

行程信息

可选

action

string

操作动作

可选

示例值:

DELETE

ext_info

array[object (OrderExtInfo) {2}]

扩展信息

可选

journey_desc

string

行程描述

可选

示例值:

中国航空公司 C8888 上海-北京

journey_elements

array[object (OrderJourneyElement) {12}]

行程元素列表

可选

journey_index

string

可选

描述本行程为整个行程中的第几程

示例值:

merchant_journey_no

string

商户行程单号

可选

示例值:

202101130000001

status

string

行程状态

可选

示例值:

MERCHANT_FINISHED

status_desc

string

行程状态描述

可选

示例值:

已完成

sub_type

string

行程子类型

可选

示例值:

abroad

title

string

行程标题

可选

示例值:

标题

type

string

行程类型

可选

示例值:

airticket

journey_create_time

string

行程创建时间

可选

示例值:

{}

journey_modify_time

string

行程修改时间

可选

示例值:

{}

logistics_info_list

array[object (OrderLogisticsInformationRequest) {2}]

可选

"物流信息列表最多支持物流信息个数，请参考产品文档注：若该值不为空，且物流信息同步至我的快递，则在查询订单时可返回具体物流信息"

logistics_code

string

可选

物流公司编号。物流公司编号值请查看产品文档

示例值:

STO

tracking_no

string

物流单号

可选

示例值:

P201802091000000002W

order_auth_code

string

可选

本字段已废弃，无需填写！

示例值:

DFSDLIGWGDF5SDLFA

order_type

string

订单类型

可选

示例值:

SERVICE_ORDER

out_biz_no

string

可选

外部订单号 out_biz_no唯一对应一笔订单，相同的订单需传入相同的out_biz_no

示例值:

1234

partner_id

string

可选

交易对应的签约商户userId

示例值:

2088301176313427

pay_amount

string

可选

支付金额，单位为【元】，需要实际支付的金额。SERVICE_ORDER且不涉及金额可不传入该字段，其他场景必传

示例值:

9.9

pay_timeout_express

string

可选

支付超时时间，超过时间支付宝自行关闭订单

示例值:

15h

record_id

string

可选

商户订单同步记录id

示例值:

2019103000502300270200000001268074

seller_id

string

卖家userId

可选

示例值:

2088301176313427

send_msg

string

可选

是否需要小程序订单代理发送模版消息。不传默认不发送

示例值:

service_code

string

可选

服务code：传入小程序后台提报的服务id，将订单与服务关联，有利于提高服务曝光机会；入参服务id的类目须与订单类型相符，若不相符将会报错；如订单类型为“外卖”，则入参的服务ID所对应的服务类目也必须得是”外卖“；service_code 通过 alipay.open.app.service.apply，(服务提报申请)接口创建服务后获取。

示例值:

2018072411000000099497

source_app

string

可选

用于区分用户下单的订单来源

示例值:

Alipay

sync_content

string

同步内容

可选

示例值:

JOURNEY_ONLY

ticket_order_list

array[object (TicketOrderInfo) {22}]

凭证信息

可选

arrival

object (JourneyLocation)

可选

departure

object (JourneyLocation)

可选

service_provider

object (OrderParticipantInfo)

可选

vehicle_info

object (OrderVehicleInfo)

可选

content

string

凭证内容

可选

示例值:

凭证内容

effective_num

integer

凭证有效数

可选

示例值:

ext_info

array[object (OrderExtInfo) {2}]

扩展信息

可选

face_value

string

票面价

可选

示例值:

functional_services

array[object (FunctionalService) {7}]

功能服务信息

可选

invalid_reason

string

凭证失效原因

可选

示例值:

用户取消

locations

array[object (JourneyLocation) {10}]

凭证可使用地点

可选

merchant_ticket_no

string

可选

商户侧凭证ID或核销码

示例值:

out_20210820

seat_infos

array[object (SeatInfo) {2}]

座位信息

可选

shops

array[object (OrderShopInfo) {8}]

凭证可使用门店列表

可选

status

string

凭证状态

可选

示例值:

TICKETED

ticket_num

integer

凭证购买数

可选

示例值:

ticket_users

array[object (UserInfomation) {7}]

凭证使用者信息

可选

title

string

凭证标题

可选

示例值:

上海-杭州

end_time

string

凭证结束时间

可选

示例值:

{}

start_time

string

凭证开始时间

可选

示例值:

{}

ticket_create_time

string

凭证创建时间

可选

示例值:

{}

ticket_modify_time

string

凭证修改时间

可选

示例值:

{}

trade_no

string

可选

订单所对应的支付宝交易号

示例值:

2019052322001400191000023731

trade_type

string

交易号类型

可选

示例值:

TRADE

order_create_time

string

订单创建时间

可选

示例值:

{}

order_modified_time

string

订单修改时间

可选

示例值:

{}

order_pay_time

string

订单支付时间

可选

示例值:

{}

示例

返回响应

🟢200common response

application/json

Body

distribute_result

array[object (OrderDataDistributeInfo) {3}]

可选

"分发结果若未分发到场景侧，则会返回具体的未分发原因"

not_distribute_reason

string

可选

未分发到场景的具体原因。开发者可根据具体原因定位解决问题后发起重试。

示例值:

小程序id不存在

scene_code

string

分发场景code。

可选

示例值:

SERVICE_MSG

scene_name

string

可选

分发场景名，对应scene_code。

示例值:

订单消息

order_id

string

支付宝订单号

可选

示例值:

2019052300502300190500000000102188

order_status

string

订单状态

可选

示例值:

PAID

record_id

string

可选

同步订单记录id （自2022年5月19日起，新接入商户，除点餐场景，该字段不再返回）

示例值:

2019103000502300270200000001268074

sync_suggestions

array[object (OrderDataSyncSuggestion) {2}]

可选

订单同步优化建议，供开发者参考

message

string

同步建议内容

可选

示例值:

建议回传蚂蚁门店ID，以便在场景中更好的分发

type

string

同步建议类型

可选

示例值:

SHOP_ID_INVALID

🔴500请求失败