Skip to content

获取支付有礼活动列表 ​

商户根据一定过滤条件,查询已创建的支付有礼活动。

请求参数类型描述
queryobject声明请求的查询参数
offsetinteger分页页码
limitinteger分页大小
activity_namestring活动名称
activity_statusstring活动状态
ACT_STATUS_UNKNOWN | CREATE_ACT_STATUS | ONGOING_ACT_STATUS | TERMINATE_ACT_STATUS | STOP_ACT_STATUS | OVER_TIME_ACT_STATUS | CREATE_ACT_FAILED | CREATE_ACT_STATUS | ONGOING_ACT_STATUS | TERMINATE_ACT_STATUS | STOP_ACT_STATUS | OVER_TIME_ACT_STATUS | CREATE_ACT_FAILED 枚举值之一
award_typestring奖品类型
BUSIFAVOR 枚举值
php
$instance->v3->marketing->paygiftactivity->activities->getAsync([
  'query' => [
    'offset'          => 1,
    'limit'           => 20,
    'activity_name'   => '良品铺子回馈活动',
    'activity_status' => 'ACT_STATUS_UNKNOWN',
    'award_type'      => 'BUSIFAVOR',
  ],
])
->then(static function(\Psr\Http\Message\ResponseInterface $response) {
  print_r(json_decode((string) $response->getBody(), true));
})
->wait();
php
$instance->chain('v3/marketing/paygiftactivity/activities')->getAsync([
  'query' => [
    'offset'          => 1,
    'limit'           => 20,
    'activity_name'   => '良品铺子回馈活动',
    'activity_status' => 'ACT_STATUS_UNKNOWN',
    'award_type'      => 'BUSIFAVOR',
  ],
])
->then(static function(\Psr\Http\Message\ResponseInterface $response) {
  print_r(json_decode((string) $response->getBody(), true));
})
->wait();
php
$instance['v3/marketing/paygiftactivity/activities']->getAsync([
  'query' => [
    'offset'          => 1,
    'limit'           => 20,
    'activity_name'   => '良品铺子回馈活动',
    'activity_status' => 'ACT_STATUS_UNKNOWN',
    'award_type'      => 'BUSIFAVOR',
  ],
])
->then(static function(\Psr\Http\Message\ResponseInterface $response) {
  print_r(json_decode((string) $response->getBody(), true));
})
->wait();
php
$response = $instance->v3->marketing->paygiftactivity->activities->get([
  'query' => [
    'offset'          => 1,
    'limit'           => 20,
    'activity_name'   => '良品铺子回馈活动',
    'activity_status' => 'ACT_STATUS_UNKNOWN',
    'award_type'      => 'BUSIFAVOR',
  ],
]);
print_r(json_decode((string) $response->getBody(), true));
php
$response = $instance->chain('v3/marketing/paygiftactivity/activities')->get([
  'query' => [
    'offset'          => 1,
    'limit'           => 20,
    'activity_name'   => '良品铺子回馈活动',
    'activity_status' => 'ACT_STATUS_UNKNOWN',
    'award_type'      => 'BUSIFAVOR',
  ],
]);
print_r(json_decode((string) $response->getBody(), true));
php
$response = $instance['v3/marketing/paygiftactivity/activities']->get([
  'query' => [
    'offset'          => 1,
    'limit'           => 20,
    'activity_name'   => '良品铺子回馈活动',
    'activity_status' => 'ACT_STATUS_UNKNOWN',
    'award_type'      => 'BUSIFAVOR',
  ],
]);
print_r(json_decode((string) $response->getBody(), true));
返回字典类型描述
offsetinteger分页页码
limitinteger分页大小
total_countinteger总数
dataobject[]结果集
activity_base_infoobject活动基本信息
activity_namestring活动名称
activity_second_titlestring活动副标题
merchant_logo_urlstring商户logo
background_colorstring背景颜色
Color010 | Color020 | Color030 | Color040 | Color050 | Color060 | Color070 | Color080 | Color090 | Color100 枚举值之一
begin_timestring活动开始时间
end_timestring活动结束时间
available_periodsobject可用时间段
available_timeobject[]可用时间
begin_timestring可用开始时间
end_timestring可用结束时间
available_day_timeobject[]每日可用时间
begin_day_timestring每日可用开始时间
end_day_timestring每日可用结束时间
out_request_nostring商户请求单号
delivery_purposestring投放目的
OFF_LINE_PAY | JUMP_MINI_APP 枚举值之一
mini_programs_appidstring商家小程序appid
mini_programs_pathstring商家小程序path
advanced_settingobject活动高级设置
delivery_user_categorystring奖品类型
BUSIFAVOR 枚举值
merchant_member_appidstring商家会员appid
payment_modeobject支付模式
payment_scene_liststring[]支付场景列表
APP_SCENE 枚举值
payment_method_informationobject支付方式信息
payment_methodstring支付方式
CFT | SPECIFIC_BANK_CARD 枚举值之一
bank_abbreviationstring银行简称
goods_tagsstring[]订单优惠标记
activity_idstring活动id
award_send_ruleobject活动奖品发放规则
full_send_ruleobject满送活动奖品发放规则
award_typestring奖品类型
BUSIFAVOR 枚举值
merchant_optionstring发券商户号选项
IN_SEVICE_COUPON_MERCHANT | MANUAL_INPUT_MERCHANT 枚举值之一
transaction_amount_minimuminteger消费金额门槛
send_contentstring发放内容
SINGLE_COUPON | GIFT_PACKAGE 枚举值之一
award_listobject[]奖品基本信息列表
stock_idstring代金券批次Id
original_image_urlstring奖品原始图(大图)
thumbnail_urlstring奖品缩略图(小图)
merchant_id_liststring[]发券商户号列表
activity_typestring活动类型
FULL_SEND_ACT_TYPE | STEP_SEND_ACT_TYPE | SPECIFIC_SEND_ACT_TYPE 枚举值之一
activity_statusstring活动状态
ACT_STATUS_UNKNOWN | CREATE_ACT_STATUS | ONGOING_ACT_STATUS | TERMINATE_ACT_STATUS | STOP_ACT_STATUS | OVER_TIME_ACT_STATUS | CREATE_ACT_FAILED 枚举值之一
creator_merchant_idstring创建商户号
belong_merchant_idstring所属商户号
create_timestring活动创建时间
update_timestring活动更新时间

参阅 官方文档 官方文档

Published on the GitHub by TheNorthMemory