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 in to your Flxpoint account and navigate to Sales Channels.
Step 2: Click Create Channel (or Add Channel).
Step 3: In the Configure Integration Type screen:
Optionally, use the Channel Wizard to guide you through the setup process.
Search for Magento in the directory and select it.
Enter a Channel Name (e.g., "Magento Store").
Click Save & Next.
Step 4: Obtain your Magento 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 an Integration Name (e.g., "Flxpoint").
Provide an email (e.g., support@flxpoint.com).
Enter your Magento admin Password to save the integration.
In the API tab, select All for permissions (or specifically grant Sales, Catalog, Customers, Stores, and System).
Click Save, then Activate to generate your Access Token.
Copy the Access Token for use in Flxpoint.
Step 5: On the Connect Channel screen, set up a new Magento connection:
Enter a Connection Name (e.g., "Magento Connection #2").
Paste the Access Token from your Magento dashboard.
Set the API Page Size (e.g., 250).
Enter your Store URL (e.g., your Magento store’s base URL).
Click Test Connection & Continue to verify the setup.
Step 6: Choose the processes to enable for your Magento channel:
Import Listings: To create and update listings and products in Flxpoint.
Get Orders: To import new orders and send back acknowledgments.
Step 7: In the Configure Settings screen for Import Listings:
Set your Master SKU by selecting Use a field from my channel and choosing a field, or select Don't set a master SKU at this time.
Under Product & Listing Management, choose how listings should be imported (e.g., "Create and update products & listings").
Click Confirm to proceed.
Step 8: In the Channel Created screen:
Check the box to Enable this to start importing your active listings into Flxpoint immediately if desired.
Check the box to Start importing orders immediately if desired.
Click Confirm & Finish to complete the setup.
Final Step: Your Magento channel is now set up! You can revisit it in Sales Channels to:
Start Import Listings to create and update listings and products in Flxpoint.
Start Get Orders to import new orders and send back acknowledgments.
Adjust any skipped steps from the channel settings or use the Channel Wizard for further configuration.
If you did not use the Channel Wizard, check other integrations like Get Orders, Sync Orders, and Sync & Link Listings to ensure full functionality.
×
![]()
Listing Operations
Flxpoint allows you to manage product listings on eBay by syncing inventory, updating product details, and controlling pricing and availability. This ensures accurate and real-time updates across your eBay store.
Import Listings
Supported | Magento - Import Listings
Introduction to Magento Import Listings Integration
This guide explains how to use the Magento Import Listings integration to bring your existing Magento listings into Flxpoint for centralized management. It ensures accurate synchronization of your inventory across platforms by importing both simple and configurable products.
Purpose of This Integration
The Magento Import Listings integration connects your Flxpoint system to Magento to:
- Import existing Magento listings into Flxpoint for centralized management.
- Link Magento listings to Flxpoint records using identifiers like SKU.
- Allow pausing of imported listings to prevent synchronization until they are properly linked and verified.
- Support both simple and configurable products for comprehensive catalog management.
How the Integration Works
The integration follows a structured process to import listings into Flxpoint:
1. Fetch Listings: Listings are retrieved from Magento, including simple and configurable products.
2. Import Data: Listings are imported into Flxpoint, including details like SKU, title, description, categories, quantity, price, and images.
3. Link Listings: Imported listings are linked to existing Flxpoint records by SKU, or new records are created if no match is found.
4. Paused Status Option: Listings can be set to a "Paused" status to prevent synchronization until verified.
5. Handle Variants: For configurable products, variants are imported with details like UPC, quantity, and price.
Configuration Options
Customize the integration to fit your needs:
- Paused Status: Automatically set newly imported listings to "Paused" to prevent syncing until they are properly linked (e.g., price, quantity).
- Master SKU: Choose a field from Magento (e.g., SKU, UPC) to populate Flxpoint’s Master SKU, defining the primary identifier for linking.
- Product & Listing Management: Decide whether to create new products and listings only, or create and update existing ones with imported data.
- Image URL: Optionally specify a field for prepending product image URLs.
Setup Instructions
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 credentials.
3. Configure Settings: Enable "Set New Listings to Paused" if desired, select a Master SKU field (e.g., SKU), choose product/listing management options, and optionally set an image URL field.
4. Run the Integration: Save and complete the setup to import listings into Flxpoint.
Operation Details
The integration supports the following features:
- Custom Fields: Supported for both parent and variant listings.
- Variants/Options: Supported for configurable products (e.g., SKU, UPC, quantity, price).
- Quantity: Supported, with available quantity saved in Flxpoint.
- Images: Supported, with image URLs saved in Flxpoint.
- Categories: Supported, with up to three category levels (categoryOne, categoryTwo, categoryThree).
- Limitations: The integration cannot be scheduled and must be run manually. Mismatched SKUs may result in duplicate listings and products. Linking based on ASIN, GTIN, MPN, or UPC is not supported.
Troubleshooting
If the integration encounters an issue, try these steps:
- Verify your Magento credentials and connection.
- Ensure the Master SKU field selected matches your data for proper linking.
- Check for duplicate listings due to mismatched SKUs.
Conclusion
With the Magento Import Listings integration, you can seamlessly bring your Magento listings into Flxpoint, ensuring centralized management and accurate synchronization.
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 keep your product listings in sync with your Flxpoint inventory. This integration ensures that prices, quantities, and statuses are always up to date between Flxpoint and Magento. It also allows you to link listings using identifiers like SKU, UPC, or GTIN, and manage product visibility.
Purpose of This Integration
The Magento Sync & Link Listings integration connects your Flxpoint system to Magento to:
- Sync price, quantity, and status updates between Flxpoint and Magento.
- Link Flxpoint listings to Magento products using identifiers like SKU, UPC, or GTIN.
- Automatically hide or delist products on Magento based on quantity or status.
- Support both simple and configurable products for comprehensive synchronization.
How the Integration Works
The integration follows a streamlined process to sync and link listings:
1. Fetch Listings: Products are retrieved from Magento in batches, starting with configurable products, then simple, and finally virtual products using the
catalogProductRepositoryV1GetListGet endpoint. 2. Link Listings: Listings are linked between Flxpoint and Magento based on user-defined priorities (e.g., SKU, UPC, GTIN). For configurable products, variants are fetched using
configurableProductLinkManagementV1GetChildrenGet. 3. Map Data: Local product data is mapped to Magento’s format, including custom attributes, using the
mapSync method. 4. Sync Regular Products: Non-variant products are synchronized using the
syncRegularProducts method and updated via catalogProductRepositoryV1SavePut. 5. Sync Variant Products: Configurable products and their variants are synchronized using the
syncVariationProducts method. 6. Handle Visibility: Products can be hidden (set to "Out of Stock") or delisted (removed) on Magento based on quantity or status, using
catalogProductRepositoryV1DeleteByIdDelete. Configuration Options
Customize the integration to fit your needs:
- Store View Code: Specify the Magento store view (e.g., "default") to sync with.
- Linking Priority: Set the order of identifiers (e.g., SKU, UPC, GTIN) to match Flxpoint listings with Magento products.
- Batch Size: Configure the batch size for linking jobs (default is 250) to avoid timeouts.
- Scheduling: Run the integration manually or schedule it (e.g., every day or every 5 minutes).
- Mapping Template: Define how Flxpoint fields map to Magento fields for syncing.
Setup Instructions
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 Listings.”
2. Connect to Magento: Select an existing Magento connection or set up a new one using your Magento credentials.
3. Configure Settings: Set the store view code, linking priority (e.g., SKU first, then UPC), adjust batch size if needed, and enable scheduling if desired.
4. Create a Mapping Template: Define how Flxpoint fields map to Magento fields (details below).
5. Run the Integration: Start the integration manually or let it run on your schedule.
Hiding
Hiding a variant temporarily sets the product to "Out of Stock" on your Magento channel, ensuring no unwanted orders occur when stock is depleted.
Unhiding
Unhiding a variant can only be used for products already on "Hide" status, bringing the product back live for Magento sales.
Delisting
Delisting permanently removes the product from your Magento channel listing. It can only be brought back to listed status after running the sync/publish job.
Mapping Template Details
A mapping template defines how data from Flxpoint is synced to Magento. For example, you can map Flxpoint’s “Quantity” field to Magento’s “Quantity” field.
Interface Overview
- The mapping screen is labeled “Mapping Template” at the top, with options to select templates.
- Buttons available: Delete, Duplicate, and Save.
- Two sections:
- From Value: Fields from Flxpoint (e.g., Listing Variant fields like Quantity, List Price).
- To Magento Product Field: Fields in Magento (e.g., Quantity, Price, Status).
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 (transmitted as blank).
- Field: Map a field from Flxpoint (e.g., Listing Variant’s “Quantity”) to a Magento field.
- Option: Set a specific value (e.g., "Active" for Status).
Available Source Fields
Flxpoint provides fields under categories like “Listing Variant,” including:
- Listing Variant: Quantity, List Price, MAP, MSRP, Estimated Cost, Estimated Dropship Fee, Estimated Shipping Cost.
Complete Field Mappings
Below is a sample list of fields you can map to Magento:
Quantity: Product stock level.
- Suggested Mapping: Map to Listing Variant’s “Quantity.”
Price: Product price.
- Suggested Mapping: Map to Listing Variant’s “List Price.”
Status: Product status (Active/Inactive).
- Suggested Mapping: Set to “Active” or map to a custom field.
Visibility: Product visibility (Visible/Not Visible).
- Suggested Mapping: Set to “Visible” or use rules for conditional visibility.
Troubleshooting
If the integration encounters an issue, try these steps:
- Verify your Magento credentials and connection.
- Ensure the linking priority (e.g., SKU, UPC) matches your data.
- Check your mapping template for correct field mappings.
- Adjust the batch size if you encounter timeout errors (e.g., reduce from 250).
Conclusion
With the Magento Sync & Link Listings integration, your Flxpoint inventory will stay in sync with Magento, ensuring accurate prices, stock levels, and visibility settings. You’ll also have control over linking, hiding, and delisting products, making inventory management seamless and efficient!
Publish Listings
Supported | Magento - Publish Listings
Introduction to Magento Publish Listings Integration
This guide explains how to use the Magento Publish Listings integration to create and update product listings on your Magento store via Flxpoint. This integration ensures that your products are accurately published and maintained, supporting both simple and configurable products, with flexible mapping and configuration options for a seamless publishing experience.
Purpose of This Integration
The Magento Publish Listings integration connects your Flxpoint system to Magento to:
- Create new product listings on Magento.
- Update existing product listings on Magento with the overwrite feature.
- Manage product attributes, categories, and images during publishing.
- Support configurable products with variants for comprehensive listing management.
How the Integration Works
The integration follows a structured process to publish listings to Magento:
1. Create Listings: New listings are created using the
create method, which maps Flxpoint products to Magento’s structure, validates them, and creates them via catalogProductRepositoryV1SavePost. 2. Update Listings: Existing listings are updated using the
update method, which maps and validates data, then updates via catalogProductRepositoryV1SavePut. 3. Handle Images: Images are managed during both creation and updates using
catalogProductAttributeMediaGalleryManagementV1CreatePost and catalogProductAttributeMediaGalleryManagementV1UpdatePut. 4. Assign Website: Products are assigned to the appropriate Magento website using
catalogProductWebsiteLinkRepositoryV1SavePost. 5. Additional Operations: Methods like
populateMappingTemplate, getPublishingListingsToUpdate, getPublishableListingsFromApi, mapUpdate, and validateUpdate support the process by preparing templates, fetching listings, and ensuring data integrity. Configuration Options
Customize the integration to fit your needs:
- Store View Code: Specify the Magento store view (default: "default").
- Website Code: Define the Magento website (default: "base").
- Root Category Name: Set the root category for products (default: "Default Category").
- Attribute Set ID: Assign the attribute set for products (default: 4).
- Disable Creation of Missing Categories: Prevent Flxpoint from creating new categories on Magento if set to "Yes." Products in a category not found on Magento will not be published, ensuring your category structure remains intact.
- Create New Attributes on Magento if Not Found: Choose to create attributes and dropdown options if they don’t exist (options: "Do not create Attributes," "Create missing Dropdown Attribute Options," "Create both Attributes and Dropdown Options"). This allows for greater flexibility in managing product attributes.
- Scheduling: Run the integration manually or schedule it (e.g., every day or every 30 minutes) for automated publishing.
- Mapping Template: Define how Flxpoint fields map to Magento fields for precise control over the publishing process.
Setup Instructions
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 credentials.
3. Configure Settings: Set the store view code, website code, root category name, and attribute set ID. For most Magento stores, use the defaults: Store View Code: "default," Website Code: "base," Root Category Name: "Default Category," Attribute Set ID: "4." Adjust category and attribute creation settings as needed.
4. Create a Mapping Template: Define how Flxpoint fields map to Magento fields (details below).
5. Run the Integration: Start the integration manually or let it run on your schedule.
Overwrite Feature
The overwrite feature allows you to update specific details of already published variants on your Magento sales channel, such as Title, Description, Categories, MPN, UPC, GTIN, and Images. This ensures your listings stay current without affecting unrelated fields.
Attributes and Attribute Sets
Magento requires specifying an attribute set when creating new product listings. To use multiple attribute sets, segment your publishes based on Attribute Set ID:
1. Configure Publish Listings with Attribute Set ID "1."
2. Select listings to publish under Attribute Set ID "1."
3. Run Publish Listings.
4. Update the configuration in Publish Listings to Attribute Set ID "2" and save.
5. Select listings to publish under Attribute Set ID "2."
6. Run Publish Listings.
7. Repeat as needed for additional attribute sets.
This approach ensures products are published with the correct attribute sets, enhancing organization and consistency.
Mapping Template Details
A mapping template defines how data from Flxpoint is published to Magento, offering precise control over product fields, attributes, and stock settings.
Interface Overview
- The mapping screen is labeled “Mapping Template” at the top, with options to select templates.
- Buttons available: Delete, Duplicate, and Save.
- Sections include:
- From Value: Fields from Flxpoint (e.g., Listing Parent fields like Title, Description).
- To Magento Configurable Product Field: Fields for configurable products (e.g., Attributes, Categories).
- To Magento Product Field: Fields for products/variants (e.g., Status, Weight).
Mapping Options
You can choose from the following options for each field:
- Don’t Map: Ignore the field entirely, preserving existing Magento values.
- Set To Empty: Clear any existing data in that field (transmitted as blank).
- Direct Copy: Copy the field value directly from Flxpoint to Magento.
- Field: Map a specific Flxpoint field (e.g., Listing Parent’s “Title”) to a Magento field.
- Value/Option: Set a constant value for all products (e.g., "Active" for Status).
- Mapping Set: Apply a predefined transformation or mapping table.
Available Source Fields
Flxpoint provides fields under categories like:
- Listing Parent: Title, Description, Category 1, Category 2, Category 3, Image, Parent SKU.
- Listing Variant: Quantity, List Price, MAP, MSRP, Estimated Cost, Estimated Dropship Fee, Estimated Shipping Cost, Weight, SKU, UPC, GTIN, MPN.
Complete Field Mappings
Below is a sample list of fields you can map to Magento:
Configurable Product Fields:
- Attributes: Product attributes (suggested: Direct Copy).
- Categories: Product categories (suggested: Direct Copy).
Product Fields (Variants):
- Description: Map to Listing Parent’s “Description.”
- Short Description: Map to Listing Parent’s “Description.”
- Images: Map to Listing Parent’s “Image.”
- Status: Set to “Active” (default: Active).
- Show Default Notification Message: Set to “False” (default: False).
- Stock Id: Set to “1” (default: 1).
- Stock Status Changed Auto: Set to “0” (default: 0).
- Use Config Backorders: Set to “True” (default: True).
- Is In Stock: Set based on quantity availability (default: True if quantity > 0).
- Max Sale Qty: Set to “10000” (default: 10000). If Use Config Max Sale Qty is “True,” the Magento configuration value is used instead.
- Backorders: Set to “0” (default: 0).
- Use Config Max Sale Qty: Set to “True” (default: True).
- Use Config Enable Qty Inc: Set to “False” (default: False).
- Is Decimal Divided: Set to “False” (default: False).
- Enable Qty Increments: Set to “False” (default: False).
- Is Qty Decimal: Set to “False” (default: False).
- Use Config Manage Stock: Set to “True” (default: True).
- Use Config Qty Increments: Set to “True” (default: True).
- Notify Stock Qty: Set to “1” (default: 1).
- Use Config Min Sale Qty: Set to “True” (default: True).
- Min Sale Qty: Set to “1” (default: 1).
- Use Config Min Qty: Set to “True” (default: True).
- Min Qty: Set to “0” (default: 0).
- Use Config Notify Stock Qty: Set to “True” (default: True).
- Qty Increments: Set to “0” (default: 0).
- Manage Stock: Set to “True” (default: True).
- Tax Class: Set to “Taxable Goods” (default: None).
- Weight: Map to Listing Variant’s “Weight.”
Special Considerations
- URL Key as Attribute Value: If set to “True” in the mapping template, the URL key will be added as an attribute during publishing (e.g., as “{product name}-{product SKU}”). This only applies during initial publishing, not overrides, ensuring existing URL keys remain unchanged.
- Custom Attributes: When set to “Set to Empty,” custom attribute values are transmitted as blank, giving you control over which attributes to clear.
- Special Characters in SKUs: SKUs with special characters (e.g., “+”) are automatically URL-encoded (e.g., “+” becomes “%2B”) to ensure successful API requests, improving reliability when publishing products.
Troubleshooting
If the integration encounters an issue, try these steps:
- Products Not Publishing: Ensure the Store View Code, Website Code, Root Category Name, and Attribute Set ID are correct (defaults: "default," "base," "Default Category," "4"). Verify your Magento credentials and connection.
- Products Showing as Inactive: Check the mapping template to ensure the “Status” field is set to “Active,” not “Inactive.”
- Unwanted Overwrites: Use the “Don’t Map” option in the mapping template for fields you don’t want to overwrite, such as URL keys, to preserve existing Magento values.
Conclusion
With the Magento Publish Listings integration, you can efficiently create and update listings on your Magento store, ensuring consistency and accuracy. The flexible mapping template, support for special characters, and detailed configuration options provide a tailored publishing experience, streamlining your inventory management process.
Order Operations
Flxpoint imports orders from eBay into your system, automating order processing, tracking updates, and inventory adjustments. This streamlines fulfillment and ensures efficient handling of eBay transactions.
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 allows you to import orders based on specific statuses and date ranges, ensuring seamless order management across platforms.
Purpose of This Integration
The Magento Get Orders integration connects your Flxpoint system to Magento to:
- Retrieve orders in specific or multiple statuses from your Magento store.
- Filter orders based on creation date for efficient imports.
- Map Magento order data, including billing and shipping addresses, to Flxpoint’s internal format.
How the Integration Works
The integration follows a structured process to fetch orders from Magento:
1. Configuration: The integration sets up APIs (
SalesOrderRepositoryV1Api and CatalogProductRepositoryV1Api) and validates settings like order status (e.g., Pending, Unshipped) and cutoff date for fetching orders. 2. Fetch Orders: Orders are retrieved in batches of 50 using pagination via the
salesOrderRepositoryV1GetListGet endpoint. 3. Map Orders: Each order is mapped to Flxpoint’s internal
OrderDto format, including billing/shipping addresses, order items, and invoices. Missing shipping information is handled, dates are parsed, and item prices are updated if missing. Configuration Options
Customize the integration to fit your needs:
- Get Orders Created Within the Last X Days: Specify the date range for fetching orders (e.g., 20 days).
- Get Orders with Order Status: Select specific statuses to retrieve (e.g., Pending, Unshipped, Processing, Complete). If none are selected, all statuses are retrieved.
- Personal Identifying Information Retention: Choose how long to retain personal data (options: Indefinitely, 30/60/90 days after shipment).
- Use Parent Item ID Instead of Item ID: Enable this to sync Simple products using the parent order line items, ensuring accurate tracking for configurable products.
- Scheduling: Run the integration manually or schedule it (e.g., every day or every 5 minutes).
- Mapping Template: Define how Magento order fields map to Flxpoint fields for precise data import.
Setup Instructions
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 credentials.
3. Configure Settings: Set the date range for fetching orders, select desired order statuses, configure personal data retention, and enable parent item ID usage if needed.
4. Create a Mapping Template: Define how Magento order fields map to Flxpoint fields (details below).
5. Run the Integration: Start the integration manually or let it run on your schedule.
Multiple Order Statuses
The integration supports retrieving orders in multiple statuses (e.g., Pending, Unshipped). For example, selecting "Pending" and "Unshipped" in Configure Settings will fetch orders in both statuses.
Shipping Mappings
Configure shipping methods in your Channel Settings to pre-select them when importing orders. This increases efficiency by auto-assigning shipping methods based on your store’s settings (e.g., Next Day, Overnight). Verify mappings in your store or marketplace to ensure accuracy.
Mapping Template Details
A mapping template defines how order data from Magento is imported into Flxpoint, ensuring accurate data alignment.
Interface Overview
- The mapping screen is labeled “Mapping Template” at the top, with options to select templates.
- Buttons available: Delete, Duplicate, and Save.
- Sections include:
- From Value: Fields from Magento (e.g., Magento Billing Address fields like Address Line 1).
- To Billing/Shipping Address Field: Fields in Flxpoint (e.g., State, Telephone).
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., Magento Billing Address’s “State”) to a Flxpoint field.
- Value: Set a constant value for all orders.
- Mapping Set: Apply a predefined transformation or mapping table.
Available Source Fields
Magento provides fields under categories like:
- Magento Billing/Shipping Address: Address Line 1, Address Line 2, City, State, Post Code, Telephone, Email, First Name, Last Name, Company, Country Code.
- Magento Order: Order ID, Status, Date Created, Grand Total, Shipping Amount, Coupon Code, Customer Note.
- Magento Order Item: SKU, Name, Price, Quantity Ordered, Item ID, Weight, Discount Amount.
Complete Field Mappings
Below is a sample list of fields you can map to Flxpoint:
Billing/Shipping Address Fields:
- State: Map to Magento Billing Address’s “State.”
- State Code: Optionally map to a state code field (suggested: Don’t Map if not needed).
- Telephone: Map to Magento Billing Address’s “Telephone.”
Order Fields:
- Order ID: Map to Magento Order’s “Order ID.”
- Status: Map to Magento Order’s “Status.”
- Grand Total: Map to Magento Order’s “Grand Total.”
Order Item Fields:
- SKU: Map to Magento Order Item’s “SKU.”
- Quantity Ordered: Map to Magento Order Item’s “Quantity Ordered.”
Troubleshooting
If the integration encounters an issue, try these steps:
- Orders Not Importing: Verify the order status on your store matches the selected statuses in Configure Settings (e.g., Pending, Unshipped). If the order is older than the configured date range (e.g., 7 days), increase the “Get Orders Created Within the Last X Days” setting.
- Connection Issues: Ensure your Magento credentials and connection are valid.
Conclusion
With the Magento Get Orders integration, you can efficiently import orders from your Magento store into Flxpoint, with flexible options to filter by status and date. The detailed mapping template ensures accurate data alignment, streamlining your order management process.
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.
Purpose of This Integration
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.
How the Integration Works
The integration follows a structured process to sync order shipments to Magento:
1. Initialization: The process starts by creating a
SyncShipmentResult object to store synchronization results. 2. Processing Orders: For each order, the integration iterates through associated shipments.
3. Posting Shipments: Each shipment is posted to Magento using the
SalesShipOrderV1Api.salesShipOrderV1ExecutePost endpoint, passing the order ID and mapped shipment data (e.g., carrier code, tracking number). 4. 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.
5. Returning Results: The
SyncShipmentResult object is returned, detailing successful and failed shipments. Configuration Options
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.
Setup Instructions
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.
Mapping Template Details
A mapping template defines how shipment data from Flxpoint is synchronized to Magento, ensuring accurate updates to shipment fields and comments.
Interface Overview
- The mapping screen is labeled “Mapping Template” at the top, with options to select templates.
- Buttons available: 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).
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.
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.
Complete Field Mappings
Below is a sample list of fields you can map to Magento:
Sales Shipment Fields:
- Carrier Code: Map to Shipment’s “Carrier” (required).
- Track Number: Map to Shipment’s “Tracking Number” (required).
Shipment Comment Fields:
- Comment: Map to Shipment’s “Note” or Order’s “Note.” This message is sent to the customer if “Notify Customer” is enabled.
Troubleshooting
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.
Correct the tracking number format and retry the sync.
- 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.