Key Features

• Product Synchronization:
  • Export product templates and variants from Odoo to Shopify (create and update)
  • Import product templates, variants, and images from Shopify
  • Synchronize product prices and basic information (barcode, weight, SKU) in both directions
  • Export and import product variant price, SKU, barcode and weight individually
  • Support for multiple product images per product template
  • Associate product images with specific product variants
  • Real-time product updates via Shopify webhooks (products/update)
• Product Attributes:
  • Import product attributes (characteristics) and their values from Shopify
  • Map Shopify options/variants to Odoo product attributes
• Customer Integration:
  • Import Shopify customers into Odoo’s contact database
  • Maintain consistent customer records across platforms
  • Automated detection of companies based on Shopify note attributes or company field
  • Real-time customer updates via Shopify webhooks
• Order Management:
  • Import sales orders from Shopify into Odoo
  • Automated creation of Odoo sales orders for Shopify purchases
  • Order status updates synchronized from Odoo to Shopify via tags (Sale Phases)
  • Import and map Shopify sale stages (order tags) to Odoo phases
  • Synchronize order cancellation from Odoo to Shopify
  • Support for Shopify webhooks (orders/updated) to automatically update orders in Odoo
• Payment and Delivery:
  • Import and map Shopify payment methods (payment acquirers) to Odoo
  • Integration with Shopify payment transactions and creation of payments in Odoo
  • Automatic mapping of delivery carriers and creation of delivery lines on orders
  • Support for pickup points (lockers) information from Shopify notes
• Automated Operations:
  • Scheduled synchronization jobs via queue_job
  • Real-time updates for orders, products and customers via webhooks
  • Automatic OAuth token refresh for Shopify Dev Dashboard Apps (tokens expire every 24h)

Authentication

The module supports two authentication modes:

Legacy Private Apps (permanent token)

Set Access Token manually in the backend configuration. Leave Token Expires At empty. The token is used as-is and never auto-refreshed.

Dev Dashboard Apps (OAuth ``client_credentials``, tokens expire in 24h)

Starting early 2025, Shopify Dev Dashboard Apps issue short-lived tokens via the OAuth client_credentials grant. Configure Client Id and Client Secret in the backend.

On first login (or when the token is missing), the module automatically requests a new token by posting to /admin/oauth/access_token with grant_type=client_credentials. The expiry time (Token Expires At) is saved on the backend record.

Subsequent API calls check the expiry: if the token expires within 30 minutes, it is silently refreshed before the call proceeds.

A scheduled action (“Shopify: Refresh Access Tokens”) runs every 23 hours to proactively renew tokens for all active backends that already have a Token Expires At date set (i.e. Dev Dashboard App backends). Backends with a permanent token (no expiry date) are never touched by the cron.

Technical Implementation

The module leverages the ShopifyAPI Python library to communicate with Shopify’s REST API and implements a sophisticated binding system based on the Deltatech marketplace framework:

• Backend Adapter: Manages API communication and authentication with Shopify
• Binding Models: Connect Odoo entities with their Shopify counterparts:
  • Product template and variant bindings
  • Customer and address bindings
  • Sales order and order line bindings
  • Delivery carrier and payment acquirer bindings
  • Sale phase (tags) bindings

Integration Requirements

The module requires:

• External Python dependency: ShopifyAPI library
• Core Deltatech marketplace modules:
  • deltatech_marketplace (base functionality)
  • deltatech_marketplace_sale (sales integration)
  • deltatech_marketplace_payment (payment integration)
  • deltatech_marketplace_delivery (delivery integration)

Benefits

• Operational Efficiency: Manage online stores without switching between platforms
• Data Consistency: Single source of truth for product and customer information
• Time Savings: Eliminate manual data entry and reduce administrative overhead
• Error Reduction: Automated synchronization prevents discrepancies
• Improved Customer Experience: Faster order processing and automated tracking updates

Features:

• import products (templates and variants) from Shopify
• export product templates and variants to Shopify (create and update)
• import product images (multiple images, with variant association) from Shopify
• import product prices (list_price) from Shopify; export price per variant
• import product metadata (barcode, weight, SKU) from Shopify; export per variant
• import product attributes (characteristics) and values from Shopify
• import sale orders from Shopify
• import customers from Shopify
• import sale stages (order tags / phases) from Shopify
• import payment acquirers (payment methods) from Shopify
• synchronize order status (tags) to Shopify via Sale Phases
• cancel Shopify orders when cancelled in Odoo
• support for Shopify webhooks (orders/updated, products/update, customers/update)
• automatic OAuth token refresh for Dev Dashboard Apps (client_credentials grant)

Table of contents

Authors

• Terrabit
• Dorin Hongu

Maintainers

Current maintainer:

This module is part of the terrabit-ro/bitshop project on GitHub.

You are welcome to contribute.