# 🧩 Public APIs

## 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.

<figure><img src="/files/Y0nKXGMzwlFIAeyI8wO7" alt=""><figcaption></figcaption></figure>

3. **Copy** your Access Key.

<figure><img src="/files/LXeYudEKL8MQGjNF28Qv" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
Please store or download the API key at that moment, as it will not be shown again.
{% endhint %}

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

## Available API Groups

{% content-ref url="/pages/Eh2qerzZCeHDwqrXdVkG" %}
[🔗Public APIs for Uploading](/b2b-wholesale-solution/api-integration/public-apis/public-apis-for-uploading.md)
{% endcontent-ref %}

{% content-ref url="/pages/UdBciowEvZI13eW63r7d" %}
[🔗Public APIs for Volume Pricing (VP)](/b2b-wholesale-solution/api-integration/public-apis/public-apis-for-volume-pricing-vp.md)
{% endcontent-ref %}

{% content-ref url="/pages/YrnO0EcwY7KxFHOpPYCy" %}
[🔗Public APIs for Custom Pricing (CP)](/b2b-wholesale-solution/api-integration/public-apis/public-apis-for-custom-pricing-cp.md)
{% endcontent-ref %}

{% content-ref url="/pages/Io5bYMqHwBMOFZena7bc" %}
[🔗Public APIs for Price List (PL)](/b2b-wholesale-solution/api-integration/public-apis/public-apis-for-price-list-pl.md)
{% endcontent-ref %}

{% content-ref url="/pages/rd4YseJBr4UDabDTgF5v" %}
[🔗Public APIs for Registration form (RF)](/b2b-wholesale-solution/api-integration/public-apis/public-apis-for-registration-form-rf.md)
{% endcontent-ref %}

| 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.

{% hint style="info" %}
Encounter a problem? Feel free to reach us at  [**support-sbc@bsscommerce.com**](mailto:support-sbc@bsscommerce.com) or [**Live Chat**](https://go.crisp.chat/chat/embed/?website_id=9f64b5a9-1a02-4190-93b8-8ef56b19f740)**.**
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs-shpf.bsscommerce.com/b2b-wholesale-solution/api-integration/public-apis.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.