Utility

Last updated October 19, 2026

Base URL

All examples assume BASE_URL=https://api.omnishelf.com and OMNI_KEY=omni_sk_YOUR_KEY.

---

GET /v1/ping

Health and identity probe. Confirms a key is valid and reports the API version and the webhook event types you can register. Touches no order data.

Use this to: - Confirm a new key is live before wiring anything else up. - Read the live event_types list rather than hard-coding it — the list grows without a version bump.

Request

curl -s "$BASE_URL/v1/ping" \
  -H "Authorization: Bearer $OMNI_KEY"

Response — 200

{
  "ok": true,
  "version": "v1",
  "event_types": [
    "fulfilment_order.created",
    "fulfilment_order.cancelled",
    "fulfilment_order.on_hold",
    "fulfilment_order.hold_released",
    "fulfilment_order.in_transit",
    "fulfilment_order.delivered",
    "fulfilment_order.undelivered",
    "fulfilment_order.status_changed"
  ]
}

Five of these (hold_released, in_transit, delivered, undelivered, status_changed) belong to the order lifecycle. You can register for them, but they are sent only once the order lifecycle is switched on for your account. See Webhooks.

Errors

401 missing_api_key / 401 invalid_api_key — the only failures possible here. Ping is still authenticated and still counts against your rate limit.