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
Important: This guide explains how to connect
Flxpoint
Flxpoint is an operations platform for e-commerce retailers.
to your
Magento
Magento is a popular e-commerce platform for online stores.
store. Make sure you have admin rights on both platforms.
Click to begin the guided integration process
Step 1: Initiate Flxpoint Channel
Create a new sales channel in Flxpoint for Magento.
1 Access Flxpoint
Log in to your Flxpoint account.
Open Sales Channels in the side menu.
2 Create a Channel
Click Create Channel.
Step 2: Configure Magento Integration
Tell Flxpoint what kind of channel you are connecting.
1 Choose Connector
Search for Magento in the connector list and select it.
2 Channel Details
Name the channel (e.g., "Magento Store").
Click Save & Next.
Complete the Integration
Step 3: Obtain Magento API Credentials
Generate an API Access Token in Magento.
1 Access Magento Admin
Log in to AdminExample: https://yourstore.com/admin.
Go to System › Integrations.
2 Create a New Integration
Click Add New Integration.
Name it (e.g., "Flxpoint").
Add an admin email (e.g., support@flxpoint.com).
Confirm your admin password.
3 Configure & Activate
In API, choose AllOr restrict as needed. resource access.
Click Save → Activate and approve.
Copy the generated Access Token.
Step 4: Connect Flxpoint to Magento
Enter the credentials you copied.
1 Connection Details
Name the connection (e.g., "Magento Live").
Paste the Access Token.
Enter your Store URLBase URL, e.g., https://www.yourstore.com.
2 API Parameters
Set Page Size (e.g., 250).
3 Test Connection
Click Test Connection & Continue.
Step 5: Configure Channel Operations
Tell Flxpoint how to manage listings and orders.
1 Import Listings
Enable Import Listings.
-
Set Master SKU to
sku. - Choose "Create & update products / listings".
2 Import Orders
Enable Get Orders.
3 Finalize Settings
Click Confirm.
Step 6: Finalize and Activate Channel
Turn syncing on.
1 Enable Sync Options
Check Import active listings.
Check Import orders.
2 Finish
Click Confirm & Finish.
Step 7: Verify Setup
Make sure everything is running smoothly.
1 Monitor Channel
Open Sales Channels and check the status.
Run Import Listings or Get Orders manually if needed.
2 Adjust If Needed
Use Channel Wizard to tweak settings.
Important Check
Enable "Sync Orders", "Sync & Link Listings", "Publish Listings".
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.
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.
The integration follows a structured process to import listings into Flxpoint:
- Fetch Listings: Listings are retrieved from Magento, including simple and configurable products.
- Import Data: Listings are imported into Flxpoint, including details like SKU, title, description, categories, quantity, price, and images.
- Link Listings: Imported listings are linked to existing Flxpoint records by SKU, or new records are created if no match is found.
- Paused Status Option: Listings can be set to a "Paused" status to prevent synchronization until verified.
- Handle Variants: For configurable products, variants are imported with details like UPC, quantity, and price.
Note: Ensure your Magento API credentials are correctly configured to avoid retrieval failures.
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.
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.
- The configuration screen is labeled “Magento - Import Listings” with sections for settings and mappings.
- Buttons: Delete, Duplicate, and Save.
-
Sections include:
- Settings: Options like Paused Status, Master SKU, Product & Listing Management, and Image URL.
- 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 Support: Imports both simple and configurable products, including variants with details like UPC, quantity, and price.
- Paused Status: Allows setting imported listings to "Paused" to prevent synchronization until verified.
- Limitations: Cannot be scheduled; must be run manually. Mismatched SKUs may result in duplicate listings. Linking by ASIN, GTIN, MPN, or UPC is not supported.
Tip: Use the "Paused Status" option to review and verify imported listings before enabling synchronization.
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 |
| Master SKU | Flxpoint Listing: Master SKU | ABC123 | Primary identifier for linking in Flxpoint (from Magento: configurable SKU field) | 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 |
| Price | Flxpoint Listing: Price | 29.99 | Sets the regular price of the product (from Magento: price) | Optional |
| Quantity | Flxpoint Listing: Quantity | 50 | Records the available stock quantity (from Magento: stock_item.qty) | Optional |
| Images | Flxpoint Listing: Images | https://example.com/image.jpg | Imports product image URLs (from Magento: media_gallery_entries) | Optional |
| Category One | Flxpoint Listing: Category One | Apparel | Assigns the product to the first-level category (from Magento: category_ids[0]) | Optional |
| Category Two | Flxpoint Listing: Category Two | T-Shirts | Assigns the product to the second-level category (from Magento: category_ids[1]) | Optional |
| Category Three | Flxpoint Listing: Category Three | Men's | Assigns the product to the third-level category (from Magento: category_ids[2]) | Optional |
| Variant SKU | Flxpoint Variant: SKU | ABC123-SM | Identifies the variant in Flxpoint (from Magento: configurable_product_options.sku) | Optional |
| Variant UPC | Flxpoint Variant: UPC | 012345678905 | Records the UPC for the variant (from Magento: configurable_product_options.upc) | Optional |
| Variant Quantity | Flxpoint Variant: Quantity | 20 | Records the available stock quantity for the variant (from Magento: configurable_product_options.qty) | Optional |
| Variant Price | Flxpoint Variant: Price | 29.99 | Sets the price for the variant (from Magento: configurable_product_options.price) | Optional |
Available Source Fields
Magento provides fields under categories like:
- Product: sku, name, price, status, visibility, type_id, custom_attributes (e.g., description), created_at, updated_at.
- Inventory: stock_item.qty, stock_item.is_in_stock.
- Media: media_gallery_entries (image URLs).
- Categories: category_ids (up to three levels).
- Variants (Configurable Products): configurable_product_options (includes sku, upc, qty, price).
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:
- Connection Failure: Verify your Magento credentials and connection.
- Linking Issues: Ensure the Master SKU field selected matches your data for proper linking.
- Duplicate Listings: Check for duplicate listings due to mismatched SKUs and correct them in Flxpoint.
Conclusion
With the Magento Import Listings integration, you can seamlessly bring your Magento listings into Flxpoint, ensuring centralized management and accurate synchronization. The ability to pause listings and support for configurable products enhances control over your inventory.
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.
- Support both simple and configurable products for comprehensive catalog synchronization.
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). - Handle Variants: For configurable products, updates variant details like price and quantity using the same SKU-based linking.
- 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:
- Settings: Options like Fields to Sync, Sync Direction, and Scheduling.
- 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.
- Variant Support: Supports syncing of configurable product variants using SKU-based linking.
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 |
| Variant SKU | Magento Variant: SKU | ABC123-SM | Links the Flxpoint variant to the Magento variant (from Flxpoint Variant: SKU) | Optional |
| Variant UPC | Magento Variant: UPC | 012345678905 | Updates the UPC for the variant in Magento (from Flxpoint Variant: UPC) | Optional |
| Variant Quantity | Magento Variant: Quantity | 20 | Updates the available stock quantity for the variant in Magento (from Flxpoint Variant: Quantity) | Optional |
| Variant Price | Magento Variant: Price | 29.99 | Updates the price for the variant in Magento (from Flxpoint Variant: Price) | 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.
- Variant: SKU, UPC, Quantity, Price.
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.
- Support both simple and configurable products for comprehensive catalog management.
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. - Handle Variants: For configurable products, publishes variant details like SKU, UPC, quantity, and price using the same SKU-based linking.
- 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:
- Settings: Options like Fields to Publish, Update Existing Products, Create New Products, and Scheduling.
- 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.
- Variant Support: Supports publishing configurable product variants, ensuring variant-specific fields like SKU, UPC, and price are correctly mapped.
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 |
| Variant SKU | Magento Variant: SKU | ABC123-SM | Identifies the variant in Magento (from Flxpoint Variant: SKU) | Optional |
| Variant UPC | Magento Variant: UPC | 012345678905 | Sets the UPC for the variant in Magento (from Flxpoint Variant: UPC) | Optional |
| Variant Quantity | Magento Variant: Quantity | 20 | Sets the available stock quantity for the variant in Magento (from Flxpoint Variant: Quantity) | Optional |
| Variant Price | Magento Variant: Price | 29.99 | Sets the price for the variant in Magento (from Flxpoint Variant: Price) | 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.
- Variant: SKU, UPC, Quantity, Price.
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
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.
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.
The integration follows a structured process to fetch orders from Magento:
-
Configuration: Sets up APIs (
SalesOrderRepositoryV1ApiandCatalogProductRepositoryV1Api) and validates settings like order status (e.g., Pending, Unshipped) and cutoff date for fetching orders. -
Fetch Orders: Retrieves orders in batches of 50 using pagination via the
salesOrderRepositoryV1GetListGetendpoint. -
Map Orders: Maps each order to Flxpoint’s internal
OrderDtoformat, including billing/shipping addresses, order items, and invoices. Handles missing shipping information, parses dates, and updates item prices if missing.
Note: Ensure your Magento API credentials are correctly configured to avoid retrieval failures.
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 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.
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.
- The mapping screen is labeled “Mapping Template” at the top, with options to select templates.
- Buttons available: Delete, Duplicate, and Save.
-
Sections include:
- Settings: Options like date range, order statuses, personal data retention, and parent item ID usage.
- 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).
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: Supports retrieving orders in multiple statuses (e.g., Pending, Unshipped) and within a specified date range for efficient imports.
-
Data Mapping: Maps Magento order data to Flxpoint’s internal
OrderDtoformat, ensuring accurate alignment of billing/shipping addresses and order items. - Shipping Mappings: Configure shipping methods in Channel Settings to auto-assign them during import, increasing efficiency (e.g., Next Day, Overnight).
Tip: Verify shipping mappings in your store to ensure accurate auto-assignment of shipping methods during order import.
Mapping Fields
Below are the fields you can map, with examples and purposes:
Magento Get Orders Mappings
| Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Order ID | Flxpoint Order: Order ID | 000000123 | Identifies the order in Flxpoint (from Magento Order: Order ID) | Required |
| Status | Flxpoint Order: Status | Pending | Records the order’s status (from Magento Order: Status) | Required |
| Grand Total | Flxpoint Order: Grand Total | 150.00 | Records the total order amount (from Magento Order: Grand Total) | Optional |
| Shipping Amount | Flxpoint Order: Shipping Amount | 15.00 | Records the shipping cost for the order (from Magento Order: Shipping Amount) | Optional |
| Coupon Code | Flxpoint Order: Coupon Code | SAVE10 | Records the coupon code used for the order (from Magento Order: Coupon Code) | Optional |
| Customer Note | Flxpoint Order: Customer Note | Please deliver after 2 PM | Records any customer notes for the order (from Magento Order: Customer Note) | Optional |
| Date Created | Flxpoint Order: Date Created | 2025-05-01T10:00:00Z | Records the date the order was created (from Magento Order: Date Created) | Optional |
| SKU | Flxpoint Order Item: SKU | ABC123 | Identifies the product in the order (from Magento Order Item: SKU) | Required |
| Name | Flxpoint Order Item: Name | Blue T-Shirt | Records the product name in the order (from Magento Order Item: Name) | Optional |
| Quantity Ordered | Flxpoint Order Item: Quantity Ordered | 3 | Records the quantity of the item ordered (from Magento Order Item: Quantity Ordered) | Required |
| Price | Flxpoint Order Item: Price | 29.99 | Records the price of the item (from Magento Order Item: Price) | Optional |
| Item ID | Flxpoint Order Item: Item ID | 12345 | Identifies the order item (from Magento Order Item: Item ID) | Optional |
| Weight | Flxpoint Order Item: Weight | 0.5 | Records the weight of the item (from Magento Order Item: Weight) | Optional |
| Discount Amount | Flxpoint Order Item: Discount Amount | 5.00 | Records the discount applied to the item (from Magento Order Item: Discount Amount) | Optional |
| Address Line 1 (Billing/Shipping) | Flxpoint Order: Address Line 1 (Billing/Shipping) | 123 Main St | Records the first line of the billing/shipping address (from Magento Billing/Shipping Address: Address Line 1) | Optional |
| Address Line 2 (Billing/Shipping) | Flxpoint Order: Address Line 2 (Billing/Shipping) | Apt 4B | Records the second line of the billing/shipping address (from Magento Billing/Shipping Address: Address Line 2) | Optional |
| City (Billing/Shipping) | Flxpoint Order: City (Billing/Shipping) | Los Angeles | Records the city of the billing/shipping address (from Magento Billing/Shipping Address: City) | Optional |
| State (Billing/Shipping) | Flxpoint Order: State (Billing/Shipping) | California | Records the state of the billing/shipping address (from Magento Billing/Shipping Address: State) | Optional |
| Post Code (Billing/Shipping) | Flxpoint Order: Post Code (Billing/Shipping) | 90210 | Records the postal code of the billing/shipping address (from Magento Billing/Shipping Address: Post Code) | Optional |
| Country Code (Billing/Shipping) | Flxpoint Order: Country Code (Billing/Shipping) | US | Records the country code of the billing/shipping address (from Magento Billing/Shipping Address: Country Code) | Optional |
| Telephone (Billing/Shipping) | Flxpoint Order: Telephone (Billing/Shipping) | 555-123-4567 | Records the telephone number for the billing/shipping contact (from Magento Billing/Shipping Address: Telephone) | Optional |
| Email (Billing/Shipping) | Flxpoint Order: Email (Billing/Shipping) | john.doe@example.com | Records the email address for the billing/shipping contact (from Magento Billing/Shipping Address: Email) | Optional |
| First Name (Billing/Shipping) | Flxpoint Order: First Name (Billing/Shipping) | John | Records the first name of the billing/shipping contact (from Magento Billing/Shipping Address: First Name) | Optional |
| Last Name (Billing/Shipping) | Flxpoint Order: Last Name (Billing/Shipping) | Doe | Records the last name of the billing/shipping contact (from Magento Billing/Shipping Address: Last Name) | Optional |
| Company (Billing/Shipping) | Flxpoint Order: Company (Billing/Shipping) | Doe Inc. | Records the company name for the billing/shipping contact (from Magento Billing/Shipping Address: Company) | Optional |
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.
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.
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.
- 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, 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.
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.
- Support 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 “Mapping Template” at the top, with options to select templates.
- Buttons available: Delete, Duplicate, and Save.
-
Sections include:
- Settings: Options like visibility, customer notifications, extension attributes, and comment appending.
- 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 |
| Shipping Cost | Magento Sales Shipment: Shipping Cost | 15.00 | Records the shipping cost for the shipment (from Flxpoint Shipment: Shipping Cost) | 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.
- Check Logs: Use the "View Logs" option to identify any API errors or mapping issues.
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.