A sample extension that extends customer data

Installs: 0

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Type:magento2-module

dev-master 2020-02-14 13:06 UTC

This package is not auto-updated.

Last update: 2020-02-15 11:36:49 UTC


README

This extension is deisgined to add simple custom customer attributes to the backend of magento and also to add two api end points to allow EDI mapping.

📦 Installation

Requirements Before Running Application

Name Version Website
PHP v7.2.x or Higher https://php.net/
Magento 2.3.4 (CE or EE) https://magento.com/

🔧 Installing the Extension Manually

If you are adding this extension manually to magento please copy the extension to the following folder

app/code

Also you need to enable the extension to make it work. So you will need to run the following command in the magento root folder.

php /data/html/bin/magento module:enable Acadaca_EDI

Note: Depending on the development / production enviroment you are install this extension on you may need to run this command as a certain user. Please consult your hosting or DevOps specialist if you need sudo access and what the user:group that php needs the files to be.

🚀 Configure the Extension for intergration access.

  • Change directories to backend - example: https://demo.example.com/admin/
  • Navigate to the following - System > Extensions > Intergrations
  • Click Add New Integration
  • Fill out Name and Your Password feilds.
  • Click the API side menu
  • Click the Resource Access and choose All
  • Click the down arrow on Save choose Save & Activate
  • Click the Allow
  • Keep a copy of the Access Token if you want to test api out.

🔧 Configure Customers to have EDI ID for api endpoint to work.

This requires that the customer has a EDI to access the data from this api endpoint.

  • Navigate to the following - Customers > All Customers.
  • Click edit customer on the right.
  • Add a id to the "EDI ID"
  • Click save

🗒 EDI Endpoints

  • Lists all customers with EDI Id's
  • { magento store url }/rest/V1/edi/customer/list
  • Lists customers by EDI Id in the customer form
  • { magento store url }/rest/V1/edi/customer/{EDI Id}

Note: For information on the api info go to { magento store url }/swagger on how to test these methods.