Magento as a Source

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

 

How To Connect

📋 Phase 1: Creating Your Magento Source +
Create Source in Flxpoint
Log into your Flxpoint account, navigate to the Sources tab, and click Configure Single Source (or + Add Source) to begin.
Set Up Source Details
Enter "Magento Supplier" as the source name, select the appropriate source type (e.g., Vendor Warehouse), and choose whether to assign a vendor (recommended for better reporting). Click Save to continue.
Tip: Assigning a vendor improves your reporting capabilities and helps with product organization.
Choose Integration Type
After creating your source, navigate to the Get Inventory (Primary) section under Integrations in the left menu. If no integrations are set up yet, click Start Creating Integrations. For this guide, we will focus on:
  • Get Inventory (Primary): Retrieves primary inventory data from Magento.
Note: You can activate additional integrations (e.g., Get Shipments) later based on your business needs.
🔐 Phase 2: Setting Up Connection +
Obtain Your Magento Access Token
To connect to Magento, you’ll need an Access Token. Follow these steps to obtain it:
  • Log into your Magento Admin panel using your credentials.
  • Navigate to System → Integrations and click Add New Integration.
  • Enter a name (e.g., “Flxpoint Integration”), then go to the API tab.
  • Set Resource Access to All, click Save, and then Activate the integration.
  • Your Access Token will be generated upon activation. Copy it and store it securely.
  • If you can’t generate the token, contact Magento support or refer to their documentation at https://devdocs.magento.com for assistance.
Important: Keep your Access Token secure and do not share it publicly, as it provides access to your Magento store data.
Configure Connection Details
From the list of Custom Integrations or Standard Integrations, locate and select Magento. In the New Magento Connection form, enter the following details:
  • Connection Name: "Magento Connection" (or any descriptive name).
  • Access Token: Paste the Access Token you obtained from Magento.
  • API Page Size: Set the number of records to fetch per page (e.g., 100).
  • Store URL: Enter your Magento store URL (e.g., https://yourstore.com).
Click Test Connection to verify the connection, then click Save Connection to proceed.
Tip: If the connection test fails, double-check your Access Token and Store URL, and ensure your Magento store is configured for API access.
⚙️ Phase 3: Configuring Settings +
Adjust Integration Settings
On the Configure Settings screen, adjust the following options:
  • Archive/Un-Archive Inventory: If enabled, any inventory not found in the Magento feed will be archived (quantity set to zero). If products are later reintroduced, they’ll be un-archived. Note: We recommend not enabling this if already active for Get Inventory (Secondary).
  • Fetch All the Attributes: If enabled, all Magento attributes will be retrieved; otherwise, only those visible on the storefront.
Map Additional Fields
Map the following Magento fields to Flxpoint fields as needed:
  • Manufacturer Code
  • UPC Code
  • Image URL (required)
  • Website ID
  • Store View Code
Click Save and Proceed to continue.
✅ Phase 4: Mapping and Activation +
Create Field Mapping
Under Define a Mapping Template, select or create a new mapping template. Map Magento fields to Flxpoint fields for the Get Inventory integration:
  • Map essential fields like Product Name, SKU, Price, and Quantity.
  • Set up any transformations needed (e.g., price markups, quantity adjustments).
Tip: Ensure all critical fields are mapped to avoid missing inventory data.
Activate and Verify
Complete the setup by clicking Save and Complete. Your Magento Get Inventory integration is now active and will run based on your configured schedule.
Next Steps: The initial inventory sync may take some time to complete. You can monitor the progress in the Integrations section of your Flxpoint dashboard under Fulfillment Sources.
Magento Connection Setup
Unable to load image. Please check the URL or try a different image.

 

 

 

Product Operations

The primary operation handles the bulk of your inventory management needs, while the secondary operation allows for more detailed control, such as focusing on specific products or updates.
 

Get Inventory (Primary)

Supported | Magento

Introduction to Get Inventory [Primary]
Welcome to the Magento (MAG) Get Inventory [Primary] integration guide! This integration retrieves inventory data from your Magento store. It ensures your inventory is up-to-date across platforms. Let’s get started!

The Magento Get Inventory [Primary] integration enables you to:
  • Sync product inventory from Magento to your system.
  • Update stock levels, prices, and product details in real-time or on a schedule.
  • Archive or un-archive inventory based on availability in Magento.
This ensures accurate inventory management across your sales channels.

The integration follows these steps:
  • 1 Connecting to MAG: Establish a connection using API credentials (Access Token, Store URL) to access your Magento system.
  • 2 Fetching Inventory Data: A GET call to the Magento API endpoint retrieves product and variant details.
  • 3 Extracting Inventory Details: Extract SKU, Quantity, Price, and other attributes from the API response.
  • 4 Mapping Data: Map Magento fields (e.g., SKU, Quantity) to your system’s fields using a mapping template.
  • 5 Syncing Data: Import the mapped data into your system, updating inventory records.
  • 6 Execution: Run manually with Run Sync or schedule (e.g., daily).
Pro Tip: Schedule regular syncs to keep inventory levels accurate.
Note: API failures pause the integration and trigger notifications.

Customize the integration with these settings:
  • Sync Frequency: Choose to sync inventory data for products within a specific time frame (e.g., last 30 days).
  • Fetch All Attributes: If enabled, fetch all attributes; otherwise, retrieve only visible attributes in the Magento storefront.
  • Archive/Un-Archive Inventory: If enabled, products not in the Magento feed are archived; if later restocked, they are un-archived.
  • Scheduling: Run manually or schedule (e.g., daily at 6 AM UTC).
  • Mapping Template: Define how Magento fields sync to your system (e.g., SKU to SKU).
Note: Enable Archive/Un-Archive to manage out-of-stock products effectively.

Follow these steps:
  • 1 Add the Integration: Go to Channels > Magento > Integrations, select “Get Inventory [Primary].”
  • 2 Connect to MAG: Use your Magento API credentials (Access Token, Store URL) or set up a new connection.
  • 3 Configure Settings:
    • Set sync frequency (e.g., last 30 days).
    • Specify Manufacturer Code, UPC Code, Website ID, and Store View Code if needed.
    • Enable or disable Fetch All Attributes and Archive/Un-Archive Inventory.
    • Configure scheduling.
  • 4 Create Mapping Template: Configure field mappings (see Mapping Template Details).
  • 5 Run the Integration: Start with Run Sync or schedule.

Mapping templates control which Magento inventory data is imported into your system.
Interface Overview
  • Screen labeled “Get Inventory [Primary]” at the top; name your template (e.g., “MAG Get Products 3”).
  • Buttons: Delete, Duplicate, Save Mapping.
  • Columns: Magento fields (left), your system fields (right).
Mapping Options
  • Don't Map: Ignore the field (e.g., Weight).
  • Set To Empty: Clear the field in your system.
  • Field: Map to a specific field in your system (e.g., SKU to SKU).
  • Value: Set a static value for the field.
  • Mapping Set: Apply a predefined mapping set for complex mappings.
  • Rules: Add custom rules to transform or filter data (e.g., only sync if Quantity > 0).
  • Required Fields: SKU, Quantity.
SKU Mapping Requirement
The SKU field must be mapped to ensure proper inventory identification.
  • Required Field: SKU uniquely identifies the inventory item.
  • Error Scenario: Unmapped SKU may cause:
    Invalid request: Missing required field 'SKU' for inventory sync
  • Fix: Go to Channels > Magento > Templates > Get Inventory [Primary] > Field Mapping, map SKU to a field, save, and re-run sync.
Recommendation: Always map SKU and Quantity for reliable inventory syncing.
Complete Field Mappings
Below are the fields you can map from Magento:
Magento Source Product
Magento Field Maps To Example Purpose Status
SKU SKU ABC123 Identifies the product Required
Name Title Blue Widget Product title Required
Description Description A high-quality blue widget Product description Required
Manufacturer Brand WidgetCo Product brand Required
Magento Source Variant
Magento Field Maps To Example Purpose Status
Quantity Quantity 50 Stock level Required
Price Source List Price 29.99 Product price Optional
UPC UPC 012345678905 Universal product code Required
Weight Weight 1.5 Product weight Optional
Practice Mapping
Try mapping Magento - SKU:

Be aware of these limitations:
  • API Rate Limits: Exceeding Magento API limits pauses the integration.
  • Data Scope: Only fetches data available via the Magento API endpoint.
  • Required Fields: SKU and Quantity must be mapped.

Troubleshoot issues with these steps:
  • Connection Issues: Verify API credentials (Access Token, Store URL) and connectivity to Magento.
  • API Errors: Ensure the Magento API endpoint is accessible.
  • Missing Data: Check mapping template for mapped fields (e.g., SKU, Quantity).
  • Rate Limits: Confirm you haven’t hit Magento API limits.
  • Contact Support: Reach out to Magento support with error details.
Diagnostic Tip: Missing inventory data often results from unmapped required fields.

Key information:
  • Date: As of 03:17 PM -04, June 01, 2025, this integration is operational.
  • Required Fields: SKU and Quantity must be mapped.
  • API Limits: Monitor to avoid sync interruptions.
Pro Tip: Map all required fields to ensure accurate inventory syncing.

Conclusion
The Magento Get Inventory [Primary] integration automates inventory syncing, ensuring your system reflects accurate stock levels. Customize mappings and schedules to fit your workflow, streamlining inventory management. Happy syncing!
 
 

Get Inventory (Secondary)

Supported | Magento

Introduction to Get Inventory [Secondary]
Welcome to the Magento (MAG) Get Inventory [Secondary] integration guide! This integration retrieves secondary inventory data, such as custom fields, variant options, and additional attributes from your Magento store. It ensures comprehensive inventory details are synced to your system. Let’s get started!

The Magento Get Inventory [Secondary] integration enables you to:
  • Sync secondary product attributes like custom fields and variant options from Magento.
  • Update detailed product information, such as dimensions and shipping costs, in your system.
  • Enhance inventory records with additional data for better product management.
This ensures a more detailed and enriched inventory catalog across your platforms.

The integration follows these steps:
  • 1 Connecting to MAG: Establish a connection using API credentials (Access Token, Store URL) to access your Magento system.
  • 2 Fetching Secondary Inventory Data: A GET call to the Magento API endpoint retrieves additional product attributes and variant details.
  • 3 Extracting Secondary Details: Extract custom fields, dimensions (Height, Width, Length), and shipping details from the API response.
  • 4 Mapping Data: Map Magento secondary fields (e.g., Height, Shipping Cost) to your system’s fields using a mapping template.
  • 5 Syncing Data: Import the mapped data into your system, enriching inventory records.
  • 6 Execution: Run manually with Run Sync or schedule (e.g., daily).
Pro Tip: Use this integration alongside Get Inventory [Primary] for a complete inventory sync.
Note: API failures pause the integration and trigger notifications.

Customize the integration with these settings:
  • Sync Frequency: Choose to sync secondary inventory data for products within a specific time frame (e.g., last 30 days).
  • Fetch Custom Fields: If enabled, fetch all custom fields (up to 100) defined in Magento.
  • Scheduling: Run manually or schedule (e.g., daily at 6 AM UTC).
  • Mapping Template: Define how Magento secondary fields sync to your system (e.g., Height to Height).
Note: Enable Fetch Custom Fields to include Magento’s custom attributes in your sync.

Follow these steps:
  • 1 Add the Integration: Go to Channels > Magento > Integrations, select “Get Inventory [Secondary].”
  • 2 Connect to MAG: Use your Magento API credentials (Access Token, Store URL) or set up a new connection.
  • 3 Configure Settings:
    • Set sync frequency (e.g., last 30 days).
    • Enable or disable Fetch Custom Fields.
    • Configure scheduling.
  • 4 Create Mapping Template: Configure field mappings (see Mapping Template Details).
  • 5 Run the Integration: Start with Run Sync or schedule.

Mapping templates control which Magento secondary inventory data is imported into your system.
Interface Overview
  • Screen labeled “Get Inventory [Secondary]” at the top; name your template (e.g., “MAG Get Inventory Secondary 1”).
  • Buttons: Delete, Duplicate, Save Mapping.
  • Columns: Magento fields (left), your system fields (right).
Mapping Options
  • Don't Map: Ignore the field (e.g., Dropship Fee).
  • Set To Empty: Clear the field in your system.
  • Field: Map to a specific field in your system (e.g., Height to Height).
  • Value: Set a static value for the field.
  • Mapping Set: Apply a predefined mapping set for complex mappings.
  • Rules: Add custom rules to transform or filter data (e.g., convert Dimension Unit to centimeters).
  • Required Fields: None (secondary fields are typically optional).
Dimension Unit Mapping Consideration
The Dimension Unit field should be mapped if dimensions (Height, Width, Length) are synced to ensure consistency.
  • Optional Field: Dimension Unit specifies the unit of measurement (e.g., inch, centimeter).
  • Error Scenario: Unmapped Dimension Unit with mapped dimensions may cause:
    Invalid request: Dimension Unit missing for dimensions (Height, Width, Length)
  • Fix: Go to Channels > Magento > Templates > Get Inventory [Secondary] > Field Mapping, map Dimension Unit, save, and re-run sync.
Recommendation: Map Dimension Unit if syncing dimensions for accurate product data.
Complete Field Mappings
Below are the fields you can map from Magento:
Magento Source Variant (Secondary Fields)
Magento Field Maps To Example Purpose Status
Height Height 10 Product height Optional
Width Width 5 Product width Optional
Length Length 15 Product length Optional
Dimension Unit Dimension Unit centimeter Unit of measurement Optional
Shipping Cost Shipping Cost 5.99 Shipping fee Optional
GTIN GTIN 012345678905 Global trade item number Optional
Custom Fields
Magento Field Maps To Example Purpose Status
Custom Field 1 Custom Field 1 Blue Custom attribute (e.g., Color) Optional
Custom Field 2 Custom Field 2 Medium Custom attribute (e.g., Size) Optional
Practice Mapping
Try mapping Magento - Dimension Unit:

Be aware of these limitations:
  • API Rate Limits: Exceeding Magento API limits pauses the integration.
  • Data Scope: Only fetches secondary data available via the Magento API endpoint.
  • Custom Fields Limit: Up to 100 custom fields can be synced.

Troubleshoot issues with these steps:
  • Connection Issues: Verify API credentials (Access Token, Store URL) and connectivity to Magento.
  • API Errors: Ensure the Magento API endpoint is accessible.
  • Missing Data: Check mapping template for mapped fields (e.g., Height, Dimension Unit).
  • Rate Limits: Confirm you haven’t hit Magento API limits.
  • Contact Support: Reach out to Magento support with error details.
Diagnostic Tip: Missing secondary data often results from unmapped fields or disabled custom field fetching.

Key information:
  • Date: As of 03:22 PM -04, June 01, 2025, this integration is operational.
  • Required Fields: None (secondary fields are optional).
  • API Limits: Monitor to avoid sync interruptions.
Pro Tip: Map relevant secondary fields to enhance product data in your system.

Conclusion
The Magento Get Inventory [Secondary] integration automates the syncing of detailed inventory attributes, enriching your product catalog. Customize mappings and schedules to fit your workflow, ensuring comprehensive inventory management. Happy syncing!
 
 

 

 

Order Operations

It submits orders to vendors for fulfillment and subsequently imports the shipment details, ensuring an integration between order processing and shipment tracking.    
 

Send Fulfillment Requests

Supported | Magento

Introduction to Send Fulfillment Requests
Welcome to the Magento (MAG) Send Fulfillment Requests integration guide! This integration sends fulfillment requests to your Magento store, creating purchase orders with billing, shipping, and item details. It ensures seamless order fulfillment across platforms. Let’s get started!

The Magento Send Fulfillment Requests integration enables you to:
  • Send fulfillment requests to Magento to create purchase orders.
  • Map billing and shipping addresses, order items, and payment details to Magento fields.
  • Automate order fulfillment processes, reducing manual effort.
This ensures efficient order processing and accurate fulfillment in Magento.

The integration follows these steps:
  • 1 Connecting to MAG: Establish a connection using API credentials (Access Token, Store URL) to access your Magento system.
  • 2 Preparing Fulfillment Data: Gather fulfillment request data, including billing/shipping addresses and order items, from your system.
  • 3 Mapping Data: Map your system’s fields (e.g., Address Line 1, SKU) to Magento fields using a mapping template.
  • 4 Sending Fulfillment Requests: A POST call to the Magento API endpoint creates a purchase order with the mapped data.
  • 5 Confirmation: Receive a confirmation from Magento with the purchase order ID and status.
  • 6 Execution: Run manually with Run Sync or schedule (e.g., daily).
Pro Tip: Schedule regular syncs to automate fulfillment request submissions.
Note: API failures pause the integration and trigger notifications.

Customize the integration with these settings:
  • Sync Frequency: Choose to send fulfillment requests within a specific time frame (e.g., last 24 hours).
  • Order Status Filter: Send requests only for orders with specific statuses (e.g., "Pending Fulfillment").
  • Scheduling: Run manually or schedule (e.g., daily at 6 AM UTC).
  • Mapping Template: Define how your system’s fields sync to Magento (e.g., Address Line 1 to Address Line 1).
Note: Use Order Status Filter to avoid sending duplicate fulfillment requests.

Follow these steps:
  • 1 Add the Integration: Go to Channels > Magento > Integrations, select “Send Fulfillment Requests.”
  • 2 Connect to MAG: Use your Magento API credentials (Access Token, Store URL) or set up a new connection.
  • 3 Configure Settings:
    • Set sync frequency (e.g., last 24 hours).
    • Apply Order Status Filter if needed.
    • Configure scheduling.
  • 4 Create Mapping Template: Configure field mappings (see Mapping Template Details).
  • 5 Run the Integration: Start with Run Sync or schedule.

Mapping templates control which data from your system is sent to Magento as part of the fulfillment request.
Interface Overview
  • Screen labeled “Magento Send Fulfillment Requests” at the top; name your template (e.g., “MAG Send Fulfillment 1”).
  • Buttons: Delete, Duplicate, Save Mapping.
  • Columns: Your system fields (left), Magento fields (right).
Mapping Options
  • Don't Map: Ignore the field (e.g., Email).
  • Set To Empty: Clear the field in Magento.
  • Field: Map to a specific Magento field (e.g., Address Line 1 to Address Line 1).
  • Value: Set a static value for the field.
  • Mapping Set: Apply a predefined mapping set for complex mappings.
  • Rules: Add custom rules to transform or filter data (e.g., only send if Quantity > 0).
  • Required Fields: Fulfillment Request Number, SKU.
Fulfillment Request Number Mapping Requirement
The Fulfillment Request Number field must be mapped to ensure proper request identification in Magento.
  • Required Field: Fulfillment Request Number uniquely identifies the request.
  • Error Scenario: Unmapped Fulfillment Request Number may cause:
    Invalid request: Missing required field 'Fulfillment Request Number' for purchase order creation
  • Fix: Go to Channels > Magento > Templates > Send Fulfillment Requests > Field Mapping, map Fulfillment Request Number to a field, save, and re-run sync.
Recommendation: Always map Fulfillment Request Number and SKU for reliable fulfillment request processing.
Complete Field Mappings
Below are the fields you can map to Magento:
Billing Address
Your Field Maps To (Magento) Example Purpose Status
Address Line 1 Address Line 1 123 Main St Billing address line 1 Required
City City New York Billing city Required
Country Code Country Code US Billing country code Required
First Name First Name John Billing first name Required
Last Name Last Name Doe Billing last name Required
Postal Code Postal Code 10001 Billing postal code Required
Shipping Address
Your Field Maps To (Magento) Example Purpose Status
Address Line 1 Address Line 1 456 Oak St Shipping address line 1 Required
City City Los Angeles Shipping city Required
Country Code Country Code US Shipping country code Required
First Name First Name Jane Shipping first name Required
Last Name Last Name Smith Shipping last name Required
Postal Code Postal Code 90001 Shipping postal code Required
Fulfillment Request Item
Your Field Maps To (Magento) Example Purpose Status
SKU SKU ABC123 Product identifier Required
Quantity Quantity Ordered 5 Quantity to fulfill Required
Title Name Blue Widget Product name Optional
UPC UPC 012345678905 Universal product code Optional
Practice Mapping
Try mapping your system’s - Fulfillment Request Number:

Be aware of these limitations:
  • API Rate Limits: Exceeding Magento API limits pauses the integration.
  • Data Scope: Only sends data supported by the Magento API endpoint for purchase orders.
  • Required Fields: Fulfillment Request Number and SKU must be mapped.

Troubleshoot issues with these steps:
  • Connection Issues: Verify API credentials (Access Token, Store URL) and connectivity to Magento.
  • API Errors: Ensure the Magento API endpoint is accessible.
  • Missing Data: Check mapping template for mapped fields (e.g., Fulfillment Request Number, SKU).
  • Rate Limits: Confirm you haven’t hit Magento API limits.
  • Contact Support: Reach out to Magento support with error details.
Diagnostic Tip: Missing fulfillment request data often results from unmapped required fields.

Key information:
  • Date: As of 03:24 PM -04, June 01, 2025, this integration is operational.
  • Required Fields: Fulfillment Request Number and SKU must be mapped.
  • API Limits: Monitor to avoid sync interruptions.
Pro Tip: Map all required fields to ensure accurate fulfillment request processing.

Conclusion
The Magento Send Fulfillment Requests integration automates the submission of fulfillment requests, ensuring seamless order processing in Magento. Customize mappings and schedules to fit your workflow, streamlining your fulfillment operations. Happy syncing!
 
 

Get Shipments

Supported | Magento

Introduction to Get Shipments
Welcome to the Magento (MAG) Get Shipments integration guide! This integration retrieves shipment data from your Magento store, including tracking numbers, carrier codes, and shipment dates. It ensures your system stays updated with the latest shipment details. Let’s get started!

The Magento Get Shipments integration enables you to:
  • Sync shipment details from Magento to your system.
  • Track shipments with details like Tracking Number, Carrier Code, and Shipment Created At.
  • Keep your system updated with real-time or scheduled shipment data.
This ensures accurate tracking and fulfillment updates across your platforms.

The integration follows these steps:
  • 1 Connecting to MAG: Establish a connection using API credentials (Access Token, Store URL) to access your Magento system.
  • 2 Fetching Shipment Data: A GET call to the Magento API endpoint retrieves shipment details.
  • 3 Extracting Shipment Details: Extract fields like Tracking Number, Carrier Code, and Shipment Created At from the API response.
  • 4 Mapping Data: Map Magento fields (e.g., Tracking Number, Carrier Code) to your system’s fields using a mapping template.
  • 5 Syncing Data: Import the mapped data into your system, updating shipment records.
  • 6 Execution: Run manually with Run Sync or schedule (e.g., daily).
Pro Tip: Schedule regular syncs to keep shipment tracking up-to-date.
Note: API failures pause the integration and trigger notifications.

Customize the integration with these settings:
  • Sync Frequency: Choose to sync shipment data within a specific time frame (e.g., last 30 days).
  • Shipment Status Filter: Fetch shipments based on their status (e.g., "Shipped").
  • Scheduling: Run manually or schedule (e.g., daily at 6 AM UTC).
  • Mapping Template: Define how Magento fields sync to your system (e.g., Tracking Number to Tracking Number).
Note: Use Shipment Status Filter to sync only relevant shipment records.

Follow these steps:
  • 1 Add the Integration: Go to Channels > Magento > Integrations, select “Get Shipments.”
  • 2 Connect to MAG: Use your Magento API credentials (Access Token, Store URL) or set up a new connection.
  • 3 Configure Settings:
    • Set sync frequency (e.g., last 30 days).
    • Apply Shipment Status Filter if needed.
    • Configure scheduling.
  • 4 Create Mapping Template: Configure field mappings (see Mapping Template Details).
  • 5 Run the Integration: Start with Run Sync or schedule.

Mapping templates control which Magento shipment data is imported into your system.
Interface Overview
  • Screen labeled “Get Shipments” at the top; name your template (e.g., “MAG Get Shipments 1”).
  • Buttons: Delete, Duplicate, Save Mapping.
  • Columns: Magento fields (left), your system fields (right).
Mapping Options
  • Don't Map: Ignore the field (e.g., Carrier).
  • Set To Empty: Clear the field in your system.
  • Field: Map to a specific field in your system (e.g., Tracking Number to Tracking Number).
  • Value: Set a static value for the field.
  • Mapping Set: Apply a predefined mapping set for complex mappings.
  • Rules: Add custom rules to transform or filter data (e.g., only sync if Shipment Created At is within the last 7 days).
  • Required Fields: Tracking Number.
Tracking Number Mapping Requirement
The Tracking Number field must be mapped to ensure proper shipment tracking in your system.
  • Required Field: Tracking Number uniquely identifies the shipment.
  • Error Scenario: Unmapped Tracking Number may cause:
    Invalid request: Missing required field 'Tracking Number' for shipment sync
  • Fix: Go to Channels > Magento > Templates > Get Shipments > Field Mapping, map Tracking Number to a field, save, and re-run sync.
Recommendation: Always map Tracking Number for reliable shipment tracking.
Complete Field Mappings
Below are the fields you can map from Magento:
Magento Shipment
Magento Field Maps To Example Purpose Status
Carrier Code Carrier UPS Shipping carrier Optional
Comment Note Shipped with care Shipment comment Optional
Shipment Created At Shipped At 2025-05-30 10:00:00 Shipment creation date Optional
Title Method Ground Shipping Shipping method title Optional
Tracking Number Tracking Number 1Z9999W99999999999 Shipment tracking number Required
Practice Mapping
Try mapping Magento - Tracking Number:

Be aware of these limitations:
  • API Rate Limits: Exceeding Magento API limits pauses the integration.
  • Data Scope: Only fetches shipment data available via the Magento API endpoint.
  • Required Fields: Tracking Number must be mapped.

Troubleshoot issues with these steps:
  • Connection Issues: Verify API credentials (Access Token, Store URL) and connectivity to Magento.
  • API Errors: Ensure the Magento API endpoint is accessible.
  • Missing Data: Check mapping template for mapped fields (e.g., Tracking Number).
  • Rate Limits: Confirm you haven’t hit Magento API limits.
  • Contact Support: Reach out to Magento support with error details.
Diagnostic Tip: Missing shipment data often results from unmapped required fields.

Key information:
  • Date: As of 03:26 PM -04, June 01, 2025, this integration is operational.
  • Required Fields: Tracking Number must be mapped.
  • API Limits: Monitor to avoid sync interruptions.
Pro Tip: Map all relevant fields to ensure comprehensive shipment tracking.

Conclusion
The Magento Get Shipments integration automates the retrieval of shipment details, ensuring your system reflects accurate tracking information. Customize mappings and schedules to fit your workflow, streamlining shipment management. Happy syncing!