Persevo
Docs

Build with Persevo.

API references for the storefront and the data vault, getting-started guides, webhook payloads and a changelog — everything you need to wire Persevo into your stack.

Quickstart

Start here.

Four routes into the platform — pick the one that matches what you’re trying to do today.

Request sandbox access

We provision a sandbox project, publishable key and access to the API references once we know your team.

Learn more

Checkout API

REST endpoints for carts, shipping options, payment sessions and orders. Reference issued under NDA with sandbox access.

Learn more

Vault API

Direct-to-storage uploads, signed URLs and TTL-managed records for personalised intake. Reference issued with sandbox access.

Learn more

Webhooks

Subscribe to lifecycle events — orders, payments and inventory — with signed delivery. Overview below.

Learn more
API

API reference.

Seven resource families cover everything you need to ship. Each lives behind a typed HTTP endpoint with an OpenAPI spec.

carts

Create and update carts, add line items, apply discounts, resolve totals.

products

Read catalogue with variants, prices, inventory and region-aware metadata.

orders

Lifecycle from placed to delivered, refunds, fulfilment state and timeline.

customers

Stable customer IDs, addresses, contact metadata, and merge operations.

shipping

Region-aware shipping options, label-ready rates, and pickup-point lookup.

payments

Payment sessions, capture and refund operations across cards and wallets.

webhooks

Subscriptions, signing keys, redelivery and an event-by-event reference.

Webhooks

Listen for what matters.

A signed POST to your endpoint at every lifecycle step. Idempotency keys included, redelivery on failure for up to 24 hours.

POST /your-endpointjson
{
  "id":         "evt_01H8XJ2C0K9R3T4A1Z9W7Q",
  "type":       "order.paid",
  "created_at": "2026-05-28T09:14:22.318Z",
  "livemode":   true,
  "data": {
    "order_id":    "ord_01H8XJ1B0H7P2S4A0Y8V6P",
    "customer_id": "cus_01H8XJ0A0G6N1R3A9X7U5N",
    "currency":    "EUR",
    "total":       4990,
    "items":       [{ "sku": "GIFT-PRINT-A4", "qty": 1 }]
  }
}

Available events

  • order.placed
  • order.paid
  • order.shipped
  • order.delivered
  • order.refunded
  • inventory.low
  • payment.succeeded
  • payment.failed
Changelog

What shipped recently.

A monthly rollup of platform-side changes. Breaking changes get a separate notice with at least 60 days’ lead time.

  1. May 2026

    Multi-currency settlement on Growth tier

    Stores on Growth can now settle in EUR, USD and GBP from a single account. Per-region routing rules in the dashboard, no contract amendment needed.

  2. Apr 2026

    Vault TTL controls in the admin

    Set TTL per record class — names, photos, video — without writing API calls. New `vault.record.expired` event for downstream cleanup.

  3. Mar 2026

    Signed webhook redelivery

    Failed webhook deliveries are now retried with exponential backoff for up to 24 hours, and surfaced in the dashboard with a single-click manual redelivery.

Help

Need a hand integrating? Talk to our team.

Sandbox keys, full API references, sample payloads and a 30-minute integration call — issued under access once we know your project.

Request accessBrowse the API surface