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, registering credit memos for returns, and reporting back on inventory state.

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

Warehouse management

List locations, read and sync stock items between systems.

GET /V1/warehouses GET /V1/stockItems POST /V1/stockItems

Fulfillment orders

Accept (with per-item qty; qty=0 rejects), allocate, ship and invoice fulfillment orders; poll the per-stage queues, a read-only failed queue and a list of all active orders.

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

Sales orders

Read customer orders with items, per-item quantity progress (canceled, assigned, shipped, invoiced, refunded), amounts and addresses.

GET /V1/salesOrders GET /V1/salesOrders/{incrementId}

Returns

Read returns with returned items, amounts, settlement type and replacement order details; poll the credit memo queue and register credit memos.

GET /V1/returns/* POST /V1/return/creditmemo

  1. Read the Authentication page — every request needs a Bearer token issued by ShipperOne support.
  2. Each customer runs its own ShipperOne instance; 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.