← Back to Console Docs

Platform Integrations

Connect your e-commerce platforms and sync products automatically

What are Platform Integrations?

Platform Integrations connect Calibrate to your e-commerce systems (like Shopify or Amazon), enabling bidirectional data sync. Calibrate imports your product catalog and prices, then can push approved price changes back to your storefront - all automatically.

How Integrations Work

  1. 1.
    Authentication: You authorize Calibrate to access your platform via OAuth (Shopify) or API credentials (Amazon)
  2. 2.
    Initial Sync: Calibrate imports your complete product catalog, variants, and current prices
  3. 3.
    Ongoing Sync: Periodic and webhook-based updates keep data current
  4. 4.
    Price Application: When you apply price changes in Calibrate, they're pushed back to your platform

Security: All credentials are encrypted at rest. Calibrate only requests the minimum permissions needed (read products, write prices). You can revoke access anytime from your platform admin.

Prerequisites

For Shopify Integration

  • Active Shopify store (any plan)
  • Store Owner or Staff account with "Manage products" permission
  • Your Shopify store domain (e.g., mystore.myshopify.com)
  • Products already created in Shopify (or ready to import)

For Amazon Integration

  • Amazon Seller Central account
  • Registered SP-API Developer Application
  • LWA Client ID, Client Secret, and Refresh Token
  • Active product listings in Amazon

Supported Platforms

Calibrate currently supports Shopify (full bidirectional sync) and Amazon SP-API (read-only import). More platforms coming soon.

Access: Navigate to Integrations in the project sidebar, or visit /p/[your-project]/integrations

Supported Platforms

🛍️

Shopify

Full Integration

Read products, variants, and prices. Write price changes back to Shopify.

Features:
  • OAuth-based authentication
  • Automatic product and variant sync
  • Real-time price updates via webhooks
  • Bidirectional sync (read and write)
  • Price change write-back to store
📦

Amazon SP-API

Read-Only Integration

Import product catalog and pricing data. Monitor competitor prices. No price write-back in MVP.

Features:
  • SP-API credential authentication
  • Catalog import and sync
  • Pricing data collection
  • Competitive price monitoring
  • Read-only access (no write-back)
💳

Stripe

Beta Integration

Import products, prices, and transactions. Enable true margin analysis.

Features:
  • Secure API Key connection
  • Product and Price sync
  • Transaction import for margin analysis
  • Real-time webhooks
  • Unified analytics

Connecting Shopify

Setup Process

  1. 1.
    Navigate to Integrations page and click on the Shopify card
  2. 2.
    Click "Connect Your Store" button
  3. 3.
    Enter your Shopify store domain (e.g., mystore.myshopify.com)
  4. 4.
    You'll be redirected to Shopify to authorize Calibrate
  5. 5.
    Log in to your Shopify admin and grant permissions:
    • • Read products and variants
    • • Write product prices
    • • Read orders (for analytics)
  6. 6.
    Click "Install app" on Shopify
  7. 7.
    You'll be redirected back to Calibrate console with a success message
  8. 8.
    Initial product sync will start automatically

💡 Tip: Make sure you have admin access to your Shopify store before starting the OAuth flow.

Connecting Amazon

Prerequisites

  • Active Amazon Seller Central account
  • Amazon SP-API credentials (Client ID and Secret)
  • Refresh token for your seller account

Setup Process

  1. 1.
    Go to Amazon Seller Central and register for SP-API access
  2. 2.
    Create a Developer Application and note your:
    • • LWA Client ID
    • • LWA Client Secret
    • • Refresh Token
  3. 3.
    In Calibrate console, navigate to Integrations → Amazon
  4. 4.
    Click "Connect Amazon SP-API"
  5. 5.
    Enter your SP-API credentials (Client ID, Secret, Refresh Token)
  6. 6.
    Select your marketplace (US, UK, EU, etc.)
  7. 7.
    Click "Connect" to test credentials
  8. 8.
    If successful, catalog sync will begin automatically

Connecting Stripe

Prerequisites

  • Active Stripe account
  • Access to Developers > API keys in Stripe Dashboard

🔒 Security Recommendation

We strongly recommend using a Restricted Key instead of a Secret Key. This ensures Calibrate only has access to the data it needs.

Required Permissions:
  • Products: Read
  • Prices: Read
  • Charges: Read
  • PaymentIntents: Read

Setup Process

  1. 1.
    Go to your Stripe Dashboard: Developers → API keys
  2. 2.
    Click "Create restricted key"
  3. 3.
    Name the key (e.g., "Calibrate Integration") and select Read for the resources listed above
  4. 4.
    Copy the generated key (starts with rk_...)
  5. 5.
    In Calibrate, go to Integrations → Stripe and click Connect
  6. 6.
    Paste your key and click Connect
  7. 7.
    Initial sync of products, prices, and transactions will begin immediately

Managing Integrations

Connection Status

View the status of your platform connections

  • Connected: Platform is linked and syncing
  • Not Connected: Platform needs to be set up
  • Error: Connection issue (check credentials)

Sync History

Monitor recent sync operations

  • Last sync timestamp
  • Sync status (Success, Syncing, Error)
  • Number of products/variants synced
  • Error messages and troubleshooting info

Manual Sync

Trigger sync operations on demand

  • Product sync: Import latest catalog
  • Price sync: Fetch current prices
  • Full sync: Complete re-import

Disconnect

Remove platform integration

  • Click 'Disconnect' button
  • Confirm in the modal
  • Catalog data is preserved
  • No more automatic syncs

Sync Settings

Automatic Sync

Connected platforms sync automatically on the following schedule:

  • Initial Import: When first connected, full catalog import
  • Periodic Sync: Every 6 hours for product and price updates
  • Webhook Triggers: Real-time updates when products change (Shopify only)
  • Price Application: Immediate sync when applying price changes

Webhook Configuration

For Shopify, webhooks are automatically configured during OAuth setup:

  • Product create/update/delete events
  • Variant update events (price changes)
  • Inventory level changes

Note: Webhooks ensure your catalog stays in sync in near real-time without manual intervention.

Troubleshooting

Sync Failed

Common Causes:
  • Platform credentials expired or revoked
  • Platform API is temporarily down
  • Network connectivity issues
Solutions:
  1. 1.Check connection status on Integrations page
  2. 2.Verify platform credentials are still valid
  3. 3.Disconnect and reconnect the integration
  4. 4.Contact support if issue persists

Products Not Syncing

Common Causes:
  • Products are archived or deleted in platform
  • Sync is in progress (can take time for large catalogs)
  • Platform API rate limits
Solutions:
  1. 1.Wait for sync to complete and check again
  2. 2.Trigger manual sync from Integrations page
  3. 3.Check sync history for error messages
  4. 4.Verify products exist in platform admin

Price Changes Not Applying

Common Causes:
  • Connector sync is queued or in progress
  • Platform credentials don't have write permissions
  • Product/variant no longer exists in platform
Solutions:
  1. 1.Check connector status in price change details
  2. 2.Verify integration has write permissions
  3. 3.Check platform for product availability
  4. 4.Review error message in connector status

Best Practices

Monitor Sync Status Regularly
Check the Integrations page weekly to ensure platforms are syncing successfully.
Use Manual Sync Sparingly
Automatic syncs should handle most updates. Only trigger manual sync if you need immediate refresh.
Test with Small Changes First
When first connecting a platform, test with a few price changes before bulk operations.
Keep Credentials Secure
Never share your API credentials. Rotate them periodically for security.
Review Sync Logs
After major catalog changes in your platform, review sync logs to ensure all updates were captured.

API Reference

The Platforms API allows you to manage platform integrations and trigger sync operations programmatically. All endpoints require authentication via Bearer token.

GET /api/platforms

List all available platform integrations and their connection status

QUERY PARAMETERS:
  • • project: Project slug (required)
GET /api/platforms/:platform

Get connection status and details for a specific platform (shopify, amazon)

QUERY PARAMETERS:
  • • project: Project slug (required)
POST /api/platforms/:platform/sync

Trigger a manual sync operation for a connected platform

REQUEST BODY:
{
  "projectSlug": "demo",
  "syncType": "full" | "products" | "prices"
}
GET /api/platforms/:platform/sync/status

Get sync status and history for a platform integration

Response Example

{
  "platform": "shopify",
  "connected": true,
  "status": "active" | "error" | "disconnected",
  "lastSync": {
    "timestamp": "2024-01-15T10:30:00Z",
    "status": "success" | "in_progress" | "failed",
    "productsCount": 150,
    "errorMessage": null
  },
  "capabilities": {
    "read": true,
    "write": true
  }
}

Related Documentation