创建价格规则

需要 write_discounts 权限点。

更多权限点使用信息,请参考:

[]

访问权限

POST https://{handle}.myshopline.com/admin/openapi/v20250601/sales/price_rules.json

[]

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

[]

创建折扣码规则

请求头

Content-Type required
[]
字段值固定为application/json; charset=utf-8
Authorization string required
[]
资源的访问令牌。请参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

请求体

price_ruleobject
[]
折扣码规则
allocation_limit integer
[]
买X得Y时，符合条件情况下可以在购物车内累计分配优惠次数的限制，例如：满1件X得1件Y的折扣方，设置allocation_limit=2，当购物车有3件X商品，3件Y商品时，仅可获得2件Y商品
[]
Example: 2
allocation_method string
[]
价格规则的分配方法, 可接受的值有 ● each 折扣适用于每个参与活动商品。例如，对于优惠 15 美元的价格规则，结账时每个有资格的商品都将优惠 15 美元，此时优惠总额等于15美元乘以商品个数。● across 计算的折扣金额将应用于整个有资格的商品。例如，对于优惠 15 美元的价格规则，折扣将分摊至每个参与活动的商品上，此时优惠总额等于15美元。当target_type值为shipping_line时，allocation_method必须为each。默认值为across
[]
Example: across
ends_at string
[]
结束时间 ● 默认值为空 ● 如果不填则认定为没有结束时间，优惠规则无限期 ● 日期处理方式同上
[]
Example: 2023-08-10T11:00:00+08:00
entitled_collection_ids array
[]
指定分类id 数组 ● 如果target_selection为entitled，则entitled_product_ids、entitled_collection_ids, entitled_variant_ids三选一必须有值 ● entitled_product_ids、entitled_collection_ids, entitled_variant_ids三个字段互斥，只可有一个字段有值
[]
Example: 12259764246208273857373144
entitled_country_ids array
[]
国家/区域id，可接受多个
[]
Example: "HK","TW","SG"
entitled_product_ids array
[]
指定商品id数组 ● 如果target_selection为entitled，则entitled_product_ids、entitled_collection_ids，entitled_variant_ids三选一必须有值 ● entitled_product_ids、entitled_collection_ids, entitled_variant_ids三个字段互斥，只可有一个字段有值,买X得Y时，表示Y商品ID列表
[]
Example: 16059766321245219059003144
entitled_variant_idsobject[]
[]
指定款式数组 ● 如果target_selection为entitled，则entitled_product_ids、entitled_collection_ids, entitled_variant_ids三选一必须有值 ● entitled_product_ids、entitled_collection_ids, entitled_variant_ids三个字段互斥，只可有一个字段有值 ● 买X得Y时，表示Y商品款式列表
product_id string
[]
商品id
[]
Example: 16059766321245219059003144
variant_id string
[]
款式id
[]
Example: 18059766321249077818743144
joint_discount boolean
[]
是否叠加自动优惠，默认值为false
joint_discount_order boolean
[]
叠加优惠-自动优惠-订单折扣
[]
Example: true
joint_discount_product boolean
[]
叠加优惠-自动优惠-商品折扣
[]
Example: true
joint_discount_shipping boolean
[]
叠加优惠-自动优惠-运费折扣
[]
Example: true
overlay_discount_code boolean
[]
叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用
[]
Example: true
overlay_discount_code_order boolean
[]
叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用。订单折扣
[]
Example: true
overlay_discount_code_product boolean
[]
叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用。商品折扣
[]
Example: true
overlay_discount_code_shipping boolean
[]
叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用。运费折扣
[]
Example: true
prerequisite_collection_ids array
[]
买X得Y时，X商品的分类Id列表，与prerequisite_product_ids，prerequisite_variant_ids不能同时使用
[]
Example: 12259764246208273857373144
prerequisite_customer_ids array
[]
先决条件：客户必须属于由指定的客户保存的搜索之一(客户分组) requisite_saved_search_ids，或者是由requisite_customer_ids 指定的客户之一。
[]
Example: 4216552768
prerequisite_product_ids array
[]
买X得Y时，买X得Y时，X商品Id列表，与prerequisite_collection_ids，prerequisite_variant_ids不会同时使用
[]
Example: 16059766321245219059003144
prerequisite_quantity_rangeobject
[]
优惠活动触发商品数量下限 ● prerequisite_quantity_range与 prerequisite_subtotal_range互斥 ● 若二者均为空则为无价格或数量的触发条件
greater_than_or_equal_to integer
[]
● 可为空 ● 必须>0 ● 只可接受整数（integer）
[]
Example: 5
prerequisite_saved_search_ids array
[]
先决条件：客户必须属于由指定的客户保存的搜索之一(客户分组) requisite_saved_search_ids，或者是由requisite_customer_ids 指定的客户之一。
[]
Example: MLC5302535370462201296
prerequisite_shipping_price_rangeobject
[]
运费必须小于或等于该值。 * 非必填，默认为空。 * 1）仅在target_type=shipping_line下才可以填写内容 * 2）数值，精度与店铺币种对应精度保持一致
less_than_or_equal_to string
[]
运费必须小于或等于该值。 * 非必填，默认为空。 * 1）仅在target_type=shipping_line下才可以填写内容 2）数值，精度与店铺币种对应精度保持一致
[]
Example: 50
prerequisite_subtotal_rangeobject
[]
优惠活动触发订单金额下限 ● prerequisite_quantity_range与 prerequisite_subtotal_range互斥 ● 若二者均为空则为无价格或数量的触发条件
greater_than_or_equal_to string
[]
● 可为空 ● 四舍五入保留到二位小数
[]
Example: 100
prerequisite_to_entitlement_purchaseobject
[]
买X得Y时，X商品需要满足的金额门槛
prerequisite_amount string
[]
X商品需要的金额门槛，与prerequisite_quantity不能同时使用
[]
Example: 100
prerequisite_to_entitlement_quantity_ratioobject
[]
买X得Y时，X商品需要的数量门槛及获得Y商品的数量
entitled_quantity integer
[]
满足1次门槛时获得Y商品的数量
[]
Example: 1
prerequisite_quantity integer
[]
满足1次门槛时需要的X商品的数量，与prerequisite_quantity不能同时使用
[]
Example: 1
prerequisite_variant_idsobject[]
[]
买X得Y时，X商品的款式id列表，与prerequisite_product_ids， prerequisite_collection_ids不会同时使用
product_id string
[]
商品Id
[]
Example: 16059766321245219059003144
variant_id string
[]
款式id
[]
Example: 18059766321249077818743144
sales_channels array
[]
销售渠道默认不传，则表示所有渠道可用；若传了指定销售渠道，则仅可在该渠道可用
[]
Example: shopper
starts_at string required
[]
规则开始时间
[]
Example: 2023-07-10T11:00:00+08:00
target_selection string
[]
优惠规则应用范围，可接受的值有 ● all，定义为所有商品； ● entitled，定义为指定范围(指定商品/指定分类)当此字段获取entitled值时，entitled_product_ids和entitled_collection_ids两者二选一必须有值；当target_type=shipping_line时必须填all。默认值为all
[]
Example: all
target_type string
[]
价格规则适用的目标类型。有效值： line_item：价格规则适用于购物订单商品项。 shipping_line：价格规则适用于购物订单运费项。
[]
Example: line_itme
title string required
[]
优惠规则的名称
[]
Example: This is title of price rule
usage_limit integer
[]
限制该优惠规则绑定的所有优惠码的可使用总次数 ● 如果不填，默认值为null或者空，指代无限制使用次数 ● 只可接受空、自然数； ● 超出上限值自动处理为上限值
[]
Example: 2
usage_per_customer integer
[]
限制每个顾客可以使用该price rule下每个code的次数 ● 如果不填，默认值为null或者空，指代无限制使用次数 ● 只可接受空、自然数； ● 超出上限值自动处理为上限值
[]
Example: 10
value string required
[]
优惠金额或者百分比，必须填负数 ● 如果value_type值是percentage，表示优惠百分比，四舍五入保留整数，例如：优惠10%，填10；● 如果value_type值是fixed_amount，表示优惠金额，单位是元，四舍五入保留两位小数，例如：优惠10.23元，填-10.23。必填字段
[]
Example: 20
value_type string required
[]
优惠类型，可接受的值有 ● percentage 百分比，当target_type=shipping_line时必须填percentage，买x送y类型活动必须填percentage； ● fixed_amount 固定金额；必填字段
[]
Example: percentage

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

traceId
[]
traceId

响应体

price_ruleobject
[]
折扣码规则
allocation_limit integer
[]
买X得Y时，符合条件情况下可以在购物车内累计分配优惠次数的限制，例如：满1件X得1件Y的折扣方，设置allocation_limit=2，当购物车有3件X商品，3件Y商品时，仅可获得2件Y商品
[]
Example: 2
allocation_method string
[]
价格规则的分配方法, 可接受的值有 ● each 折扣适用于每个参与活动商品。例如，对于优惠 15 美元的价格规则，结账时每个有资格的商品都将优惠 15 美元，此时优惠总额等于15美元乘以商品个数。● across 计算的折扣金额将应用于整个有资格的商品。例如，对于优惠 15 美元的价格规则，折扣将分摊至每个参与活动的商品上，此时优惠总额等于15美元。当target_type值为shipping_line时，allocation_method必须为each。默认值为across
[]
Example: across
create_at string
[]
创建时间
[]
Example: 2023-07-10T11:00:00+08:00
ends_at string
[]
结束时间 ● 默认值为空 ● 如果不填则认定为没有结束时间，优惠规则无限期 ● 日期处理方式同上
[]
Example: 2023-08-10T11:00:00+08:00
entitled_collection_ids array
[]
指定分类id 数组 ● 如果target_selection为entitled，则entitled_product_ids、entitled_collection_ids, entitled_variant_ids三选一必须有值 ● entitled_product_ids、entitled_collection_ids, entitled_variant_ids三个字段互斥，只可有一个字段有值
[]
Example: 12259764246208273857373144
entitled_country_ids array
[]
国家/区域id数组，暂时无用
[]
Example: "HK","TW","SG"
entitled_product_ids array
[]
指定商品id 数组 ● 如果target_selection为entitled，则entitled_product_ids、entitled_collection_ids，entitled_variant_ids三选一必须有值 ● entitled_product_ids、entitled_collection_ids, entitled_variant_ids三个字段互斥，只可有一个字段有值,买X得Y时，表示Y商品ID列表
[]
Example: 16059766321245219059003144
entitled_variant_idsobject[]
[]
指定款式数组 ● 如果target_selection为entitled，则entitled_product_ids、entitled_collection_ids, entitled_variant_ids三选一必须有值 ● entitled_product_ids、entitled_collection_ids, entitled_variant_ids三个字段互斥，只可有一个字段有值 ● 买X得Y时，表示Y商品款式列表
product_id string
[]
商品id
[]
Example: 16059766321245219059003144
variant_id string
[]
款式id
[]
Example: 18059766321249077818743144
id string
[]
折扣码规则id
[]
Example: 6018695669979551970
joint_discount boolean
[]
是否叠加自动优惠，默认值为false
joint_discount_order boolean
[]
叠加优惠-自动优惠-订单折扣
[]
Example: true
joint_discount_product boolean
[]
叠加优惠-自动优惠-商品折扣
[]
Example: true
joint_discount_shipping boolean
[]
叠加优惠-自动优惠-运费折扣
[]
Example: true
overlay_discount_code boolean
[]
叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用
[]
Example: true
overlay_discount_code_order boolean
[]
叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用。订单折扣
[]
Example: true
overlay_discount_code_product boolean
[]
叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用。商品折扣
[]
Example: true
overlay_discount_code_shipping boolean
[]
叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用。运费折扣
[]
Example: true
prerequisite_collection_ids array
[]
买X得Y时，买X得Y时，X商品Id列表，与prerequisite_collection_ids，prerequisite_variant_ids不会同时使用
[]
Example: 12259764246208273857373144
prerequisite_customer_ids array
[]
先决条件：客户必须属于由指定的客户保存的搜索之一(客户分组) requisite_saved_search_ids，或者是由requisite_customer_ids 指定的客户之一。
[]
Example: 4216552768
prerequisite_product_ids array
[]
买X得Y时，X商品的分类Id列表，与prerequisite_product_ids，prerequisite_variant_ids不能同时使用
[]
Example: 16059766321245219059003144
prerequisite_quantity_rangeobject
[]
优惠活动触发商品数量下限 ● prerequisite_quantity_range与 prerequisite_subtotal_range互斥 ● 若二者均为空则为无价格或数量的触发条件
greater_than_or_equal_to integer
[]
● 可为空 ● 必须>0 ● 只可接受整数（integer）
[]
Example: 5
prerequisite_saved_search_ids array
[]
先决条件：客户必须属于由指定的客户保存的搜索之一(客户分组) requisite_saved_search_ids，或者是由requisite_customer_ids 指定的客户之一。
[]
Example: MLC5302535370462201296
prerequisite_shipping_price_rangeobject
[]
运费必须小于或等于该值。 * 非必填，默认为空。 * 1）仅在target_type=shipping_line下才可以填写内容 * 2）数值，精度与店铺币种对应精度保持一致
less_than_or_equal_to string
[]
运费必须小于或等于该值。 * 非必填，默认为空。 * 1）仅在target_type=shipping_line下才可以填写内容 2）数值，精度与店铺币种对应精度保持一致
[]
Example: 50
prerequisite_subtotal_rangeobject
[]
优惠活动触发订单金额下限 ● prerequisite_quantity_range与 prerequisite_subtotal_range互斥 ● 若二者均为空则为无价格或数量的触发条件
greater_than_or_equal_to string
[]
● 可为空 ● 四舍五入保留到二位小数
[]
Example: 100
prerequisite_to_entitlement_purchaseobject
[]
买X得Y时，X商品需要满足的金额门槛
prerequisite_amount string
[]
X商品需要的金额门槛，与prerequisite_quantity不能同时使用
[]
Example: 100
prerequisite_to_entitlement_quantity_ratioobject
[]
买X得Y时，X商品需要的数量门槛及获得Y商品的数量
entitled_quantity integer
[]
满足1次门槛时获得Y商品的数量
[]
Example: 1
prerequisite_quantity integer
[]
满足1次门槛时需要的X商品的数量，与prerequisite_quantity不能同时使用
[]
Example: 1
prerequisite_variant_idsobject[]
[]
买X得Y时，X商品的款式id列表，与prerequisite_product_ids， prerequisite_collection_ids不会同时使用
product_id string
[]
商品id
[]
Example: 16059766321245219059003144
variant_id string
[]
款式id
[]
Example: 18059766321249077818743144
sales_channels array
[]
此处需要返回当前折扣活动已选的渠道进行实际返回
[]
Example: web
starts_at string
[]
折扣码规则开始时间
[]
Example: 2023-07-10T11:00:00+08:00
target_selection string
[]
优惠规则应用范围，可接受的值有 ● all，定义为所有商品； ● entitled，定义为指定范围(指定商品/指定分类) 当此字段获取entitled值时，entitled_product_ids和entitled_collection_ids两者二选一必须有值；● explicit，定义为单个商品，当target_type=shipping_line时必须填explicit。默认值为all
[]
Example: all
target_type string
[]
价格规则适用的目标类型。有效值： line_item：价格规则适用于购物订单商品项。 shipping_line：价格规则适用于购物订单运费项。
[]
Example: line_itme
title string
[]
折扣码规则名称
[]
Example: This is title of price rule
update_at string
[]
更新时间
[]
Example: 2023-07-10T11:00:00+08:00
usage_limit integer
[]
限制该优惠规则绑定的所有优惠码的可使用总次数 ● 如果不填，默认值为null或者空，指代无限制使用次数 ● 只可接受空、自然数； ● 超出上限值自动处理为上限值
[]
Example: 2
usage_per_customer integer
[]
限制单个顾客使用每个与该优惠规则绑定的优惠码的次数 ● 如果不填，默认值为null或者空，指代无限制使用次数 ● 只可接受空、自然数； ● 超出上限值自动处理为上限值
[]
Example: 10
value string
[]
优惠金额/百分比 ● 如果value_type值是percentage ○ 四舍五入，保留整数 ● 如果value_type值是fixed_amount ○ 四舍五入，保留两位小数
[]
Example: 20
value_type string
[]
优惠类型，可接受的值为 ● percentage ● fixed_amount
[]
Example: percentage

API Explorer

调试台

示例代码

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

Body

Body required

{
  "price_rule": {
    "allocation_limit": 2,
    "allocation_method": "across",
    "ends_at": "2023-08-10T11:00:00+08:00",
    "entitled_collection_ids": [
      "12259764246208273857373144"
    ],
    "entitled_country_ids": [
      "\"HK\",\"TW\",\"SG\""
    ],
    "entitled_product_ids": [
      "16059766321245219059003144"
    ],
    "entitled_variant_ids": [
      {
        "product_id": "16059766321245219059003144",
        "variant_id": "18059766321249077818743144"
      }
    ],
    "joint_discount": false,
    "joint_discount_order": true,
    "joint_discount_product": true,
    "joint_discount_shipping": true,
    "overlay_discount_code": true,
    "overlay_discount_code_order": true,
    "overlay_discount_code_product": true,
    "overlay_discount_code_shipping": true,
    "prerequisite_collection_ids": [
      "12259764246208273857373144"
    ],
    "prerequisite_customer_ids": [
      "4216552768"
    ],
    "prerequisite_product_ids": [
      "16059766321245219059003144"
    ],
    "prerequisite_quantity_range": {
      "greater_than_or_equal_to": 5
    },
    "prerequisite_saved_search_ids": [
      "MLC5302535370462201296"
    ],
    "prerequisite_shipping_price_range": {
      "less_than_or_equal_to": "50"
    },
    "prerequisite_subtotal_range": {
      "greater_than_or_equal_to": "100"
    },
    "prerequisite_to_entitlement_purchase": {
      "prerequisite_amount": "100"
    },
    "prerequisite_to_entitlement_quantity_ratio": {
      "entitled_quantity": 1,
      "prerequisite_quantity": 1
    },
    "prerequisite_variant_ids": [
      {
        "product_id": "16059766321245219059003144",
        "variant_id": "18059766321249077818743144"
      }
    ],
    "sales_channels": [
      "shopper"
    ],
    "starts_at": "2023-07-10T11:00:00+08:00",
    "target_selection": "all",
    "target_type": "line_itme",
    "title": "This is title of price rule",
    "usage_limit": 2,
    "usage_per_customer": 10,
    "value": "20",
    "value_type": "percentage"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/sales/price_rules.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json' \
     --data '
{
  "price_rule": {
    "allocation_limit": 2,
    "allocation_method": "across",
    "ends_at": "2023-08-10T11:00:00+08:00",
    "entitled_collection_ids": [
      "12259764246208273857373144"
    ],
    "entitled_country_ids": [
      "\"HK\",\"TW\",\"SG\""
    ],
    "entitled_product_ids": [
      "16059766321245219059003144"
    ],
    "entitled_variant_ids": [
      {
        "product_id": "16059766321245219059003144",
        "variant_id": "18059766321249077818743144"
      }
    ],
    "joint_discount": false,
    "joint_discount_order": true,
    "joint_discount_product": true,
    "joint_discount_shipping": true,
    "overlay_discount_code": true,
    "overlay_discount_code_order": true,
    "overlay_discount_code_product": true,
    "overlay_discount_code_shipping": true,
    "prerequisite_collection_ids": [
      "12259764246208273857373144"
    ],
    "prerequisite_customer_ids": [
      "4216552768"
    ],
    "prerequisite_product_ids": [
      "16059766321245219059003144"
    ],
    "prerequisite_quantity_range": {
      "greater_than_or_equal_to": 5
    },
    "prerequisite_saved_search_ids": [
      "MLC5302535370462201296"
    ],
    "prerequisite_shipping_price_range": {
      "less_than_or_equal_to": "50"
    },
    "prerequisite_subtotal_range": {
      "greater_than_or_equal_to": "100"
    },
    "prerequisite_to_entitlement_purchase": {
      "prerequisite_amount": "100"
    },
    "prerequisite_to_entitlement_quantity_ratio": {
      "entitled_quantity": 1,
      "prerequisite_quantity": 1
    },
    "prerequisite_variant_ids": [
      {
        "product_id": "16059766321245219059003144",
        "variant_id": "18059766321249077818743144"
      }
    ],
    "sales_channels": [
      "shopper"
    ],
    "starts_at": "2023-07-10T11:00:00+08:00",
    "target_selection": "all",
    "target_type": "line_itme",
    "title": "This is title of price rule",
    "usage_limit": 2,
    "usage_per_customer": 10,
    "value": "20",
    "value_type": "percentage"
  }
}
'

这篇文章对你有帮助吗？

SHOPLINE

条款协议

Error loading component.