BSS B2B Solutions

BSS B2B Solution: Public API

ERP Integration with the BSS B2B Solution Public API: Keys, Endpoints and Limits

The Public API in BSS B2B Solution lets your ERP, PIM or custom tool create, update and delete Custom Pricing, Volume Pricing, Price List and Discount Code rules, handle registration forms, and look up customers, products and collections. It needs the Platinum plan on a live store and one API key per store. There is no orders endpoint.

  • By BSS B2B Team
  • Reviewed by Hoa Nguyen, Senior Marketer. Last reviewed
  • Last updated
Install BSS B2B Solution Back to BSS B2B Solution Needs the Platinum plan. BSS B2B Solution has a 14-day free trial on paid plans. 4.9 out of 5 from 1,189 reviews on the Shopify App Store (as of October 10, 2026).

How do I get an API key and make the first call?

You set up the key inside the app. The calls themselves are made by your developer or integration partner, using the endpoint pages in the user guide.

  1. Check the plan

    The Public API needs the Platinum plan, or the Enterprise plan on a legacy plan. The key cannot be created on other plans.

  2. Open the Public API card

    In the app menu, click Integrations and find the Public API card. Click Get API key.

  3. Generate the key and store it

    Generate the key, then click Copy or Download straight away. The app shows it once. Treat it like a password: anyone who has it can read your B2B data and call the write endpoints.

  4. Switch the Public API function on

    The page that holds the key has a Public API function control with an Enable button. Requests, version 1 and version 2, are accepted only while the function is on.

  5. Send the key with each request

    For version 1, pass `accessKey` in the request body or the header `x-bss-b2b-api-key`, together with your shop `domain`. Version 2 uses the header `x-api-key`. A few version 1 endpoints read the key from the body only: the Custom Pricing, Volume Pricing and Price List upload endpoints, `PUT /rule/delete-items`, `PUT /pl/delete-items` and `PUT /pl/update-items`. The Discount Code upload endpoint reads the key from the `x-bss-b2b-api-key` header only.

  6. Write rules, then upload them

    Create or update rules with the Custom Pricing, Volume Pricing or Price List endpoints. Then call the upload endpoint for the module so the enabled rules reach the live theme.

  7. Check Logs and usage

    On the Public API card, click Logs and usage. It lists recent requests with their status, method and path, and you can open a row to see the full request and response.

Integrations page with Public API card and Get API key button
The Public API card on the Integrations page.
Public API card with a hidden key and Copy and Download buttons
After generating the key, copy or download it. It is not shown again.

Generate an API key and make your first call on the Platinum plan. The listing shows a 14-day free trial on paid plans.

Install BSS B2B Solution Read the Public API guide

What the Public API covers

This is what the user guide and the app code document, grouped by module. The user guide has a page with payloads for the Custom Pricing, Volume Pricing, Price List, Registration Form and upload groups.

ModuleWhat you can doNotes
Custom PricingGet rules by domain or ID, save, bulk save, delete, mass delete, upload, and look up rules by products or by customers.Version 1, path /rule/*.
Volume PricingThe same set as Custom Pricing, without the by-products and by-customers lookups and without delete-items. Version 2 adds GET /vp/rules.Version 1, path /qb/*.
Price ListThe Custom Pricing set plus update status, update, delete items and update items.Version 1, path /pl/*.
Discount CodeGet, create and delete rules, plus an upload endpoint.Version 1, path /dc/*.
Registration FormFetch a form schema, submit a wholesale registration, filter applications and change the status of pending applications.Status changes work on pending accounts only. Multi-step forms always need an email.
Order LimitRead the rules and update a rule.Version 1, path /ol/*.
Customers, products, collectionsLook up customer tags, search customers, get customers by IDs or tags, list products and collections.Read-only. You cannot create or edit customers or products through the API.
OrdersNot available.There is no orders endpoint.

Source: the BSS B2B Solution Public API code and the BSS user guide for Public APIs, checked October 9, 2026.

Keys, headers and API versions

Each store has one API key. If a key already exists, the app will not create a second one. To rotate it, delete the key on the Public API card, which stops every client using it at once, then generate a new one.

The two API versions use different header names. Version 1 (`/api/v1/...`) reads `x-bss-b2b-api-key`, or `accessKey` in the body. Version 2 (`/api/v2/...`) reads `x-api-key`. If you integrate several groups, check the header per endpoint. Do not send the key as `Authorization: Bearer`. Version 2 answers that with `401 ACCESS_KEY_MISSING`. Version 1 answers with HTTP 200 and `success: false`, so read the `success` field and not only the HTTP status.

  • Version 1: Custom Pricing, Volume Pricing, Price List, Discount Code, Registration Form, Order Limit, lookups.
  • Version 2: GET /vp/rules for Volume Pricing (the documented endpoint).
  • Upload partial results also come back with HTTP 200: check `status` or `success`.
Custom Pricing rule list with seven rules, discounts and status
Rules you write through the API appear in the same lists as rules made by hand.

What are the limits of the Public API?

Platinum only

Public API access needs the Platinum plan on a live store, or Enterprise on a legacy plan. One key per store.

Version 2 rate limit

60 requests per 60 seconds per store, with X-RateLimit headers. Going over returns 429.

Upload: once per 5 minutes

Each upload endpoint allows one request per module every 5 minutes. Batch your changes, then upload once.

Bulk writes run one at a time

While a bulk save, mass delete, bulk delete, delete-items or update-items call runs for a store, other bulk writes in Custom Pricing, Price List and Volume Pricing return 429 with the message that the domain is executing another process. After a server error, wait up to 3 minutes.

Theme storage cap

Uploaded rules live in Shopify metafields: 10 keys, 2,000,000 characters per key, about 20,000,000 in total. Rules beyond the cap are skipped and listed in a partial_success report. Only enabled rules are uploaded.

No orders endpoint

The API manages rules, registrations and lookups. It cannot create, read or change orders.

Customers and products are read-only

You can search and read them. To change a customer tag by event, use Auto Tag in the app.

Check the response body

Version 1 returns HTTP 200 for some failures, and partial uploads also return 200. Test the success field in your job.

How it fits with the rest of the app

The API writes the same rule types you create in the admin, so Custom Pricing, Volume Pricing and Price List rules follow the usual order in the cart. Price List rules are checked first, then Custom Pricing, with Volume Pricing on top. Rules made through the API show in the app lists next to rules made by hand.

Pushing rules for tagged buyers pairs well with Auto Tag, which adds the customer tags that those rules target. If your price list changes a few times a year, a CSV import is simpler than an integration.

Who should use it

Distributors and manufacturers whose prices, price classes or customer groups already live in an ERP, a PIM or a data pipeline, and who have a developer or integration partner to write a scheduled job. The API suits large catalogs where changing rules by hand takes too long.

If nobody on your side writes code, use the admin screens or CSV import instead. The user guide describes the API as a toolkit for developers and integration partners, not as a connector for one named ERP product.

Which plan includes the Public API?

The Public API is on the Platinum plan. On the Shopify App Store listing, as of October 9, 2026, Platinum is $99 per month, or $1,069.20 per year with 10% off yearly billing. The listing shows a 14-day free trial on paid plans.

Use cases for the Public API

Each use case shows one setup with screenshots. Browse all use cases.

The Import and export page with Export and Import cards and the export history
  • BSS B2B Solution

Import Wholesale Prices From CSV

Export your price rules, edit the prices in a spreadsheet and import the file back. The same CSV flow works for Custom Pricing, Price Lists and Volume Pricing, so large catalogs and many customer groups stay manageable.

Explore use case: Import Wholesale Prices From CSV

Guides and glossary

Each topic has one page that owns it. Start from these.

Auto Tag

Tag buyers by event so tag-based rules apply.

Wholesale pricing

Show business buyers their own prices with price lists, custom pricing and quantity breaks.

Customer onboarding

Turn applicants into approved wholesale buyers with registration forms, approval and customer tags.

Glossary

ERP integrationPrice listCustomer tag

User guides on docs.bss-b2b.solutions

More BSS B2B Solution features

Each feature has its own page. See also all BSS B2B Solution features.

Auto Tag

Add or remove customer and order tags when a Shopify event matches your rules, so tag-based prices and access follow the buyer.

Discount codes

Give wholesale buyers a private code they enter in the cart, with rules for who can use it, what it covers and how often.

Manual Orders

Build a Shopify draft order for a customer in the admin, with their wholesale prices already applied.

Multi-currency display

Show wholesale prices in the buyer's currency with a switcher. Checkout stays in your store or Markets currency.

Shopify POS pricing

The B2B Price tile in Shopify POS shows the wholesale discount for the cart. Staff apply or remove it from the tile.

Connect your ERP to your wholesale prices

Install BSS B2B Solution from the Shopify App Store, with a 14-day free trial on paid plans.

Get BSS B2B Solution See how BSS B2B Solution works

Also: BSS B2B Lock for hidden prices for guests and BSS B2B Quote for quotes and quick order.

Frequently asked questions

Which plan includes the BSS B2B Solution Public API?

The Platinum plan, or Enterprise on a legacy plan. As of October 9, 2026 the App Store listing shows Platinum at $99 per month. A store gets one API key, which the app shows only once.

What can I send to the Public API?

Custom Pricing, Volume Pricing, Price List and Discount Code rules, registration form submissions and status changes, and Order Limit updates. Customers, products and collections can be read and searched but not changed.

Can the Public API create or read orders?

No. There is no orders endpoint. The API manages pricing rules, registrations and lookups. To place an order for a buyer, use Manual Orders in the app admin, which builds a Shopify draft order with the buyer's prices.

What are the rate limits?

Version 2 allows 60 requests per 60 seconds per store. Each upload endpoint allows one request per module every 5 minutes. Bulk writes for one store run one at a time, and extra calls get a 429 response.

How do I authenticate, and can I use a Bearer token?

Send the key as `accessKey` in the body or in a header: x-bss-b2b-api-key for version 1, x-api-key for version 2. Bearer tokens are not supported, so Authorization: Bearer fails with a 401 on version 2.

What happens if I lose or leak the API key?

Delete the key on the Public API card. Clients using it stop working at once. Then generate a new key and copy it immediately, because it is shown only once.

Sources, method and update log

Feature behavior follows our review of the BSS B2B Solution app code on October 3, 2026 and the BSS user guides. Prices and ratings come from the App Store listing on the date shown. We make BSS B2B Solution, BSS B2B Lock and BSS B2B Quote.

Sources

  1. BSS user guide: Public APIs, read . Plan, key steps, headers, rate limits, logs, metafield caps.
  2. BSS user guide: Public APIs for uploading, read . Upload endpoints, capacity and partial report.
  3. BSS user guide: Public APIs for Registration form, read . Form and wholesaler endpoints, pending-only status changes.
  4. Shopify App Store listing: BSS B2B Wholesale Pricing, read . Plan prices and trial.

Update log

  • : First version.
  • : Added a mid-page install button.
Install BSS B2B Solution 14-day free trial on paid plans