Integration Extensions

Magento 2 Diamond Search

Installation and User Guide for Magento 2 Diamond Search Extension

Table of Contents

  1. Prerequisites( module installed previously )
    • Module Installed via composer
    • Module Installed by Placing Files in app/code
  2. Installation
    • Installation via app/code
    • Installation via Composer
  3. Configuration Settings for Diamond Search
    • General Settings
    • Filter Widget Settings
    • Myo Widget
  4. Integration Modes
    • Local
    • RapNet
  5. Custom Attribute Set
    • Settings
    • Diamonds
  6. Ring Builder
    • Choosing a Diamond
    • Choosing a Setting
    • Review Complete Ring
  7. Setup 360 view and Certificate
    • Certificate
    • 360 view
  8. Frontend

Prerequisites( module installed previously )

If you have previously installed this module on your store using MageInn Extension then you need to follow the steps below in order to install it again on your site. You will need to remove the module first then proceed with the installation steps in the next section.

Module Installed via Composer

If the module was installed previously via composer then run the commands below to remove it completely:- 

// disable the module php bin/magento module:disable Mageinn_DiamondSearch

//remove the module composer remove mageinn/module-diamondsearch

//run upgrade commands 
php bin/magento setup:upgrade 
php bin/magento setup:di:compile 
php bin/magento setup:static-content:deploy

Module Installed by placing files in app/code

If the module was previously installed by placing extension files in app/code then simply go the following directory app/code/MageInn/ and remove the DiamondSearch folder completely then run the upgrade commands as shown below:- 

php bin/magento setup:upgrade 
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

Installation

https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer

Configuration Settings for Diamond Search

Go to Admin> Stores> Configuration> Scommerce > Diamond Search

General Settings

image (57).jpg

Widget Filter Settings

image (78).png

image (58).jpg

image (59).jpg

image (59).jpg

image (79).png

image (60).jpg

image (80).png

Myo Widget

image (81).png

Integration Modes

The extension comes with two integration modes:- Local and RapNet.

Local

When mode is set to local you can create your diamond products directly from Magento admin. All you need to do is to assign "Diamonds" attribute set to your diamond products

RapNet

RapNet brings millions of dollars in diamond product to your Magento store, without the cost of owning the physical diamonds. All diamonds and attributes should be configured directly from RapNet admin panel. RapNet provides data and pricing in real time. Once the customer places the order using the ring builder the product gets automatically created in Magento catalog. https://www.rapnet.com/

Custom Attribute Set

By default, the module adds two attribute sets i.e. Settings and Diamonds. These contain essential attributes for the module to work. If you want to create a custom attribute set, you need to include the attributes from these existing sets in order for your custom attribute set to work properly and the functional flow to be correct. We will go through each of these attribute sets and the attributes contained within them.

Settings

If you want to use a custom attribute set for "Rings" aside from settings then include critical Settings attributes which are Shape, Size from and Size To and these attributes must have values against them for everything to work correctly on frontend as these values get used to select correct Ring. All the attributes included in this attribute set are as follows:-

Rings

All the attributes included in this attribute set are as follows:-

Ring Builder

Ring Builder is a great tool to allow your customers to pair any diamond with setting of their choice. Ring builder is fully responsive. You can also define a filter for each setting, so that only compatible diamonds are shown when setting is selected.

The entire process is divided into three steps namely, choosing a diamond, choosing a ring and in the final step a bundled product is created using previous selections and customers can place an order with that product.

Note:- Customers can start by either choosing a diamond first or choosing a setting(ring) first they will automatically be redirected to the next step.

Choosing a Diamond

If customers chooses to start by selecting a diamond then they will be able to see the diamond search page as shown in the image below. It contains several filters which can be utilized to pinpoint the exact diamond as per requirements.

image (82).png

Once the customer decides on a diamond they click on it which takes them to a detailed page for that diamond. It contains all the necessary details related to that specific diamond. Once satisfied they click on SELECT DIAMOND and they are redirected to the next step i.e choosing a ring.

image (61).jpg

Choosing a Setting(Ring)

In the next step, customers are directed towards the ring selection. Rings automatically get filtered and only the compatible rings for the diamond selected are displayed on this page. Simply click on choose this setting and you will redirected to the final step.

image (62).jpg

Review Complete Ring

In the final step a bundled product is created using the first two selections which customers can add to basket and place an order with it.

image (63).jpg

Multicurrency Setup

Multiple currencies can be added/selected from Admin > Stores Configuration > General > Currency Setup - Allowed Currencies - Select currencies

image (83).png

Currency rates can be configured against base currency from Admin > Stores > Currency > Currency Rates

image (84).png

Base currency can be defined from Admin > Stores Configuration > General > Currency Setup > Base Currency - Select currency

Currency Switcher Frontend

image (85).png

Setup 360 view and Certificate

Please follow the steps provided below in order to setup 360 view and certificate:-

  1. Use local inventory in the configuration
  2. Update diamond and add below values from Admin > Catalog > Products > Select Diamiond > Edit > "Diamond Details"
    1. Put any value with url of the document (ex. https://certimage.s3-accelerate.amazonaws.com/images/full_size/certificates/LG480159253.pdf) in the "Has cert file" attribute for the certificate
    2. Put any value for 360 url value for " Sarineloupe Url" attribute (ex. V360 Viewer ) and 1 to " Has Sarineloupe" attribute.

Test URL - Choose a diamond

image (86).png

Certificate

image (87).png

360 view

image (88).png

Frontend

The below screengrab contains order with custom ring size selected:-

image (89).png

If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact support@scommerce-mage.com.

Magento 2 Not On The High Street Integration

Installation and User Guide for Magento 2 Noths Integration Extension

Table of Contents

  1. Installation
    • Installation via app/code
    • Installation via Composer
  2. Configuration Settings for Noths Integration
    • General Settings
    • Integration Settings
  3. Noths Order(s) View from Back-end
    • Noths Order Import
    • Noths Order Details on Order View Page
    • Noths Order Logs

Installation

https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer

Configuration Settings for Noths Integration

Go to Admin > Stores > Configuration > Scommerce Configuration > Noths

General Settings

image (64).jpg

Integration Settings

image (90).png

image (91).png

Noths Order(s) View from Back-end

image (65).jpg

image (66).jpg

image (67).jpg

If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact support@scommerce-mage.com.

Magento 2 Creditsafe Integration

Installation and User Guide for Magento 2 Creditsafe Integration Extension

Table of Contents

  1. Installation
    • Installation via app/code
    • Installation via Composer
  2. Configuration Settings for Creditsafe Integration
    • General Settings
    • API Configuration
    • Limits and Messages Configuration
    • Limits Configuration
    • Emails
    • Customer Configuration
  3. CreditSafe API Logs
  4. CreditSafe Information Stored Against the Customer
  5. Customer Verification Process
  6. CreditSafe Adjustment Grid
    • CreditSafe Transactions Grid
    • Import CreditSafe transactions in the Grid
  7. Frontend
    • Apply for CreditSafe Application
    • CreditSafe Company Application
    • Successful Credit Application

Installation

https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer

Configuration Settings for Creditsafe Integration

Go to Admin> Stores> Configuration> Scommerce > Credit Safe

General Settings

image (92).png

API Configuration

image (93).png

Limits and Messages Configuration

Create creditsafe rules based on your requirements.

Similarly you can create multiple rules as per your requirements to appropriately assign the credit limits to your applicants.

image (94).png

Limits Configuration

image (94ii.png

Emails

image (95).png

Customer Configuration

image (37) (1).png

CreditSafe API Logs

All requests and responses with regards to creditsafe endpoints are logged into a grid. You can view the logs by going into Admin>System>CreditSafe API Logs>Credit Safe Logs.

image (38) (1).png

If you further click on any of the entries it contains the information as shown in the image below:-

image (39) (1).png

CreditSafe Information Stored Against the Customer

Our module adds certain fields against the customer to keep track of credit assignment and available credit limits. Following fields are added:-

image (40) (1).png

Customer Verification Process

Based on the "Approval Type" configuration described earlier, the customer's verification takes place:-

image (41) (2).png

CreditSafe Adjustment Grid

CreditSafe Transactions Grid

It allows you to track and manage adjustments made to customer credit limits based on their orders and payments. With this system, you can view and manage adjustments made to customer credit limits in a single, easy-to-use grid. Easily Keep track of adjustments made to customer credit limits. Go to Admin>Sales>Creditsafe>Transactions. The grid reflects both positive and negative adjustments i.e when a customer makes a purchase using their credit limit and when they make the payment of the invoice.

image (42) (1).png

Import CreditSafe transactions in the Grid

You can import transactions by either going into Admin>System>Import our by going to sales>Orders>Import from CSV. Next select the "Entity Type" as "CreditSafe Transaction Import" from the dropdown.

image (43) (1).png

The format of the import file should be as shown in the image. The fields required are as follows:-

image (96).png

Frontend

Apply for CreditSafe Application

Customers can apply for creditsafe application from their My Account section using the button "Apply for Web Credit Account".

image (97).png

image (45) (1).png

CreditSafe Company Application

image (46) (1).png

Successful Credit Application

image (47) (1).png

If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact support@scommerce-mage.com.

Magento 2 PunchOut & ERP Integration

Installation and User Guide for Magento 2 PunchOut & ERP Integration

  1. Configuration Settings for PunchOut Integration
    • General Settings
    • Order Creation Settings
    • Catalog Settings
    • Punchout Session Settings
    • UBL Configuration
  2. Managing PunchOut Clients
  3. Setting Up Catalogs and Pricing
  4. Testing the Integration
    • Step-by-Step Testing Guide
  5. Handling Purchase Orders (End-to-End Workflow)
  6. Troubleshooting Common Issues

Installation

https://docs.scommerce-mage.com/magento-2-extensions/installation-via-composer/installation-via-composer

Configuration Settings for PunchOut Integration

Go to Admin > Stores > Configuration > Scommerce Configuration > Punchout

General Settings

image (270).png

Order Creation Settings

image (271).png

Catalog Settings

image (272).png

Punchout Session Settings

image (273).png

UBL Configuration

image.png

Managing PunchOut Clients

This is the most critical part of the setup. Each corporate client you wish to integrate with must be configured as a "PunchOut Client."

  1. Go to Admin>Customers>Punchout>Manage Punchout Clients

image (274).png

2. Click "Add New Punchout Client" to configure a new connection.

image (275).png

3. Fill in the following fields:

image.png

4. Click "Save Config."

Setting Up Catalogs and Pricing

The extension leverages Magento's native customer group functionality to deliver a personalized experience.

  1. Create a Customer Group: Before configuring a PunchOut client, navigate to Customers > Customer Groups and create a new group for them (e.g., "PunchOut - Global Office Inc.").
  2. Assign Custom Pricing: Use Marketing > Catalog Price Rules to create rules that apply specific discounts or fixed prices for products and assign the rule to the customer group you just created.
  3. Restrict Catalog (Optional): If you need to show only specific categories to a client, you may need to use native Magento functionality or a third-party category permissions module to restrict access for the designated customer group.

Testing the Integration

Our extension adheres strictly to industry standards, allowing you to validate your configuration using independent, third-party testing tools. We recommend using the PunchOut Commerce cXML Order Tester.

Step-by-Step Testing Guide:

  1. Get Your PunchOut URL: Your Magento PunchOut URL is typically your store's base URL followed by /scpunchout/create/session/. For example: https://yourstore.com/scpunchout/create/session
  2. Open the Testing Tool: Navigate to https://punchoutcommerce.com/tools/cxml-order-tester.
  3. Configure the Tester:
    • PunchOut Login URL: Enter your Magento PunchOut URL from Step 1.
    • cXML Payload: The tool provides a template. You must edit the Identity and SharedSecret values in the XML to exactly match the credentials you configured for your PunchOut Client in the Magento admin.
    • UBL Payload: The tool provides a template. You must edit the Username, password and Endpoint ID values in the XML to exactly match the credentials you configured for your PunchOut Client in the Magento admin.
  4. Initiate the Session: Click the "Start Session" button on the tester website to test CXL and "Start UBL Session" to test the UBL2.1
  5. Shop in Magento: You should be redirected to your Magento storefront and automatically logged in as a member of the mapped customer group. Browse the site and verify that you see the correct products and contract pricing. Add one or more items to your basket.
  6. Transfer the Cart: Once you have items in your basket, click the "Transfer to ERP" button.
  7. Verify the Response: You will be redirected back to the PunchOut Commerce testing tool. It will now display the cXML response sent from your Magento store. Carefully inspect this XML to confirm that the correct SKUs, quantities, and prices are present. A successful test confirms your configuration is working correctly. You can validate the UBL output at:- https://ecosio.com/en/peppol-and-xml-document-validator/ 

Handling Purchase Orders (End-to-End Workflow)

The PunchOut process is typically two-phased.

image.png

image.png

image.png

image.png

 

image.png

Our extension can receive this incoming Purchase Order and automatically create a corresponding sales order in your Magento system, enabling a fully automated, end-to-end workflow. The specific endpoint URL for receiving POs (/scpunchout/order/) should be provided to your client's IT team.

Troubleshooting Common Issues

If you have a question related to this extension please check out our FAQ Section first. If you can't find the answer you are looking for then please contact support@scommerce-mage.com.