Retrieves a list of price rules

GET

/admin/api/{api_version}/price_rules.json

Retrieves a list of price rules. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Make paginated requests to the REST Admin API.

请求参数

Path 参数

api_version

string

必需

Query 参数

created_at_max

string

可选

Show price rules created before date (format 2017-03-25T16:15:47-04:00).

created_at_min

string

可选

Show price rules created after date (format 2017-03-25T16:15:47-04:00).

ends_at_max

string

可选

Show price rules ending before date (format 2017-03-25T16:15:47-04:00).

ends_at_min

string

可选

Show price rules ending after date (format 2017-03-25T16:15:47-04:00).

limit

string

可选

The maximum number of results to retrieve.

since_id

string

可选

Restrict results to after the specified ID.

starts_at_max

string

可选

Show price rules starting before date (format 2017-03-25T16:15:47-04:00).

starts_at_min

string

可选

Show price rules starting after date (format 2017-03-25T16:15:47-04:00).

times_used

string

可选

Show price rules with times used.

updated_at_max

string

可选

Show price rules last updated before date (format 2017-03-25T16:15:47-04:00).

updated_at_min

string

可选

Show price rules last updated after date (format 2017-03-25T16:15:47-04:00).

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200Retrieves a list of price rules

application/json

Body

price_rules

array[object (PriceRule) {29}]

可选

allocation_method

string

可选

The allocation method of the price rule. Valid values:

each: The discount is applied to each of the entitled items. For example, for a price rule that takes $15 o ff, e a c h e n t i tl e d l in e i t e mina c h ec k o u tw i ll b e d i sco u n t e d b y$ 15.
across: The calculated discount amount will be applied across the entitled items. For example, for a price rule
that takes $15 off, the discount will be applied across all the entitled items.

When the value of target_type is shipping_line, then this value must be each.

created_at

string

只读可选

The date and time (ISO 8601 format) when the price rule was created.

updated_at

string

只读可选

The date and time (ISO 8601 format) when the price rule was updated.

customer_selection

enum<string>

可选

The customer selection for the price rule.

枚举值:

allprerequisite

ends_at

string

可选

The date and time (ISO 8601 format) when the price rule ends. Must be after starts_at.

entitled_collection_ids

string

可选

A list of IDs of collections whose products will be eligible to the discount. It can be used only with
target_type set to line_item and target_selection set to entitled.
It can't be used in combination with entitled_product_ids or entitled_variant_ids.

示例值:

45646548698979761006

entitled_country_ids

string

可选

A list of IDs of shipping countries that will be entitled to the discount. It can be used only with target_type set to shipping_line and target_selection set to entitled.

entitled_product_ids

string

可选

A list of IDs of products that will be entitled to the discount. It can be used only with target_type set to line_item
and target_selection set to entitled.

If a product variant is included in entitled_variant_ids, then entitled_product_ids can't include the ID of the product associated with that variant.

示例值:

789739775542382368242

entitled_variant_ids

string

可选

A list of IDs of product variants that will be entitled to the discount. It can be used only with target_type set to line_item
and target_selection set to entitled.

If a product is included in entitled_product_ids, then entitled_variant_ids can't include the ID of any variants associated with that product.

示例值:

67987987985675765905

string

只读可选

The ID for the price rule.

once_per_customer

string

可选

Whether the generated discount code will be valid only for a single use per customer. This is tracked using customer ID.

prerequisite_customer_ids

string

可选

A list of customer IDs. For the price rule to be applicable, the customer must match one of the specified customers.

If prerequisite_customer_ids is populated, then customer_segment_prerequisite_ids must be empty.

示例值:

3840283490053492039843

prerequisite_quantity_range

string

可选

The minimum number of items for the price rule to be applicable. It has the following property:

greater_than_or_equal_to: The quantity of an entitled cart item must be greater than or equal to this value.

customer_segment_prerequisite_ids

string

可选

A list of customer segment IDs. For the price rule to be applicable, the customer must be in the group of customers matching a customer segment.

If customer_segment_prerequisite_ids is populated, then prerequisite_customer_ids must be empty.

示例值:

112234543243535360314

prerequisite_shipping_price_range

string

可选

The maximum shipping price for the price rule to be applicable. It has the following property:

less_than_or_equal_to: The shipping price must be less than or equal to this value.

prerequisite_subtotal_range

string

可选

The minimum subtotal for the price rule to be applicable. It has the following property:

greater_than_or_equal_to: The subtotal of the entitled cart items must be greater than or equal to this value for the discount to apply.

prerequisite_to_entitlement_purchase

string

可选

The prerequisite purchase for a Buy X Get Y discount. It has the following property:

prerequisite_amount: The minimum purchase amount required to be entitled to the discount.

starts_at

string

可选

The date and time (ISO 8601 format) when the price rule starts.

target_selection

enum<string>

可选

The target selection method of the price rule.

枚举值:

allentitled

target_type

enum<string>

可选

The target type that the price rule applies to.

枚举值:

line_itemshipping_line

title

string

可选

The title of the price rule. This is used by the Shopify admin search to retrieve discounts. It is also displayed on the Discounts page of the Shopify admin for bulk discounts.

For non-bulk discounts, the discount code is displayed on the admin.

For a consistent search experience, use the same value for title as the code property of the associated discount code.

usage_limit

string

可选

The maximum number of times the price rule can be used, per discount code.

prerequisite_product_ids

string

可选

List of product ids that will be a prerequisites for a Buy X Get Y type discount. The prerequisite_product_ids can be used only with:

target_type set to line_item,
target_selection set to entitled,
allocation_method set to each and
prerequisite_to_entitlement_quantity_ratio defined.

Caution

If a product variant is included in prerequisite_variant_ids, then prerequisite_product_ids can't include the ID of the product associated with that variant.

示例值:

789739775542382368242

prerequisite_variant_ids

string

可选

List of variant ids that will be a prerequisites for a Buy X Get Y type discount. The entitled_variant_ids can be used only with:

target_type set to line_item,
target_selection set to entitled,
allocation_method set to each and
prerequisite_to_entitlement_quantity_ratio defined.

Caution

If a product is included in prerequisite_product_ids, then prerequisite_variant_ids can't include the ID of any variants associated with that product.

示例值:

67987987985675765905

prerequisite_collection_ids

string

可选

List of collection ids that will be a prerequisites for a Buy X Get Y discount. The entitled_collection_ids can be used only with:

target_type set to line_item,
target_selection set to entitled,
allocation_method set to each and
prerequisite_to_entitlement_quantity_ratio defined.

Cannot be used in combination with prerequisite_product_ids or prerequisite_variant_ids.

示例值:

45646548698979761006

value

string

可选

The value of the price rule. If if the value of target_type is shipping_line, then only -100 is accepted.
The value must be negative.

value_type

enum<string>

可选

The value type of the price rule.

枚举值:

percentage

prerequisite_to_entitlement_quantity_ratio

string

可选

Buy/Get ratio for a Buy X Get Y discount. prerequisite_quantity defines the necessary 'buy' quantity and entitled_quantity the offered 'get' quantity.

The prerequisite_to_entitlement_quantity_ratio can be used only with:

value_type set to percentage,
target_type set to line_item,
target_selection set to entitled,
allocation_method set to each,
prerequisite_product_ids or prerequisite_variant_ids or prerequisite_collection_ids defined and
entitled_product_ids or entitled_variant_ids or entitled_collection_ids defined.

Caution

Cannot be used in combination with prerequisite_subtotal_range, prerequisite_quantity_range or prerequisite_shipping_price_range.

allocation_limit

string

可选

The number of times the discount can be allocated on the cart - if eligible. For example a Buy 1 hat Get 1 hat for free discount can be applied 3 times on a cart having more than 6 hats, where maximum of 3 hats get discounted - if the allocation_limit is 3. Empty (null) allocation_limit means unlimited number of allocations.

Caution

allocation_limit is only working with Buy X Get Y discount. The default value on creation will be null (unlimited).

示例

Retrieve all price rulesRetrieve all price rules after a specified ID

{
    "price_rules": [
        {
            "id": 507328175,
            "value_type": "fixed_amount",
            "value": "-10.0",
            "customer_selection": "all",
            "target_type": "line_item",
            "target_selection": "all",
            "allocation_method": "across",
            "allocation_limit": null,
            "once_per_customer": false,
            "usage_limit": null,
            "starts_at": "2022-12-28T12:05:09-05:00",
            "ends_at": "2023-01-09T12:05:09-05:00",
            "created_at": "2023-01-03T12:05:09-05:00",
            "updated_at": "2023-01-03T12:05:09-05:00",
            "entitled_product_ids": [],
            "entitled_variant_ids": [],
            "entitled_collection_ids": [],
            "entitled_country_ids": [],
            "prerequisite_product_ids": [],
            "prerequisite_variant_ids": [],
            "prerequisite_collection_ids": [],
            "prerequisite_saved_search_ids": [],
            "prerequisite_customer_ids": [],
            "prerequisite_subtotal_range": null,
            "prerequisite_quantity_range": null,
            "prerequisite_shipping_price_range": null,
            "prerequisite_to_entitlement_quantity_ratio": {
                "prerequisite_quantity": null,
                "entitled_quantity": null
            },
            "title": "SUMMERSALE10OFF",
            "admin_graphql_api_id": "gid://shopify/PriceRule/507328175"
        },
        {
            "id": 106886544,
            "value_type": "fixed_amount",
            "value": "-10.0",
            "customer_selection": "all",
            "target_type": "line_item",
            "target_selection": "all",
            "allocation_method": "across",
            "allocation_limit": null,
            "once_per_customer": false,
            "usage_limit": null,
            "starts_at": "2023-01-01T12:05:09-05:00",
            "ends_at": "2023-01-05T12:05:09-05:00",
            "created_at": "2023-01-03T12:05:09-05:00",
            "updated_at": "2023-01-03T12:05:09-05:00",
            "entitled_product_ids": [],
            "entitled_variant_ids": [],
            "entitled_collection_ids": [],
            "entitled_country_ids": [],
            "prerequisite_product_ids": [],
            "prerequisite_variant_ids": [],
            "prerequisite_collection_ids": [],
            "prerequisite_saved_search_ids": [],
            "prerequisite_customer_ids": [],
            "prerequisite_subtotal_range": null,
            "prerequisite_quantity_range": null,
            "prerequisite_shipping_price_range": null,
            "prerequisite_to_entitlement_quantity_ratio": {
                "prerequisite_quantity": null,
                "entitled_quantity": null
            },
            "title": "TENOFF",
            "admin_graphql_api_id": "gid://shopify/PriceRule/106886544"
        }
    ]
}

修改于 2023-01-29 12:00:31

Creates a price rule

Updates an existing a price rule