OpenAPI Access Process for Warehouse

This guide aims to assist partners in completing the data integration between OneWarehouse and the Warehouse Management System (WMS). OneWarehouse will push relevant data to the API addresses provided by the warehouse via Webhook to achieve real-time synchronization of products, orders, and inventory information.

For complete OpenAPI specifications and detailed parameter descriptions, please refer to our official API documentation: OneWarehouse OpenAPI Documentation.

1. API Push Endpoint Configuration (Webhook)

To achieve automatic data push, please provide the corresponding API receiving endpoints (URLs) for the following six scenarios. OneWarehouse will actively send JSON-formatted data to these addresses based on business triggers.

⚠️ Important Prerequisite Providing these six API receiving endpoints is a mandatory prerequisite for setting up the Sandbox environment. If not provided, we will be unable to proceed with the subsequent Sandbox environment configuration and will not be able to provide the test client for your integration testing.

2. Sandbox Environment Information

Before proceeding with the official production environment integration, please complete development and integration testing in the Sandbox environment first.

2.1 Authentication Keys

Please configure the following information in your authentication logic:

• AppKey: t3t0rqr6wg58000inw8ukx5tsw7qg82x6030rme9
• AppSecret: fvuid3zizjy6zf66etxhlwr2dmxx49c088n6gde3

2.2 Sandbox Test Client

• Access URL: https://admin-sandbox.onewarehouse.net/
• Login Account: Please use the Sandbox test account exclusively configured and provided by us.

3. Integration and Testing Process

Testing Steps Description:

1. Submit Environment Configuration: Please submit the above six receiving URLs to us.
2. Test Environment Setup (Estimated 2 working days): We will configure the Webhook in the backend based on the URLs you provided. Once completed, we will deliver the Sandbox account and environment for your testing.
3. Login Client for Self-Testing (API Trigger Instructions): Please log in to the Sandbox client and manually perform the following operations to trigger each API push and test the complete business flow (it is recommended to follow the sequence below):
   • Product Sync API:
     • Initial Sync: Triggered when creating a "Purchase Inbound Order" and clicking save (the initial sync of a new product occurs when creating an inbound order).
     • Subsequent Updates: Triggered when editing an existing product and clicking save.
   • Purchase Inbound Order API: Triggered when creating and saving a "Purchase Inbound Order".
   • [Outbound Prerequisite] Inbound Order Callback API: After receiving the purchase inbound order, please be sure to call the Inbound Order Callback API first to simulate the warehouse completing the inbound process. This will generate actual inventory for the product to be tested, which is a mandatory prerequisite for successfully executing subsequent outbound operations.
   • Return Inbound Order API: Triggered when executing the "Execute Inbound" action for pending return orders.
   • Inbound Order Cancellation API: Triggered when executing the "Void/Intercept Inbound" action for pending inbound orders.
   • Outbound Order Creation API: Provided there is inventory, triggered when executing the "Execute Outbound" action for pending orders.

   • Get Shipping Label API: After receiving the outbound order push and successfully executing the outbound process, you can call this API to get the shipping label image.

     ⚠️ CRITICAL: The Get Shipping Label API must be called before the "Outbound Order Callback API". Once you call the Outbound Order Callback API to change the order status to shipped, you will no longer be able to call the Get Shipping Label API.

   • [Outbound Return] Outbound Order Callback API: After successfully obtaining the shipping label and completing the operations within the warehouse, call this API to synchronize the order status to shipped.
   • Outbound Order Cancellation API: Triggered when executing the "Intercept Shipment" action for pending outbound orders.
4. Data Validation: Check whether your WMS correctly receives the data pushed at each node, and confirm whether it returns a compliant Response (e.g., HTTP 200 and the correct JSON response).
5. Troubleshooting: The OneWarehouse team will establish a dedicated communication software group with your company (supports LINE / WhatsApp / Slack / WeChat, etc.). If any errors occur or data does not meet expectations during testing, please provide the log records of the Request and Response in the group, and our technical staff will assist in troubleshooting.

4. Release and Official Go-Live

1. Launch Application: Once all required APIs for integration have passed the integration testing, and both parties confirm that the data flow is accurate, you can apply to us to switch to the production environment.
2. Parameter Switch: We will officially provide the AppKey, AppSecret, and the official version client link dedicated to the production environment.
3. Official Release: Please switch the receiving address of your WMS to the production domain name. After cooperating to complete the final online first-order verification, it can officially go live and run.

If you have any technical questions, please feel free to contact the OneWarehouse technical integration team.