🔗 Connecting Magento 2 to Optiply
Optiply has a standard integration with Magento 2 using the REST API via token-based authentication. Because this connection requires specific configuration, we will set up the integration for you.
To proceed, you must gather the following information and send it to your Optiply Onboarding Specialist.
Step 1: API Information & Permissions
We need specific credentials to access your Magento environment.
Required Credentials:
Please provide the following 5 items:
Magento Base URL (Your shop's URL)
Permissions:
The API account connected to these credentials must have "Administrator Permissions".
Please refer to our separate guide: Magento Backoffice - Setting API Permissions for exact setup instructions.
Important: Setting these permissions correctly is critical to ensure we can connect to all necessary endpoints.
Step 2: Configuration Preferences
We need to know how you want Optiply to interpret your data. Please answer the following questions when submitting your credentials.
A. Store Scope
Optiply can distinguish between different stores within your Magento environment.
Default: We synchronise data from all stores.
Custom: If you only want to sync specific stores, please provide the Website ID and Store ID for the ones we should retrieve.
B. Stock Logic
Magento 2 has two types of stock levels.
Salable Quantity: The amount available for sale (deducts reserved stock). (Default)
Quantity: The physical number of items in the warehouse.
Action: Let us know if you want to change the default setting to base advice on "Quantity" instead.
C. Magento Inventory Management
Do you use Magento Inventory Management (formerly MSI)? Please confirm Yes/No.
D. Item Deliveries (Receipts)
Do you want to register the receipt of purchased orders in Magento through Optiply?
If Yes, when you process a goods receipt in Optiply, we will update the stock/status in Magento.
Step 3: Supplier Data (Manual Setup)
To complete your setup, you must provide:
Supplier List: A list of your suppliers (Name, Lead Time, etc.). We will add them to your system manually.
Product-Supplier Links: We need to know which products are bought from which supplier.
You can provide a list (CSV) for us to import.
OR you can add this information manually through the Optiply frontend after the connection is live.
Crucial Note: We cannot retrieve supplier information from Magento, as it is not a native entity in standard Magento 2.
❓ Frequently Asked Questions (FAQs)
Why is the "Salable Quantity" the default?
"Salable Quantity" is usually safer for purchasing advice because it accounts for items that are physically in the warehouse but already reserved for open sales orders. Using "Quantity" might lead you to under-order stock that is already spoken for.
Where do I generate the keys?
In your Magento Admin Panel, navigate to System → Extensions → Integrations. Add a new integration to generate the Consumer Key, Secret, and Access Tokens.
I have multiple websites. Can I connect them all?
Yes. By default, we pull data from the entire Magento installation. If you need to separate them (e.g., different inventory pools), providing the specific Website ID and Store ID allows us to filter the data accordingly.