latestSwagger 2.0ShopBase Dev 1.02026-08-10153268547.4 KB

353ccde6240d

DiscountCode

Retrieve a list of price rules

Retrieve a list of price rules

get/admin/price_rules.json

Request body

created_at_maxinteger
created_at_mininteger
ends_at_maxinteger
ends_at_mininteger
fieldsstring[]
filterstring
idsinteger[]
ignore_idinteger
limitinteger
no_prerequisiteboolean
pageinteger
shop_idinteger
since_idinteger
sort_bystring
starts_at_maxinteger
starts_at_mininteger
target_selectionstring
times_usedinteger
titlestring
typestring
updated_at_maxinteger
updated_at_mininteger

Response

OK

Example response

{
  "price_rules": [
    {
      "created_at": "2019-03-14T16:09:54-04:00",
      "customer_selection": "prerequisite",
      "ends_at": "2019-07-19T17:59:10Z",
      "entitled_collection_ids": [
        4564654869,
        8979761006
      ],
      "entitled_country_ids": [
        6798798798,
        5675765905
      ],
      "entitled_product_ids": [
        7897397755,
        42382368242
      ],
      "id": 9808080986,
      "once_per_customer": true,
      "prerequisite_collection_ids": [
        384028349005,
        3492039843
      ],
      "prerequisite_customer_ids": [
        384028349005,
        3492039843
      ],
      "prerequisite_emails": [
        "hoaipiu@gmail.com",
        "tieumapmap@gmail.com",
        "traxanh@mtp.com"
      ],
      "prerequisite_quantity_range": {
        "greater_than_or_equal_to": 50
      },
      "prerequisite_shipping_price_range": {
        "less_than_or_equal_to": 10
      },
      "prerequisite_subtotal_range": {
        "greater_than_or_equal_to": 40
      },
      "prerequisite_variant_ids": [
        384028349005,
        3492039843
      ],
      "starts_at": "2019-04-19T17:59:10Z",
      "target_selection": "entitled",
      "target_type": "line_item",
      "title": "SUMMERSALE10OFF",
      "updated_at": "2019-03-14T16:09:54-04:00",
      "usage_limit": 10,
      "value": -60,
      "value_type": "fixed_amount"
    }
  ]
}