查询单个折扣码活动规则

需要 read_price_rules 权限点。
更多权限点使用信息，请参考：
访问权限。
GET https://{handle}.myshopline.com/admin/openapi/v20260301/sales/price_rules/:price_rule_id.json
handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。
通过活动规则 ID 查询折扣码的活动规则信息。支持查询固定金额、百分比、买 X 送 Y、免运费折扣码活动规则。
路径参数
  • price_rule_id string required
    折扣码活动规则的唯一标识符 ID。
请求头
  • Content-Type string required
    字段值固定为 application/json; charset=utf-8。
  • Authorization string required
    资源的访问令牌。参考 应用授权 获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
    例子:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
状态码
更多状态码信息，参考 HTTP 状态码。
响应头
  • traceId
    请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。
响应体
  • price_ruleobject
    折扣码活动规则的信息。
  • allocation_limit string
    每个订单的最大使用次数。仅适用于买 X 送 Y 活动。 例子：有一个买 1 顶帽子送 1 顶帽子的活动，若 allocation_limit 为 3，当购物车内有超过 6 顶帽子时，该活动仅可被应用 3 次；若为 null，活动每笔订单不限制使用次数。
  • allocation_method string
    折扣活动规则的分配方法。有效枚举值包含：
    • each：折扣金额应用于每个参与活动的商品。例如，活动规则为优惠 20 美元，则结账时每个适用的商品都将各自优惠 20 美元。
    • across：折扣金额在所有参与活动的商品之间分摊。例如，活动规则为优惠 20 美元，折扣将分摊至每个适用的商品上，使得优惠总额等于 20 美元。
  • create_at string
    折扣码活动规则创建的日期和时间。
    格式：ISO 8601。
    例子: 2021-08-31T02:20:26+08:00
  • ends_at string
    折扣码活动规则结束的日期和时间。为 null 则活动没有结束时间。
    格式：ISO 8601。
    例子: 2023-08-31T02:20:26+08:00
  • entitled_collection_ids array
    折扣码活动规则适用的指定商品分类 ID 列表。活动为买 X 送 Y 时，表示 Y 商品的适用分类 ID 列表。
    最大个数限制：500
  • entitled_country_ids array
    折扣码活动规则适用的国家或地区列表。仅适用于免运费活动。为 null 时表示适用于所有国家地区。
    最大个数限制：500
    例子: ["\"HK\",\"TW\",\"SG\""]
  • entitled_product_ids array
    折扣码活动规则适用的指定商品 ID 列表。活动为买 X 送 Y 时，表示 Y 商品的适用商品 ID 列表。
    最大个数限制：500
  • entitled_variant_idsobject[]
    折扣码活动规则适用的商品款式 ID 列表。活动为买 X 送 Y 时，表示 Y 商品的适用商品款式 ID 列表。
    最大个数限制：500
  • product_id string
    商品 ID。
  • variant_id string
    商品款式 ID。
  • id string
    折扣码活动规则的唯一标识符 ID。
  • joint_discount boolean
    该活动规则是否叠加所有自动折扣。
    • true ：叠加所有自动折扣
    • false ：不叠加自动折扣
  • joint_discount_order boolean
    该活动规则是否叠加订单维度的自动折扣。
    • true ：叠加订单维度的自动折扣
    • false ：不叠加订单维度的自动折扣
  • joint_discount_product boolean
    该活动规则是否叠加商品维度的自动折扣。
    • true ：叠加商品维度的自动折扣
    • false ：不叠加商品维度的自动折扣
  • joint_discount_shipping boolean
    该活动规则是否叠加免运费自动折扣。
    • true ：叠加免运费自动折扣
    • false ：不叠加免运费自动折扣
  • overlay_discount_code boolean
    该活动规则是否叠加所有折扣码。
    • true ：叠加所有折扣码
    • false ：不叠加折扣码
  • overlay_discount_code_order boolean
    该活动规则是否叠加订单维度的折扣码活动。
    • true ：叠加订单维度的折扣码活动
    • false ：不叠加订单维度的折扣码活动
  • overlay_discount_code_product boolean
    该活动规则是否叠加商品维度的折扣码活动。
    • true ：叠加商品维度的折扣码活动
    • false ：不叠加商品维度的折扣码活动
  • overlay_discount_code_shipping boolean
    该活动规则是否叠加免运费折扣码活动。
    • true：叠加免运费的折扣码活动
    • false：不叠加免运费的折扣码活动
  • prerequisite_collection_ids array
    若该活动规则为买 X 送 Y，表示 X 商品的分类 ID 列表。
    最大个数限制：500
  • prerequisite_customer_ids array
    该活动规则适用客户的 ID 列表。
    最大个数限制：500
  • prerequisite_product_ids array
    若该活动规则为买 X 送 Y，表示 X 商品的商品 ID 列表。
    最大个数限制：500
  • prerequisite_quantity_rangeobject
    该活动规则应用的商品数量门槛。
  • greater_than_or_equal_to integer
    商品数量门槛。为 null 表示活动没有商品数量门槛。
  • prerequisite_saved_search_ids array
    该活动规则适用客户分组的 ID 列表。
    最大个数限制：500
  • prerequisite_shipping_price_rangeobject
    若该活动规则为免运费，表示免运费金额的上限。运费金额超过该上限时，不可应用免运费活动。
  • less_than_or_equal_to string
    可应用免运费的最高运费金额。
  • prerequisite_subtotal_rangeobject
    该活动规则应用的商品金额门槛。
  • greater_than_or_equal_to string
    商品金额门槛。
  • prerequisite_to_entitlement_purchaseobject
    若该活动规则为买 X 送 Y，表示活动应用所至少要购买的 X 商品的金额。
  • prerequisite_amount string
    X 商品的金额门槛。
  • prerequisite_to_entitlement_quantity_ratioobject
    若该活动规则为买 X 送 Y，表示活动应用所需要购买的 X 商品的数量门槛及可获得 Y 商品的数量。
  • entitled_quantity integer
    满足门槛时可获得 Y 商品的数量。
  • prerequisite_quantity integer
    X 商品的数量门槛。
  • prerequisite_variant_idsobject[]
    若该活动规则为买 X 送 Y，表示 X 商品的商品款式 ID 列表。
    最大个数限制：500
  • product_id string
    商品 ID。
  • variant_id string
    商品款式 ID。
  • recurring_cycle_limit integer
    可应用折扣的订阅期数。此字段仅适用于以下类型的优惠活动：订单折扣码、商品折扣码、免运费折扣码。 例如：若为 3，则折扣将应用于订阅的前三个周期；若为 1，则仅应用于订阅的首笔订单；若为 -1，则表示折扣将应用于该订阅的所有后续定期付款。
    例子: -1
  • sales_channels array
    该活动规则适用的销售渠道。为 all 时表示当前活动适用于所有销售渠道。当前活动仅在指定销售渠道可用时，sales_channels 返回指定渠道。
    例子: ["web"]
  • starts_at string
    活动规则开始的日期和时间。
    格式：ISO 8601。
    例子: 2021-08-31T02:20:26+08:00
  • target_selection string
    活动规则的指定生效范围。有效枚举值包含：
    • all: 所有商品均可参与
    • entitled: 仅指定商品参与
  • target_type string
    活动规则适用的目标类型。有效枚举值包含：
    • line_item ：商品项
    • shipping_line ：运费项
  • title string
    活动规则的名称，用于展示给用户。
  • update_at string
    活动规则更新的日期和时间。
    格式：ISO 8601。
    例子: 2021-08-31T02:20:26+08:00
  • usage_limit integer
    该活动规则的折扣码总共可使用的最大次数。为 null 时该活动总共可使用次数无上限。
  • usage_per_customer integer
    对于该活动规则的每个折扣码，每位客户可使用的最大次数。为 null 表示不限制。
  • value string
    该活动规则的优惠值。 如果 value_type 是 percentage，value 表示百分比的数值； 如果 value_type 是 fixed_amount，value 表示优惠的金额数值。
  • value_type string
    该活动规则的优惠类型。有效枚举值包含：
    • percentage ：百分比优惠，指客户可以享受百分比折扣。
    • fixed_amount ：固定金额优惠，指客户可以享受满减折扣。
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— path required
— header required

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/sales/price_rules/price_rule_id.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_rule": {
    "allocation_method": "across",
    "create_at": "2023-07-12T01:25:37+08:00",
    "entitled_country_ids": [],
    "id": "6019132058521049481",
    "joint_discount": false,
    "joint_discount_order": false,
    "joint_discount_product": false,
    "joint_discount_shipping": false,
    "overlay_discount_code": false,
    "overlay_discount_code_order": false,
    "overlay_discount_code_product": false,
    "overlay_discount_code_shipping": false,
    "prerequisite_subtotal_range": {
      "greater_than_or_equal_to": "100.00"
    },
    "sales_channels": [
      "all"
    ],
    "starts_at": "2023-07-12T01:25:37+08:00",
    "target_selection": "all",
    "target_type": "line_item",
    "title": "Affiliate Distribution: Basic discount",
    "update_at": "2023-07-12T01:25:37+08:00",
    "value": "5",
    "value_type": "percentage"
  }
}
这篇文章对你有帮助吗？
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
条款协议
隐私
条款
开发者协议
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.