This guide walks you through the complete setup and usage of the Ongoing WMS integration with Returnflows, including:
API access & authentication
Webhook configuration
Returnflows settings
How exchanges are created, released, and fulfilled
Image markers for your visual documentation
π¨βπ 1. Setup in Ongoing (WMS Admin / 3PL)
Step 1: Create API user for Goods Owner
Go to Administration β API for Goods Owners
Find the customer you want to give access to
Click the dropdown arrow and open the API section
Fill in:
Username must begin with
WSI
Email = customerβs email or
[email protected]
Type of integration =
Other
Password = optional (either you or the user can define it)
Click Create
π
π€ 2. Setup in Returnflows (Goods Owner)
Step 2.1: Authentication tab
Navigate to Settings β Integrations β Ongoing and fill in:
Field | Description |
Warehouse | Found in your Ongoing URL (e.g. |
Goods Owner ID | Displayed next to your company name in the top-right corner |
Username & Password | Received from your 3PL |
π
π
Step 2.2: API Server
Select the API server your Ongoing WMS instance runs on (e.g., wms1
, wms2
, etc.)
π
Step 2.3: Warehouse Settings
Choose the warehouse location where your goods are physically stored.
π
Step 2.4: Order Status Codes
Status | Description |
Open | Initial status for new exchange orders (they should not be picked/shipped yet) |
Returned | Indicates the return has been received |
Released | Used to release the exchange once return is handled |
Sent | Marks that the exchange order has been shipped and completed |
Default: Open
, Returned
, Released
, Sent
π
Step 2.5: Return Order Status Codes
Status | Description |
Notified | A return has been created but not yet received |
Returned | The return item has been received and completed |
Default: Notified
, Returned
π
Step 2.6: Webhook Auth Token
In the Webhook Settings tab:
Paste your custom token (you define this during setup)
This token is used in your Ongoing webhook authentication setup
π
π 3. Set up the webhook in Ongoing
Go to System β Webhooks in your Ongoing interface
Click Create new regular webhook
Select
Order status is changed
as the event typeUnder Authentication: Choose
Fixed X-Auth-Token
Paste the same token you entered in Returnflows
Under Settings:
Paste the Webhook URL shown at the top of the Ongoing integration page in Returnflows
Enable the webhook
π
π« 4. What happens next?
Once everything is correctly configured:
Returnflows will:
Automatically create exchange orders in Ongoing
Set them to status Open
Monitor the return:
If Instant Exchange = OFF β order is released when webhook
return.closed
is triggeredIf Instant Exchange = ON β order is released on webhook
shipment.event.in_transit
Change the order status to Released
Once Ongoing marks it as Sent, Returnflows will:
Fulfill the product in Shopify
Capture any price difference (if needed)
βΉοΈ Summary
When fully configured, the Ongoing integration enables:
β
Automatic creation of exchange orders
β
Real-time syncing across WMS and Shopify
β
Clean order fulfillment logic
β
Smooth return & exchange experience for your customer
π¬ Need help?
Not sure which status codes to use?
Need help configuring the webhook?
Reach out to our support team β weβll walk you through it π§βπ»