Skip to content

Omnishelf Seller API

Docs last updated October 20, 2026

Version 1 — Developer Documentation

Fulfilment orders, carrier labels, tracking submission, inventory reporting, and signed webhooks. Everything documented here is live in production today.

What the API does

The Omnishelf Seller API lets you run fulfilment programmatically for the orders you fulfil. It works in two directions:

  • Pull — you call Omnishelf over HTTPS to list actionable fulfilment orders, download carrier labels, and read tracking.
  • Push — Omnishelf calls a webhook URL you host the moment an order becomes actionable, is put on hold, or is cancelled.

Getting access

API keys and webhook registrations are created and managed by Omnishelf staff on request — there is no self-service portal for either. Email your Omnishelf contact to get set up.

Base URL

https://api.omnishelf.com

Set this once in your environment and use it for every request:

export BASE_URL="https://api.omnishelf.com"
export OMNI_KEY="omni_sk_YOUR_KEY"

What's in this guide

Section What you'll find
Quickstart From zero to a verified key and webhook in five steps
Fulfilment Lifecycle How orders move through the system — read before the endpoint reference
Authentication Bearer tokens, key format, revocation
Conventions Base URL, identifier formats, timestamps, pagination
API Reference All 14 endpoints with request/response examples
Webhooks Event types, payload shape, signature verification, retry schedule
Errors & Rate Limits Every error code and what to do about it
Status Reference Order, shipment, and parcel status vocabularies

Using an AI assistant

The whole guide is available as plain text for AI coding tools such as Claude, ChatGPT or Cursor. Give your assistant one of these URLs: