🧩 Public APIs

The Public API integration lets you programmatically manage B2B pricing rules and registration workflows at scale — without manually configuring each rule in the app dashboard.

Who Should Use This

Public APIs are intended for:

• Developers integrating B2B pricing with external ERP or PIM systems

• Merchants with large catalogs who need automated pricing rule management

• Teams using CSV/data pipeline workflows to sync pricing from external sources

Plan Requirement

Public API access requires the Platinum plan.

Authentication

All API requests require an Access Key generated from within the app:

1. Go to API & Integration → Public API.

2. Click Generate API Key to generate the API Key.

1. Copy your Access Key.

Please store or download the API key at that moment, as it will not be shown again.

1. Include it in all API requests as a Bearer token header or in the request body.

Available API Groups

🔗Public APIs for Uploading🔗Public APIs for Volume Pricing (VP)🔗Public APIs for Custom Pricing (CP)🔗Public APIs for Price List (PL)🔗Public APIs for Registration form (RF)

API Group	What it manages
Uploading APIs	Upload/sync active rules to your Shopify theme
Volume Pricing (QB) APIs	Manage quantity break / volume pricing rules
Custom Pricing (CP) APIs	Manage custom pricing rules
Price List (PL) APIs	Manage price list per customer rules
Registration Form (RF) APIs	Manage wholesale registration workflows

Rate Limits

Endpoint group	Limit
Upload endpoints	1 request per module per 5 minutes

Exceeding rate limits returns a 429 Too Many Requests response.

Technical Constraints

Pricing data is stored in Shopify metafields as JSON with these limits:

• Maximum 10 keys per metafield

• Maximum 2,000,000 characters per key

• Maximum ~20,000,000 characters total

Content exceeding these limits will not be uploaded to the theme.

Encounter a problem? Feel free to reach us at [e-mail] or Live Chat.