Hold on! This plugin is still a work in progress and definetely has got some limitations or bugs. I recommend testing it thoroughly and only use it in a production environment if you're 100% confident it fulfills your needs. Please report any issues you encounter to help me (and the community) improve the plugin.

Introducing Medusa-Plugin-Printful

Requirements

• Fully working Medusa server, with Redis and Postgres running (when running locally, you should proxy the server through a service like ngrok to make it accessible for Printful webhooks).
• Printful Account and Store (ID)

Installation

1. In your Medusa Server root, run the following command:
   Copy to clipboardyarn add medusa-plugin-printful
2. Next, configure the plugin in your medusa-config.js file as described in the Configuration section above.
3. Start your Medusa server with Copy to clipboardyarn start and verify that the plugin is working correctly by testing its functionality thoroughly. Please keep in mind that the plugin is still a work in progress and may have some limitations or bugs.

Configuration

123456789101112131415
{
    resolve: medusa-plugin-printful,
    options: {
        printfulAccessToken: process.env.PRINTFUL_ACCESS_TOKEN, 
        storeId: process.env.PRINTFUL_STORE_ID, 
        backendUrl: process.env.BACKEND_URL, 
        enableWebhooks: true, 
        enableSync: true,
        batchSize: 3
        productTags: true,
        productCategories: true,
        redisURL: REDIS_URL or process.env.REDIS_URL,
        confirmOrder: true
    }
}

Options

• Copy to clipboardprintfulAccessToken: Access token for the Printful API.
• Copy to clipboardstoreId: Store ID for Printful.
• Copy to clipboardbackendUrl: Base URL for the Medusa server (without trailing slash - i.e. Copy to clipboardhttp://localhost:9000 or Copy to clipboardhttps://api.your-domain.com).
• Copy to clipboardenableWebhooks: Enable or disable Printful webhook listener.
• Copy to clipboardenableSync: Enable or disable product synchronization between Printful and Medusa.
• Copy to clipboardbatchSize: This value is used to define how many jobs are added to the queue at once
• Copy to clipboardproductTags: Enable or disable wether product tags should be created and updated in Medusa
• Copy to clipboardproductCategories: Enable or disable wether product the product category should be added and updated (non-existent categories are going to be created) in Medusa.
• Copy to clipboardconfirmOrder: Enable or disable if the order should be confirmed straight away when sending it to Printful, or if the order should be sent as a draft (wich requires a manual confirmation in the Printful Dashboard). Defaults to Copy to clipboardfalse.

Enhancements and Updates

• The plugin now leverages BullMQ to handle synchronization jobs, ensuring efficient handling of multiple tasks.
• It uses an exponential backoff algorithm to manage the retries of failed tasks. This strategy helps in reducing the load on the server and improving the overall efficiency of tasks execution.
• The option Copy to clipboardbatchSize now determines the number of jobs that are added to the queue at once, giving you more control over the load management.

Custom Endpoints

• Copy to clipboard/admin/printful/create_webhooks: Manually create and enable the webhooks for Printful.
• Copy to clipboard/admin/printful/sync: Start a full Printful product catalog synchronization manually.
• Copy to clipboard/admin/printful/create_regions: Create all available regions from Printful in Medusa with the corresponding countries. (Attention: this will delete all existing regions in Medusa!)

What the plugin does

• Syncs Printful products with Medusa. (this includes variants, images, and options)
• Syncs Printful orders with Medusa.
• Creates and enables webhooks for Printful.
• Listens to Printful webhook events and automatically syncs product information & orders between Printful and Medusa.
• Can create regions in Medusa based on the regions available in Printful.
• Can create product tags and categories in Medusa based on the tags and categories available in Printful.
• Uses the BullMQ job queue to manage synchronization tasks, improving reliability and efficiency.

What's Next

Thanks

Contributing