Introduction to Retrieve
Welcome to Retrieve, an AI-powered integration platform designed to seamlessly connect your business systems and automate data flows between them.
What is Retrieve?
Retrieve is a powerful integration platform that enables businesses to:
- Connect Multiple Systems: Integrate e-commerce platforms, ERPs, CRMs, marketing tools, and custom applications
- Automate Data Flows: Schedule automatic data synchronization or trigger integrations based on events
- Transform Data: Apply custom business logic to transform data between different formats and structures
- Monitor & Debug: Track integration performance with detailed logs and error handling
Key Features
Visual Workflow Builder
Create sophisticated integrations using an intuitive node-based interface. Connect multiple systems in sequence, apply transformations at each step, and build complex data pipelines with minimal code.
Pre-built Integration Packages
Retrieve includes ready-to-use integration packages for popular platforms:
- E-commerce: Shopify, BigCommerce, WooCommerce, Magento
- ERP Systems: NetSuite, SAP, Acumatica
- CRM: Salesforce, HubSpot
- Marketing: Klaviyo, Mailchimp
- Shipping: ShipStation, EasyPost
- And many more...
Each package includes pre-configured actions for common operations like syncing products, orders, customers, and inventory.
Custom Rewrite Functions
Apply custom JavaScript code to transform data at any point in your integration:
- Data Mapping: Map fields between different system structures
- Business Logic: Apply custom validation, calculations, or filtering
- API Calls: Make additional API requests to enrich data
- Conditional Routing: Direct data to different destinations based on conditions
Real-time Monitoring
- Job History: View detailed logs of every integration execution
- Error Tracking: Identify and troubleshoot failed jobs quickly
- Performance Metrics: Monitor data volume, execution time, and success rates
- Queue Management: Control job priorities and retry failed jobs
Core Concepts
Integrations
An integration represents a configured workflow between systems. Each integration includes:
- Nodes: Individual steps in the workflow, each with its own action and configuration
- Credentials: API keys, tokens, or authentication details for each system
- Configuration: System-specific settings and parameters
- Scheduling: When and how often the integration runs
Actions
Actions are the fundamental operations performed by integrations:
- Pull Actions: Retrieve data from a source system (e.g., fetch new orders from Shopify)
- Push Actions: Send data to a destination system (e.g., create customers in NetSuite)
- Custom Actions: Execute specialized operations (e.g., cancel an order, update inventory)
Each integration package provides a set of pre-built actions tailored to that platform's API.
Important: All actions return data as an array of records in the data field. This applies to both single and multiple records:
// Always return data as an array
return {
jobStatus: 1,
data: [record1, record2, record3] // Always an array
}Workflows
Workflows enable sophisticated integrations with multiple sequential steps:
- Nodes: Individual steps in the workflow, each performing a specific action
- Connections: Define the flow of data from one node to the next
- Field Mapping: Configure how data fields are mapped between systems at each node
- Conditional Logic: Route data to different paths based on conditions
- Parallel Processing: Execute multiple branches simultaneously
Field Mapping
Field mapping defines how data is transformed between systems:
- Map source fields to destination fields
- Apply transformations (concatenation, formatting, calculations)
- Set default values for missing data
- Use conditional mappings based on data content
Rewrite Functions
Rewrite functions are custom JavaScript code snippets that provide complete control over data transformation:
- Pre-transformation: Modify data before it's processed
- Post-transformation: Adjust data after standard mapping
- Custom Logic: Implement complex business rules
- External APIs: Fetch additional data from other sources
Getting Started
Ready to build your first integration?
- Quickstart Guide - Set up your first integration in minutes
- Understanding Workflows - Learn how to build complex multi-step integrations
- Integration Packages - Explore available pre-built integrations
- Field Mapping - Master data transformation techniques
Support & Resources
If you need help:
- Browse our comprehensive Integration Packages documentation
- Learn about Rewrite Functions for advanced customization
- Understand the System Architecture for optimization insights