Setting Up Integrations with Osa Commerce
Learn about the ways in which integrations may be set up to enhance your business's efficiency and productivity.
Table of Contents
This article outlines the most common types of integrations that are set up with Osa Commerce, and goes into some detail of what can be expected while setting them up.
This is not a comprehensive list, and with Osa's fully tech-agnostic Integration Manager, optimal integrations of any type can be set up based on the specific requirements for the integration and the system capabilities.
API Integrations
API integration is the process of connecting two or more applications or systems using APIs (Application Programming Interfaces) to exchange data and perform actions.
Most out-of-the-box service providers (such as Shopping Carts and web-based solutions) use API as their preferred method of integrations.
Timeline for Integration
While there is an abundance of API documentation is typically available, each integration will need to be scoped individually to provide an accurate assessment of the length of time required to complete the setup. However, each endpoint can be estimated to take around 1-2 weeks for completion.
Osa's API Documentation
Unified Commerce API Documentation
Osa Warehouse Management API Documentation
EDI Integrations
EDI integration, or Electronic Data Interchange integration, is the process of electronically exchanging business documents between organizations. Among the applications of EDI integrations are data interchanges in the supply chain industry.
Different types of EDI documents have differing levels of complexity and correspondingly take different lengths of time to scope out, establish and test.
Most often, the following data is required before the process of EDI integration can begin:
- Connector (FTP, SFTP, AS2, VAN, etc.)
- Number and Type of Documents (832, 846, 850, 856, 810, etc.)
- Specification Documents (X12, Flat File, XML, Json, Database)
- Sample Files for each document
- Identification / Credentials (Trading Partner ID, Login, API Keys, etc) - depending on the solution
Timeline for Integration
This can be approximated based on the type of integration being set up.
For documents such as: 832 [Price/Sales Catalog], 846 [Inventory Inquiry/Advice], 850 [Purchase Order], 856 [Ship Notice/Manifest], 810 [Invoice]
- In general each document takes around 15 hours with about 1 hour of framework, 8 hour of development, 6 hours of testing and approval with the retailer.
- This process usually takes (for each document) about
- 1 to 2 weeks for development
- 2 to 4 weeks for testing and approval
For documents such as: 943 [Warehouse Stock Transfer Shipment Advice], 944 [Warehouse Stock Transfer Receipt Advice], 940 [Warehouse Shipping Order], 945 [Warehouse Shipping Advice], 947 [Warehouse Inventory Adjustment Advice]
- In general these are much more complex to set up due to more framework and logic steps needing to be accounted for. These need to be scoped case by case.
- This process usually takes (for each document) about
- 2 to 3 weeks for development
- 2 to 4 weeks for testing and approval
- 4 to 6 weeks for hypercare
There are several other documents which may be exchanged or required that will need to be scoped based on individual expectations, such as: 997 [Functional Acknowledgment], 753 [Request for Routing Instructions], 754 [Routing Instructions].
Direct Integrations
Direct integration, also known as point-to-point integration, is a method of connecting two applications or systems without using a centralized integration platform.
Due to the amount of customization with any of these platforms they are often hard to directly integrate to. There is also usually a large amount of logic which needs to be customized and accounted for. Typically, these integration will require a detailed scoping session where an overall architecture will be built and a data flow document created which will be agreed upon by all parties before proceeding.
Timeline for Integration
In general this process takes:
- 1 to 4 weeks of scoping
- 2 to 8 weeks of development
- 2 to 4 weeks of testing and approval
- 4 to 8 weeks of hypercare