OpenAPI for Merchant Integration Process

1. Process Overview

To help merchants deeply integrate their internal systems (such as ERP, WMS, or independent websites) with OneWarehouse, we provide a standardized OpenAPI. The complete API integration process is divided into four standard phases: Application ➔ Configuration & Setup ➔ Development & Testing ➔ Go-Live & Operations.

2. Detailed Onboarding Steps

Phase 1: Application

Before starting any technical development, please contact our team to complete a preliminary requirement assessment.

1. Contact Customer Support / Account Manager: Merchants should first contact OneWarehouse customer support or their dedicated Account Manager to express their intention to integrate.

2. Submit Business Requirements: Submit an integration request containing basic company information, business scenarios, expected system types for integration, and estimated API request volume. This allows the platform to conduct a preliminary review and resource assessment.

Phase 2: Configuration & Setup

Once approved, we will prepare a dedicated test environment and credentials for your team.

1. Create an Account & Obtain Credentials: Please go to the platform's test environment (https://admin-test.onewarehouse.net/user/login) to create a merchant test account. This account will be used exclusively for Sandbox testing and debugging.

2. Obtain API Credentials: Apply for and retrieve your Signature Authentication Key or OAuth 2.0 Credentials. (⚠️ These are critical credentials for making API calls. Please ensure your technical team keeps them highly secure.)

3. Platform Review & Parameter Configuration: OneWarehouse will review your test account application and configure relevant parameters (e.g., Webhook callback URLs, notification methods) based on your specific business needs.

Phase 3: Development & Testing

Enter the actual coding phase. Please conduct all development entirely within the test environment to avoid affecting live production data.

1. Access API Documentation: Your technical team should review the OpenAPI Developer Documentation online to understand API endpoints, request parameters, and response formats.

   • 👉 Documentation Link: https://openapi.myoneship.cn/docs/guide?token=c9e66078-dc23-4a45-b3c4-ae3a6abf22c8

2. Set Up Development Environment: Prepare your local development environment (programming languages, tools, etc.) and write the code according to the API documentation to establish data interaction.

3. Sandbox Testing: Use the Sandbox environment provided by the platform to execute API call tests. Ensure you thoroughly verify the accuracy of the API requests and confirm that data exchanges (like order syncing and inventory updates) are functioning flawlessly.

Phase 4: Go-Live & Operations

After successful testing and receiving confirmation from the platform, you can switch to the production environment.

1. Deploy to Production Environment: Deploy your finalized code to the official production environment. Ensure that production network and security settings (like IP whitelists and firewalls) are properly configured.

2. Monitoring & Maintenance:

   • Real-time Monitoring: After going live, actively monitor your API traffic (including success rates, response times, and error codes).

   • Regular Updates: Periodically check for OneWarehouse OpenAPI updates and adjust your code to maintain compatibility with future versions.

3. Optimization & Expansion: Adjust and optimize your API calling strategies (e.g., utilizing batch processing) based on actual operational data. As your business grows, you can gradually expand the API scope to utilize additional functional modules.

📚 Quick Resource Links

• Test Environment Backend Login: https://admin-test.onewarehouse.net/user/login

• OpenAPI Developer Documentation: https://openapi.myoneship.cn/docs/guide?token=c9e66078-dc23-4a45-b3c4-ae3a6abf22c8