Shopify Integration

Overview

Shopify is a leading cloud-based e-commerce platform that enables businesses to create online stores and sell products across multiple channels. The Shopify integration package provides comprehensive tools for synchronizing products, orders, customers, inventory, collections, gift cards, and more between Shopify and other systems.

⚠️ API Deprecation Notice

Important: The REST API endpoints in this package are now DEPRECATED. For new projects, use the GraphQL endpoints instead, which provide better performance, more flexibility, and access to the latest Shopify features.

GraphQL is Shopify's preferred API technology and offers several advantages:

  • More efficient data retrieval (request only what you need)
  • Stronger typing and better error handling
  • Better support for Shopify's latest features
  • Improved performance

For more information, see the Shopify GraphQL Admin API documentation.

Key Features

🛍️ Product Management

Sync products, variants, pricing, and inventory across systems with both REST and GraphQL APIs

📦 Order Processing

Pull orders from Shopify and push order updates, including fulfillments and tracking

👥 Customer Sync

Synchronize customer data, addresses, and account information bidirectionally

📊 Inventory Control

Manage inventory levels across locations with real-time updates via REST or GraphQL

🏷️ Collections

Organize products into smart and custom collections for better merchandising

🎁 Gift Cards

Pull and push gift card data for promotional campaigns and customer rewards

Configuration

Required Fields

Configure the Shopify integration with the following API credentials:

{
  "shopify": {
    "api_parameters": {
      "api_secret_key": "shpss_xxxxxxxxxxxxx",
      "admin_api_access_token": "shpat_xxxxxxxxxxxxx",
      "host_name": "your-store.myshopify.com",
      "shop": "your-store",
      "private_access_token": "shpat_xxxxxxxxxxxxx",
      "api_version": "2023-07"
    }
  }
}

api_secret_key

Type: String (required)

Description: The API secret key for your Shopify custom app

How to get: Create a custom app in Shopify Admin → Apps → App development → Create an app → Configuration tab

admin_api_access_token

Type: String (required)

Description: Admin API access token with appropriate permissions

How to get: In your custom app → API credentials → Admin API access token (install the app to reveal)

host_name

Type: String (required)

Description: Your Shopify store's hostname

Example: your-store.myshopify.com

shop

Type: String (required)

Description: Your Shopify store name (without .myshopify.com)

Example: your-store

private_access_token

Type: String (optional)

Description: Storefront API private access token (required for storefront operations)

How to get: Custom app → API credentials → Storefront API access token

api_version

Type: String (optional)

Description: Shopify API version to use

Default: 2023-07

Example: 2024-01, 2024-04

Note: See Shopify API release notes for available versions

How to Get Shopify API Credentials

  1. Access Shopify Admin

    Log in to your Shopify store admin panel at https://your-store.myshopify.com/admin

  2. Navigate to Apps

    Go to Settings → Apps and sales channels → Develop apps (you may need to enable custom app development first)

  3. Create Custom App

    Click Create an app, provide an app name (e.g., "Retrieve Integration"), and select an app developer

  4. Configure API Scopes

    Click Configure Admin API scopes and select the permissions your integration needs:

    • read_products, write_products - For product sync
    • read_orders, write_orders - For order management
    • read_customers, write_customers - For customer sync
    • read_inventory, write_inventory - For inventory updates
    • read_fulfillments, write_fulfillments - For shipping/fulfillments
    • read_gift_cards, write_gift_cards - For gift card operations
  5. Install the App

    Click Save, then click Install app to generate the access tokens

  6. Copy Credentials

    Go to API credentials tab and copy the following values (shown only once - save them securely!):

    • Admin API access token → admin_api_access_token
    • API secret key → api_secret_key
    • Storefront API access token (if needed) → private_access_token

    Your host_name is your store URL (e.g., your-store.myshopify.com) and shop is just the store name (e.g., your-store)

  7. Add to Retrieve

    In Retrieve, configure your Shopify integration with these credentials in the api_parameters object

Action-Specific Configuration

Some actions support additional configuration fields:

Incremental Sync (Pull Actions)

For pull actions, you can specify a timestamp to pull only records updated since that date:

{
  "shopify": {
    "api_parameters": { ... },
    "orders_last_pull": "2024-01-15T10:30:00Z",
    "products_last_pull": "2024-01-15T09:00:00Z",
    "customers_last_pull": "2024-01-15T08:00:00Z"
  }
}

These fields are automatically updated after each successful pull with the latest sync timestamp.

Resources

📖 REST Admin API

Official REST API documentation

🚀 GraphQL Admin API

GraphQL API reference (recommended)

🔐 Authentication Guide

Setting up API credentials

Next Steps

After configuring your Shopify integration:

  • Select an action from the list above to view detailed implementation guides
  • Review the Shopify API rate limits to plan your sync frequency
  • Consider using GraphQL endpoints for new integrations for better performance
  • Test your integration in a Shopify development store before going to production