alipay.merchant.order.sync(订单数据同步接口) 在线调试(沙箱环境)

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

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 alipay.merchant.order.sync
format String 40 仅支持JSON JSON
charset String 10 请求使用的编码格式,如utf-8,gbk,gb2312等 utf-8
sign_type String 10 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2
sign String 344 商户请求参数的签名串,详见签名 详见示例
timestamp String 19 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" 2014-07-24 03:07:50
version String 3 调用的接口版本,固定为:1.0 1.0
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
out_biz_no String 必选 128 外部订单号 1234
buyer_id String 必选 20 买家userId 2088102165400195
seller_id String 必选 20 卖家userId 2088301176313427
partner_id String 必选 20 签约商户userId 2088301176313427
amount Price 必选 11 订单金额,单位为元 12.34
trade_no String 必选 64 订单所对应的支付宝交易号 2019052322001400191000023731
item_order_list ItemOrderInfo[] 可选 商品信息列表
sku_id String 可选 34 商品 sku id 2018111300502205000000176601
item_id String 可选 34 商品 id 2018111300502228000000177053
item_name String 必填 256 商品名称 苹果
unit_price Price 特殊可选 18 商品单价(单位:元)。
小程序订单助手业务中,为必传;其他业务场景参见对应的产品文档。
13.18
quantity Number 特殊可选 9 商品数量(单位:自拟)。
小程序订单助手业务中,为必传;其他业务场景参见对应的产品文档。
20
ext_info OrderExtInfo[] 可选 扩展信息,请参见产品文档。小程序订单助手业务中,扩展参数必须传递素材id;其他业务场景参见对应的产品文档。
ext_key String 必填 64 键值 MY_KEY
ext_value String 必填 1024 MY_VALUE
logistics_info_list OrderLogisticsInformationRequest[] 可选 物流信息
列表最多支持物流信息个数,请参考产品文档
注:若该值不为空,且物流信息同步至我的快递,则在查询订单时可返回具体物流信息
tracking_no String 必填 128 物流单号 P201802091000000002W
logistics_code String 可选 128 物流公司编号。
物流公司编号值请查看产品文档
注:该值为空时,有可能匹配不到物流信息。若有则必传
STO
ext_info OrderExtInfo[] 可选 扩展信息,请参见产品文档
ext_key String 必填 64 键值 MY_KEY
ext_value String 必填 1024 MY_VALUE

响应参数

参数 类型 是否必填 最大长度 描述 示例值
order_id String 必填 34 同步成功后的订单号 2019052300502300190500000000102188

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
AlipayMerchantOrderSyncRequest request = new AlipayMerchantOrderSyncRequest();
request.setBizContent("{" +
"\"out_biz_no\":\"1234\"," +
"\"buyer_id\":\"2088102165400195\"," +
"\"seller_id\":\"2088301176313427\"," +
"\"partner_id\":\"2088301176313427\"," +
"\"amount\":12.34," +
"\"trade_no\":\"2019052322001400191000023731\"," +
"      \"item_order_list\":[{" +
"        \"sku_id\":\"2018111300502205000000176601\"," +
"\"item_id\":\"2018111300502228000000177053\"," +
"\"item_name\":\"苹果\"," +
"\"unit_price\":13.18," +
"\"quantity\":20," +
"          \"ext_info\":[{" +
"            \"ext_key\":\"MY_KEY\"," +
"\"ext_value\":\"MY_VALUE\"" +
"            }]" +
"        }]," +
"      \"logistics_info_list\":[{" +
"        \"tracking_no\":\"P201802091000000002W\"," +
"\"logistics_code\":\"STO\"" +
"        }]," +
"      \"ext_info\":[{" +
"        \"ext_key\":\"MY_KEY\"," +
"\"ext_value\":\"MY_VALUE\"" +
"        }]" +
"  }");
AlipayMerchantOrderSyncResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "alipay_merchant_order_sync_response": {
        "code": "10000",
        "msg": "Success",
        "order_id": "2019052300502300190500000000102188"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "alipay_merchant_order_sync_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
SYSTEM_ERROR 系统繁忙 系统繁忙,请稍后重试
INVALID_PARAMETER 参数有误 参数错误,请检查参数是否正确
MATERIAL_ID_ILLEGAL 素材id不合法 请检查素材id是否正确
CONTENT_ILLEGAL 内容不合法 请检查内容是否正确
TINY_APP_ID_NULL 交易没有关联小程序id 请使用关联了小程序的交易同步订单信息
TINY_APP_ID_ILLEGAL 交易关联小程序id不合法 请检查交易关联的小程序id是否合法
LOGISTICS_INFO_EXIST 物流信息已存在 物流信息不可重复同步
TRADE_NOT_EXIST 交易不存在 请检查交易号是否正确
ITEM_INFO_NOT_COMPLETE 商品信息不完整 请检查商品信息
NO_PERMISSOON 没有权限 请检查订单pid与交易pid是否一致
ORDER_ERROR_STATUS 订单状态错误 请确认订单状态
LOGISTICS_SIZE_LARGE 物流信息条数过大 请检查入参中的物流信息,是否超过最大允许条数
ITEM_HAS_EXIST 商品已经存在 您的订单商品信息已经通过支付链路同步,无法修改。若要同步其他信息请确保商品信息为空
AMOUNT_ILLEGAL 订单金额错误 请检查,传入订单金额是否与交易中的金额一致
onlineServer