检索价格规则列表

需要 read_discounts 权限点。
更多权限点使用信息，请参考：
访问权限。
GET https://{handle}.myshopline.com/admin/openapi/v20260301/sales/price_rules.json
handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。
分页查询priceRule
查询参数
  • created_at_max string
    例子: 2023-07-11T09:00:00+08:00
  • created_at_min string
    创建时间区间范围查询的最小值（create_at >= create_at_min）
    例子: 2023-07-10T09:00:00+08:00
  • ends_at_max string
    例子: 2023-07-11T09:00:00+08:00
  • ends_at_min string
    活动结束时间区间范围查询的最小值（end_at >= end_at_min）
    例子: 2023-07-10T09:00:00+08:00
  • limit string
    查询数量限制，默认50，不能超过1000
    例子: 50
  • page_info string
    分页查询的唯一标识，用于定位特定页面。
    该字段值需要在你已经查询完分页信息后，在该接口响应头中的 link 字段值中获取。例如，你获取到的 link 的值为 <https://{handle}.myshopline.com/admin/openapi/{version}/sales/price_rules.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" ，那么 page_info 的值为 eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 。
    关于更多如何使用分页信息，请参考 分页机制。
  • since_id string
    返回在某个id“之后”的折扣码规则
    例子: 6018703339935504723
  • starts_at_max string
    活动开始时间区间范围查询的最小值（start_at >= start_at_max）
    例子: 2023-07-11T09:00:00+08:00
  • starts_at_min string
    活动开始时间区间范围查询的最小值（start_at >= start_at_min）
    例子: 2023-07-10T09:00:00+08:00
  • times_used integer
    查询使用的次数为当前值的折扣码规则
    例子: 3
  • update_at_max string
    活动更新时间区间范围查询的最小值（update_at >= update_at_max）
    例子: 2023-07-11T09:00:00+08:00
  • update_at_min string
    活动更新时间区间范围查询的最小值（update_at >= update_at_min）
    例子: 2023-07-10T09:00:00+08:00
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8。
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
更多状态码信息，参考 HTTP 状态码。
响应头
  • link
    提供分页数据的 URL 链接。你可以获取该字段值中的 page_info 信息用于下一次分页请求中。
    当你请求的页面存在上一页或下一页的时候，该字段会被返回。关于更多如何使用分页信息，请参考 分页机制。
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。
响应体
  • price_rulesobject[]
    折扣码规则
  • prerequisite_customer_ids array
    指定客户 先决条件：客户必须属于由指定的客户保存的搜索之一(客户分组) requisite_saved_search_ids，或者是由requisite_customer_ids 指定的客户之一。
    例子: [""]
  • prerequisite_product_ids array
    买X得Y时，买X得Y时，X商品Id列表，与prerequisite_collection_ids，prerequisite_variant_ids不会同时使用
    例子: ["16059766321245219059003144"]
  • joint_discount_order boolean
    叠加优惠-自动优惠-订单折扣
    例子: true
  • usage_limit integer
    限制该优惠规则绑定的所有优惠码的可使用总次数 ● 如果不填，默认值为null或者空，指代无限制使用次数 ● 只可接受空、自然数； ● 超出上限值自动处理为上限值
    例子: 2
  • target_selection string
    优惠规则应用范围，可接受的值有 ● all，定义为所有商品； ● entitled，定义为指定范围(指定商品/指定分类)当此字段获取entitled值时，entitled_product_ids和entitled_collection_ids两者二选一必须有值；当target_type=shipping_line时必须填all。默认值为all
    例子: all
  • title string
    折扣码规则的名称
    例子: This is title of price rule
  • prerequisite_shipping_price_rangeobject
    运费必须小于或等于该值。 * 非必填，默认为空。 * 1）仅在target_type=shipping_line下才可以填写内容 * 2）数值，精度与店铺币种对应精度保持一致
  • less_than_or_equal_to string
    运费必须小于或等于该值。 * 非必填，默认为空。 * 1）仅在target_type=shipping_line下才可以填写内容 2）数值，精度与店铺币种对应精度保持一致
    例子: 50
  • starts_at string
    ● 采用ISO 8601时间制格式，标准制格式为 ○ 2021-10-20T09:59:10+08:00 ● 如果时区未传值，则认定为GMT标准时间
    例子: 2023-07-10T11:00:00+08:00
  • allocation_limit string
    买X得Y时，符合条件情况下可以在购物车内累计分配优惠次数的限制，例如：满1件X得1件Y的折扣方，设置allocation_limit=2，当购物车有3件X商品，3件Y商品时，仅可获得2件Y商品
    例子: 2
  • value string
    优惠金额或者百分比， ● 如果value_type值是percentage，表示优惠百分比，四舍五入保留整数，例如：优惠10%，填10；● 如果value_type值是fixed_amount，表示优惠金额，单位是元，四舍五入保留两位小数，例如：优惠10.23元，填-10.23。必填字段
    例子: 20
  • joint_discount boolean
    叠加优惠 ● 默认值为false
  • joint_discount_product boolean
    叠加优惠-自动优惠-商品折扣
    例子: true
  • prerequisite_variant_idsobject[]
    买X得Y时，X商品的款式id列表，与prerequisite_product_ids， prerequisite_collection_ids不会同时使用
  • product_id string
    商品id
    例子: 16059766321245219059003144
  • variant_id string
    款式id
    例子: 18059766321249077818743144
  • target_type string
    价格规则适用的目标类型。 有效值： line_item：价格规则适用于购物订单商品项。 shipping_line：价格规则适用于购物订单运费项。
    例子: line_itme
  • 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列表
    例子: ["16059766321245219059003144"]
  • prerequisite_saved_search_ids array
    指定客户组 先决条件：客户必须属于由指定的客户保存的搜索之一(客户分组) requisite_saved_search_ids，或者是由requisite_customer_ids 指定的客户之一。
    例子: [""]
  • overlay_discount_code_shipping boolean
    叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用。运费折扣
    例子: true
  • overlay_discount_code_order boolean
    叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用。订单折扣
    例子: true
  • prerequisite_to_entitlement_purchaseobject
    买X得Y时，X商品需要满足的金额门槛
  • prerequisite_amount string
    X商品需要的金额门槛，与prerequisite_quantity不能同时使用
    例子: 100
  • value_type string
    优惠类型，可接受的值有 ● percentage 百分比，当target_type=shipping_line时必须填percentage，买x送y类型活动必须填percentage； ● fixed_amount 固定金额；必填字段
    例子: percentage
  • joint_discount_shipping boolean
    叠加优惠-自动优惠-运费折扣
    例子: true
  • overlay_discount_code_product boolean
    叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用。商品折扣
    例子: true
  • 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商品款式列表
  • variant_id string
    款式id
    例子: 18059766321249077818743144
  • product_id string
    商品id
    例子: 16059766321245219059003144
  • overlay_discount_code boolean
    叠加优惠-折扣码优惠，允许使多个优惠码活动叠加优惠使用
  • entitled_country_ids array
    国家/区域id，可接受多个
    例子: ["\"HK\",\"TW\",\"SG\""]
  • create_at string
    创建时间
    例子: 2023-07-10T11:00:00+08:00
  • prerequisite_collection_ids array
    买X得Y时，X商品的分类Id列表，与prerequisite_product_ids，prerequisite_variant_ids不能同时使用
    例子: ["12259764246208273857373144"]
  • prerequisite_subtotal_rangeobject
    优惠活动触发订单金额下限 ● prerequisite_quantity_range与 prerequisite_subtotal_range互斥 ● 若二者均为空则为无价格或数量的触发条件
  • greater_than_or_equal_to string
    ● 可为空 ● 四舍五入保留到二位小数 例： ● 若传入11.116666，处理为11.12
    例子: 100
  • 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三个字段互斥，只可有一个字段有值
    例子: ["12259764246208273857373144"]
  • allocation_method string
    价格规则的分配方法, 可接受的值有 ● each 折扣适用于每个参与活动商品。例如，对于优惠 15 美元的价格规则，结账时每个有资格的商品都将优惠 15 美元，此时优惠总额等于15美元乘以商品个数。● across 计算的折扣金额将应用于整个有资格的商品。例如，对于优惠 15 美元的价格规则，折扣将分摊至每个参与活动的商品上，此时优惠总额等于15美元。 当target_type值为shipping_line时，allocation_method必须为each。默认值为across
    例子: across
  • update_at string
    更新时间
    例子: 2023-07-10T11:00:00+08:00
  • id string
    折扣码规则id
    例子: 6018695669979551970
  • usage_per_customer integer
    限制每个顾客可以使用该price rule下每个code的次数 ● 如果不填，默认值为null或者空，指代无限制使用次数 ● 只可接受空、自然数； ● 超出上限值自动处理为上限值
    例子: 10
  • prerequisite_to_entitlement_quantity_ratioobject
    买X得Y时，X商品需要的数量门槛及获得Y商品的数量
  • entitled_quantity integer
    满足1次门槛时获得Y商品的数量
    例子: 1
  • prerequisite_quantity integer
    满足1次门槛时需要的X商品的数量，与prerequisite_quantity不能同时使用
    例子: 1
  • prerequisite_quantity_rangeobject
    优惠活动触发商品数量下限 ● prerequisite_quantity_range与 prerequisite_subtotal_range互斥 ● 若二者均为空则为无价格或数量的触发条件
  • greater_than_or_equal_to integer
    ● 可为空 ● 必须>0 ● 只可接受整数（integer）
    例子: 5
  • ends_at string
    结束时间 ● 默认值为空 ● 如果不填则认定为没有结束时间，优惠规则无限期 ● 日期处理方式同上
    例子: 2023-08-10T11:00:00+08:00
  • sales_channels array
    销售渠道默认不传，则表示所有渠道可用；若传了指定销售渠道，则仅可在该渠道可用
    例子: ["web"]
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— header required
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query
— query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/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'
Examples
根据创建时间查询活动信息
Response
{
  "price_rules": [
    {
      "overlay_discount_code_order": false,
      "overlay_discount_code_shipping": false,
      "usage_per_customer": 1,
      "allocation_method": "across",
      "id": "6020626582653110393",
      "prerequisite_subtotal_range": {
        "greater_than_or_equal_to": "100.00"
      },
      "value_type": "fixed_amount",
      "joint_discount_shipping": false,
      "title": "This is title of price rule: fixed_amount",
      "usage_limit": 1,
      "joint_discount_product": false,
      "target_type": "line_item",
      "overlay_discount_code_product": false,
      "sales_channels": [
        "web"
      ],
      "entitled_country_ids": [],
      "joint_discount_order": false,
      "overlay_discount_code": false,
      "target_selection": "all",
      "update_at": "2023-07-13T02:10:17+08:00",
      "joint_discount": false,
      "starts_at": "2023-07-12T00:00:00+08:00",
      "value": "-10.00",
      "create_at": "2023-07-13T02:10:17+08:00"
    },
    {
      "sales_channels": [
        "all"
      ],
      "title": "This is title of price rule",
      "starts_at": "2023-07-10T11:00:00+08:00",
      "value_type": "percentage",
      "create_at": "2023-08-10T15:28:04+08:00",
      "joint_discount": true,
      "overlay_discount_code_product": true,
      "joint_discount_product": true,
      "prerequisite_subtotal_range": {
        "greater_than_or_equal_to": "100.00"
      },
      "target_selection": "all",
      "usage_limit": 10,
      "id": "6062017087609511417",
      "update_at": "2023-08-10T15:44:18+08:00",
      "usage_per_customer": 2,
      "overlay_discount_code": true,
      "overlay_discount_code_order": true,
      "overlay_discount_code_shipping": true,
      "joint_discount_order": true,
      "value": "10",
      "entitled_country_ids": [],
      "joint_discount_shipping": true,
      "allocation_method": "across",
      "target_type": "line_item",
      "ends_at": "2024-07-10T11:00:00+08:00"
    },
    {
      "joint_discount_shipping": false,
      "title": "This is title of price rule",
      "create_at": "2023-08-10T11:27:54+08:00",
      "usage_limit": 2,
      "ends_at": "2023-07-10T11:00:00+08:00",
      "joint_discount_product": false,
      "prerequisite_quantity_range": {
        "greater_than_or_equal_to": 5
      },
      "joint_discount_order": false,
      "sales_channels": [
        "all"
      ],
      "usage_per_customer": 10,
      "allocation_method": "across",
      "target_type": "line_item",
      "overlay_discount_code_shipping": true,
      "update_at": "2023-08-10T12:00:54+08:00",
      "overlay_discount_code": false,
      "overlay_discount_code_order": false,
      "target_selection": "all",
      "value_type": "percentage",
      "starts_at": "2023-07-10T11:00:00+08:00",
      "value": "20",
      "id": "SL201SAS06061775335241819244",
      "joint_discount": false,
      "overlay_discount_code_product": false,
      "entitled_country_ids": []
    }
  ]
}
这篇文章对你有帮助吗？
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.