修改商家券活动基本信息
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
PATCH
/v3/alipay/marketing/ordervoucher/activity/{activity_id}
alipay.marketing.activity.ordervoucher
修改商家券活动基本信息接口同步返回修改请求受理结果，后续通过alipay.marketing.activity.message.modified消息接口异步发送修改活动成功事件消息。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'http://dev-cn.your-api-server.com/v3/alipay/marketing/ordervoucher/activity/' \
--header 'Content-Type: application/json' \
--data-raw '{
"activity_base_info": {
"belong_merchant_info": {
"business_type": "string",
"merchant_id": "string",
"merchant_id_type": "string"
},
"activity_id": "string",
"activity_name": "string",
"activity_operation_status": "string",
"activity_product_type": "string",
"activity_status": "string",
"code_mode": "string",
"out_activity_id": "string"
},
"customer_guide": {
"voucher_send_guide": {
"voucher_detail_url": "alipays://platformapi/startapp?appId=xxxx"
},
"voucher_use_guide": {
"mini_app_id": "2021238412323412",
"mini_app_path": "/index/path/path&query=xx%3dxx",
"service_codes": "[\"2020030921000303380758\"]"
},
"mini_app_id": "2021238412323412",
"mini_app_path": "/index/path/path&query=xx%3dxx",
"real_shop_ids": "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]",
"service_codes": "[\"2020030921000303380758\"]",
"shop_ids": "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]",
"store_ids": "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]"
},
"voucher_available_scope_info": {
"voucher_available_account_info": {
"available_pids": [
"string"
],
"available_smids": [
"string"
]
},
"voucher_available_app_info": {
"available_app_ids": [
"string"
]
},
"voucher_available_geography_scope_info": {
"available_geography_city_info": {
"all_city": true,
"available_city_codes": [
"string"
]
},
"available_geography_shop_info": {
"available_geography_all_shop": {
"available_brand_id": "string",
"exclude_shop_ids": [
"string"
],
"merchant_ids": [
"string"
]
},
"available_real_shop_ids": [
"string"
],
"available_shop_ids": [
"string"
]
},
"available_geography_scope_type": "string"
},
"voucher_available_goods_info": {
"goods_description": "string",
"goods_detail": "string",
"goods_detail_rich_description": "string",
"goods_name": "string",
"origin_amount": "string",
"available_goods_sku_ids": [
"string"
],
"exclude_goods_sku_ids": [
"string"
],
"goods_detail_images": [
"string"
]
},
"voucher_available_item_info": {
"item_id": "string",
"out_item_info": [
{
"item_app_id": "string",
"out_item_id": "string"
}
]
}
},
"voucher_customer_guide_info": {
"voucher_send_guide_info": {
"mini_app_send_guide_info": {
"mini_app_url": "string"
},
"send_guide_mode": [
"string"
]
},
"voucher_use_guide_info": {
"mini_app_use_guide_info": {
"mini_app_url": "string",
"mini_app_service_codes": [
"string"
]
},
"use_guide_mode": [
"string"
]
}
},
"voucher_display_info": {
"brand_logo": "adeDSktiQO-u5vJUqVbcQwAAACMAAQED",
"brand_name": "商家优惠",
"customer_service_mobile": "81XXXXXXX",
"customer_service_url": "alipay://xxxx",
"voucher_comment": "食材新鲜，品质之选",
"voucher_description": "1、本券不可兑换现金，不可找零。2、每个用户最多可以领取1张。3、如果订单发生退款，优惠券无法退还。",
"voucher_image": "adeDSktiQO-u5vJUqVbcQwAAACMAAQED",
"voucher_detail_images": "[\"adeDSktiQO-u5vJUqVbcQwAAACMAAQE1\",\"adeDSktiQO-u5vJUqVbcQwAAACMAAQE2\",\"adeDSktiQO-u5vJUqVbcQwAAACMAAQE3\"]"
},
"voucher_display_pattern_info": {
"brand_logo": "string",
"brand_logo_url": "string",
"brand_name": "string",
"customer_service_mobile": "string",
"customer_service_url": "string",
"voucher_description": "string",
"voucher_image": "string",
"voucher_image_url": "string",
"voucher_name": "string",
"voucher_detail_image_urls": [
"string"
],
"voucher_detail_images": [
"string"
]
},
"voucher_send_mode_info": {
"voucher_package_mode_info": {
"voucher_package_id": "string"
},
"voucher_sale_mode_info": {
"settle_info": {
"settle_mode": "string",
"settle_target_type": "string"
},
"fund_custody_mode": "string",
"overdue_refundable": true,
"overdue_refundable_need_confirm": true,
"payee_pid": "string",
"refundable": true,
"refundable_need_confirm": true,
"sale_amount": "string"
},
"voucher_send_rule_info": {
"max_quantity_by_day": 0,
"natural_person_limit": true,
"phone_number_limit": true,
"phone_number_need_input_limit": true,
"publish_end_time": "string",
"publish_start_time": "string",
"quantity": 0,
"quantity_limit_per_user": 0,
"quantity_limit_per_user_period_type": "string",
"real_name_limit": true
},
"voucher_send_mode": "string"
},
"voucher_send_rule": {
"natural_person_limit": false,
"phone_number_limit": "true",
"voucher_quantity_limit_per_user": 1
},
"voucher_use_rule": {
"exchange_voucher": {
"voucher_detail_url": "alipays://platformapi/startapp?appId=xxxx",
"voucher_name": "满10减1"
},
"voucher_available_scope": {
"order_voucher_available_city_code": {
"city_codes": "[\"100100\"]"
},
"order_voucher_available_shop": {
"order_voucher_merchant_all_shop": {
"exclude_shop_ids": "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]"
},
"real_shop_ids": "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]",
"shop_ids": "[\"2018051000502000000011111111\",\"2018040200502000000011111111\",\"2018062800502000000022271997\"]"
},
"modify_type": "ADD"
},
"voucher_valid_period": {
"valid_days_after_receive": 3,
"wait_days_after_receive": 2,
"valid_begin_time": {},
"valid_end_time": {}
}
},
"voucher_use_rule_info": {
"voucher_use_time_info": {
"absolute_period_info": {
"time_restrict_info": {
"disable_period_info": [
{
"date_rule_info": {
"date_range_info": {
"begin_date": "string",
"end_date": "string"
},
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
}
},
"holiday_rule_info": {
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
}
},
"week_rule_info": {
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
},
"week_day": "string"
},
"rule_type": "string"
}
],
"usable_period_info": [
{
"date_rule_info": {
"date_range_info": {
"begin_date": "string",
"end_date": "string"
},
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
}
},
"holiday_rule_info": {
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
}
},
"week_rule_info": {
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
},
"week_day": "string"
},
"rule_type": "string"
}
]
},
"valid_begin_time": "string",
"valid_end_time": "string"
},
"relative_period_info": {
"time_restrict_info": {
"disable_period_info": [
{
"date_rule_info": {
"date_range_info": {
"begin_date": "string",
"end_date": "string"
},
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
}
},
"holiday_rule_info": {
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
}
},
"week_rule_info": {
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
},
"week_day": "string"
},
"rule_type": "string"
}
],
"usable_period_info": [
{
"date_rule_info": {
"date_range_info": {
"begin_date": "string",
"end_date": "string"
},
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
}
},
"holiday_rule_info": {
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
}
},
"week_rule_info": {
"time_range_info": {
"end_time_info": {
"end_time": "string",
"end_time_type": "string"
},
"begin_time": "string"
},
"week_day": "string"
},
"rule_type": "string"
}
]
},
"valid_days_after_receive": 0,
"wait_days_after_receive": 0
},
"period_type": "string"
},
"quantity_limit_per_user": 0,
"quantity_limit_per_user_period_type": "string",
"voucher_max_use_times": 0,
"voucher_use_ext_info": "string"
},
"activity_name": "满10减1活动",
"merchant_access_mode": "SELF_MODE",
"out_biz_no": "20170101000001654bb46ba",
"voucher_available_scope_modify_type": "ADD",
"publish_end_time": {},
"publish_start_time": {}
}'响应示例响应示例
200 - 示例 1
{
"voucher_available_scope_result_info": {
"voucher_available_geography_scope_result_info": {
"available_geography_shop_result_info": {
"available_geography_all_shop_result_info": {
"fail_exclude_shop_infos": [
{
"fail_message": "string",
"real_shop_id": "string",
"shop_id": "string",
"fail_reasons": [
"string"
]
}
],
"success_exclude_shop_ids": [
"string"
]
},
"fail_available_real_shop_infos": [
{
"fail_message": "string",
"real_shop_id": "string",
"shop_id": "string",
"fail_reasons": [
"string"
]
}
],
"fail_available_shop_infos": [
{
"fail_message": "string",
"real_shop_id": "string",
"shop_id": "string",
"fail_reasons": [
"string"
]
}
],
"success_available_real_shop_ids": [
"string"
],
"success_available_shop_ids": [
"string"
]
}
}
},
"voucher_use_rule_result": {
"voucher_available_scope_result": {
"order_voucher_available_shop_result": {
"order_voucher_merchant_all_shop_result": {
"exclude_shop_fail_infos": [
{
"fail_message": "string",
"shop_id": "string",
"fail_reasons": [
"string"
]
}
],
"success_exclude_shop_ids": [
"string"
]
},
"real_shop_fail_infos": [
{
"fail_message": "string",
"real_shop_id": "string",
"fail_reasons": [
"string"
]
}
],
"shop_fail_infos": [
{
"fail_message": "string",
"shop_id": "string",
"fail_reasons": [
"string"
]
}
],
"success_real_shop_ids": [
"string"
],
"success_shop_ids": [
"string"
]
},
"voucher_available_type": "string"
}
}
}请求参数
Path 参数
activity_id
string
活动id1
Body 参数application/json