ForjioHuudisIdentityPlugipayPaymentsStorlaunchE-commerceFulkrumaFulfilmentRiplloMarketingLinkSnapShort URLsPawpadoGPU streaming
Ripllo Docs
⌘K

API resources

Every resource group exposed by the Ripllo API, with a link to its per-resource page. Each page documents every endpoint with method, path, parameters, response shape, and error codes.

If you're new to the API, read API overview and Authentication first — the per-resource pages assume you know the response envelope and HMAC signing recipe.

Marketing primitives

Resource What
Discount codes Percent/fixed/shipping discounts. Validate, redeem, list applicable.
Referrals Program config + customer-issued referral links + attribution/fulfilment.
Abandoned cart Reminder config, recovery tracking, suppression list, public unsubscribe.
Pixels Meta + Google + TikTok pixel and CAPI configuration per merchant.
Feeds Google Merchant Center XML product feed config + emission.
Blog Long-form storefront content. Markdown body, draft/published, RSS-ready.

Audience & outreach

Resource What
Contacts The merchant's audience database. CRUD + CSV-style bulk import.
Contact lists Manually-curated groupings of contacts.
Audience segments Saved filters over the contact table. Resolved at send time.
Marketing campaigns The "blast send" surface. Multi-channel fan-out + templates.
Channels Provider integrations (email, SMS, WhatsApp, social) the campaigns send through.

Platform & settings

Resource What
API keys HMAC credentials for server-to-server auth.
Webhook endpoints Where Ripllo POSTs event notifications.
Billing Plan, subscription, usage, invoice history. Plugipay Pattern 2 under the hood.

Reading these pages

Each resource page follows the same shape:

  1. Overview — what the resource is, how it relates to the others.
  2. Endpoints — one section per method (Create, Retrieve, List, Update, Archive, plus resource-specific extras like validate or redeem).
  3. Per-endpoint — method + path, request parameters table, response example, error codes specific to this operation.
  4. The object — the full field reference for the resource.
  5. Events — which webhook events this resource produces (or reserved — not currently emitted for events in the catalog but not yet wired).

Where to find things

  • Code samples in your language? Each endpoint shows Node, Python, and Go side by side. For a deeper SDK reference, see SDKs.
  • Webhook event types? Webhooks has the full catalog.
  • HMAC signing recipe? Authentication.
  • Partner-platform calls? Most resources have a /validate, /redeem, /recover, or /public/:accountId pair that's called by the partner platform (Storlaunch) on behalf of a merchant. Those endpoints use the same HMAC scheme but pass the target merchant via X-Ripllo-On-Behalf-Of when the key has ripllo:platform:admin scope.

Coverage notes

Some endpoints exist in the backend but aren't documented here because they're internal:

  • /api/v1/admin/* — Ripllo platform admin operations (KYC review, dispute resolution).
  • /api/v1/webhooks/storlaunch/*, /api/v1/webhooks/plugipay/*, /api/v1/webhooks/engagement/* — inbound webhooks from partner platforms into Ripllo, not outbound from Ripllo.
  • /api/v1/uploads/* — presigned-URL minting for the dashboard's image uploader. Auth-bound to the portal session, not the API key.
  • /api/v1/creator-stats/*, /api/v1/marketplace/*, /api/v1/campaigns/*, /api/v1/programs/*, /api/v1/collaborations/*, /api/v1/affiliates/* — the creator marketplace surface. Documented separately under the marketplace section once Phase G ships; the routes exist but the public contract is still iterating.
  • /api/v1/funnels/*, /api/v1/inbox/* — portal-only at present. Documented when Phase F.2 freezes the schema.
  • /api/v1/integrations/*, /api/v1/insights/*, /api/v1/audit-log/*, /api/v1/merchants/* — portal-driven; safe to call via SDK but the shape is dashboard-coupled.

If you need access to one of these, contact us — we can usually expose the relevant data via a documented endpoint instead.