Developers

Build with your Plunk data

Bring your products, sales, forecasts and shopper apps into your own site, portal and systems.

Create API key ›Get started

cURL

curl "https://api.plunk.io/cx/v1/products/top/this_month?limit=3" \
  -H "Authorization: Bearer sk_test_••••"

JavaScript

const res = await fetch(
  'https://api.plunk.io/cx/v1/products/top/this_month?limit=3',
  { headers: { Authorization: `Bearer ${process.env.PLUNK_SECRET_KEY}` } },
);
const { items } = await res.json();

Python

res = requests.get(
    "https://api.plunk.io/cx/v1/products/top/this_month",
    params={"limit": 3},
    headers={"Authorization": f"Bearer {os.environ['PLUNK_SECRET_KEY']}"},
)

APIs

Customer API

api.plunk.io/cx/v1

Products, sales, dealers, stores, audiences and forecasts in your own systems, plus events and sales sent in from your storefront.

Keys

Secret sk_ and publishable pk_

Created in

Billing & Usage › API

Limits

1,000 a day, 20,000 a month per key

Quickstart ›

Shopper App API

share.plunk.io

The COM/COL Visualizer, Sectional Builder and Room Planner as a one-line embed, or as endpoints for your own shopper experience.

Keys

Visualizer App key

Created in

Plunk Studio › Visualizer Apps

Header

x-visualizer-key

Overview ›

What you can build

With the Customer API

• Send storefront events, sales, order status and inventory into Plunk from your site, payment webhooks or ERP.
• Show bestsellers, trending products, semantic search and “customers also bought” on your storefront.
• Mirror your catalog with live availability and “ships in N days” on a trade site or portal.
• Build rep and dealer portals on your own site: dealer rankings, lapse risk, open orders and reorder requests.
• Pull store performance, audience performance, customer sales and contact interest into your own reporting.
• Read demand forecasts, the restock queue and similarity forecasts for new designs.
• Create, edit, approve and export product images from your own systems.

With the Shopper App API

• Drop the COM/COL Visualizer, Sectional Builder or Room Planner onto your website with one script tag.
• Build a custom shopper app on the same endpoints: renders, lead capture, COM/COL requests, sectional configurations and room plans.
• Get a webhook the moment a shopper submits a COM/COL request.

Base URLs

API	Base URL	Authentication
Customer API	https://api.plunk.io/cx/v1	Authorization: Bearer <key> or X-Api-Key: <key>
Shopper App API	https://share.plunk.io	x-visualizer-key: <key>

Which plans include the API

• Plunk Commerce includes both APIs: the Customer API and the Shopper App API for the storefront apps.
• Studio Storefront includes the Shopper App API.
• Studio Designer, Pro and Team plans don’t include API access.

Plunk Commerce includes everything: Plunk Studio, the storefront apps and the Customer API. See plans and pricing or plunk.io/pricing.

Start here

• Customer API quickstart: your first call in five minutes.
• Authentication and keys: publishable and secret keys, and where each may live.
• Capabilities: the discovery document your integration codes against.
• Shopper App API overview: keys, embeds and the shopper flows.
• API changelog: what changed and when.

Tip

Your team can also ask Plunk questions from the AI assistants they already use, signed in with their own Plunk account. That is separate from the developer API. Ask us through support to connect your account.