How to Connect
Magento Version Supported: 2.4x
Connection Details
- Store URL: https://MagentoStore.com
- Access Token REQUIRED
- Store View Code REQUIRED
- Website Code Only Required for Publishing Products
- Root Category Name Only Required for Publishing Products
- Attribute Set ID Only Required for Publishing Products
Magento Connection Steps
Then navigate to Stores → Settings → Configuration → Services → OAuth → Access Token.
- Go to System > Integrations
- Click "Add New Integration"
- Name your integration "Flxpoint" and input your account login password to verify the account owner.
- Click the "API" tab to the left
- Choose 'ALL' under resource access
- Copy Access Token and paste it with Flxpoint.
Store View Code
In Magento's admin section, click Store >>> All Store.
Select the Store View Name column that corresponds to the website you chose in step A.
The Edit Store View Page will open.
Here you'll find the Code value needed for the Store View Code.
Website Code
In Magento's admin section, click Store >>> All Store.
Select the Website Name column that corresponds to the website you would like to update.
The Edit Website Page will open.
Here you'll find the Code value needed for the Website Code.
Root Category Name
In Magento's admin section, click Store >>> All Store.
Select the Store Name column that corresponds to the website you have chose in step A.
The Edit Store Page will open.
Here you'll find the Root Category Name.
Attriibute Set ID
On Magento, create a new Attribute Set.
Next, add all attributes you would like Flxpoint to have on publish products to the Magento Attribute Set.
Once created, you will see the Attribute Set Numeric ID in the URL.
Supported Operations
Import Listings Supported
Publish Listings Supported
Link Listings Supported
Get Orders Supported
Sync Orders Supported
Listing Operations
Link Listings
Supported
The Link Listings operation allows Flxpoint to connect Flxpoint listings to your existing Magento products, as long as the ID, SKU, or custom attribute matches between the two systems. This both preserves your existing product data and allows updates without creating new product listings.
For users that may want to use a "Custom Attribute" to link, such as UPC, you can find this configurable on the link listings flyout page. Just configure your desired "Custom Attribute" with the fields meta name "upc" and Flxpoint will attempt to link based on the selected field in our system and the configured custom attribute.
Batch Size
Flxpoint supports the concept of configuring the "Batch Size" for linking jobs. We found that submitting requests for 250 products in each batch caused a timeout error on some Magento websites. This batch size is configurable on the "Link Listings" flyout menu.
If you find that you are not able to link listings; please try reducing the batch size and submitting the request again.
Sync Listings
Supported
The Sync Listings operation is primarily responsible for updating the Quantity and Price of products on your store. In some cases, Sync Listings can also update meta fields such as Magento's "Sale Price".
Optimal Syncs
Flxpoint supports "Force Sync" for Magento. Click on the underlined text to understand Force Sync and its values
Delisting
Supported How delisting works with Magento
Delisting permanently removes the product from your Magento channel listing, can only be brought back to listed status again after running the sync/publish job is made to run.
Hide
Supported Hiding the variant for Magento channel listing
Hiding the variant temporary sets the product to a state where an it appears as Out of stock on your Magento channel, making sure there are no unwanted order for the variant.
Unhide
Supported Unhiding the variant for Magento channel listing
Unhiding can only be used for the product variants that are already on hide status to bring the product back live for Magento sales channel.
Import Listings
Supported
Import Listings can import pre-existing Magento listings into Flxpoint.
For more information on the import listings integration, please see: Import Listings
Manual Integration
The import listings integration cannot be scheduled. You will need to manually run the import listings integration when you want to import listings.
Potential Listings Duplication
Import listings will only link Flxpoint's SKU to Magentos's SKU.
Mismatched SKUs will result in duplicate listings and products.
Linking to Flxpoint channel listings and product catalog based on ASIN, GTIN, MPN, or UPC is not supported.
Listing Parent
- sku
- title (e.g. ShortDescription)
- description
- categoryOne
- categoryTwo
- categoryThree
- options
- customFields
- images
Listing Variants
- sku
- title (e.g. name)
- upc
- quantity
- msrp
- price
- weight
- options
- customFields
- images
Listing Management:
- Applies to listings at the Channel Listings level in Flxpoint.
- Select from two options: Create Only or Create & Overwrite Existing
- Create Only: Magento listings will be imported and linked to existing Flxpoint listings based on SKU. If there is not a SKU match to an existing Flxpoint listing, a new listing will be created.
- Create & Overwrite Existing: Magento listings will be imported and linked to existing Flxpoint listings based on SKU. For all SKU matches, the listing data in Flxpoint will be overwritten by the imported Shopify listing data. If there is not a SKU match to an existing Flxpoint listing, a new listing will be created.
Set New Listings to Paused:
- If enabled, this setting will automatically set all newly imported listings to a Paused status.
- Pausing newly imported listings allows you space to connect your imported listings to sources before orders flow into Flxpoint. This step is important in ensuring fields, such as pricing and quantity, are accurate.
- If you choose to enable this setting, you will need to manually unpause the imported listings when you are ready to do so. You can unpause the listings by clicking Actions → Edit → Unpause as shown below:
Steps to Unpause Listings
Import Listings Recent Notifications:
Once the Import Listings job has completed, you can view the results of the job in the Recent Notifications log. The recent notification log will provide a breakdown of how many parent and variant items were created or updated, as well as any errors encountered.
You can find the Recent Notifications log by navigating to the following:
- Magento Channel Settings Gear → Integrations → Import Listings → Scroll to the bottom of the integration screen
Publish Listings
Supported
The Publish Listings operation is responsible for creating new listings and offerings on your store.
Attributes and Attribute Sets
Magento requires the specification of an attribute set when creating new product listings. If you would like to use multiple attribute sets, please segment your publishes based on Attribute Set ID. This is configurable in the Publish Listings operation.
1. Configure Publish Listings with Attribute Set ID "1"
2. Select listings to publish under Attribute Set ID "1"
3. Run Publish Listings
4. Alter the configuration in Publish Listings. (Set Attribute Set ID to "2" and save)
5. Select listings to publish under Attribute Set ID "2"
6. Run Publish Listings
7. Repeat as desired.
Overwrite
Supported Overwriting the Variant details
Overwrite feature enables you to overwrite any data for already published variant on your Magento sales channel. i.e. updating Title, Description, categories, MPN, UPC, GTIN, Images.
Order Operations
Shipping Mappings
Required
Configure the Shipping method to assign the mapping to imported orders. Shipping Mapping is the process of pre-selecting specific shipping methods and saving them in your Channel Settings so that when new orders are made to import, your preferred forms will be auto-assigned to those orders.
The idea is to increase efficiency by eliminating the need to select shipping methods for individual orders. If you're unsure, check the store shipping method in your test order to confirm how the shipping details are imported from your store or marketplace. You will need to map to this exact method and assign different shipping for the Next Day, Overnight. depending on the carriers and processes supported by your supplier
Get Orders
Supported
The Get Orders operation retrieves orders in a specific, or multiple order statuses from your website.
Multiple Order Statuses
Magento offers the option of retrieving multiple order statuses.
If you would like to import orders that are in the status "Pending" and "Unshipped" you can select both options using the checkboxes provided under the "Configure Settings" section of the operation.
Sync Orders
Supported
Sync Orders will sync any changes that have been made to Orders since the last time sync was performed to Magento channel Specifically, this will sync back components like Order Shipments
Specifically, this will sync back components like tracking information, shipping information and carrier information
Frequently Asked Questions
Why is my Link Listings job not finding my products?
If your Link Listings job is not identifying the appropriate products on your store you can check the following aspects:
1. Ensure that there is only one instance of the value on your Magento store.
a. For example, if you're attempting to link via SKU, ensure that only one product on your store has the requested SKU. In some instances, having more than one of the same value (two products with SKU "123") will fail to link the products.
2. Ensure that the data points your searching for are in the expected fields.
b. In some cases the Link process might be configured to check two different fields "SKU" to "ID" for example. Double check to make sure that your configured Link process values match your expectation.
All of my published products are showing as "Inactive" after a publish.
If this is happening the most likely scenario is that your mapping template for Publish Listings has the field "Status" set to Inactive. Please check your mapping template, ensure that the "Status" field is set to "Active" and attempt the publish again.
If this continues to happen; please contact our support team for further assistance.
My Test Connection button is saying that Flxpoint can connect to my store, but after running a publish operation no products appear.
The most common reason this occurs is due to one or multiple of the fields under "Configure Settings". If you're receiving an OK response when testing connection, but unable to publish listings, please ensure that your Store View Code, Website Code, Root Category Name, and Attribute Set ID are correct. For most Magento stores, these are the defaults:
Store View Code: default
Website Code: base
Root Category Name: Default Category Attribute Set ID: 1
My Orders are not importing, what should I do?
The most likely cause of this issue relates to the order status on your store, and the order status we're looking for based on our configurations. If you are unsuccessful at importing an order; double check the status of the order, and ensure it matches your configurations for this operation.
The second possibility is that the order is "too old" for us to import. Under "Configure Settings" you also have the option of selecting the date range of orders we can import. If you set this limit to 7 days, consider checking the non-imported orders creation date and increasing the number under the "Get Orders Created within the last X Days" configuration.
My order has shipment information but the order is not updating on my store.
The first step to resolving this issue is to check the order that is failing to update inside of Flxpoint. In instances where Flxpoint fails to update shipment information onto a store, we log an error on the shipment that explains why the shipment was rejected. This error code should give you an idea of what next step to take when trying to sync this shipment to your store.
The most common reasons shipments fail are:
- The tracking number on the order does not match the format expected for a specific carrier - The tracking number is too long/malformed - The tracking number field is populated with more than one tracking number.