The Data Access API provides programmatic, read-only access to published pricing data in Zilliant Pricing Plus. It makes published pricing information available to external integrations and internal clients in a secure, predictable, and repeatable way, without relying on UI-driven exports or ad hoc data pulls.
What you can retrieve
The Data Access API gives access to two broad categories of information: pricing frameworks and published pricing records.
Tip
For details about pricing frameworks and other pricing elements, read our Pricing Plus documentation.
Frameworks
Get information about:
Pricing frameworks that exist in your tenant, and which ones have a published version.
Published framework versions, so you can query a specific published snapshot.
Pricing framework elements within a published version, such as pricing steps, adjustments, and cost components that make up a framework version.
Element scoping definitions, including available scopes, fallback behavior, and which scoping attributes are valid for filtering.
Published pricing records
Retrieve published pricing records tied to elements, including:
Prices
Adjustments
Calculated prices
Costs
Overrides
Records include identifiers that indicate what they apply to, such as product and scope, and effective date ranges that determine when they’re valid.
Common use cases
Use the Data Access API for a range of tasks, such as:
Scheduled synchronization to downstream systems
Retrieve published prices and related records on a schedule and load them into ERP, CPQ, CRM, eCommerce, or other systems.
Analytics and reporting pipelines
Extract published price outputs, adjustments, and costs to support margin reporting, audit trails, and historical comparisons.
Audit-ready retrieval
Reproduce what was published at a specific time, and reconcile downstream system behavior against the published source of truth.
Targeted extracts for subsets of the business
Use product ID and scope filters to retrieve only the rows relevant to a product set, region, or segment.
How it works
The typical flow for using the Data Access API looks like this:
Authenticate.
Obtain an access token and use it in the Authorization header for each request.
Query your pricing data:
Find what is published
Identify which pricing frameworks currently have an active published version. You can also specify the published version you want to query rather than relying on the current published version.
Pick the element you want to query
Published pricing data is organized around elements, which represent the pricing steps or components in a framework version. Before retrieving records, you can look up the elements for the published version to get the correct element identifier and understand which scope keys are valid for filtering.
Retrieve published records
Query the published records you need, such as prices, adjustments, calculated prices, costs, or active overrides. You can narrow the result set using product filters, scope filters, and an effective date to get records as of a specific point in time, and use cursor-based pagination to work through large datasets.
Use advanced filters
If simple filters are not enough, use endpoints with more complex filtering. For example, apply sorting and return only specific fields to get responses suitable for your needs.
Rate limits
To help keep the service stable and responsive, the Data Access API applies rate limits to requests. Rate limits are enforced per tenant environment. This means that all clients, integrations, or applications that use the same tenant environment share the same rate limit.
The Data Access API uses two types of thresholds:
A burst threshold limits short spikes in traffic over a brief period, such as many requests sent at once.
A sustained threshold limits how many requests you send continuously over a longer period. It helps control steady high-volume traffic over time, such as frequent polling or large sync jobs.
The API also uses two levels of enforcement:
A soft limit warns you that your request volume is getting high, but still allows the request.
A hard limit stops the request and returns an error response.
Rate limit thresholds
Traffic pattern | Threshold type | Limit |
|---|---|---|
Sustained traffic over a 1-minute rolling average | Soft | 8 requests per second |
Sustained traffic over a 1-minute rolling average | Hard | 15 requests per second |
Short burst of traffic over a 10-second window | Soft | 25 requests per second |
Short burst of traffic over a 10-second window | Hard | 40 requests per second |
What happens when you exceed a soft limit
If you exceed a soft limit, the API still processes the request. The response may include the following warning headers:
X-RateLimit-Warning—Indicates that the request exceeded a soft limit. Possible value:true.X-RateLimit-Soft—Indicates which soft limit was exceeded. Possible values:sustained,burst, orboth.
What happens when you exceed a hard limit
If you exceed a hard limit, the API returns a 429 Too Many Requests error. The response includes a Retry-After header that indicates how many seconds you have to wait before retrying the request.
What’s next
Start with the Get an access token topic. After you have a token, choose the endpoint that matches what you want to retrieve, build the request with the required parameters, and send it to get the needed data.