Public API v2
Public API v2 lets you manage the rules of 12 B2B Solution modules from your own systems: an ERP, a PIM, a middleware. Create, read, replace and delete rules one by one or 250 at a time, then publish them to your storefront.
Which plan includes Public API v2?
Section titled “Which plan includes Public API v2?”Public API is available on the Platinum plan. Each module also needs to be in your plan: a module your plan does not include answers 403.
Base URL
Section titled “Base URL”All endpoints live under https://solution-public-api.bss-b2b.solutions/api/v2. The OpenAPI document is at https://solution-public-api.bss-b2b.solutions/docs/v2/json, with an interactive reference at https://solution-public-api.bss-b2b.solutions/docs/v2.
Which modules does Public API v2 cover?
Section titled “Which modules does Public API v2 cover?”| Module | Path | Takes effect |
|---|---|---|
| Custom Pricing | /api/v2/custom-pricing/rules |
Saved in the app; reaches the storefront at the next upload. |
| Price List | /api/v2/price-list/rules |
Saved in the app; reaches the storefront at the next upload. |
| Volume Pricing | /api/v2/volume-pricing/rules |
Saved in the app; reaches the storefront at the next upload. |
| Order Limit | /api/v2/order-limit/rules |
Saved in the app; reaches the storefront at the next upload. |
| Quantity Increment | /api/v2/quantity-increment/rules |
Saved in the app; reaches the storefront at the next upload. |
| Extra Fee | /api/v2/extra-fee/rules |
Saved in the app; reaches the storefront at the next upload. |
| Shipping Rate | /api/v2/shipping-rate/rules |
Saved in the app; reaches the storefront at the next upload. |
| Discount Code | /api/v2/discount-code/rules |
Works at checkout as soon as it is saved; the code box updates at the next upload. |
| Tax Display | /api/v2/tax-display/rules |
Saved in the app; reaches the storefront at the next upload. |
| Buy X Get Y | /api/v2/bogo/rules |
Saved in the app; reaches the storefront at the next upload. |
| Auto Tag | /api/v2/auto-tag/rules |
Applies as soon as it is saved. No upload. |
| Net Terms | /api/v2/net-terms/rules |
Saved in the app; reaches the storefront at the next upload. |
| Credit limit | /api/v2/credit/customers |
Read-only. Returns each customer’s credit figures when you call it. No rules, no upload. |
Conventions
Section titled “Conventions”- JSON in and out, fields in
snake_case, values of enums as lowercase strings. - Every response has the same envelope (see Responses) and errors use real HTTP status codes (see Errors & retries).
- Lists are paged by cursor (see Paging). Requests cost points from a per-store budget (see Rate limits).