Medusa Recommend Product Plugin

Table of Contents

1. Installation
2. Usage
   • Register the Plugin
   • Run Migrations
   • Admin Panel Features
3. API Reference
   • Store API
   • Admin API
4. Error Handling
5. License

Installation

1
npm install medusa-recommend-product-plugin

Usage

Register the Plugin

1. Open Copy to clipboardmedusa-config.js.
2. Locate the Copy to clipboardplugins array.
3. Add the plugin configuration as shown below:

123456789
const plugins = [
  // other plugins
  {
    resolve: "medusa-recommend-product-plugin",
    options: {
      enableUI: true, // Enables the admin UI for managing recommendations
    },
  },
];

Run Migrations

1
npx medusa migrations run

Admin Panel Features

• View Recommendations: On the product details page, you can view the list of current recommendations.
• Add New Recommendations: Easily add new product recommendations through a simple interface.

API Reference

Store API

Get Product Recommendations

• URL: Copy to clipboard/api/store/products/{productId}/recommendations
• Method: Copy to clipboardGET
• Content-Type: Copy to clipboardapplication/json

1
curl -X GET "https://your-medusa-url.com/api/store/products/123/recommendations"

1234567891011121314
[
 [
    {
      "id": "recommendation_.....",
      "recommendedProduct": [{
        "id": "prod1",
        "name": "Product 1",
        "description": "This is product 1",
        ...
      }],
      "forProductId":"product_1"
    },
  ]
]

Admin API

Create Product Recommendations

• URL: Copy to clipboard/api/admin/recommendations
• Method: Copy to clipboardPOST
• Content-Type: Copy to clipboardapplication/json

123456
curl -X POST "https://your-medusa-url.com/api/admin/recommendations" \
-H "Content-Type: application/json" \
-d '{
  "forProductId": "prod1",
  "recommendedProducts": ["prod2", "prod3"]
}'

1234567891011121314
{
  "data": [
    {
      "id": "recommendation_.....",
      "recommendedProduct": [{
        "id": "prod1",
        "name": "Product 1",
        "description": "This is product 1",
        ...
      }],
      "forProductId":"product_1"
    },
  ]
}

Delete Product Recommendations

• URL: Copy to clipboard/api/admin/recommendations
• Method: Copy to clipboardDELETE
• Content-Type: Copy to clipboardapplication/json

12345
curl -X DELETE "https://your-medusa-url.com/api/admin/recommendations" \
-H "Content-Type: application/json" \
-d '{
  "recommendationIds": ["rec1", "rec2"]
}'

123
{
  "success": true
}

Error Handling

Error Response Format

12345678910111213
{
  "message": "Error message describing the issue.",
  "code": "Error code",
  "errors": [
    {
      "field": "Field that caused the error",
      "message": "Detailed message about the error"
    }
  ],
  "payload": {
    // Additional error-related data, if applicable
  }
}

Common Error Codes

• Copy to clipboardINTERNAL_SERVER_ERROR: An unexpected error occurred on the server.
• Copy to clipboardVALIDATION_ERROR: Input data failed validation.
• Copy to clipboardBAD_REQUEST: The request was malformed or invalid.
• Copy to clipboardNOT_FOUND: The requested resource was not found.
• Copy to clipboardUNPROCESSABLE_ENTITY_ERROR: The server understood the request but could not process it.

Example Error Messages

• Copy to clipboardrecommendationAlreadyExist: "This product already has a recommendation associated with the recommended product."
• Copy to clipboardrecommendationNotFound: "Recommendation not found for the provided ID."
• Copy to clipboardnoDuplicateProdRecommendation: "You cannot create multiple recommendations for the same product with the same recommended product."

License