ZEPP API Documentation

The ZEPP API is a REST API that returns JSON. It exposes identity verification, catalogue, pricing, orders and fulfilment as one plug-and-play layer. Every response is JSON, every error is predictable, and the same primitives power EPP, SPP and brand storefronts alike.

Authenticate every request with a secret API key passed as a Bearer token. Use sandbox keys for testing and live keys in production. Keep secret keys server-side and rotate them anytime from your dashboard without downtime.

curl https://api.zrpl.co/v1/catalogue \
  -H "Authorization: Bearer $ZEPP_KEY"

Verify a buyer, fetch their eligible catalogue, and create an order in three calls. The example below verifies a buyer, lists what they're eligible for, then places an order.

const zepp = require('@zrpl/zepp')(process.env.ZEPP_KEY);

// 1. verify a buyer by their work/campus email
const buyer = await zepp.auth.verify({ email: 'asha@partner-corp.com' });

// 2. fetch the catalogue eligible for this verified buyer
const items = await zepp.catalogue.list({ token: buyer.token });

// 3. place an order
const order = await zepp.orders.create({
  buyer_token: buyer.token,
  items: [{ sku: 'BRD-204', qty: 1 }],
});

Buyers are verified by matching their email domain against a program's whitelist. Verification returns a short-lived buyer token used for all subsequent calls. Tokens are scoped to a single program and expire automatically, so nothing sensitive stays long-lived.

A program defines a closed user group (e.g. epp_indigo, spp_iitb), its whitelisted domains, and the pricing rules that apply. A buyer can belong to more than one program, and the API resolves the right prices for each context.

Catalogue responses are scoped to the buyer's program, so prices are always the verified, exclusive prices. Products a buyer isn't eligible for simply never appear in the response.

Subscribe to events such as order.confirmed, order.shipped and order.delivered to keep your systems in sync. Each event is signed, so you can verify it genuinely came from ZEPP before acting on it.