Skip to content

Integrations

The same ShipperOne API is consumed in different sequences by different kinds of integrators. These guides walk through the flow per role — what endpoints to call, in what order, and with which payloads.

  • ERP integration — for finance / ERP systems that drive allocation and invoicing, and register credit memos for returns. Polls pending_allocation, pending_invoice and pending_creditmemo; calls allocate, invoice and creditmemo. Does not handle physical shipment.

  • Fulfillment partner integration — for any party that physically fulfils orders: 3PLs, dropshippers, or in-house warehouses (often running a WMS). Polls pending_accept and pending_shipment; calls accept (with qty per item; qty=0 rejects that item) and ship. Also has read-only access to a failed queue for diagnostics.

  • Reading data — for any system that only needs to read: reporting, reconciliation, customer service tools, or an ERP that books sales orders and returns. Covers sales orders, fulfillment orders and returns. Only the read endpoints are needed.

A fulfillment order is a unit of work produced by ShipperOne when a customer order (a sales order) is routed to a location. One sales order can be split into several fulfillment orders, one per location. It progresses through four stages, each with its own polling endpoint and a matching action endpoint that moves the order forward:

#StageWhat happensPolling endpointAction endpointOwner
1Pending acceptWarehouse decides if it can fulfilGET /V1/fulfillmentOrders/pending_acceptPOST /V1/fulfillmentOrder/accept (per-item qty; 0 rejects)Fulfillment partner
2Pending allocationStock is reserved against the orderGET /V1/fulfillmentOrders/pending_allocationPOST /V1/fulfillmentOrder/allocateERP
3Pending shipmentOrder is picked, packed and dispatchedGET /V1/fulfillmentOrders/pending_shipmentPOST /V1/fulfillmentOrder/shipFulfillment partner
4Pending invoiceFiscal invoice is issued for shipped itemsGET /V1/fulfillmentOrders/pending_invoicePOST /V1/fulfillmentOrder/invoiceERP

A return records goods sent back against a shipped fulfillment order. Every return waits for a credit memo from the ERP; registering it completes the return.

StageWhat happensPolling endpointAction endpointOwner
Pending credit memoCredit memo is issued for the returnGET /V1/returns/pending_creditmemoPOST /V1/return/creditmemoERP

These rules apply across both guides:

  • Authentication — every request carries a Bearer token. See Authentication for details.
  • Base URL — each customer runs its own ShipperOne instance; substitute your tenant hostname for YOUR_SHIPPER_BASE_URL in all examples.
  • Path prefix — every REST URL is shaped https://YOUR_SHIPPER_BASE_URL/rest/{store_code}/V1/…. Your store_code is provided alongside your token — typically all on single-store tenants, or a country code (rs, hr, me, …) on multi-country tenants.
  • items[] payload — every action that operates on line items takes an explicit items[] array. A sales order is fulfilled partially by splitting it into fulfillment orders and by the per-item qty decision on accept; after accept, allocate, ship and invoice act on the fulfillment order as a whole, and their items[] must list every accepted item. See the Fulfillment partner integration guide for details.
  • Read-only lists — every list endpoint returns a fixed page of at most 100 records — 10,000 for GET /V1/stockItems — (?page=1, ?page=2, …; iterate until you receive an empty array) and accepts date=yyyy-mm-dd hh:mm:ss to return only records updated since that time. An invalid page or date returns 400.