Now in Beta: Multi-Entity Global Rules

Documentation

Explore our comprehensive documentation to understand how to integrate and utilize PriceFlow effectively. From API references to step-by-step guides, we provide all the resources you need to get started and make the most of our platform.

products schema

Field	Type	Description
sku	String	Unique identifier for the product entity.
base_price	Decimal	Cost per unit in the base currency.
base_currency	String	ISO 4217 currency code.
name	String	The display name of the product.
category	String	The category to which the product belongs.
metadata	JSON	Additional key-value pairs.

JSON EXAMPLE

{"id":"success"
"name":"SaaS Enterprise"
"base_currency":"USD"
"base_price":99.99
"category":"Software"
"metadata":{"features":[0:"API Access"
1:"Priority Support"
2:"Unlimited Users"
]
"trial_period_days":30
"support_email":"support@saasenterprise.com"
}
}

CSV Mapping Guide

Destination Field	Requirement	type	default value
sku	Required	String	N/A
base_price	Required	Decimal	N/A
base_currency	Required	String	N/A
name	Optional	String	N/A
category	Optional	String	N/A

Tips

Tips for CSV Upload

—Use a consistent format for the base_currency field.
—Ensure that the metadata JSON is properly escaped in the CSV.

Things to avoid

Common Errors

—Duplicate SKUs will result in the last occurrence being used.
—Invalid JSON in the metadata field will cause the row to be skipped.

Data integrity

Validation Rules

—Missing required fields will cause the row to be skipped.
—base_price must be a positive number.

Data Types

—Ensure that base_price is a valid decimal.
—metadata should be a valid JSON object if provided.

Unique Constraints

—Each product must have a unique SKU.

Customers Schema

Field	Type	Description
code	String	Pricora internal customer ID.
external_id	String	Identifier in your own system.
email	String	Verified communication address.
region	String	Operational jurisdiction (e.g. EU).
name	String	Full name of the customer.
metadata	JSON	Additional key-value pairs.

JSON EXAMPLE

{"code":"CUST-001"
"external_id":"EXT-12345"
"email":"customer@example.com"
"region":"EU"
"name":"John Doe"
"metadata":{"company":"Example Corp"
"tier":"Enterprise"
}
}

CSV Mapping Guide

Destination Field	Requirement	type	default value
code	Required	String	N/A
external_id	Optional	String	N/A
email	Optional	String	N/A
region	Optional	String	N/A
name	Optional	String	N/A

Data integrity

Validation Rules

—All fields are mandatory for customer creation.
—Country must follow ISO 3166-1 alpha-2 format.

Common Mistakes

—Invalid country codes (e.g., 'UK' instead of 'GB').
—Missing unique customer IDs.

Pricing Rules Schema

Field	Type	Description
code	String	Unique identifier for the Customer.
name	String	The display name of the Rule.
sku	String	The product's stock keeping unit.
value	Decimal	The value of the pricing rule.
type	Enum (FLAT/PERCENT)	The type of the pricing rule (Fixed \| Percentage).
minimum_quantity	Integer	The minimum quantity for which the pricing rule applies.
priority	Integer	The priority of the pricing rule.
status	Enum (TRUE/FALSE)	Indicates whether the pricing rule is active.
metadata	JSON	Additional key-value pairs.

JSON EXAMPLE

{"code":"PR-001"
"name":"Summer Sale"
"sku":"SKU-456"
"value":15
"type":"FLAT"
"minimum_quantity":100
"priority":90
"status":true
"metadata":{"description":"15 USD off for summer promotio..."
"valid_from":"2024-06-01"
"valid_to":"2024-08-31"
}
}

CSV Mapping Guide

Destination Field	Requirement	type	default value
code	Required	String	N/A
sku	Required	String	N/A
value	Required	Decimal	N/A
type	Required	Enum (FLAT/PERCENT)	N/A
name	Optional	String	N/A
minimum_quantity	Optional	Integer	1
priority	Optional	Integer	0
status	Optional	Enum (TRUE/FALSE)	TRUE

Data integrity

Validation Rules

—Type must be exactly 'FLAT' or 'PERCENT'.
—Value must be numeric.

Common Mistakes

—Referencing non-existent SKUs.
—Overlapping priorities for the same SKU.