The Magento-Flxpoint integration combines powerful ecommerce functionality with flexible sales management tools. This seamless platform simplifies operations, supports scalability, and drives growth through streamlined order processing, personalized customer experiences, and real-time data insights.
How to connect
Step 1: Log into your Flxpoint account and navigate to the Channels section.
Step 2: Click on + Add Channel to start your Magento integration.
Step 3: In the popup, select Magento as your channel, enter a channel name, and click Continue.
Step 4: Obtain your Magento authentication credentials.
Log in to your Magento Admin Dashboard at https://account.magento.com/. Watch this video tutorial for a visual guide.
Navigate to System > Integrations.
Click Add New Integration.
Enter a name (e.g., "Flxpoint") and your admin Password. Leave other fields as default or use a supported email (e.g., support@flxpoint.com).
In the API tab, select All for permissions (or specifically select Sales, Catalog, Customers, Stores, and System).
Click Save, then Activate the integration.
Copy the generated Access Token for use in the next step.
Step 5: Enter your Magento authentication details.
Provide your Magento Access Token (copied from the previous step).
Enter your Magento Store URL.
Select the API Page Size (e.g., 250) from the dropdown.
Click Continue to authenticate your Magento account.
Step 6: Configure your Magento integration settings:
- Import Products: Enable to import products from Magento. Set the Master SKU field (e.g., Magento Product - SKU to Master SKU) and enable Set New Products to Paused if desired.
- Publish Products: Enable to create and publish products to Magento. Configure settings like Product Visibility (e.g., Catalog, Search), Stock Management (e.g., Enable Qty Increments), and Attribute Mapping (e.g., Map Flxpoint attributes to Magento attributes).
- Sync Products: Enable to sync pricing and inventory data with Magento. Set the linking identifier (e.g., Flxpoint Product: SKU to Magento Product: SKU).
- Get Orders: Enable to import orders from Magento. Select order statuses (e.g., Processing, Pending) and set the time range (e.g., Created Last 7 Days).
- Sync Orders: Enable to sync order and shipment data with Magento. Configure settings like Order Status Updates (e.g., Update Magento when orders are shipped).
Step 7: Click Continue to finalize the setup. Your Magento channel is now connected.
A confirmation message will appear: “Success! Your connection to Magento was created successfully and your selected operations have been configured.”
Step 8: Manage your Magento integration.
In the Channels > Magento section, you’ll see the status as Active with options to Run Sync, View Logs, Adjust Schedule, or Edit Integration Settings.
Tip: Use the Integration Settings to fine-tune operations like importing, publishing, or syncing products and orders.
×
![Modal Image]()
Listing Operations
Import Listings
Supported | Magento - Import Listings
Introduction to Magento Import Listings Integration
This guide explains how to use the Magento Import Listings integration to retrieve product listings from your Magento store into Flxpoint. This integration ensures that product details, including SKUs, prices, and inventory levels, are accurately imported for inventory management and sales channel synchronization.
The Magento Import Listings integration connects your Flxpoint system to Magento to:
- Retrieve product listings from your Magento store based on specified criteria (e.g., status, visibility).
- Import product details such as SKUs, names, prices, and stock quantities into Flxpoint.
- Enable synchronization of listings with sales channels, inventory updates, or pricing adjustments.
The integration follows a structured process to fetch listings from Magento:
-
Listing Retrieval: Sends a GET request to the Magento API endpoint
/rest/V1/productswith filters (e.g., status="enabled", visibility="catalog,search"). - Data Mapping: Maps Magento product fields to Flxpoint listing fields using a configurable mapping template (e.g., Magento’s "sku" to Flxpoint’s "SKU").
- Data Storage: Saves the retrieved listings in Flxpoint for further processing (e.g., inventory synchronization).
- Syncing: Listings can be imported manually or on a schedule (e.g., daily at 8 AM UTC).
Note: Ensure your Magento API credentials are correctly configured to avoid retrieval failures.
Customize the integration to fit your needs:
- Product Status Filter: Specify which product statuses to retrieve (e.g., "enabled", "disabled").
- Visibility Filter: Filter products by visibility (e.g., "catalog,search", "not visible individually").
- Date Modified Range: Set a date range for products to fetch (e.g., last 7 days).
- Scheduling: Run the integration manually or schedule it (e.g., daily at 8 AM UTC).
- Mapping Template: Define how Magento product fields map to Flxpoint listing fields for accurate data import.
Follow these steps to set up the Magento Import Listings integration:
- 1 Add the Integration: Navigate to the Integrations section, select Magento as the integration type, and choose “Import Listings.”
- 2 Connect to Magento: Select an existing Magento connection or set up a new one using your Magento API credentials.
- 3 Configure Settings: Set the product status and visibility filters, define a date range for retrieval, and configure the sync schedule.
- 4 Create a Mapping Template: Define how Magento product fields map to Flxpoint listing fields (details below).
- 5 Run the Integration: Start the integration manually or let it run on your schedule.
- The mapping screen is labeled “Magento - Import Listings” with sections for field mappings.
- Buttons: Delete, Duplicate, and Save.
- Sections include:
- From Value: Fields from Magento (e.g., Product fields like sku, name).
- To Flxpoint Listing Field: Fields in Flxpoint (e.g., SKU, Name).
This section provides key details about the Magento Import Listings integration to help you understand the process:
-
Magento Integration: Connects to your Magento store via the
/rest/V1/productsendpoint to retrieve product listings. Connection settings are configured through API credentials. - Product Filtering: Listings are fetched based on filters like status, visibility, and date modified, ensuring only relevant products are imported.
- Data Mapping: A mapping template ensures Magento product fields are accurately mapped to Flxpoint listing fields for seamless integration.
Tip: Use filters to avoid importing outdated or irrelevant listings, and regularly review the mapping template to ensure all necessary fields are included.
Mapping Fields
Below are the fields you can map, with examples and purposes:
Magento Import Listings Mappings
| Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| SKU | Flxpoint Listing: SKU | ABC123 | Identifies the product in Flxpoint (from Magento: sku) | Required |
| Name | Flxpoint Listing: Name | Blue T-Shirt | Records the product name (from Magento: name) | Required |
| Description | Flxpoint Listing: Description | A comfortable blue t-shirt made of 100% cotton. | Provides the product description (from Magento: custom_attributes.description) | Optional |
| Short Description | Flxpoint Listing: Short Description | Blue cotton t-shirt. | Provides a short description of the product (from Magento: custom_attributes.short_description) | Optional |
| Price | Flxpoint Listing: Price | 29.99 | Sets the regular price of the product (from Magento: price) | Optional |
| Special Price | Flxpoint Listing: Special Price | 24.99 | Sets the promotional price of the product (from Magento: special_price) | Optional |
| Stock Quantity | Flxpoint Listing: Stock Quantity | 50 | Records the available stock quantity (from Magento: stock_item.qty) | Optional |
| In Stock | Flxpoint Listing: In Stock | true | Indicates if the product is in stock (from Magento: stock_item.is_in_stock) | Optional |
| Images | Flxpoint Listing: Images | https://example.com/image.jpg | Imports product image URLs (from Magento: media_gallery_entries) | Optional |
| Categories | Flxpoint Listing: Categories | Apparel > T-Shirts | Assigns the product to categories (from Magento: category_ids) | Optional |
| Status | Flxpoint Listing: Status | Enabled | Indicates the product’s status (from Magento: status) | Optional |
| Visibility | Flxpoint Listing: Visibility | Catalog, Search | Indicates the product’s visibility settings (from Magento: visibility) | Optional |
| Created At | Flxpoint Listing: Created At | 2025-05-01T10:00:00Z | Records the date the product was created (from Magento: created_at) | Optional |
| Updated At | Flxpoint Listing: Updated At | 2025-05-02T12:00:00Z | Records the date the product was last updated (from Magento: updated_at) | Optional |
| Product Type | Flxpoint Listing: Product Type | Simple | Indicates the type of product (from Magento: type_id) | Optional |
| Weight | Flxpoint Listing: Weight | 0.5 | Records the product’s weight (from Magento: weight) | Optional |
Available Source Fields
Magento provides fields under categories like:
- Product: sku, name, price, special_price, status, visibility, type_id, weight, custom_attributes (e.g., description, short_description), created_at, updated_at.
- Inventory: stock_item.qty, stock_item.is_in_stock.
- Media: media_gallery_entries (image URLs).
- Categories: category_ids.
Mapping Options
You can choose from the following options for each field:
- Don’t Map: Ignore the field entirely.
- Set To Empty: Clear any existing data in that field.
- Field: Map a specific Magento field (e.g., Product’s “sku”) to a Flxpoint field.
- Value: Set a constant value for all listings.
- Mapping Set: Apply a predefined transformation or mapping table.
If the integration encounters an issue, try these steps:
- Listings Not Retrieved: Check the product status and visibility filters to ensure they match the listings you expect to fetch.
- Connection Issues: Ensure your Magento API credentials and connection are valid.
- Missing Data: Verify the mapping template includes all required fields (e.g., SKU, Name).
- Check Logs: Use the "View Logs" option to identify any API errors or mapping issues.
Conclusion
With the Magento Import Listings integration, you can efficiently import product listings from your Magento store into Flxpoint, enabling seamless inventory management and sales channel synchronization. Flexible configuration options and detailed mapping templates ensure accurate data import, streamlining your e-commerce operations.
Sync & Link Listings
Supported | Magento - Sync & Link Listings
Introduction to Magento Sync & Link Listings Integration
This guide explains how to use the Magento Sync & Link Listings integration to synchronize and link product listings between Flxpoint and your Magento store. This integration ensures that product details such as prices, stock quantities, and statuses are updated in Magento, and listings are correctly linked using identifiers like SKU.
The Magento Sync & Link Listings integration connects your Flxpoint system to Magento to:
- Link Flxpoint listings to Magento products using identifiers like SKU.
- Sync product details such as prices, stock quantities, and statuses from Flxpoint to Magento.
- Ensure consistency across platforms by keeping Magento listings up to date with Flxpoint data.
The integration follows a structured process to sync and link listings with Magento:
- Listing Linking: Matches Flxpoint listings to Magento products using the SKU as the primary identifier.
- Data Mapping: Maps Flxpoint listing fields to Magento product fields using a configurable mapping template (e.g., Flxpoint’s "Price" to Magento’s "price").
-
Syncing Updates: Sends a PUT request to the Magento API endpoint
/rest/V1/products/{sku}to update product details (e.g., price, stock quantity, status). - Error Handling: Logs errors if a SKU cannot be found in Magento or if the update fails due to validation issues.
- Sync Scheduling: Updates can be performed manually or on a schedule (e.g., every hour).
Note: Ensure that SKUs in Flxpoint match those in Magento to avoid linking failures.
Customize the integration to fit your needs:
- Fields to Sync: Choose which fields to sync (e.g., Price, Stock Quantity, Status).
- Sync Direction: Configure whether to sync data from Flxpoint to Magento only, or bidirectionally (if supported).
- Scheduling: Run the integration manually or schedule it (e.g., every hour).
- Mapping Template: Define how Flxpoint listing fields map to Magento product fields for accurate synchronization.
Follow these steps to set up the Magento Sync & Link Listings integration:
- 1 Add the Integration: Navigate to the Integrations section, select Magento as the integration type, and choose “Sync & Link Listings.”
- 2 Connect to Magento: Select an existing Magento connection or set up a new one using your Magento API credentials.
- 3 Configure Settings: Choose the fields to sync (e.g., Price, Stock Quantity), set the sync direction, and configure the sync schedule.
- 4 Create a Mapping Template: Define how Flxpoint listing fields map to Magento product fields (details below).
- 5 Run the Integration: Start the integration manually or let it run on your schedule.
- The mapping screen is labeled “Magento - Sync & Link Listings” with sections for field mappings.
- Buttons: Delete, Duplicate, and Save.
- Sections include:
- From Value: Fields from Flxpoint (e.g., Listing fields like SKU, Price).
- To Magento Product Field: Fields in Magento (e.g., sku, price).
This section provides key details about the Magento Sync & Link Listings integration to help you understand the process:
-
Magento Integration: Connects to your Magento store via the
/rest/V1/products/{sku}endpoint to update product listings. Connection settings are configured through API credentials. - Linking Process: Uses the SKU to link Flxpoint listings to Magento products, ensuring accurate synchronization.
- Data Synchronization: Updates Magento with Flxpoint data for specified fields, maintaining consistency across platforms.
Tip: Ensure that the fields you choose to sync are correctly mapped to avoid data mismatches in Magento.
Mapping Fields
Below are the fields you can map, with examples and purposes:
Magento Sync & Link Listings Mappings
| Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| SKU | Magento Product: SKU | ABC123 | Links the Flxpoint listing to the Magento product (from Flxpoint Listing: SKU) | Required |
| Name | Magento Product: Name | Blue T-Shirt | Updates the product name in Magento (from Flxpoint Listing: Name) | Optional |
| Description | Magento Product: Description | A comfortable blue t-shirt made of 100% cotton. | Updates the product description in Magento (from Flxpoint Listing: Description) | Optional |
| Short Description | Magento Product: Short Description | Blue cotton t-shirt. | Updates the short description of the product in Magento (from Flxpoint Listing: Short Description) | Optional |
| Price | Magento Product: Price | 29.99 | Updates the regular price of the product in Magento (from Flxpoint Listing: Price) | Optional |
| Special Price | Magento Product: Special Price | 24.99 | Updates the promotional price of the product in Magento (from Flxpoint Listing: Special Price) | Optional |
| Stock Quantity | Magento Product: Stock Quantity | 50 | Updates the available stock quantity in Magento (from Flxpoint Listing: Stock Quantity) | Optional |
| In Stock | Magento Product: In Stock | true | Updates the in-stock status in Magento (from Flxpoint Listing: In Stock) | Optional |
| Images | Magento Product: Images | https://example.com/image.jpg | Updates product image URLs in Magento (from Flxpoint Listing: Images) | Optional |
| Categories | Magento Product: Categories | Apparel > T-Shirts | Updates the product’s categories in Magento (from Flxpoint Listing: Categories) | Optional |
| Status | Magento Product: Status | Enabled | Updates the product’s status in Magento (from Flxpoint Listing: Status) | Optional |
| Visibility | Magento Product: Visibility | Catalog, Search | Updates the product’s visibility settings in Magento (from Flxpoint Listing: Visibility) | Optional |
| Weight | Magento Product: Weight | 0.5 | Updates the product’s weight in Magento (from Flxpoint Listing: Weight) | Optional |
Available Source Fields
Flxpoint provides fields under categories like:
- Listing: SKU, Name, Price, Special Price, Stock Quantity, In Stock, Status, Visibility, Description, Short Description, Images, Categories, Weight, Created At, Updated At.
Mapping Options
You can choose from the following options for each field:
- Don’t Map: Ignore the field entirely.
- Set To Empty: Clear any existing data in that field.
- Field: Map a specific Flxpoint field (e.g., Listing’s “Price”) to a Magento field.
- Value: Set a constant value for all listings.
- Mapping Set: Apply a predefined transformation or mapping table.
If the integration encounters an issue, try these steps:
- Linking Failure: Ensure the SKU in Flxpoint matches the SKU in Magento. Verify that the Magento product exists.
- Sync Failure: Check the mapping template for errors, and ensure the fields being synced (e.g., Price) meet Magento’s validation rules.
- Connection Issues: Ensure your Magento API credentials and connection are valid.
- Check Logs: Use the "View Logs" option to identify any API errors or mapping issues.
Conclusion
With the Magento Sync & Link Listings integration, you can seamlessly synchronize and link product listings between Flxpoint and your Magento store, ensuring accurate and up-to-date product data. Flexible configuration options and detailed mapping templates enable precise synchronization, enhancing your e-commerce operations.
Publish Listings
Supported | Magento - Publish Listings
Introduction to Magento Publish Listings Integration
This guide explains how to use the Magento Publish Listings integration to publish product listings from Flxpoint to your Magento store. This integration allows you to create new products or update existing ones in Magento, ensuring that your store reflects the latest product data from Flxpoint.
The Magento Publish Listings integration connects your Flxpoint system to Magento to:
- Publish new product listings from Flxpoint to Magento, creating new products as needed.
- Update existing Magento products with the latest data from Flxpoint (e.g., price, stock quantity).
- Ensure your Magento store reflects accurate and up-to-date product information for sales.
The integration follows a structured process to publish listings to Magento:
- Product Check: Checks if the product exists in Magento using the SKU. If it exists, the integration updates the product; if not, it creates a new one.
- Data Mapping: Maps Flxpoint listing fields to Magento product fields using a configurable mapping template (e.g., Flxpoint’s "Name" to Magento’s "name").
-
Publishing: Sends a POST request to
/rest/V1/productsto create a new product, or a PUT request to/rest/V1/products/{sku}to update an existing product. - Error Handling: Logs errors if the publish fails due to validation issues (e.g., missing required fields) or duplicate SKUs.
- Publishing Schedule: Listings can be published manually or on a schedule (e.g., daily at 8 AM UTC).
Note: Ensure that required fields (e.g., SKU, Name) are mapped correctly to avoid publishing failures.
Customize the integration to fit your needs:
- Fields to Publish: Choose which fields to publish (e.g., Name, Price, Stock Quantity).
- Update Existing Products: Enable or disable updates for existing products (options: Yes/No).
- Create New Products: Enable or disable creation of new products if they don’t exist in Magento (options: Yes/No).
- Scheduling: Run the integration manually or schedule it (e.g., daily at 8 AM UTC).
- Mapping Template: Define how Flxpoint listing fields map to Magento product fields for accurate publishing.
Follow these steps to set up the Magento Publish Listings integration:
- 1 Add the Integration: Navigate to the Integrations section, select Magento as the integration type, and choose “Publish Listings.”
- 2 Connect to Magento: Select an existing Magento connection or set up a new one using your Magento API credentials.
- 3 Configure Settings: Choose the fields to publish, enable/disable updates for existing products and creation of new products, and configure the publishing schedule.
- 4 Create a Mapping Template: Define how Flxpoint listing fields map to Magento product fields (details below).
- 5 Run the Integration: Start the integration manually or let it run on your schedule.
- The mapping screen is labeled “Magento - Publish Listings” with sections for field mappings.
- Buttons: Delete, Duplicate, and Save.
- Sections include:
- From Value: Fields from Flxpoint (e.g., Listing fields like SKU, Name).
- To Magento Product Field: Fields in Magento (e.g., sku, name).
This section provides key details about the Magento Publish Listings integration to help you understand the process:
-
Magento Integration: Connects to your Magento store via the
/rest/V1/productsendpoint to create or update product listings. Connection settings are configured through API credentials. - Publishing Process: Creates new products with a POST request or updates existing ones with a PUT request, based on the SKU.
- Data Validation: Ensures that required fields (e.g., SKU, Name) are provided and meet Magento’s validation rules to avoid publishing errors.
Tip: Test the integration with a small batch of listings first to ensure the mapping and publishing process works as expected.
Mapping Fields
Below are the fields you can map, with examples and purposes:
Magento Publish Listings Mappings
| Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| SKU | Magento Product: SKU | ABC123 | Identifies the product in Magento (from Flxpoint Listing: SKU) | Required |
| Name | Magento Product: Name | Blue T-Shirt | Sets the product name in Magento (from Flxpoint Listing: Name) | Required |
| Description | Magento Product: Description | A comfortable blue t-shirt made of 100% cotton. | Sets the product description in Magento (from Flxpoint Listing: Description) | Optional |
| Short Description | Magento Product: Short Description | Blue cotton t-shirt. | Sets the short description of the product in Magento (from Flxpoint Listing: Short Description) | Optional |
| Price | Magento Product: Price | 29.99 | Sets the regular price of the product in Magento (from Flxpoint Listing: Price) | Optional |
| Special Price | Magento Product: Special Price | 24.99 | Sets the promotional price of the product in Magento (from Flxpoint Listing: Special Price) | Optional |
| Stock Quantity | Magento Product: Stock Quantity | 50 | Sets the available stock quantity in Magento (from Flxpoint Listing: Stock Quantity) | Optional |
| In Stock | Magento Product: In Stock | true | Sets the in-stock status in Magento (from Flxpoint Listing: In Stock) | Optional |
| Images | Magento Product: Images | https://example.com/image.jpg | Publishes product image URLs to Magento (from Flxpoint Listing: Images) | Optional |
| Categories | Magento Product: Categories | Apparel > T-Shirts | Assigns the product to categories in Magento (from Flxpoint Listing: Categories) | Optional |
| Status | Magento Product: Status | Enabled | Sets the product’s status in Magento (from Flxpoint Listing: Status) | Optional |
| Visibility | Magento Product: Visibility | Catalog, Search | Sets the product’s visibility settings in Magento (from Flxpoint Listing: Visibility) | Optional |
| Weight | Magento Product: Weight | 0.5 | Sets the product’s weight in Magento (from Flxpoint Listing: Weight) | Optional |
| Product Type | Magento Product: Product Type | Simple | Sets the type of product in Magento (from Flxpoint Listing: Product Type) | Optional |
Available Source Fields
Flxpoint provides fields under categories like:
- Listing: SKU, Name, Price, Special Price, Stock Quantity, In Stock, Status, Visibility, Description, Short Description, Images, Categories, Weight, Product Type, Created At, Updated At.
Mapping Options
You can choose from the following options for each field:
- Don’t Map: Ignore the field entirely.
- Set To Empty: Clear any existing data in that field.
- Field: Map a specific Flxpoint field (e.g., Listing’s “Name”) to a Magento field.
- Value: Set a constant value for all listings.
- Mapping Set: Apply a predefined transformation or mapping table.
If the integration encounters an issue, try these steps:
- Publish Failure: Check the mapping template for missing required fields (e.g., SKU, Name) or invalid data (e.g., duplicate SKUs).
- Validation Errors: Ensure that the data being published (e.g., Price, Stock Quantity) meets Magento’s validation rules.
- Connection Issues: Ensure your Magento API credentials and connection are valid.
- Check Logs: Use the "View Logs" option to identify any API errors or mapping issues.
Conclusion
With the Magento Publish Listings integration, you can seamlessly publish product listings from Flxpoint to your Magento store, creating or updating products as needed. Flexible configuration options and detailed mapping templates ensure accurate publishing, enhancing your e-commerce operations.
Order Operations
Get Orders
Supported | Magento - Get Orders
Introduction to Magento Get Orders Integration
This guide explains how to use the Magento Get Orders integration to retrieve orders from your Magento store into Flxpoint. This integration ensures that order details, including customer information, items, and shipping details, are accurately imported for processing and fulfillment.
The Magento Get Orders integration connects your Flxpoint system to Magento to:
- Retrieve orders from your Magento store based on specified criteria (e.g., status, date range).
- Import order details such as customer information, items, and shipping details into Flxpoint.
- Enable processing of orders for fulfillment, inventory updates, or other workflows.
The integration follows a structured process to fetch orders from Magento:
-
Order Retrieval: Sends a GET request to the Magento API endpoint
/rest/V1/orderswith filters (e.g., status="pending", date range). - Data Mapping: Maps Magento order fields to Flxpoint order fields using a configurable mapping template (e.g., Magento’s "increment_id" to Flxpoint’s "Order Number").
- Data Storage: Saves the retrieved orders in Flxpoint for further processing (e.g., creating fulfillment requests).
- Syncing: Orders can be fetched manually or on a schedule (e.g., every hour).
Note: Ensure your Magento API credentials are correctly configured to avoid retrieval failures.
Customize the integration to fit your needs:
- Order Status Filter: Specify which order statuses to retrieve (e.g., "pending", "processing").
- Date Range: Set a date range for orders to fetch (e.g., last 7 days).
- Scheduling: Run the integration manually or schedule it (e.g., every hour).
- Mapping Template: Define how Magento order fields map to Flxpoint order fields for accurate data import.
Follow these steps to set up the Magento Get Orders integration:
- 1 Add the Integration: Navigate to the Integrations section, select Magento as the integration type, and choose “Get Orders.”
- 2 Connect to Magento: Select an existing Magento connection or set up a new one using your Magento API credentials.
- 3 Configure Settings: Set the order status filter (e.g., "pending") and date range for retrieval, and configure the sync schedule.
- 4 Create a Mapping Template: Define how Magento order fields map to Flxpoint order fields (details below).
- 5 Run the Integration: Start the integration manually or let it run on your schedule.
- The mapping screen is labeled “Magento - Get Orders” with sections for field mappings.
- Buttons: Delete, Duplicate, and Save.
- Sections include:
- From Value: Fields from Magento (e.g., Order fields like increment_id, customer_firstname).
- To Flxpoint Order Field: Fields in Flxpoint (e.g., Order Number, Customer Name).
This section provides key details about the Magento Get Orders integration to help you understand the process:
-
Magento Integration: Connects to your Magento store via the
/rest/V1/ordersendpoint to retrieve orders. Connection settings are configured through API credentials. - Order Filtering: Orders are fetched based on filters like status and date range, ensuring only relevant orders are imported.
- Data Mapping: A mapping template ensures Magento order fields are accurately mapped to Flxpoint fields for seamless integration.
Tip: Regularly review the mapping template to ensure all necessary order fields are included for your workflow.
Mapping Fields
Below are the fields you can map, with examples and purposes:
Magento Get Orders Mappings
| Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Order Number | Flxpoint Order: Order Number | 000000123 | Identifies the order in Flxpoint (from Magento: increment_id) | Required |
| Customer First Name | Flxpoint Order: Customer First Name | John | Records the customer’s first name (from Magento: customer_firstname) | Optional |
| Customer Last Name | Flxpoint Order: Customer Last Name | Doe | Records the customer’s last name (from Magento: customer_lastname) | Optional |
| Flxpoint Order: Email | john.doe@example.com | Records the customer’s email for communication (from Magento: customer_email) | Optional | |
| Shipping Address 1 | Flxpoint Order: Shipping Address 1 | 123 Main St | Specifies the first line of the shipping address (from Magento: shipping_address.street[0]) | Optional |
| Shipping Address 2 | Flxpoint Order: Shipping Address 2 | Apt 4B | Specifies the second line of the shipping address (from Magento: shipping_address.street[1]) | Optional |
| Shipping City | Flxpoint Order: Shipping City | Los Angeles | Specifies the city of the shipping address (from Magento: shipping_address.city) | Optional |
| Shipping Region | Flxpoint Order: Shipping Region | CA | Specifies the region or state of the shipping address (from Magento: shipping_address.region) | Optional |
| Shipping Postcode | Flxpoint Order: Shipping Postcode | 90210 | Specifies the postal code of the shipping address (from Magento: shipping_address.postcode) | Optional |
| Shipping Country | Flxpoint Order: Shipping Country | US | Specifies the country of the shipping address (from Magento: shipping_address.country_id) | Optional |
| Billing Address 1 | Flxpoint Order: Billing Address 1 | 123 Main St | Specifies the first line of the billing address (from Magento: billing_address.street[0]) | Optional |
| Billing Address 2 | Flxpoint Order: Billing Address 2 | Apt 4B | Specifies the second line of the billing address (from Magento: billing_address.street[1]) | Optional |
| Billing City | Flxpoint Order: Billing City | Los Angeles | Specifies the city of the billing address (from Magento: billing_address.city) | Optional |
| Billing Region | Flxpoint Order: Billing Region | CA | Specifies the region or state of the billing address (from Magento: billing_address.region) | Optional |
| Billing Postcode | Flxpoint Order: Billing Postcode | 90210 | Specifies the postal code of the billing address (from Magento: billing_address.postcode) | Optional |
| Billing Country | Flxpoint Order: Billing Country | US | Specifies the country of the billing address (from Magento: billing_address.country_id) | Optional |
| Items (SKU) | Flxpoint Order: Items (SKU) | ABC123 | Lists the product SKUs in the order (from Magento: items.sku) | Required |
| Items (Quantity) | Flxpoint Order: Items (Quantity) | 3 | Specifies the quantity of each item ordered (from Magento: items.qty_ordered) | Required |
| Items (Price) | Flxpoint Order: Items (Price) | 29.99 | Specifies the price of each item (from Magento: items.price) | Optional |
| Total | Flxpoint Order: Total | 150.00 | Records the total order amount (from Magento: grand_total) | Optional |
| Shipping Cost | Flxpoint Order: Shipping Cost | 15.00 | Records the shipping cost for the order (from Magento: shipping_amount) | Optional |
| Order Date | Flxpoint Order: Order Date | 2025-05-01T10:00:00Z | Records the date the order was placed (from Magento: created_at) | Optional |
| Status | Flxpoint Order: Status | Pending | Records the order’s status (from Magento: status) | Optional |
Available Source Fields
Magento provides fields under categories like:
- Order: increment_id, customer_firstname, customer_lastname, customer_email, grand_total, shipping_amount, created_at, status, updated_at.
- Address: shipping_address, billing_address (includes street, city, region, postcode, country_id).
- Items: sku, qty_ordered, price, product_type.
Mapping Options
You can choose from the following options for each field:
- Don’t Map: Ignore the field entirely.
- Set To Empty: Clear any existing data in that field.
- Field: Map a specific Magento field (e.g., Order’s “increment_id”) to a Flxpoint field.
- Value: Set a constant value for all orders.
- Mapping Set: Apply a predefined transformation or mapping table.
If the integration encounters an issue, try these steps:
- Orders Not Retrieved: Check the order status filter and date range settings to ensure they match the orders you expect to fetch.
- Connection Issues: Ensure your Magento API credentials and connection are valid.
- Missing Data: Verify the mapping template includes all required fields (e.g., Order Number, Items).
- Check Logs: Use the "View Logs" option to identify any API errors or mapping issues.
Conclusion
With the Magento Get Orders integration, you can efficiently import orders from your Magento store into Flxpoint, enabling seamless order processing and fulfillment. Flexible configuration options and detailed mapping templates ensure accurate data import, streamlining your e-commerce operations.
Sync Orders
Supported | Magento - Sync Orders
Introduction to Magento Sync Orders Integration
This guide explains how to use the Magento Sync Orders integration to synchronize updates to orders, specifically shipment details, from Flxpoint back to your Magento store. This integration ensures that tracking information, shipping details, and carrier information are accurately updated on your Magento channel.
The Magento Sync Orders integration connects your Flxpoint system to Magento to:
- Sync updates to orders since the last synchronization, focusing on shipment components.
- Update Magento with tracking information, shipping details, and carrier information.
- Notify customers of shipment updates and add comments visible on the store’s front-end, if configured.
- Supports partial shipments: Only a portion of the order items can be shipped and synced, if needed.
The integration follows a structured process to sync order shipments to Magento:
-
Initialization: The process starts by creating a
SyncShipmentResultobject to store synchronization results. - Processing Orders: For each order, the integration iterates through associated shipments.
-
Posting Shipments: Each shipment is posted to Magento using the
SalesShipOrderV1Api.salesShipOrderV1ExecutePostendpoint, passing the order ID and mapped shipment data (e.g., carrier code, tracking number). - Error Handling: If an "External Order Item ID Mismatch" error occurs, a specific error message is logged. Other exceptions are logged as warnings, and failed shipments are recorded in the results.
-
Returning Results: The
SyncShipmentResultobject is returned, detailing successful and failed shipments.
Note: Ensure your Magento connection is active to avoid synchronization failures.
Customize the integration to fit your needs:
- Is Visible on Front: Choose whether shipment comments are visible on the front-end of your Magento store (options: Yes/No).
- Notify Customer: Enable to have Magento alert customers when a new shipment is added to their order (options: Yes/No).
- Extension Attribute: Enable if your setup requires a custom plugin to send extension attributes (options: Yes/No).
- Append Comment: Choose whether to append a comment with new shipment notifications (options: Yes/No).
- Scheduling: Run the integration manually or schedule it (e.g., every day or every 5 minutes).
- Mapping Template: Define how Flxpoint shipment fields map to Magento fields for precise synchronization.
Follow these steps to set up the Magento Sync Orders integration:
- 1 Add the Integration: Navigate to the Integrations section, select Magento as the integration type, and choose “Sync Orders.”
- 2 Connect to Magento: Select an existing Magento connection or set up a new one using your Magento credentials.
- 3 Configure Settings: Decide if shipment comments should be visible on the front-end, if customers should be notified, if extension attributes are needed, and if comments should be appended.
- 4 Create a Mapping Template: Define how Flxpoint shipment fields map to Magento fields (details below).
- 5 Run the Integration: Start the integration manually or let it run on your schedule.
- The mapping screen is labeled “Magento - Sync Orders” with sections for field mappings.
- Buttons: Delete, Duplicate, and Save.
- Sections include:
- From Value: Fields from Flxpoint (e.g., Shipment fields like Carrier, Tracking Number).
- To Magento Sales Shipment Field: Fields in Magento (e.g., Carrier Code, Track Number).
- To Magento Shipment Comment Field: Fields for comments (e.g., Comment).
This section provides key details about the Magento Sync Orders integration to help you understand the process:
-
Magento Integration: Connects to your Magento store via the
SalesShipOrderV1Api.salesShipOrderV1ExecutePostendpoint to update shipment details. Connection settings are hardcoded and not configurable through the UI. - Partial Shipments: Supports syncing only a portion of the order items if needed, allowing flexibility in fulfillment.
- Customer Notifications: If "Notify Customer" is enabled, Magento will alert customers about new shipments, and comments can be made visible on the store’s front-end if "Is Visible on Front" is enabled.
Tip: Ensure your mapping template includes required fields like Carrier Code and Track Number to avoid sync failures.
Mapping Fields
Below are the fields you can map, with examples and purposes:
Magento Sync Orders Mappings
| Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Carrier Code | Magento Sales Shipment: Carrier Code | UPS | Identifies the shipping carrier (from Flxpoint Shipment: Carrier) | Required |
| Track Number | Magento Sales Shipment: Track Number | 1Z9999W99999999999 | Provides the tracking number for the shipment (from Flxpoint Shipment: Tracking Number) | Required |
| Method | Magento Sales Shipment: Method | Ground | Specifies the shipping method used (from Flxpoint Shipment: Method) | Optional |
| Fulfillment Request Number | Magento Sales Shipment: Order ID | 123456 | Associates the shipment with the order in Magento (from Flxpoint Shipment: Fulfillment Request Number) | Optional |
| Shipped At | Magento Sales Shipment: Created At | 2025-05-01T10:00:00Z | Records the date and time the shipment was created (from Flxpoint Shipment: Shipped At) | Optional |
| Comment | Magento Shipment Comment: Comment | Shipped via UPS on 2025-05-01 | Adds a comment to the shipment, visible to customers if configured (from Flxpoint Shipment: Note or Order: Note) | Optional |
Available Source Fields
Flxpoint provides fields under categories like:
- Order: Order Number, Order Total, Note, Ordered On, Reference Number.
- Shipment: Carrier, Tracking Number, Tracking URL, Method, Note, Shipped At, Shipping Cost, Fulfillment Request Number.
Mapping Options
You can choose from the following options for each field:
- Don’t Map: Ignore the field entirely.
- Set To Empty: Clear any existing data in that field.
- Field: Map a specific Flxpoint field (e.g., Shipment’s “Carrier”) to a Magento field.
- Value: Set a constant value for all shipments.
- Mapping Set: Apply a predefined transformation or mapping table.
If the integration encounters an issue, try these steps:
-
Shipment Not Updating on Store: Check the order in Flxpoint for logged errors on the shipment, which explain why the update failed. Common issues include:
- Tracking number format doesn’t match the expected carrier format.
- Tracking number is too long or malformed.
- Tracking number field contains multiple tracking numbers.
- Connection Issues: Ensure your Magento credentials and connection are valid.
Conclusion
With the Magento Sync Orders integration, you can seamlessly update shipment details like tracking and carrier information on your Magento store. Flexible configuration options and detailed mapping templates ensure precise synchronization, while customer notifications and front-end visibility enhance the shopping experience. The integration also supports partial shipments, allowing you to sync only part of an order if needed.