This guide walks you through setting up a CSV/XLSX File as a Sales Channel in Flxpoint, empowering you to seamlessly manage your product listings and orders. You’ll learn how to:
Create and name your channel.
Select the best processes for syncing listings or processing orders.
Configure file connections using FTP/SFTP, HTTP, or Email.
Flxpoint’s CSV/XLSX integrations simplify the management of regularly updated product data. Whether you're maintaining a consistent data feed for your sales channel, business, or partners, this method ensures your information stays current with minimal setup effort.
How to Connect
📋 Phase 1: Initial Channel Setup+
Access the Channels Section
Log into your Flxpoint account and navigate to the Sales Channels (or Reseller Channels) section on the left sidebar.
Create a New Channel
Click on + Add Channel to open the Channel Wizard and start the setup process.
Tip: If you’re managing multiple channels, consider naming them clearly to avoid confusion (e.g., "CSV Channel - Supplier A").
Select CSV/XLSX File as Channel Type
In the wizard, choose CSV/XLSX File from the list of supported channels. Name your channel (e.g., "My CSV/XLSX Channel") and select the processes you want to enable, such as Publish Listings, Get Orders, Sync Listings, and Sync Orders. Then click Next.
🔧 Phase 2: Configure Integration Type+
Confirm CSV/XLSX Integration
In the Configure Integration Type step, verify that CSV/XLSX File is selected as the integration type. Click Next to proceed.
🔐 Phase 3: Connect Channel+
Set Up Inbound Connection
Under CSV/XLSX File (Inbound), select how Flxpoint will receive data. Options include:
FTP (Basic Auth) - Provide FTP server details, username, and password.
Manual File - Upload files manually through the Flxpoint interface.
HTTP - Provide a URL where Flxpoint can fetch the file.
Email (Inbound) - Set up an email address for Flxpoint to retrieve files.
Google Sheets File - Link a Google Sheet with the necessary permissions.
FTP (Token Based) - Use a token for secure FTP access.
Fill in the required details and click Save Connection.
Set Up Outbound Connection
Under CSV/XLSX File (Outbound), select how Flxpoint will send data. Options include:
S3 HTTP File - Provide an S3 bucket URL and credentials.
Email (Outbound) - Specify an email address to send files.
FTP (Basic Auth) - Provide FTP server details.
FTP (Token Based) - Use a token for secure FTP access.
Fill in the required details and click Save Connection.
Verify Connections
Test each connection by clicking Test Connection to ensure Flxpoint can access the inbound and outbound sources. Once successful, click Next.
✅ Phase 4: Confirm Integrations+
Review and Confirm
In the Confirm Integrations step, review your settings:
Channel Name: Ensure it matches your intended name (e.g., "My CSV/XLSX Channel").
Processes: Verify the selected processes (e.g., Sync Listings, Get Orders).
Connections: Confirm the inbound and outbound connections are correct.
Check the box to acknowledge that the information is correct, then click Confirm Integrations.
Note: After confirming, you won’t be able to modify these settings until you exit the channel setup.
🚀 Phase 5: Finalize Setup+
Complete Remaining Steps
Continue through the wizard’s remaining steps, such as Listing Management, Pricing & Quantity Rules, and Order Fulfillment. You can configure these now or click Set Up Later to handle them later.
Start Syncing
Once setup is complete, your CSV/XLSX File Channel will appear in the Channels list with a status of 100% Onboarded. You can now start syncing by configuring integrations for processes like Import Listings or Get Orders.
Next Steps: Go to the Import Listings section to start syncing your product data, or configure other processes as needed.
×
Listing Operations
This section covers the operations for managing your listings using a CSV/XLSX channel.
Import Listings
Status:NOT SUPPORTED
The Link Listings feature is not currently available with CSV/XLSX integration processes.
Sync & Link Listings
Sync & Link Listings
Introduction to CSV/XLSX File Integration
Welcome to the CSV/XLSX File Integration guide for syncing listings! This integration allows you to import and update listings using CSV or XLSX files. It ensures your listings are accurately synced with your system. Let’s get started!
The CSV/XLSX File Integration enables you to:
Import listings data from CSV or XLSX files into your system.
Update existing listings with new data from your files.
Automate the syncing process via various connection types like S3 HTTP, FTP, or Email.
This ensures your listings are always up-to-date with minimal manual effort.
The integration follows these steps:
1Connecting to the Source: Establish a connection using methods like S3 HTTP, FTP, or Email to access your CSV/XLSX file.
2Fetching File Data: The system retrieves the file from the specified source (e.g., an S3 bucket URL).
3Extracting Listings Details: Extract data such as SKU, title, and price from the file.
4Mapping Data: Map file columns (e.g., SKU, Price) to your system’s fields using a mapping template.
5Syncing Data: Import the mapped data into your system, updating listing records.
6Execution: Run manually with Run Sync or schedule (e.g., daily).
Pro Tip: Schedule regular syncs to keep your listings updated automatically.
Note: File retrieval failures will pause the integration and trigger notifications.
Use the form below to set up how your CSV or XLSX file will be processed. Each option helps the system understand your file’s structure and schedule the sync. Don’t worry if you’re new—we’ve included examples to guide you!
If your file name includes a date (e.g., listings_20250601.csv), specify the format here using placeholders like YYYY for year, MM for month, and DD for day.
Example: For a file named "listings_20250601.csv", use "listings_YYYYMMDD.csv".
Enter the exact name of your file or a pattern if it includes dates (as set above).
Example: "listings.csv" or "listings_20250601.csv".
If your file has a header row (e.g., "SKU,Title,Price"), select "Yes." If it’s just data without headers, select "No," and the system will use column numbers (e.g., Column 0, Column 1).
Example: For "SKU,Title,Price" on the first row, choose "Yes."
Choose the format of your file. Most users use CSV, but if you’re uploading an Excel file, select XLSX.
Example: Select "CSV" for a file like "listings.csv".
If your file starts with blank rows or comments before the actual data, specify how many rows to skip. For example, if your headers or data start on row 5, enter "4".
Example: If your headers are on row 5, set this to "4".
For XLSX files, specify which sheet to read (starting at 0). Use "0" for the first sheet, "1" for the second, etc.
Example: For the first sheet in an Excel file, use "0".
If your file uses quotes around values (e.g., "SKU123","Blue Widget"), specify the quote character. Usually, this can be auto-detected.
Example: For a CSV with values like "SKU123","Blue Widget", choose "Double Quote".
Choose the delimiter that separates values in your file. For example, a CSV typically uses commas, but some files use pipes or tabs.
Example: For "SKU|UPC|COST", select "Pipe".
If your file has grouped headers (e.g., for product attributes), choose how to name them in the mapping template.
Example: For a column "Color", this might become "Attribute_20_name".
Enable this to number options sequentially in the mapping template (e.g., Attribute_20_name, Attribute_21_name).
Example: If enabled, "Color" and "Size" become "Attribute_20_name", "Attribute_21_name".
Specify the line separator in your file. Most systems can auto-detect this, so you can usually leave it as "Default".
Example: For Windows files, you might choose "CRLF".
Override the default file extension if needed (normally .csv or .xlsx).
Example: Use ".csv" for a CSV file.
Note: Setting the correct delimiter and quote character ensures your file is parsed accurately. If your file fails to load, double-check these settings.
Follow these steps:
1Add the Integration: Go to Channels > CSV/XLSX File > Integrations, select “CSV/XLSX File Integration.”
2Connect to the Source: Choose a connection type (e.g., S3 HTTP, FTP, Email) and provide the necessary credentials or URL.
3Configure Settings:
Specify the file name or pattern (e.g., listings.csv).
Set the number of rows to skip (e.g., 4 if headers start on row 5).
Select the Excel sheet index (e.g., 0 for the first sheet).
Define the delimiter (e.g., comma for CSV).
Configure scheduling (e.g., daily at 6 AM UTC).
4Create Mapping Template: Configure field mappings (see Mapping Template Details).
5Run the Integration: Start with Run Sync or schedule.
Mapping templates control which CSV/XLSX file data is imported into your system.
Interface Overview
Screen labeled “Sync Listings” at the top; name your template (e.g., “Sync Listings 1”).
Buttons: Delete, Duplicate, Save Mapping.
Options: Choose between “Column Header Name” or “Column Index Positions” for mapping.
Columns: Add columns to map file data to your system fields.
Mapping Options
Header Name vs Column Index: Decide if the system should use column header names or index positions (e.g., Column 0, Column 1) for mapping.
Don't Map: Ignore the field (e.g., a non-essential column like "Notes").
Set To Empty: Clear the field in your system.
Field: Map to a specific field in your system (e.g., "SKU" to "Product SKU").
Value: Set a static value for the field.
Required Fields: SKU must be mapped for proper listing identification.
SKU Mapping Requirement
The SKU field must be mapped to ensure proper listing identification.
Required Field: SKU uniquely identifies the listing.
Error Scenario: Unmapped SKU may cause:
Recommendation: Always map SKU for reliable listing syncing.
Complete Field Mappings
Below are the fields you can map from your CSV/XLSX file:
Product Details
File Column
Maps To
Example
Purpose
Status
SKU
Product SKU
ABC123
Identifies the product listing
Required
Title
Product Title
Blue Widget
Describes the product
Optional
Pricing and Inventory
File Column
Maps To
Example
Purpose
Status
Price
Product Price
19.99
Sets the listing price
Optional
Quantity
Inventory Quantity
50
Updates stock levels
Optional
Practice Mapping
Try mapping CSV/XLSX - SKU:
Be aware of these limitations:
File Availability: The file must be accessible at the specified source, or the sync will fail.
Data Scope: Only data within the specified sheet and rows (after skipping) will be processed.
Required Fields: SKU and other required fields must be mapped in the template.
Conclusion
The CSV/XLSX File Integration automates listing updates, ensuring your system reflects accurate listing details. Customize settings and mappings to fit your workflow, streamlining the syncing process. Happy syncing!
Publish Listings
Publish Listings
Introduction to CSV/XLSX Listing Publishing
Welcome to the CSV/XLSX Listing Publishing guide! This integration allows you to publish your product listings to a CSV/XLSX file or an external system, such as a marketplace or sales channel. It ensures your listings (e.g., SKU, Title, Price) are accurately created or updated in the target system. Let’s get started!
The CSV/XLSX Listing Publishing integration enables you to:
Export listing data (e.g., SKU, Title, Price) from your system to a CSV/XLSX file.
Publish listings to an external system via connection types like S3 HTTP, FTP, or Email.
Automate the process to keep your external listings up-to-date.
This ensures your product listings are consistently reflected in external systems with minimal manual effort.
The integration follows these steps:
1Connecting to the Destination: Establish a connection using methods like S3 HTTP, FTP, or Email to send your CSV/XLSX file.
2Fetching Listing Data: Retrieve listing data (e.g., SKU, Title, Price) from your system.
3Mapping Data: Map your system fields (e.g., Product Title) to file columns using a mapping template.
4Generating the File: Create a CSV/XLSX file with the mapped data.
5Publishing Data: Export the file to the specified destination, updating external listings.
6Execution: Run manually with Run Sync or schedule (e.g., daily).
Pro Tip: Schedule regular syncs to keep your external listings updated automatically.
Note: Connection failures will pause the integration and trigger notifications.
Use the form below to set up how your listing data will be exported to a CSV or XLSX file. Each option helps the system format your file and schedule the sync. We’ve included examples to guide you through the process!
If your file name includes a date (e.g., listings_publish_20250601.csv), specify the format here using placeholders like YYYY for year, MM for month, and DD for day.
Example: For a file named "listings_publish_20250601.csv", use "listings_publish_YYYYMMDD.csv".
Enter the exact name of the file to be created or a pattern if it includes dates (as set above).
Example: "listings_publish.csv" or "listings_publish_20250601.csv".
Choose whether to include a header row (e.g., "SKU,Title,Price") in the exported file.
Example: Select "Yes" to include headers like "SKU,Title".
Choose the format of the exported file. CSV is most common, but you can select XLSX for Excel files.
Example: Select "CSV" for a file like "listings_publish.csv".
For XLSX files, specify which sheet to write to (starting at 0). Use "0" for the first sheet, "1" for the second, etc.
Example: Use "0" to write to the first sheet in an Excel file.
Specify the quote character for values in the exported file (e.g., "ABC123","Blue Widget"). Usually, this can be set to "Double Quote".
Example: Choose "Double Quote" to wrap values like "Blue Widget".
Choose the delimiter to separate values in the exported file. Commas are typical for CSV files.
Example: For "SKU|Title|Price", select "Pipe".
Specify the line separator for the exported file. Use "CRLF" for Windows compatibility, or leave as "Default".
Example: Choose "CRLF" for Windows files.
Specify the file extension for the exported file (normally .csv or .xlsx).
Example: Use ".csv" for a CSV file.
Note: Ensure the delimiter and quote character match the requirements of the external system receiving the file.
Follow these steps:
1Add the Integration: Go to Channels > CSV/XLSX File > Integrations, select “Publish Listings.”
2Connect to the Destination: Choose a connection type (e.g., S3 HTTP, FTP, Email) and provide the necessary credentials or URL.
3Configure Settings:
Specify the file name or pattern (e.g., listings_publish.csv).
Select the Excel sheet index (e.g., 0 for the first sheet).
Define the delimiter (e.g., comma for CSV).
Configure scheduling (e.g., daily at 6 AM UTC).
4Create Mapping Template: Configure field mappings (see Mapping Template Details).
5Run the Integration: Start with Run Sync or schedule.
Mapping templates control which listing data from your system is exported to the CSV/XLSX file for publishing.
Interface Overview
Screen labeled “Publish Listings” at the top; name your template (e.g., “Publish Listings 1”).
Buttons: Delete, Duplicate, Save Mapping.
Columns: Your system fields (left), file fields (right).
Mapping Options
Don't Map: Ignore the field (e.g., Internal Notes).
Set To Empty: Leave the field empty in the exported file.
Column: Map to a specific column in the exported file (e.g., Product SKU to Column 0).
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 publish listings updated in the last 24 hours).
Required Fields: SKU.
SKU Mapping Requirement
The SKU field must be mapped to ensure proper listing identification in the exported file.
Required Field: SKU uniquely identifies the listing.
Error Scenario: Unmapped SKU may cause:
Invalid request: Missing required field 'SKU' for listing publish
Fix: Go to Channels > CSV/XLSX File > Templates > Publish Listings > Field Mapping, map SKU to a column, save, and re-run sync.
Recommendation: Always map SKU for reliable listing publishing.
Complete Field Mappings
Below are the fields you can map from your system to the exported file:
Product Details
System Field
Maps To
Example
Purpose
Status
Product SKU
File Column 0
ABC123
Uniquely identifies the listing
Required
Product Title
File Column 1
Blue Widget
Describes the product
Recommended
Description
File Column 2
A high-quality blue widget
Provides product details
Optional
Image URL
File Column 3
https://example.com/image.jpg
Links to product image
Optional
Pricing and Inventory
System Field
Maps To
Example
Purpose
Status
Product Price
File Column 4
19.99
Sets the listing price
Recommended
Inventory Quantity
File Column 5
50
Specifies available stock
Recommended
Practice Mapping
Try mapping System - Product Title:
Key information:
Date: As of 12:40 PM -04, June 01, 2025, this integration is operational.
Required Fields: SKU must be mapped.
Connection Limits: Monitor to avoid sync interruptions.
Pro Tip: Map all recommended fields to ensure accurate listing publication.
Be aware of these limitations:
Connection Availability: The destination must be accessible, or the sync will fail.
Data Scope: Only mapped fields will be exported to the file.
Required Fields: SKU must be mapped in the template.
Conclusion
The CSV/XLSX Listing Publishing integration automates the process of publishing your product listings to external systems. Customize settings and mappings to fit your workflow, ensuring seamless listing updates. Happy publishing!
Order Operations
This section covers the operations related to processing orders, including retrieving new orders and syncing shipment data.
Get Orders
Get Orders
Introduction to CSV/XLSX Order Integration
Welcome to the CSV/XLSX Order Integration guide for retrieving orders! This integration allows you to import order data from CSV or XLSX files into your system. It ensures your orders, including billing and shipping details, are accurately synced. Let’s get started!
The CSV/XLSX Order Integration enables you to:
Import order data, including billing and shipping addresses, from CSV or XLSX files.
Update your system with order details like order numbers, line items, and costs.
Automate the retrieval process using connection types like S3 HTTP, FTP, or Email.
This ensures your order records are up-to-date with minimal manual effort.
The integration follows these steps:
1Connecting to the Source: Establish a connection using methods like S3 HTTP, FTP, or Email to access your CSV/XLSX file.
2Fetching File Data: The system retrieves the file from the specified source (e.g., an S3 bucket URL).
3Extracting Order Details: Extract data such as Order Number, SKU, and Address Line 1 from the file.
4Mapping Data: Map file columns (e.g., Order Number, Quantity) to your system’s fields using a mapping template.
5Syncing Data: Import the mapped data into your system, updating order records.
6Execution: Run manually with Run Sync or schedule (e.g., daily).
Pro Tip: Schedule regular syncs to keep your order data updated automatically.
Note: File retrieval failures will pause the integration and trigger notifications.
Use the form below to set up how your CSV or XLSX file containing order data will be processed. Each option helps the system understand your file’s structure and schedule the sync. We’ve included examples to guide you through the process!
If your file name includes a date (e.g., orders_20250601.csv), specify the format here using placeholders like YYYY for year, MM for month, and DD for day.
Example: For a file named "orders_20250601.csv", use "orders_YYYYMMDD.csv".
Enter the exact name of your file or a pattern if it includes dates (as set above).
Example: "orders.csv" or "orders_20250601.csv".
If your file has a header row (e.g., "Order Number,Address Line 1,SKU"), select "Yes." If it’s just data without headers, select "No," and the system will use column numbers (e.g., Column 0, Column 1).
Example: For "Order Number,Address Line 1,SKU" on the first row, choose "Yes."
Choose the format of your file. Most users use CSV, but if you’re uploading an Excel file, select XLSX.
Example: Select "CSV" for a file like "orders.csv".
If your file starts with blank rows or comments before the actual data, specify how many rows to skip. For example, if your headers or data start on row 5, enter "4".
Example: If your headers are on row 5, set this to "4".
For XLSX files, specify which sheet to read (starting at 0). Use "0" for the first sheet, "1" for the second, etc.
Example: For the first sheet in an Excel file, use "0".
If your file uses quotes around values (e.g., "12345","123 Main St"), specify the quote character. Usually, this can be auto-detected.
Example: For a CSV with values like "12345","123 Main St", choose "Double Quote".
Choose the delimiter that separates values in your file. For example, a CSV typically uses commas, but some files use pipes or tabs.
Example: For "Order Number|Address Line 1|SKU", select "Pipe".
Specify the line separator in your file. Most systems can auto-detect this, so you can usually leave it as "Default".
Example: For Windows files, you might choose "CRLF".
Override the default file extension if needed (normally .csv or .xlsx).
Example: Use ".csv" for a CSV file.
Note: Setting the correct delimiter and quote character ensures your file is parsed accurately. If your file fails to load, double-check these settings.
Follow these steps:
1Add the Integration: Go to Channels > CSV/XLSX File > Integrations, select “Get Orders.”
2Connect to the Source: Choose a connection type (e.g., S3 HTTP, FTP, Email) and provide the necessary credentials or URL.
3Configure Settings:
Specify the file name or pattern (e.g., orders.csv).
Set the number of rows to skip (e.g., 4 if headers start on row 5).
Select the Excel sheet index (e.g., 0 for the first sheet).
Define the delimiter (e.g., comma for CSV).
Configure scheduling (e.g., daily at 6 AM UTC).
4Create Mapping Template: Configure field mappings (see Mapping Template Details).
5Run the Integration: Start with Run Sync or schedule.
Mapping templates control which CSV/XLSX file order data is imported into your system.
Interface Overview
Screen labeled “Get Orders” at the top; name your template (e.g., “Get Orders 1”).
Buttons: Delete, Duplicate, Save Mapping.
Columns: File fields (left), your system fields (right).
Mapping Options
Don't Map: Ignore the field (e.g., Notes).
Set To Empty: Clear the field in your system.
Column: Map to a specific column in your file (e.g., Order Number to Column 0).
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 orders from the last 7 days).
Required Fields: Order Number, SKU.
Order Number Mapping Requirement
The Order Number field must be mapped to ensure proper order identification.
Required Field: Order Number uniquely identifies the order.
Error Scenario: Unmapped Order Number may cause:
Invalid request: Missing required field 'Order Number' for order sync
Fix: Go to Channels > CSV/XLSX File > Templates > Get Orders > Field Mapping, map Order Number to a field, save, and re-run sync.
Recommendation: Always map Order Number and SKU for reliable order syncing.
Complete Field Mappings
Below are the fields you can map from your CSV/XLSX file:
Billing Address
File Field
Maps To
Example
Purpose
Status
Address Line 1
Billing Address Line 1
123 Main St
Primary billing address line
Recommended
City
Billing City
New York
Billing city
Recommended
Country
Billing Country
USA
Billing country
Recommended
Full Name
Billing Full Name
John Doe
Billing recipient’s name
Recommended
Postal Code
Billing Postal Code
10001
Billing postal code
Recommended
State
Billing State
NY
Billing state
Optional
Address Line 2
Billing Address Line 2
Apt 4B
Secondary billing address line
Optional
Company Name
Billing Company Name
Acme Corp
Billing company name
Optional
Country Code
Billing Country Code
US
Billing country code
Optional
Email
Billing Email
john.doe@example.com
Billing email address
Optional
First Name
Billing First Name
John
Billing first name
Optional
Last Name
Billing Last Name
Doe
Billing last name
Optional
Phone
Billing Phone
555-123-4567
Billing phone number
Optional
State Code
Billing State Code
NY
Billing state code
Optional
Channel Invoice
File Field
Maps To
Example
Purpose
Status
Created On
Invoice Created On
2025-06-01
Date invoice was created
Optional
Invoice Number
Invoice Number
INV12345
Invoice identifier
Optional
Other Cost
Other Cost
5.00
Additional invoice costs
Optional
Shipping Cost
Shipping Cost
10.00
Shipping cost on invoice
Optional
Subtotal
Subtotal
135.00
Invoice subtotal
Optional
Tax Cost
Tax Cost
5.00
Tax amount on invoice
Optional
Total
Total
150.00
Total invoice amount
Optional
Order
File Field
Maps To
Example
Purpose
Status
Order Number
Order Number
ORD12345
Uniquely identifies the order
Required
Ordered On
Order Date
2025-06-01
Date the order was placed
Recommended
Reference Number
Reference Number
REF12345
Additional order reference
Optional
Channel Shipping Text
Channel Shipping Text
Standard Shipping
Shipping method description
Optional
Note
Order Note
Customer requested gift wrap
Additional order notes
Optional
Order Total
Order Total
150.00
Total order amount
Optional
Order Line Item
File Field
Maps To
Example
Purpose
Status
Quantity
Item Quantity
2
Number of items ordered
Recommended
SKU
Item SKU
ABC123
Identifies the product
Required
Cost
Item Cost
50.00
Cost per item
Optional
Default Weight Unit
Default Weight Unit
kg
Unit for item weight
Optional
Price
Item Price
75.00
Price per item
Optional
Title
Item Title
Blue Widget
Item description
Optional
Weight
Item Weight
1.5
Weight of the item
Optional
Shipping Address
File Field
Maps To
Example
Purpose
Status
Address Line 1
Shipping Address Line 1
123 Main St
Primary shipping address line
Recommended
City
Shipping City
New York
Shipping city
Recommended
Country
Shipping Country
USA
Shipping country
Recommended
Full Name
Shipping Full Name
John Doe
Shipping recipient’s name
Recommended
Postal Code
Shipping Postal Code
10001
Shipping postal code
Recommended
State
Shipping State
NY
Shipping state
Optional
Address Line 2
Shipping Address Line 2
Apt 4B
Secondary shipping address line
Optional
Company Name
Shipping Company Name
Acme Corp
Shipping company name
Optional
Country Code
Shipping Country Code
US
Shipping country code
Optional
Email
Shipping Email
john.doe@example.com
Shipping email address
Optional
First Name
Shipping First Name
John
Shipping first name
Optional
Last Name
Shipping Last Name
Doe
Shipping last name
Optional
Phone
Shipping Phone
555-123-4567
Shipping phone number
Optional
State Code
Shipping State Code
NY
Shipping state code
Optional
Practice Mapping
Try mapping CSV/XLSX - Order Number:
Be aware of these limitations:
File Availability: The file must be accessible at the specified source, or the sync will fail.
Data Scope: Only data within the specified sheet and rows (after skipping) will be processed.
Required Fields: Order Number and SKU must be mapped in the template.
Conclusion
The CSV/XLSX Order Integration automates order retrieval, ensuring your system reflects accurate order details, including billing and shipping information. Customize settings and mappings to fit your workflow, streamlining the process. Happy syncing!
Sync Orders
Sync Orders
Introduction to CSV/XLSX Order Sync
Welcome to the CSV/XLSX Order Sync guide! This integration allows you to export or update order data, such as statuses and tracking numbers, back to a CSV/XLSX file or external system. It ensures your order updates are reflected accurately in your external records. Let’s get started!
The CSV/XLSX Order Sync integration enables you to:
Export updated order data (e.g., status, tracking numbers) from your system to a CSV/XLSX file.
Sync order updates to an external system via connection types like S3 HTTP, FTP, or Email.
Automate the process to keep your external records up-to-date.
This ensures your external systems reflect the latest order information with minimal manual effort.
The integration follows these steps:
1Connecting to the Destination: Establish a connection using methods like S3 HTTP, FTP, or Email to send your CSV/XLSX file.
2Fetching Order Data: Retrieve updated order data (e.g., Order Number, Status) from your system.
3Mapping Data: Map your system fields (e.g., Order Status) to file columns using a mapping template.
4Generating the File: Create a CSV/XLSX file with the mapped data.
5Sending Data: Export the file to the specified destination, updating external records.
6Execution: Run manually with Run Sync or schedule (e.g., daily).
Pro Tip: Schedule regular syncs to keep your external systems updated automatically.
Note: Connection failures will pause the integration and trigger notifications.
Use the form below to set up how your order data will be exported to a CSV or XLSX file. Each option helps the system format your file and schedule the sync. We’ve included examples to guide you through the process!
If your file name includes a date (e.g., order_sync_20250601.csv), specify the format here using placeholders like YYYY for year, MM for month, and DD for day.
Example: For a file named "order_sync_20250601.csv", use "order_sync_YYYYMMDD.csv".
Enter the exact name of the file to be created or a pattern if it includes dates (as set above).
Example: "order_sync.csv" or "order_sync_20250601.csv".
Choose whether to include a header row (e.g., "Order Number,Status,Tracking Number") in the exported file.
Example: Select "Yes" to include headers like "Order Number,Status".
Choose the format of the exported file. CSV is most common, but you can select XLSX for Excel files.
Example: Select "CSV" for a file like "order_sync.csv".
For XLSX files, specify which sheet to write to (starting at 0). Use "0" for the first sheet, "1" for the second, etc.
Example: Use "0" to write to the first sheet in an Excel file.
Specify the quote character for values in the exported file (e.g., "ORD12345","Shipped"). Usually, this can be set to "Double Quote".
Example: Choose "Double Quote" to wrap values like "Shipped".
Choose the delimiter to separate values in the exported file. Commas are typical for CSV files.
Example: For "Order Number|Status|Tracking Number", select "Pipe".
Specify the line separator for the exported file. Use "CRLF" for Windows compatibility, or leave as "Default".
Example: Choose "CRLF" for Windows files.
Specify the file extension for the exported file (normally .csv or .xlsx).
Example: Use ".csv" for a CSV file.
Note: Ensure the delimiter and quote character match the requirements of the external system receiving the file.
Follow these steps:
1Add the Integration: Go to Channels > CSV/XLSX File > Integrations, select “Sync Orders.”
2Connect to the Destination: Choose a connection type (e.g., S3 HTTP, FTP, Email) and provide the necessary credentials or URL.
3Configure Settings:
Specify the file name or pattern (e.g., order_sync.csv).
Select the Excel sheet index (e.g., 0 for the first sheet).
Define the delimiter (e.g., comma for CSV).
Configure scheduling (e.g., daily at 6 AM UTC).
4Create Mapping Template: Configure field mappings (see Mapping Template Details).
5Run the Integration: Start with Run Sync or schedule.
Mapping templates control which order data from your system is exported to the CSV/XLSX file.
Interface Overview
Screen labeled “Sync Orders” at the top; name your template (e.g., “Sync Orders 1”).
Buttons: Delete, Duplicate, Save Mapping.
Columns: Your system fields (left), file fields (right).
Mapping Options
Don't Map: Ignore the field (e.g., Notes).
Set To Empty: Leave the field empty in the exported file.
Column: Map to a specific column in the exported file (e.g., Order Status to Column 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 export orders updated in the last 24 hours).
Required Fields: Order Number.
Order Number Mapping Requirement
The Order Number field must be mapped to ensure proper order identification in the exported file.
Required Field: Order Number uniquely identifies the order.
Error Scenario: Unmapped Order Number may cause:
Invalid request: Missing required field 'Order Number' for order sync
Fix: Go to Channels > CSV/XLSX File > Templates > Sync Orders > Field Mapping, map Order Number to a column, save, and re-run sync.
Recommendation: Always map Order Number for reliable order syncing.
Complete Field Mappings
Below are the fields you can map from your system to the exported file:
Order Details
System Field
Maps To
Example
Purpose
Status
Order Number
File Column 0
ORD12345
Uniquely identifies the order
Required
Order Status
File Column 1
Shipped
Current status of the order
Recommended
Tracking Number
File Column 2
1Z9999W99999999999
Shipping tracking number
Recommended
Updated On
File Column 3
2025-06-01
Date the order was last updated
Optional
Note
File Column 4
Delivered on time
Additional order notes
Optional
Order Line Item
System Field
Maps To
Example
Purpose
Status
SKU
File Column 5
ABC123
Identifies the product
Recommended
Quantity
File Column 6
2
Number of items in the order
Optional
Practice Mapping
Try mapping System - Order Status:
Be aware of these limitations:
Connection Availability: The destination must be accessible, or the sync will fail.
Data Scope: Only mapped fields will be exported to the file.
Required Fields: Order Number must be mapped in the template.
Conclusion
The CSV/XLSX Order Sync integration automates the process of updating external systems with your latest order data. Customize settings and mappings to fit your workflow, ensuring seamless synchronization. Happy syncing!