Get Price Rule Count

Retrieves the total number of price rules available in your store.

🔒

Requires price_rules access scope. More access scope

The Price Rule Count API retrieves the total number of price rules available in your store.

This API is especially useful for:

  1. Checking the total number of active and inactive price rules in your store.
  2. Providing a quick overview of discount rules without retrieving their details.
  3. Integrating the count with dashboards or reports for summary analytics.

Request Parameters

Public Request Parameters

📘

Response Explanation

Public Response Parameters

📘

Successful Response

ParameterTypeExampleDescription
codestring200Error code (200 indicates success)
messagestringSuccessError message
dataobject{...}Contains the price rules data
data.countint32Total number of price rules.22

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!