跳至主要內容

营销活动

Alex大约 13 分钟开发文档API接口文档

营销活动

GET 活动列表

GET /front/marketing/activityBase/list

活动表

请求参数

名称位置类型必选说明
activityEndtimequeryinteger活动结束时间
activityIdqueryinteger活动编号
activityIsFinishqueryinteger活动是否完成(ENUM):0-未完成;1-已完成;2-已解散(目前用于团购)
activityNamequerystring活动名称
activityRemarkquerystring活动说明
activitySortqueryinteger活动排序
activityStarttimequeryinteger活动开始时间
activityStatequeryinteger活动状态(ENUM):0-未开启;1-正常;2-已结束;3-管理员关闭;4-商家关闭
activityTitlequerystring活动标题
activityTypequeryinteger参与类型(ENUM):1-免费参与;2-积分参与;3-购买参与;4-分享参与
activityTypeIdqueryinteger活动类型
activityUseLevelquerystring使用等级(DOT)
createTimeEndquerystring创建时间结束值
createTimeStartquerystring创建时间起始值
like[0].columnquerystring搜索字段
like[0].likequerystring搜索字符
metquerystringnone
order[0].sidxquerystring排序字段
order[0].sortquerystring排序方式
pagequeryinteger分页查询页码
sidxquerystring排序字段
sizequeryinteger分页查询每页数量
sortquerystring排序方式
storeIdqueryinteger店铺编号
subsiteIdquerystring分站编号
userIdqueryinteger用户编号

返回示例

200 Response

{
  "code": 0,
  "data": {
    "items": [
      {
        "activity_addtime": "2019-08-24T14:15:22Z",
        "activity_endtime": 0,
        "activity_id": 0,
        "activity_is_finish": 0,
        "activity_name": "string",
        "activity_remark": "string",
        "activity_rule": "string",
        "activity_rule_json": {
          "cutPrice": {
            "cut_down_fixed_price": 0,
            "cut_down_max_price": 0,
            "cut_down_min_limit_price": 0,
            "cut_down_min_price": 0,
            "cut_down_type": 0,
            "cut_down_user_num": 0,
            "item_id": 0,
            "item_name": "string",
            "item_unit_price": 0,
            "product_image": "string"
          },
          "giftBag": {
            "activity_bag_category": "string",
            "activity_detail_intro": "string",
            "activity_video": "string",
            "giftbag_amount": 0,
            "giftbag_image": "string",
            "giftbag_quantity": 0,
            "giftbag_zu_image": "string",
            "transport_type_id": 0
          },
          "groupBooking": {
            "group_fixed_amount": 0
          },
          "groupBuyStore": {
            "group_buy_limit": 0,
            "group_quantity": 0,
            "group_sale_price": 0,
            "group_sale_quantity": 0,
            "product_id": 0,
            "product_image": "string",
            "product_unit_price": 0
          },
          "lottery": {
            "lottery_award": "string",
            "lottery_awards_times": 0,
            "lottery_day_times": 0,
            "lottery_image": "string",
            "lottery_max_awards_times": 0,
            "lottery_not_awards_remark": "string",
            "lottery_probability": "string",
            "lottery_share_add_times": 0,
            "lottery_subtitle": "string",
            "lottery_type": 0,
            "lottery_used_times": 0
          },
          "marketing": {
            "activity_address": "string",
            "activity_co_sponsor": "string",
            "activity_detail_intro": "string",
            "activity_image": "string",
            "activity_process": "string",
            "activity_sponsor": "string",
            "contact_organizer": "string",
            "contact_phone": 0,
            "end_join_time": 0,
            "guest_image": "string",
            "start_join_time": 0
          },
          "popUp": {
            "pop_up_image": "string",
            "pop_up_type": 0,
            "pop_up_url": "string"
          },
          "requirement": {
            "buy": {
              "item": [
                0
              ],
              "subtotal": 0
            },
            "points": {
              "needed": 0
            }
          },
          "rule": [
            {
              "item": [
                0
              ],
              "max_num": 0,
              "points_double": 0,
              "points_standard": 0,
              "total": 0
            }
          ],
          "voucher": {
            "voucher_end_date": 0,
            "voucher_image": "string",
            "voucher_pre_quantity": 0,
            "voucher_price": 0,
            "voucher_product_limit": 0,
            "voucher_quantity": 0,
            "voucher_quantity_free": 0,
            "voucher_quantity_use": 0,
            "voucher_start_date": 0
          }
        },
        "activity_sort": 0,
        "activity_starttime": 0,
        "activity_state": 0,
        "activity_title": "string",
        "activity_type": 0,
        "activity_type_id": 0,
        "activity_use_level": "string",
        "activity_use_level_name": "string",
        "if_gain": false,
        "item": [
          {
            "activity_id": 0,
            "activity_info": {
              "activity_base": {
                "activity_addtime": "2019-08-24T14:15:22Z",
                "activity_endtime": 0,
                "activity_id": 0,
                "activity_is_finish": 0,
                "activity_name": "string",
                "activity_remark": "string",
                "activity_rule": "string",
                "activity_sort": 0,
                "activity_starttime": 0,
                "activity_state": 0,
                "activity_title": "string",
                "activity_type": 0,
                "activity_type_id": 0,
                "activity_use_level": "string",
                "store_id": 0,
                "subsite_id": "string",
                "user_id": 0
              },
              "activity_id": 0,
              "activity_item_endtime": 0,
              "activity_item_id": 0,
              "activity_item_min_quantity": 0,
              "activity_item_price": 0,
              "activity_item_recommend": false,
              "activity_item_starttime": 0,
              "activity_item_state": 0,
              "activity_type_id": 0,
              "category_id": 0,
              "item_id": 0,
              "product_id": 0,
              "store_id": 0
            },
            "available_quantity": 0,
            "cart_id": 0,
            "cart_quantity": 0,
            "cart_select": false,
            "category_id": 0,
            "color_id": 0,
            "is_on_sale": false,
            "is_oos": false,
            "item_barcode": "string",
            "item_cost_price": 0,
            "item_discount_amount": 0,
            "item_enable": 0,
            "item_fx_commission": 0,
            "item_id": 0,
            "item_is_change": false,
            "item_is_default": false,
            "item_market_price": 0,
            "item_name": "string",
            "item_number": "string",
            "item_points_subtotal": 0,
            "item_policy_discountrate": 0,
            "item_quantity": 0,
            "item_quantity_frozen": 0,
            "item_rebate": 0,
            "item_reduction": 0,
            "item_sale_price": 0,
            "item_save_price": 0,
            "item_spec": "string",
            "item_src_id": 0,
            "item_subtotal": 0,
            "item_unit_points": 0,
            "item_unit_price": 0,
            "item_volume": 0,
            "item_voucher": 0,
            "item_warn_quantity": 0,
            "item_weight": 0,
            "kind_id": 0,
            "product_id": 0,
            "product_image": "string",
            "product_inventory_lock": 0,
            "product_item_name": "string",
            "product_name": "string",
            "product_state_id": 0,
            "product_tags": "string",
            "product_tips": "string",
            "pulse_bargains": [
              {}
            ],
            "pulse_bargains_cart": [
              {}
            ],
            "pulse_gift_cart": [
              {}
            ],
            "pulse_multple": [
              {}
            ],
            "pulse_reduction": [
              {}
            ],
            "spec_item_ids": "string",
            "store_id": 0,
            "transport_type_id": 0
          }
        ],
        "item_number": 0,
        "product_item_name": "string",
        "store_id": 0,
        "store_name": "string",
        "subsite_id": "string",
        "use_level": "string",
        "user_id": 0
      }
    ],
    "page": 0,
    "records": 0,
    "size": 0,
    "total": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new windowOKInline
401Unauthorizedopen in new windowUnauthorizedInline
403Forbiddenopen in new windowForbiddenInline
404Not Foundopen in new windowNot FoundInline

GET 活动表-优惠券列表

GET /front/marketing/activityBase/listVoucher

活动表-优惠券列表

请求参数

名称位置类型必选说明
activityEndtimequeryinteger活动结束时间
activityIdqueryinteger活动编号
activityIsFinishqueryinteger活动是否完成(ENUM):0-未完成;1-已完成;2-已解散(目前用于团购)
activityNamequerystring活动名称
activityRemarkquerystring活动说明
activitySortqueryinteger活动排序
activityStarttimequeryinteger活动开始时间
activityStatequeryinteger活动状态(ENUM):0-未开启;1-正常;2-已结束;3-管理员关闭;4-商家关闭
activityTitlequerystring活动标题
activityTypequeryinteger参与类型(ENUM):1-免费参与;2-积分参与;3-购买参与;4-分享参与
activityTypeIdqueryinteger活动类型
activityUseLevelquerystring使用等级(DOT)
createTimeEndquerystring创建时间结束值
createTimeStartquerystring创建时间起始值
like[0].columnquerystring搜索字段
like[0].likequerystring搜索字符
metquerystringnone
order[0].sidxquerystring排序字段
order[0].sortquerystring排序方式
pagequeryinteger分页查询页码
sidxquerystring排序字段
sizequeryinteger分页查询每页数量
sortquerystring排序方式
storeIdqueryinteger店铺编号
subsiteIdquerystring分站编号
userIdqueryinteger用户编号

返回示例

200 Response

{
  "code": 0,
  "data": {
    "items": [
      {
        "activity_addtime": "2019-08-24T14:15:22Z",
        "activity_endtime": 0,
        "activity_id": 0,
        "activity_is_finish": 0,
        "activity_name": "string",
        "activity_remark": "string",
        "activity_rule": "string",
        "activity_rule_json": {
          "cutPrice": {
            "cut_down_fixed_price": 0,
            "cut_down_max_price": 0,
            "cut_down_min_limit_price": 0,
            "cut_down_min_price": 0,
            "cut_down_type": 0,
            "cut_down_user_num": 0,
            "item_id": 0,
            "item_name": "string",
            "item_unit_price": 0,
            "product_image": "string"
          },
          "giftBag": {
            "activity_bag_category": "string",
            "activity_detail_intro": "string",
            "activity_video": "string",
            "giftbag_amount": 0,
            "giftbag_image": "string",
            "giftbag_quantity": 0,
            "giftbag_zu_image": "string",
            "transport_type_id": 0
          },
          "groupBooking": {
            "group_fixed_amount": 0
          },
          "groupBuyStore": {
            "group_buy_limit": 0,
            "group_quantity": 0,
            "group_sale_price": 0,
            "group_sale_quantity": 0,
            "product_id": 0,
            "product_image": "string",
            "product_unit_price": 0
          },
          "lottery": {
            "lottery_award": "string",
            "lottery_awards_times": 0,
            "lottery_day_times": 0,
            "lottery_image": "string",
            "lottery_max_awards_times": 0,
            "lottery_not_awards_remark": "string",
            "lottery_probability": "string",
            "lottery_share_add_times": 0,
            "lottery_subtitle": "string",
            "lottery_type": 0,
            "lottery_used_times": 0
          },
          "marketing": {
            "activity_address": "string",
            "activity_co_sponsor": "string",
            "activity_detail_intro": "string",
            "activity_image": "string",
            "activity_process": "string",
            "activity_sponsor": "string",
            "contact_organizer": "string",
            "contact_phone": 0,
            "end_join_time": 0,
            "guest_image": "string",
            "start_join_time": 0
          },
          "popUp": {
            "pop_up_image": "string",
            "pop_up_type": 0,
            "pop_up_url": "string"
          },
          "requirement": {
            "buy": {
              "item": [
                0
              ],
              "subtotal": 0
            },
            "points": {
              "needed": 0
            }
          },
          "rule": [
            {
              "item": [
                0
              ],
              "max_num": 0,
              "points_double": 0,
              "points_standard": 0,
              "total": 0
            }
          ],
          "voucher": {
            "voucher_end_date": 0,
            "voucher_image": "string",
            "voucher_pre_quantity": 0,
            "voucher_price": 0,
            "voucher_product_limit": 0,
            "voucher_quantity": 0,
            "voucher_quantity_free": 0,
            "voucher_quantity_use": 0,
            "voucher_start_date": 0
          }
        },
        "activity_sort": 0,
        "activity_starttime": 0,
        "activity_state": 0,
        "activity_title": "string",
        "activity_type": 0,
        "activity_type_id": 0,
        "activity_use_level": "string",
        "activity_use_level_name": "string",
        "if_gain": false,
        "item": [
          {
            "activity_id": 0,
            "activity_info": {
              "activity_base": {
                "activity_addtime": "2019-08-24T14:15:22Z",
                "activity_endtime": 0,
                "activity_id": 0,
                "activity_is_finish": 0,
                "activity_name": "string",
                "activity_remark": "string",
                "activity_rule": "string",
                "activity_sort": 0,
                "activity_starttime": 0,
                "activity_state": 0,
                "activity_title": "string",
                "activity_type": 0,
                "activity_type_id": 0,
                "activity_use_level": "string",
                "store_id": 0,
                "subsite_id": "string",
                "user_id": 0
              },
              "activity_id": 0,
              "activity_item_endtime": 0,
              "activity_item_id": 0,
              "activity_item_min_quantity": 0,
              "activity_item_price": 0,
              "activity_item_recommend": false,
              "activity_item_starttime": 0,
              "activity_item_state": 0,
              "activity_type_id": 0,
              "category_id": 0,
              "item_id": 0,
              "product_id": 0,
              "store_id": 0
            },
            "available_quantity": 0,
            "cart_id": 0,
            "cart_quantity": 0,
            "cart_select": false,
            "category_id": 0,
            "color_id": 0,
            "is_on_sale": false,
            "is_oos": false,
            "item_barcode": "string",
            "item_cost_price": 0,
            "item_discount_amount": 0,
            "item_enable": 0,
            "item_fx_commission": 0,
            "item_id": 0,
            "item_is_change": false,
            "item_is_default": false,
            "item_market_price": 0,
            "item_name": "string",
            "item_number": "string",
            "item_points_subtotal": 0,
            "item_policy_discountrate": 0,
            "item_quantity": 0,
            "item_quantity_frozen": 0,
            "item_rebate": 0,
            "item_reduction": 0,
            "item_sale_price": 0,
            "item_save_price": 0,
            "item_spec": "string",
            "item_src_id": 0,
            "item_subtotal": 0,
            "item_unit_points": 0,
            "item_unit_price": 0,
            "item_volume": 0,
            "item_voucher": 0,
            "item_warn_quantity": 0,
            "item_weight": 0,
            "kind_id": 0,
            "product_id": 0,
            "product_image": "string",
            "product_inventory_lock": 0,
            "product_item_name": "string",
            "product_name": "string",
            "product_state_id": 0,
            "product_tags": "string",
            "product_tips": "string",
            "pulse_bargains": [
              {}
            ],
            "pulse_bargains_cart": [
              {}
            ],
            "pulse_gift_cart": [
              {}
            ],
            "pulse_multple": [
              {}
            ],
            "pulse_reduction": [
              {}
            ],
            "spec_item_ids": "string",
            "store_id": 0,
            "transport_type_id": 0
          }
        ],
        "item_number": 0,
        "product_item_name": "string",
        "store_id": 0,
        "store_name": "string",
        "subsite_id": "string",
        "use_level": "string",
        "user_id": 0
      }
    ],
    "page": 0,
    "records": 0,
    "size": 0,
    "total": 0
  },
  "error": "string",
  "msg": "string",
  "status": 0
}

返回结果

状态码状态码含义说明数据模型
200OKopen in new windowOKInline
401Unauthorizedopen in new windowUnauthorizedInline
403Forbiddenopen in new windowForbiddenInline
404Not Foundopen in new windowNot FoundInline