私域产品
小程序产品
权限集列表
搜索关键词
搜索直达
收藏
消息
小程序码
小程序服务
订单中心
小程序开发管理
交易组件
小程序商品
接入指南
api 列表
普通商品
普通商品履约模版
本地生活商品
支付宝文件
商品变更相关
商品营销相关
相关资料
支付产品
开发 > 服务端 > 私域产品 > 小程序产品 > 权限集列表 > 小程序商品 > api 列表 >  >  > 履约信息同步接口
已更新
文档更新记录 >
收藏
订阅更新
我的文档
设置
回到旧版
接入检测
即可查看检测结果)
若有未通过的接入检测项,接口将无法调通
履约信息的同步接口,支持履约的新建和更新操作

公共请求参数

参数类型是否必选最大长度描述示例值
app_idstring必选32
支付宝分配给开发者的应用id
2014072300007148
methodstring必选128
接口名称
alipay.open.app.delivery.info.sync
formatstring可选40
仅支持json
json
charsetstring必选10
请求使用的编码格式,如utf-8,gbk,gb2312等
utf-8
sign_typestring必选10
商户生成签名字符串所使用的签名算法类型,目前支持rsa2和rsa,推荐使用rsa2
rsa2
signstring必选344
商户请求参数的签名串,详见签名
详见示例
timestampstring必选19
发送请求的时间,格式"yyyy-mm-dd hh:mm:ss"
2014-07-24 03:07:50
versionstring必选3
调用的接口版本,固定为:1.0
1.0
app_auth_tokenstring可选40
biz_contentstring必选
请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

业务请求参数

delivery_type|履约类型必选string[1,16]
【描述】履约类型
【枚举值】
电商卖货: express
到店自提: pickup
外卖到家: same_city
【示例值】express
delivery_name|履约信息名称必选string[1,20]
【描述】履约名称
【注意事项】同一个appid下履约信息名称不能重复,该字段会自动覆盖属性(attrs)中的履约名称(delivery_name)值,以保证名称的一致性
【示例值】同城配送满30元起送
attrs|履约属性必选appitemattrvo[][1,1000]
【描述】履约属性,从模板中查询(alipay.open.app.delivery.template.query)得到,is_required=1时表示属性必填。
【注意事项】相关属性说明和创建示例请参考
attr_key|商品属性key必选string[1,40]
【描述】商品属性key
【示例值】key1
attr_value|商品属性value必选string[1,102400]
【描述】商品属性value
【示例值】value1
delivery_id|履约信息id可选string[1,32]
【描述】履约信息主键可唯一确定一条履约,该字段用来区分创建or更新履约信息。
【示例值】20230530021000800000001
常见请求示例
curl 'https://openapi.alipay.com/gateway.do?charset=utf-8&method=alipay.open.app.delivery.info.sync&format=json&sign=${sign}&app_id=${appid}&version=1.0&sign_type=rsa2×tamp=${now}' \
 -f 'biz_content={
	"delivery_type":"express",
	"delivery_name":"同城配送满30元起送",
	"delivery_id":"20230530021000800000001",
	"attrs":[
		{
			"attr_key":"key1",
			"attr_value":"value1"
		}
	]
}' 
说明:本示例仅供参考。

公共响应参数

参数类型是否必选最大长度描述示例值
codestring必选-
网关返回码,
40004
msgstring必选-
网关返回码描述,
business failed
sub_codestring可选-
业务返回码,参见具体的api接口文档
acq.trade_has_success
sub_msgstring可选-
业务返回码描述,参见具体的api接口文档
交易已被支付
signstring必选-
签名,
dzxh8eetuahoye3w1j poiphfdxoybfunn1lket/v7p4zjdyojwea6izs6hz0ydw5cp/viufub5i0/v5wens3oyr8zredqo6d futdlhdc efyckiqhbxizgngpdpdfp1pis7bdhhzrszhbrqb7o4k3dxc aanfauu4v6zdwczo=

业务响应参数

delivery_id|履约信息id必选string(32)
【描述】履约信息id
【示例值】20230530021000800000001
响应示例
{
    "alipay_open_app_delivery_info_sync_response": {
        "code": "10000",
        "msg": "success",
        "delivery_id": "20230530021000800000001"
    },
    "sign": "eritjkeijkjhkkkkkkkhjereeeeeeeeeee"
}
说明:本示例仅供参考。

公共错误码

业务错误码

错误码错误描述凯发app官方网站的解决方案
system_error系统繁忙
服务器异常 可能发生了网络或者系统异常,导致服务调用失败,商户可以用同样的请求发起重试
invalid_parameter参数有误
请根据接口返回的参数非法的具体错误信息,修改参数后进行重试
mini_app_not_online应用未上架
请检查该appid是否已上架
permission_check_error权限校验失败
确认当前操作账号是否匹配当前传入pid或alipay_app_id,或已做相关授权
内容没有解决您的问题?您还可以前往 或 寻求帮助
凯发k8官方网娱乐官方 copyright © 2022 支付宝(杭州)信息技术有限公司  | icp证浙b2-20160559
该文档对你是否有帮助?
当前页面目录
网站地图