折扣

优惠券

属性	说明	必填	类型
ID	优惠券ID	是	number
discount_type	优惠类型	是	string
name	优惠券名称	是	string
code	优惠码	是	String
status	优惠券状态	是	String
free_shipping	是否是免运费优惠券	是	string
coupon_amount	优惠金额	是	string
minimum_amount	最小优惠金额	是	string
usage_count	优惠券已使用次数	是	number
usage_limit	优惠券总共可以使用的次数	是	int
usage_limit_per_user	每个用户可以使用优惠券次数	是	int
auto_coupon	是否是自动优惠券	是	string
product_categories	指定商品分类优惠时设置分类ID	是	array
product_ids	指定商品优惠时设置商品ID	是	array
start_date	开始时间	是	string
end_date	结束时间	是	string
total_discount	总折扣	是	number
total_sales	总销售额	是	number
minimum_piece	最小件数	是	string
active	状态	是	string

获得价格规则列表

GET /openapi/2023-10/price_rules

Query Parameters

Name	Type	Description
filter[auto_coupon]*	string	是否自动
filter[display]*	string	是否使用extra优惠码
filter[display_status]*	string	是否开启extra优惠码
append*	string	追加字段
sort*	string	排序
filter[search]	string	目前可查询【优惠名称】
coupon_type	string	cart_discount 普通优惠(默认) step_discount 梯度优惠 buy_x_y_discount 满送优惠

200: OK 返回数据详情

{
    "data": [{
        "discount_type": "优惠类型",
        "ID": "优惠券ID",
        "name": "优惠券名称",
        "code": "优惠码",
        "status": "优惠券状态",
        "free_shipping": "是否是免运费优惠券",
        "coupon_amount": "优惠金额",
        "minimum_amount": "最小优惠金额",
        "usage_count": "优惠券已使用次数",
        "usage_limit": "优惠券总共可以使用的次数",
        "usage_limit_per_user": "每个用户可以使用优惠券次数",
        "auto_coupon": "是否是自动优惠券",
        "product_categories": "指定商品分类优惠时设置分类ID",
        "product_ids": "指定商品优惠时设置商品ID",
        "start_date": "开始时间",
        "end_date": "结束时间",
        "total_discount": "总折扣",
        "total_sales": "总销售额",
        "minimum_piece": "最小件数",
        "active": "状态"
    }],
    "links": {
        "first": "首页url",
        "last": "尾页url",
        "prev": "上一页url",
        "next": "下一页url"
    },
    "meta": {
        "current_page": "当前页码",
        "from": "当前页起始条数号",
        "last_page": "尾页页码",
        "path": "分页基本url",
        "per_page": "每页显示条数",
        "to": "当前页结束条数号",
        "total": "数据总数"
    }
}

创建价格规则

POST /openapi/2023-10/price_rules

Request Body

Name	Type	Description
discount_type*	string	优惠类
name*	string	优惠券名称
code*	string	优惠码，为空时自动优惠券
status*	string	优惠券状态
free_shipping*	string	是否是免运费优惠券
coupon_amount*	string	优惠金额
minimum_amount*	string	最小优惠金额
usage_limit*	int	优惠券总共可以使用的次数
usage_limit_per_user*	int	每个用户可以使用优惠券次数
auto_coupon*	string	是否是自动优惠券
product_categories*	array	指定商品分类优惠时设置分类ID
product_ids*	array	指定商品优惠时设置商品ID
start_date*	string	开始时间
end_date*	string	结束时间
total_discount*	number	总折扣
total_sales*	number	总销售额
minimum_piece*	string	最小件数
coupon_type	string	cart_discount 普通优惠(默认) step_discount 梯度优惠 buy_x_y_discount 满送优惠

获得指定id详情

GET /openapi/2023-10/price_rules/{price_rule_id}

Query Parameters

Name	Type	Description
price_rule_id*	int	Id
coupon_type	string	cart_discount 普通优惠(默认) step_discount 梯度优惠 buy_x_get_y_discount 满送优惠

更新指定价格规则

PUT /openapi/2023-10/price_rules/{price_rule_id}

Query Parameters

Name	Type	Description
price_rule_id*	int	ID

Request Body

Name	Type	Description
discount_type	string	优惠类型
name	string	优惠券名称
code	string	优惠码
status	string	优惠券状态
free_shipping	string	是否是免运费优惠券
coupon_amount	string	优惠金额
minimum_amount	string	最小优惠金额
usage_limit_per_user	int	每个用户可以使用优惠券次数
auto_coupon	string	是否是自动优惠券
product_categories	array	指定商品分类优惠时设置分类ID
product_ids	array	指定商品优惠时设置商品ID
start_date	string	开始时间
end_date	string	结束时间
minimum_piece	string	结束时间
coupon_type	string	cart_discount 普通优惠(默认) step_discount 梯度优惠 buy_x_y_discount 满送优惠

200: OK 返回数据详情

{
    "discount_type": "优惠类型",
    "ID": "优惠券ID",
    "name": "优惠券名称",
    "code": "优惠码",
    "status": "优惠券状态",
    "free_shipping": "是否是免运费优惠券",
    "coupon_amount": "优惠金额",
    "minimum_amount": "最小优惠金额",
    "usage_count": "优惠券已使用次数",
    "usage_limit": "优惠券总共可以使用的次数",
    "usage_limit_per_user": "每个用户可以使用优惠券次数",
    "auto_coupon": "是否是自动优惠券",
    "product_categories": "指定商品分类优惠时设置分类ID",
    "product_ids": "指定商品优惠时设置商品ID",
    "start_date": "开始时间",
    "end_date": "结束时间",
    "total_discount": "总折扣",
    "total_sales": "总销售额",
    "minimum_piece": "最小件数",
    "active": "状态"
}

删除指定价格规则

DELETE /openapi/2023-10/price_rules/{price_rule_id}

Query Parameters

Name	Type	Description
price_rule_id*	int	ID

Headers

Name	Type	Description
Accept*	String
Authorization*	String
coupon_type	String	cart_discount 普通优惠(默认) step_discount 梯度优惠 buy_x_y_discount 满送优惠