通用场景
履约信息的同步接口,支持履约的新建和更新操作
公共请求参数
业务请求参数
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"
}
]
}'
说明:本示例仅供参考。
公共响应参数
业务响应参数
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,或已做相关授权 |