Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
medusa-plugin-shopify-ts
Advanced tools
Readme
Typicall shopify stores can have from between a few 100 products to millions of products. We found syncing large stores difficult, so we built an upgraded pluging that takes advantage of medusa's batch processing capabilities to sync between the medusa store and shopify. Each page retrieved from shopify is treated as a batch for processing later.
Nothing much here, just install the plugin like any other plugin,
yarn add medusa-plugin-shopify-ts
In medusa-config.js
{
resolve:'medusa-plugin-shopify-ts'
options:{
api_key : #"<Your default shopify private app admin api key>}
store_domain: #"<Your default shopify domain without the myshopify.com part for example :abc.myshopify.com will be abc>"
default_store_name: #"default_store_name"
}
}
This plugin takes advantage of the event bus system that medusa offers, So the best way to trigger the sync is to listen for the event, and resolve the shopify service and call sync. Here is a simplified implementation of how you can do this
async syncWithShopify(): Promise<boolean> {
// return true;
await this.shopifyService_
.withTransaction(this.manager_)
.importIntoStore(
{
...this.shopifyService_.options /* default store */,
enable_vendor_store: true,
auto_create_store: true,
medusa_store_admin_email:
this.configModule.projectConfig.secureKeys
.ADMIN_EMAIL ?? "admin@testwebsite.com"
},
(job: BatchJob): Promise<void> => {
this.logger.info(`${job.id} created`);
return;
}
);
await this.atomicPhase_(async (manager) => {
return await this.eventBusService
.withTransaction(manager)
.emit("medusa.shopify.sync.completed", {});
});
return true;
}
The sync with shopify is triggered in response to a startup completion event, or any other event you'd like Here is the full service implementation
import {
BatchJob,
EventBusService,
TransactionBaseService
} from "@medusajs/medusa";
import { ConfigModule } from "@medusajs/medusa/dist/types/global";
import { default as ShopifyService } from "medusa-plugin-shopify-ts/services/shopify";
import { EntityManager } from "typeorm";
import { Service } from "medusa-extender";
import { Logger } from "@medusajs/medusa/dist/types/global";
export interface PostStartupActionServiceProps {
manager: EntityManager;
eventBusService: EventBusService;
shopifyService: ShopifyService;
configModule: ConfigModule;
logger: Logger;
}
class PostStartupActionService extends TransactionBaseService {
protected manager_: EntityManager;
protected transactionManager_: EntityManager;
shopifyService_: ShopifyService;
readonly container: PostStartupActionServiceProps;
protected configModule: ConfigModule;
protected readonly configModule_: ConfigModule;
static resolutionKey = "postStartupActionService";
eventBusService: EventBusService;
logger: Logger;
constructor(container: PostStartupActionServiceProps) {
super(container);
this.manager_ = container.manager;
this.container = container;
this.configModule = container.configModule;
this.shopifyService_ = container.shopifyService;
this.eventBusService = container.eventBusService;
this.logger = container.logger;
}
withTransaction(transactionManager: EntityManager): this {
if (!transactionManager) {
return this;
}
const cloned = new PostStartupActionService({
...this.container,
manager: transactionManager
});
cloned.transactionManager_ = transactionManager;
return cloned as this;
}
async syncWithShopify(): Promise<boolean> {
// return true;
await this.shopifyService_
.withTransaction(this.manager_)
.importIntoStore(
{
...this.shopifyService_.options /* default store */,
enable_vendor_store: true,
auto_create_store: true,
medusa_store_admin_email:
this.configModule.projectConfig.secureKeys
.ADMIN_EMAIL ?? "admin@testwebsite.com"
},
(job: BatchJob): Promise<void> => {
this.logger.info(`${job.id} created`);
return;
}
);
await this.atomicPhase_(async (manager) => {
return await this.eventBusService
.withTransaction(manager)
.emit("medusa.shopify.sync.completed", {});
});
return true;
}
}
export default PostStartupActionService;
The plugin also exposes to api (experimental)
"/save-shopify-products", --retrieves and saves the products
"/fetch-shopify-products", -- retrived the products from shopify.
As much as we love FOSS software, nothing in this world is truely free. We'll be grateful if you can buy our team a coffee (https://www.buymeacoffee.com/uMRqW9NmS9).
FAQs
A plugin to pull from shopify store
The npm package medusa-plugin-shopify-ts receives a total of 15 weekly downloads. As such, medusa-plugin-shopify-ts popularity was classified as not popular.
We found that medusa-plugin-shopify-ts demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.