Rules API

The rules API provides information about surprise and delight and volume discounts that can be used to inform customers on the front end.

Fetch Rules API

get-rules-by-domain-or-hostname

get

get-rules-by-domain-or-hostname

Query parameters

domainstringOptionalExample: {{SHOP_NAME}}.myshopify.com

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /storefront-http/get-rules-by-domain-or-hostname HTTP/1.1
Host: api.skio.com
Accept: */*

200Success

{
  "rules": [
    {
      "id": "text",
      "type": "text",
      "name": "text",
      "data": {
        "discount": {
          "type": "text",
          "amount": 1
        },
        "startDate": "2025-05-07T20:00:22.797Z",
        "cycleToApply": 1,
        "enableABTesting": true,
        "variantToQuantity": {
          "ANY_ADDITIONAL_PROPERTY": 1
        },
        "abTestingPercentage": 1
      }
    }
  ]
}