Integration Development Guides

Guides for partners connecting Propeller with external business systems. All content in this section uses the REST API.

Each topic starts with a concept explanation covering how Propeller handles the domain from an integration perspective, followed by practical how-to content with code examples.

Integration patterns

Architectural patterns, core API concepts and authentication. Start here to understand how Propeller fits into a business system landscape.

• Sources — connecting external system identifiers to Propeller resources
• Lookup Keys — referencing resources by external ID instead of internal Propeller IDs
• Pagination — controlling list results with page and offset parameters
• Directives — controlling bulk endpoint behavior during data import
• Expanding Resources — requesting related data inline to avoid separate API calls
• Localized Strings — handling multi-language content in API requests and responses
• B2B/B2C Data Models — differences between business and consumer commerce data models
• Authentication and security — OAuth 2.0 token management and credential security
• Webhooks and events — subscribing to platform events and triggering actions via webhooks

Domain guides

Domain-level guides for syncing data between Propeller and external business systems (ERP, PIM, CRM).

Users

• Import Companies, Contacts and Customers
• Import Addresses
• Export Companies, Contacts and Customers

Products and Categories

• Import Categories
• Import Products with Attributes
• Import Media
• Import Stock

Pricing

• Import Product Prices
• Import Product Cost Prices
• Import Customer-specific Pricing

Orders

• Import Orders
• Import Order Shipments
• Update Order Status of Orders
• Export Orders