Skip to content

Welcome to the ShipperOne API

The ShipperOne REST API exposes the operations needed to integrate fulfillment and inventory workflows with external systems — accepting orders, allocating to warehouses, generating invoices and shipments, and reporting back on inventory state.

The schema documented here is the complete public surface of the ShipperOne OMS.

Warehouse management

List locations, sync stock items between systems.

GET /V1/warehouses POST /V1/stockItems

Fulfillment orders

Accept, allocate, ship, invoice and reject fulfillment orders; poll the per-stage queues.

GET /V1/fulfillmentOrders/pending_* POST /V1/fulfillmentOrder/*

  1. Read the Authentication page — every request needs a Bearer token issued by ShipperOne support.
  2. Each customer runs its own ShipperOne instance (e.g. victoria-rs.sf1.shipper1.com); use your instance’s hostname in the request URLs below — the schema shows YOUR_SHIPPER_BASE_URL as a placeholder.
  3. All payloads are JSON. Send Content-Type: application/json on writes.

The API schema is regenerated quarterly, on each ShipperOne release. Breaking changes are flagged in advance through your account manager. Deprecated operations are removed from the public schema before the release that retires them.