Magento as Source

Integrating Magento as a Source will allow you to automate your fulfillment operations through our pre-built API connection.

 

Magento Connection Setup
Phase 1: Creating Your Magento Source +
Create Source in Flxpoint
Log into your Flxpoint account, navigate to the Sources tab, and click Configure Single Source (or + Add Source) to begin.
Set Up Source Details
Enter "Magento Supplier" as the source name, select the appropriate source type (e.g., Vendor Warehouse), and choose whether to assign a vendor (recommended for better reporting). Click Save to continue.
Tip: Assigning a vendor improves your reporting capabilities and helps with product organization.
Choose Integration Type
After creating your source, navigate to the Get Inventory (Primary) section under Integrations in the left menu. If no integrations are set up yet, click Start Creating Integrations. For this guide, we will focus on:
  • Get Inventory (Primary): Retrieves primary inventory data from Magento.
Note: You can activate additional integrations (e.g., Get Shipments) later based on your business needs.
Phase 2: Setting Up Connection +
Obtain Your Magento Access Token
To connect to Magento, you'll need an Access Token. Follow these steps to obtain it:
  • Log into your Magento Admin panel using your credentials.
  • Navigate to System → Integrations and click Add New Integration.
  • Enter a name (e.g., "Flxpoint Integration"), then go to the API tab.
  • Set Resource Access to All, click Save, and then Activate the integration. If you are required to restrict access (for example, for GDPR or internal security policies), you can instead use the Minimum Recommended Permission Set listed below.
  • Your Access Token will be generated upon activation. Copy it and store it securely.
If you can't generate the token, contact Magento support or refer to their documentation at https://devdocs.magento.com for assistance.
Important: Keep your Access Token secure and do not share it publicly, as it provides access to your Magento store data.
Magento API Endpoints Used
If you are using Magento as a Source in Flxpoint, the following Magento REST API endpoints are used by the integration:

Get Inventory (Primary / Secondary)

  • /V1/products
  • /V1/categories
  • /V1/products/attributes

Send Fulfillment Requests

  • Create Order: /V1/orders
  • Order Acknowledgement: /fulfillment-requests/{fulfillmentRequestId}/acknowledge

Get Shipments

  • /V1/shipments
Minimum Recommended Permission Set
When creating the integration in your Magento Admin (System → Integrations), you can either:
  • Grant Resource Access = All (simplest and recommended for most merchants), or
  • Grant access only to the specific areas used by Flxpoint, as listed below.
When you need to restrict permissions (for example, for GDPR or internal security policies), enable at least:

Catalog

  • Catalog
    • Products
    • Categories
    • Attributes → Product

Sales

  • Sales
    • Operations
      • Orders
      • Shipments
Configure Connection Details
From the list of Custom Integrations or Standard Integrations, locate and select Magento. In the New Magento Connection form, enter the following details:
  • Connection Name: "Magento Connection" (or any descriptive name).
  • Access Token: Paste the Access Token you obtained from Magento.
  • API Page Size: Set the number of records to fetch per page (e.g., 100).
  • Store URL: Enter your Magento store URL (e.g., https://yourstore.com).
Click Test Connection to verify the connection, then click Save Connection to proceed.
Tip: If the connection test fails, double-check your Access Token and Store URL, and ensure your Magento store is configured for API access.
Phase 3: Configuring Settings, Mapping & Activation +
Adjust Integration Settings
On the Configure Settings screen, adjust the following options:
  • Archive/Un-Archive Inventory: If enabled, any inventory not found in the Magento feed will be archived (quantity set to zero). If products are later reintroduced, they'll be un-archived.
  • Fetch All the Attributes: If enabled, all Magento attributes will be retrieved; otherwise, only those visible on the storefront.
Note: We recommend not enabling Archive/Un-Archive if already active for Get Inventory (Secondary).
Map Additional Fields
Map the following Magento fields to Flxpoint fields as needed:
  • Manufacturer Code
  • UPC Code
  • Image URL (required)
  • Website ID
  • Store View Code
Click Save and Proceed to continue.
Create Field Mapping
Under Define a Mapping Template, select or create a new mapping template. Map Magento fields to Flxpoint fields for the Get Inventory integration:
  • Map essential fields like Product Name, SKU, Price, and Quantity.
  • Set up any transformations needed (e.g., price markups, quantity adjustments).
Tip: Ensure all critical fields are mapped to avoid missing inventory data.
Activate and Verify
Complete the setup by clicking Save and Complete. Your Magento Get Inventory integration is now active and will run based on your configured schedule.
Next Steps: The initial inventory sync may take some time to complete. You can monitor the progress in the Integrations section of your Flxpoint dashboard under Fulfillment Sources.

 

Product & Order Operations

Now that you’ve finished the wizard, you’ll see Mangeto has four integrations available in Flxpoint: two for products and two for orders. Get Inventory [Primary] (GIP) and Get Inventory [Secondary] (GIS) keep your Mangeto stock and pricing updated, while Send Fulfillment Requests and Get Shipments handle sending orders to Mangeto and pulling back shipment/tracking data. All four use the same Mangeto connection and credentials you just set up so you can simply choose the operations that match your workflow.

 

Product Operations

Get Inventory Primary imports your Magento catalog including metadata such as attributes, images, titles and description. We recommend running this once daily to import any new items. Get Inventory Secondary is a faster, more efficient operation to import more frequent pricing and quantity updates. We recommend running this hourly. 

Get Inventory (Primary)

Get Inventory

The Get Inventory operation retrieves inventory data from your Magento store, ensuring inventory is up-to-date across all connected platforms. It syncs product inventory including stock levels, prices, and product details in real-time or on a configurable schedule.

Once configured, Flxpoint connects to Magento via API, pulls the latest product and variant information, maps it according to your template, and updates your inventory records automatically. This keeps your catalog accurate and reduces the risk of overselling or listing stale data.

What It Does
  • Syncs product inventory from your Magento store into Flxpoint.
  • Updates stock levels, prices, and product details automatically.
  • Archive or un-archive inventory based on product availability.
Workflow

1 Connect — Use your Magento API credentials (Access Token, Store URL) to authenticate the integration.

2 Fetch — A GET call to the Magento API retrieves product and variant details.

3 Map — Extract SKU, Quantity, Price and other fields; map them via your mapping template.

4 Save — Import the mapped data, updating your inventory records in Flxpoint.

Configuration Settings
Setting Description
Sync Frequency How often inventory is pulled from Magento (e.g., every 15 minutes, hourly, daily).
Fetch All Attributes When enabled, retrieves all product attributes. When disabled, only storefront-visible attributes are fetched.
Archive/Un-Archive Inventory Automatically archives products no longer available and un-archives them when they reappear.
Scheduling Configure the exact schedule or interval for automatic inventory syncs.
Mapping Template Select or create a mapping template that defines how Magento fields translate to Flxpoint fields.
Setup Steps

1 Add Integration

Navigate to Sources in Flxpoint and add a new Magento integration. Select Get Inventory as the operation.

2 Connect to Magento

Enter your Magento API credentials — Access Token and Store URL. Test the connection to confirm it shows Connected.

3 Configure Settings

Set your preferred options:

  • Sync Frequency — Choose how often inventory should sync.
  • Manufacturer Code — Specify the attribute code used for manufacturer/brand.
  • UPC Code — Specify the attribute code used for UPC.
  • Website ID — Enter the Magento Website ID to pull inventory from.
  • Store View Code — Enter the Store View Code if pulling from a specific store view.
  • Fetch All Attributes — Toggle on to retrieve all product attributes, or leave off for storefront-visible only.
  • Archive/Un-Archive — Enable to automatically manage product availability.

4 Create Mapping Template

Build or select a mapping template that maps Magento product fields to Flxpoint inventory fields. At minimum, map SKU and Quantity.

5 Run / Schedule

Run the operation manually to verify data flows correctly, then set your preferred schedule for automatic syncing.

Mapping Options

Each field in your mapping template can be configured using one of the following options:

Option Description
Don't Map Skip this field entirely — no data will be imported for it.
Set To Empty Clear any existing value by setting the field to empty.
Field Map directly from a Magento source field.
Value Set a static/fixed value for every record.
Mapping Set Use a predefined set of value translations (e.g., convert codes to labels).
Rules Apply conditional logic to determine the mapped value.
Required Fields
Required: At minimum, SKU and Quantity must be mapped for the Get Inventory operation to function correctly.
Source Product Fields
Magento Field Maps To Example Purpose Status
SKU SKU ABC123 Identifies the product Required
Name Title Blue Widget Product title Required
Description Description A high-quality blue widget Product description Required
Manufacturer Brand WidgetCo Product brand Required
Source Variant Fields
Magento Field Maps To Example Purpose Status
Quantity Quantity 50 Stock level Required
Price Source List Price 29.99 Product price Optional
UPC UPC 012345678905 Universal product code Required
Weight Weight 1.5 Product weight Optional
SKU Mapping Note: SKU must be mapped for proper inventory identification. Always map SKU and Quantity for reliable syncing.
Quick Checks

Before running the operation, verify the following:

  • Connection status shows Connected.
  • A mapping template is selected for the operation.
  • SKU and Quantity are mapped in your template.
Troubleshooting
Issue Possible Cause Resolution
Connection Issues Invalid or expired API credentials. Verify your Magento Access Token and Store URL are correct and active.
API Errors Magento API endpoint is unreachable. Confirm the API endpoint is accessible and your Magento instance is online.
Missing Data Fields not mapped in template. Check your mapping template to ensure all required fields are mapped.
Rate Limits Too many API requests in a short period. Check your Magento API rate limits and adjust sync frequency if needed.
Operation Details
Feature Availability What to Expect
Inventory Sync Supported Products and variants are retrieved via the Magento API.
Archive/Un-Archive Supported Automatically archives missing products and un-archives when they reappear.
Fetch All Attributes Supported Retrieve all product attributes or only storefront-visible attributes.
API Rate Limits Limitation May pause the integration if Magento rate limits are exceeded.
Tip: Schedule regular syncs to keep inventory levels accurate and reduce the risk of overselling across your connected platforms.
 
 

Get Inventory (Secondary)

Introduction

Get Inventory (Secondary) retrieves secondary inventory data such as custom fields, variant options, and additional attributes from your Magento store. This integration enhances inventory records with detailed product information beyond the primary sync.

While Get Inventory [Primary] handles core product data (SKU, title, quantity, price), the secondary integration focuses on dimensions, shipping costs, GTIN, and up to 100 custom fields — giving you a complete picture of every product in your catalog.

The sections below walk through setup, mapping, and troubleshooting for this integration.

What It Does: Syncs secondary product attributes like custom fields and variant options. Updates dimensions, shipping costs, and detailed product info. Enhances inventory records with additional data for better management.

Each run follows this workflow:

  • 1Connect — Use Magento API credentials (Access Token, Store URL) to authenticate with your Magento instance.
  • 2Fetch — A GET call retrieves additional product attributes and variant details from the Magento API.
  • 3Map — Extract dimensions (Height, Width, Length), shipping details, custom fields, and other secondary attributes.
  • 4Save — Import mapped data into Flxpoint, enriching inventory records with the additional details.
Example: A product in Magento has Height 10, Width 5, Length 15 (centimeters) and a shipping cost of 5.99. After the secondary sync, these values appear on the Flxpoint inventory record alongside the primary data.

Configuration options include:

  • Sync Frequency — How often the secondary integration runs.
  • Fetch Custom Fields — Enable to retrieve up to 100 custom fields from Magento.
  • Scheduling — Set a recurring schedule or run on demand.
  • Mapping Template — Select or create the template that defines field mapping.
Step 1: Add Integration (Get Inventory Secondary)

Navigate to your source integrations and add a new Get Inventory Secondary operation for your Magento source.

Step 2: Connect to Magento

Use your existing Magento connection or create a new one with your Access Token and Store URL. Click Test Connection to verify, then save.

Step 3: Configure Settings
  • Sync Frequency — Choose how often secondary data is refreshed.
  • Fetch Custom Fields — Toggle on to pull up to 100 custom fields from Magento.
  • Scheduling — Enable a recurring schedule or leave as manual.
Step 4: Create Mapping Template

Define how Magento secondary fields map to Flxpoint inventory fields. See the Mapping Utilities section below for details.

Step 5: Run / Schedule

Run the integration manually to verify results, then enable scheduling for automated syncs. The status page will show Connected, Configured, and Mapped when everything is ready.


The Mapping Template defines how Magento secondary fields map to Flxpoint inventory fields. All secondary fields are typically optional — there are no required fields for this integration.

Mapping Options

Each field in the mapping template can be set to one of the following:

  • Don't Map — Skip the field entirely.
  • Set To Empty — Clear the field value on each sync.
  • Field — Map directly from a Magento source field.
  • Value — Set a static value for every record.
  • Mapping Set — Use a predefined set to translate values.
  • Rules — Apply conditional logic to transform data during mapping.
Source Variant (Secondary Fields)

Key fields available from Magento for secondary mapping:

Magento Field Maps To Example Purpose Status
Height Height 10 Product height Optional
Width Width 5 Product width Optional
Length Length 15 Product length Optional
Dimension Unit Dimension Unit centimeter Unit of measurement Optional
Shipping Cost Shipping Cost 5.99 Shipping fee Optional
GTIN GTIN 012345678905 Global trade item number Optional
Note: If you are syncing dimensions (Height, Width, Length), always map Dimension Unit as well to ensure consistency across your inventory records.
Custom Fields

When Fetch Custom Fields is enabled, up to 100 custom fields can be mapped:

Magento Field Maps To Example Purpose Status
Custom Field 1 Custom Field 1 Blue Custom attribute (e.g., Color) Optional
Custom Field 2 Custom Field 2 Medium Custom attribute (e.g., Size) Optional
Summary: Secondary mapping focuses on dimensions, shipping details, GTIN, and custom fields. Keep core product fields (SKU, title, quantity, price) in the Primary job.

Quick Checks
  • Connection shows Connected and passes Test Connection.
  • Mapping template is selected and saved.
  • Dimension Unit is mapped if you are syncing dimension fields (Height, Width, Length).
Troubleshooting
  • Connection issues: Verify your Magento API credentials (Access Token, Store URL) and click Test Connection.
  • API errors: Confirm the Magento API endpoint is accessible and the store URL is correct.
  • Missing data (dimensions): Check that Height, Width, Length, and Dimension Unit are all mapped in the template. If Dimension Unit is missing, dimension values may not display correctly.
  • Rate limits: Magento may throttle API requests. If the integration pauses unexpectedly, check your Magento API rate limit settings.
  • Custom fields not syncing: Ensure Fetch Custom Fields is enabled in the integration settings before running the sync.
Operation Details
Feature Availability What to Expect
Secondary Attributes Supported Dimensions, shipping cost, GTIN
Custom Fields Supported Up to 100 custom fields
API Rate Limits Limitation May pause integration if exceeded
Tip: Use Get Inventory Secondary alongside Get Inventory Primary for a complete inventory sync. Primary handles core product data while Secondary enriches records with dimensions, shipping details, and custom fields.
 
 
Optional but recommended

Keep your catalog up to date automatically

After configuring Get Inventory Primary and Get Inventory Secondary, you can schedule both jobs so items, inventory, and pricing update for you.

  • Schedule Primary to import new and updated items.
  • Schedule Secondary after Primary to refresh stock and pricing.
  • Adjust the cadence anytime if your supplier changes their update frequency.
How to schedule Get Inventory operations in Flxpoint
Click the animation to view it larger.


 

Order Operations

Configure Flxpoint to route orders to vendors for fulfillment and  import the shipment details, so they sync back to your sales channel and customer. 

Send Fulfillment Requests

Introduction

The Magento – Send Fulfillment Requests integration sends fulfillment requests to your Magento store, creating purchase orders with billing, shipping, and item details. This enables automated order fulfillment directly from Flxpoint to Magento.

By automating fulfillment requests, this integration reduces manual effort and ensures seamless processing. Billing and shipping addresses, order items, and payment details are mapped and transmitted to Magento via the API.

The sections below walk through setup, field mapping, and troubleshooting for this integration.

What it does: Sends fulfillment requests to Magento to create purchase orders. Maps billing/shipping addresses, order items, and payment details. Automates order fulfillment, reducing manual effort.
Workflow

1 Connect — Use Magento API credentials (Access Token, Store URL).
2 Prepare — Gather fulfillment data (billing/shipping addresses, order items).
3 Map — Map system fields to Magento fields via a mapping template.
4 Send — A POST call to the Magento API creates a purchase order with the mapped data.

Configuration Options
  • Sync Frequency — How often fulfillment requests are sent.
  • Order Status Filter — Controls which orders are eligible for fulfillment.
  • Scheduling — Set up recurring or on-demand runs.
  • Mapping Template — Defines how Flxpoint fields map to Magento fields.
Step 1: Add Integration

Add the Send Fulfillment Requests integration from the Magento source integrations list.

Step 2: Connect to Magento

Enter your Magento API credentials, including your Access Token and Store URL. Click Test Connection, then Save Connection once successful.

Step 3: Configure Settings

Set the Sync Frequency, Order Status Filter, and Scheduling preferences based on your fulfillment workflow.

Step 4: Create Mapping Template

Create or select a mapping template that defines how Flxpoint fulfillment data maps to Magento purchase order fields.

Step 5: Run / Schedule

Run the integration manually to verify, then enable the schedule for automated fulfillment processing.


The Mapping Template defines how Flxpoint fulfillment data maps to Magento purchase order fields.

Mapping Options
  • Don't Map — Field is skipped entirely.
  • Set To Empty — Sends an empty value for the field.
  • Field — Maps a Flxpoint field directly to a Magento field.
  • Value — Sets a static value for the field.
  • Mapping Set — Uses a predefined set of value translations.
  • Rules — Applies conditional logic to determine the mapped value.
Required Fields: Fulfillment Request Number and SKU must be mapped for proper request identification and processing.
Billing Address
Your Field Maps To (Magento) Example Purpose Status
Address Line 1 Address Line 1 123 Main St Billing address line 1 Required
City City New York Billing city Required
Country Code Country Code US Billing country code Required
First Name First Name John Billing first name Required
Last Name Last Name Doe Billing last name Required
Postal Code Postal Code 10001 Billing postal code Required
Shipping Address
Your Field Maps To (Magento) Example Purpose Status
Address Line 1 Address Line 1 456 Oak St Shipping address line 1 Required
City City Los Angeles Shipping city Required
Country Code Country Code US Shipping country code Required
First Name First Name Jane Shipping first name Required
Last Name Last Name Smith Shipping last name Required
Postal Code Postal Code 90001 Shipping postal code Required
Fulfillment Request Item
Your Field Maps To (Magento) Example Purpose Status
SKU SKU ABC123 Product identifier Required
Quantity Quantity Ordered 5 Quantity to fulfill Required
Title Name Blue Widget Product name Optional
UPC UPC 012345678905 Universal product code Optional

Quick Checks
  • Connection shows Connected and passes Test Connection.
  • Mapping template is selected and saved.
  • Fulfillment Request Number and SKU are mapped.
Troubleshooting
  • Connection Issues — Verify your Magento API credentials (Access Token, Store URL) and click Test Connection again.
  • API Errors — Confirm the Magento API endpoint is accessible and responding correctly.
  • Missing Data — Check your mapping template to ensure Fulfillment Request Number and SKU are mapped.
  • Rate Limits — Magento API rate limits may pause the integration if exceeded. Reduce sync frequency if needed.
  • Duplicate Requests — Use the Order Status Filter to prevent duplicate fulfillment requests from being sent.
Operation Details
Feature Availability What to Expect
Purchase Order Creation Supported Creates orders in Magento via API.
Billing/Shipping Mapping Supported Full address field mapping.
Item Mapping Supported SKU, Quantity, Title, UPC.
API Rate Limits Limitation May pause integration if exceeded.
Tip: Map all required fields (Fulfillment Request Number, SKU) to ensure accurate fulfillment processing.
 
 

Get Shipments

Introduction

The Magento – Get Shipments integration retrieves shipment data from your Magento store, including tracking numbers, carrier codes, and shipment dates. This keeps your system updated with the latest shipment details for accurate tracking and fulfillment.

Shipment records are pulled via the Magento REST API and mapped into Flxpoint so order statuses reflect real-time carrier and tracking information. The sections below walk through each step of the setup and configuration process.

What it does: Syncs shipment details from Magento including tracking numbers, carrier codes, and shipment dates. Keeps your system updated with real-time or scheduled shipment data.

Each run follows this workflow:

  • 1Connect — Use your Magento API credentials (Access Token, Store URL) to establish the connection.
  • 2Fetch — A GET call to the Magento API retrieves shipment details from your store.
  • 3Map — Extract Tracking Number, Carrier Code, and Shipment Created At via your mapping template.
  • 4Save — Import the mapped data, updating shipment records in Flxpoint.
Configuration Options
  • Sync Frequency — How often shipment data is pulled from Magento.
  • Shipment Status Filter — Filter which shipments are retrieved based on their status.
  • Scheduling — Set a recurring schedule (UTC) or run on demand.
  • Mapping Template — Defines how Magento shipment fields map to Flxpoint fields.
Step 1: Add Integration (Get Shipments)

Navigate to your Magento source in Flxpoint. Under Integrations, locate Get Shipments and click to add the integration.

Step 2: Connect to Magento

Select or create a Magento connection using your Access Token and Store URL. Click Test Connection to verify, then Save Connection.

Note: You can reuse the same Magento connection configured during inventory setup. No separate connection is needed for shipments.
Step 3: Configure Settings
  • Sync Frequency — Choose how often to pull shipment data.
  • Shipment Status Filter — Select which shipment statuses to include.
  • Scheduling — Enable a recurring schedule or plan to run manually.

Click Save and Proceed.

Step 4: Create Mapping Template

Define how Magento shipment fields are mapped to Flxpoint. Ensure Tracking Number is mapped (required). See the Mapping Utilities section below for full details.

Step 5: Run / Schedule

Click Save and Complete. Run the integration manually to verify results, then enable your preferred schedule for ongoing automation.


The Mapping Template defines how Magento shipment data maps to Flxpoint shipment fields.

Mapping Options
  • Don't Map — Skip the field entirely.
  • Set To Empty — Clear the destination field.
  • Field — Map directly from a Magento source field.
  • Value — Set a static value for the destination field.
  • Mapping Set — Use a predefined set to translate values.
  • Rules — Apply conditional logic to determine the mapped value.
Required Fields
  • Tracking Number — Must be mapped for proper shipment tracking.
Magento Shipment Field Mapping
Magento Field Maps To Example Purpose Status
Carrier Code Carrier UPS Shipping carrier Optional
Comment Note Shipped with care Shipment comment Optional
Shipment Created At Shipped At 2025-08-07 10:00:00 Shipment creation date Optional
Title Method Ground Shipping Shipping method title Optional
Tracking Number Tracking Number 1Z9999W99999999999 Shipment tracking number Required
Summary: Map Tracking Number (required) and optional carrier, date, method, and comment fields to get full shipment visibility in Flxpoint.

Quick Checks
  • Connection shows Connected and passes Test Connection.
  • Mapping template is selected and saved.
  • Tracking Number field is mapped (required).
Troubleshooting
  • Connection Issues — Verify your Magento API credentials (Access Token, Store URL) and click Test Connection again.
  • API Errors — Confirm the Magento API endpoint is accessible and not blocked by firewall or maintenance mode.
  • Missing Data — Check your mapping template and ensure Tracking Number is mapped. Verify that shipments exist in your Magento store for the selected status filter.
  • Rate Limits — Magento API rate limits may pause the integration if exceeded. Reduce sync frequency or increase the API page size if needed.
Operation Details
Feature Availability What to Expect
Shipment Sync Supported Tracking, carrier, and dates via Magento API.
Carrier Mapping Supported Carrier Code mapped to Carrier field.
Shipment Status Filter Supported Filter retrieved shipments by status.
API Rate Limits Limitation May pause integration if exceeded.
Tip: Schedule regular syncs to keep shipment tracking up-to-date. Start with a manual run to verify data before enabling full automation.
 
 
Optional but recommended

You’re ready to automate this source

You’ve finished setting up this source. If you’d like, you can now put its operations on an automated schedule.

  • Select the operations to schedule (for example, Get Inventory, Get Orders, Send Fulfillment Requests, Get Shipments).
  • Pick how often and when they should run. You can edit or pause schedules anytime from the operations screen.

Tip: A daily schedule for key operations is a simple place to start.

How to schedule source operations in Flxpoint
Click the animation to view it larger.

 

 

Trobleshooting Common Errors

Common issues and solutions for Magento integration. Expand each item to learn more.

Still need help? If you're experiencing issues not covered here, contact Magento support or your Flxpoint account manager.

Contact Support