Getting Started

Get started with PriceRules

Set up your workspace, import your pricing data, and make your first price resolution request in a few steps.

Quick start

The fastest path from an empty workspace to your first resolved price.

01Create your workspace

Your workspace is the central place where your products, customers, pricing rules, API keys, and usage are managed.

02Import your data

Upload your products, customers, and pricing rules using CSV imports.

03Create an API key

Generate an API key from your workspace settings so your application can authenticate with PriceRules.

04Resolve a price

Send a product and customer request to the pricing API and receive the calculated price.

Setup

Five steps to your first request

You can complete the initial setup entirely from the PriceRules dashboard.

Step 01

Create your workspace

Your workspace is the central place where your products, customers, pricing rules, API keys, and usage are managed.

Step 02

Import your data

Upload your products, customers, and pricing rules using CSV imports.

View import schema
Step 03

Create an API key

Generate an API key from your workspace settings so your application can authenticate with PriceRules.

API keys are sensitive credentials.

Store them securely and never expose them in browser-side code.
Step 04

Resolve a price

Send a product and customer request to the pricing API and receive the calculated price.

Step 05

Integrate PriceRules

Connect the pricing endpoint to your ecommerce platform, ERP, application, or backend.

API

Make your first request

Once your product and customer exist, you can resolve a price through the API.

RequestcURLPOST /api/v1/pricing/resolve
curl -X POST https://pricerules.app/api/v1/pricing/resolve \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "CUST-001",
    "products": [
      { "sku": "SKU-001", "quantity": 10 }
    ]
  }'

Replace YOUR_API_KEY with an API key from your workspace.

ResponseJSON200 OK
{
  "mode": "business",
  "success": true,
  "data": {
    "customer_id": "CUST-001",
    "items": [
      {
        "sku": "SKU-001",
        "base_price": 100,
        "quantity": 10,
        "final_price": 90,
        "applied_rule": {
          "id": "0d338b61-8862-494c-a6fb-6fba93c3ec84",
          "name": "CUST-001 10% off",
          "type": "discount",
          "value": 10,
          "constraints": { "minimum_quantity": null }
        },
        "match_reason": "MOST_SPECIFIC_RULE",
        "pricing_summary": {
          "savings": 10,
          "message": "Customer saved 10.00 due to active pricing rules"
        }
      }
    ]
  },
  "billing": { "limit": 10000, "usage": 1, "remaining": 9999 },
  "meta": { "request_id": "req_…", "processing_ms": 12.4 }
}

Understanding the response

The response tells your application how the final price was determined.

FieldDescription
base_priceThe original product price before pricing rules.
final_priceThe price returned after applicable pricing rules.
quantityThe quantity used during price resolution.
match_reasonIndicates why the returned price was selected.

What's next?

Once your first request works, these are the areas you'll use most.

Need help?

If you're having trouble with an import, API request, or pricing rule, check the relevant documentation section or contact support.