GuidesAPIBlog
Open Shippified

Developer overview

AdminUpdated Sep 24, 2026

Developer overview

Shippified turns Discord monitor webhooks and retailer order emails into one normalized order ledger, then tracks those orders through to delivery. Everything the dashboard does goes through the same HTTP API, so you can read, create, and update orders yourself, subscribe to events, and feed in new order sources.

This section is the narrative guide. For endpoint-by-endpoint detail generated from the OpenAPI spec, see the API reference pages (the ref- pages in this section).

Platform surfaces

Surface

Direction

What it is

Page

REST API

You call Shippified

JSON over HTTPS at https://shippified.net/api. Orders, bots, email sources, templates, tracking, webhook subscriptions, account.

REST API conventions, Orders

Authentication

You call Shippified

Bearer tokens: long-lived API keys (sk_…) or 14-day session tokens. Account export and deletion need a session token.

Authentication

Outbound webhooks

Shippified calls you

Signed POST requests to your URL when orders are created, merged, updated, shipped, or delivered, when tracking refreshes (including from the background tracker), and when a share card is created. Signing secrets persist across deploys.

Webhooks

Discord webhook intake

Sender calls Shippified

A Discord-compatible webhook URL per bot. Anything that can post a Discord webhook payload can create orders.

Getting orders in

Email intake

Sender calls Shippified

Manual raw-email import, mailbox polling (IMAP, Gmail, Microsoft), and forwarding inboxes.

Getting orders in

Inbound mail worker contract

Operator only

POST /api/inbound/mail, called by the Cloudflare Email Worker that receives mail sent to <slug>@shippified.net. Requires a shared deployment key and refuses all requests when none is configured.

Getting orders in

Custom templates

You call Shippified

Create parsing templates, preview extraction, test match rules, and dry-run the full parser.

Templates API

TypeScript SDK

Library

shippified-sdk 0.2.0, a typed fetch wrapper over the REST API, plus a webhook signature helper. Not on npm: install from a checkout or a packed tarball.

TypeScript SDK

MCP server

Library

mcp-shippified 0.2.0, a Model Context Protocol server that exposes the API as 49 tools for Claude and other MCP clients. Not on npm: build it from a checkout or install a packed tarball.

MCP server

OpenAPI spec

Reference

OpenAPI 3.1 document at https://shippified.net/api/openapi.json. An interactive viewer is served at https://shippified.net/api.

API reference (ref- pages)

How the pieces fit

Discord monitor ──POST──▶ /api/webhooks/discord/:handle/:slug ─┐
Mailbox poll / forwarding / manual import ──▶ email intake ─────┼─▶ parser ─▶ order ledger ─▶ outbound webhooks
Your code ──POST /api/orders──────────────────────────────────┘                  │
                                                                                 ▼
                                               REST API / SDK / MCP read and update orders

Every inbound message goes through one intake pipeline. For email, that includes the source's allowed-senders check, applied to the real sender on every path. The message is parsed against built-in shapes and your custom templates. The result is then either merged into an existing order with the same order number or created as a new order. Order status is one of ordered, shipped, delivered, canceled, or issue, and it only moves forward: ordered → shipped → delivered. A background tracker keeps in-flight orders current on carriers that have live tracking on the instance. See Orders → Status.

Quick start

  1. Create an API key in the dashboard under Settings → Developer, or call POST /api/account/api-keys with a session token. See Authentication.

  2. Export it:

    export SHIPPIFIED_API_KEY="sk_..."

  3. List your most recent orders:

    curl -s "https://shippified.net/api/orders?limit=5" \
  -H "Authorization: Bearer $SHIPPIFIED_API_KEY"

  4. Fetch the OpenAPI spec (no auth required):

    curl -s https://shippified.net/api/openapi.json

  5. Check service health (no auth required):

    curl -s https://shippified.net/api/healthz

Where to go next

  • REST API conventions: errors, pagination, rate limits, IDs, and timestamps.

  • Orders: the order object and every order endpoint.

  • Webhooks: subscribing to events and verifying signatures.

  • Getting orders in: Discord-format intake and email import.

  • If you are setting up Shippified as a reseller rather than building against it, start with the quickstart guide.

Was this page helpful?