Skip to main content
A developer’s guide to integrating the Droplinked APIs for seamless store and app creation. Each recipe is a complete, end-to-end walkthrough you can copy into your own project.

Build a custom store with the headless APIs

From auth and shop discovery through cart, shipping, payment, and order creation — with full JavaScript and Python implementations.

Build a custom store with Droplinked headless APIs

Learn how to build a fully custom store directly on your platform or app using Droplinked’s headless APIs for seamless inventory and checkout management.

Prerequisites

Before you begin, you’ll need:
  1. A Droplinked account — sign up at droplinked.com
  2. An API key — your authentication credential for API requests
  3. A shop name — your unique shop identifier
  4. Basic development knowledge (or a developer to help implement)

Get your API key

1

Log into the merchant dashboard

Go to droplinked.com and sign in.
2

Open API Keys

Navigate to Settings → API Keys.
3

Generate a key

Click Generate New API Key and copy the value securely.
Never share your API key publicly or commit it to version control.

Base configuration

Example — curl


Step 1 — Fetch shop information

Get your shop details to display branding on the storefront.
Sample response:
Use this to render the shop name, description, and currency formatting on your homepage.

Step 2 — List your products

Fetch all products to populate the catalog.
Sample response:
The lowestPrice shown here is for display only. To add items to a cart you need the SKU ID from the product details endpoint (step 3).

Step 3 — Get product details (and the SKU)

When a customer clicks a product, fetch the complete details including SKUs.
Sample response:
Product vs SKU
  • A product is the general item (e.g. “Blue T-Shirt”)
  • A SKU is a specific variant with its own price (e.g. “Blue T-Shirt — Size Large — $29.99”)
  • A product can have many SKUs (sizes, colors, etc.)
  • You add the SKU to the cart, not the product

Step 4 — Create a cart

Body:
Response (excerpt):
Save the cart ID in localStorage (browser) or a session (server) so customers can continue shopping after a refresh.

Step 5 — Add product to cart

Add items using the SKU ID (not the product ID).
Body:
Optional m2m_data for made-to-measure / customized products:

Update or remove items


Step 6 — Checkout — shipping, payment, order

Get shipping rates

Select a rate

Body:

List payment methods

Create the order

Body:
Response (excerpt):

Complete reference implementations


Best practices

1. Error handling

Wrap every API call in try / catch (or its language equivalent) and surface user-friendly messages:

2. Cart persistence

Store the cart ID so customers can resume:

3. Loading states

Show loading indicators while fetching data — the public endpoints can take a few hundred milliseconds on first load.

4. Inventory checking

Always confirm a SKU is available before adding to cart:

5. Price formatting

Use the platform’s Intl.NumberFormat and the shop’s currency:

Troubleshooting


Endpoint quick reference

For one-on-one help, email support@droplinked.com.