Skip to main content

Build an Integration

Connect business systems to Propeller using the REST API. Sync products, pricing, orders, customers and inventory between Propeller and your ERP, PIM, CRM or warehouse system.

What the REST API is for

The REST API is designed for system-to-system communication. Use it to:

  • Import products — push product data from a PIM or ERP into Propeller
  • Sync pricing — keep pricing in Propeller up-to-date with your ERP
  • Export orders — pull orders from Propeller for fulfillment processing
  • Manage customers — sync companies, contacts and addresses with your CRM
  • Update inventory — push stock levels from your warehouse system

See API Landscape for guidance on when to use the REST API vs the GraphQL API.

Steps

This track walks you through the key integration patterns:

  1. Authenticate — get an access token and make your first API call
  2. Import a catalog tree — import categories from your ERP into Propeller
  3. Search orders — search and export orders for ERP processing
  4. What's next — explore advanced integration patterns