Welcome to the Shift4Shop Integration Guide! This resource is designed to help you seamlessly connect Flxpoint with your Shift4Shop store, enabling efficient management of listings, orders, and updates. Whether you're publishing products, retrieving orders, or syncing tracking information, we've got you covered with clear, step-by-step instructions.
How to connect
📋 Phase 1: Initial Channel Setup
+
Log in to Flxpoint
Log in to your Flxpoint account and navigate to Sales Channels.
Create a New Channel
Click "+" to Create Channel.
Tip: Ensure you have your Shift4Shop credentials ready for the next steps.
Configure Channel Settings
In the Channel Setup screen:
- Search for Shift4Shop in the directory and select it.
- Enter a Channel Name (e.g., "Shift4Shop Store").
- Select the desired processes (e.g., Sync Listings, Publish Listings, Get Orders, Sync Orders).
- Click Save & Next to proceed to the connection setup.
🔐 Phase 2: Obtain Shift4Shop Credentials
+
Access Shift4Shop Admin Dashboard
Log in to your Shift4Shop Admin Dashboard at https://www.shift4shop.com/login-page.html. Watch this video tutorial for a visual guide.
Enable REST API
- Navigate to Modules and search for REST API.
- Click Settings and then Add in the top right corner.
- Follow the prompts to enable the REST API and generate your Private Key.
- Verify permissions (e.g., access to products, orders, brands, customers, categories) and click Authorize.
- Copy the Private Key for use in Flxpoint.
Important: Save your Private Key securely, as it’s required for the connection setup.
🔗 Phase 3: Connect Channel
+
Set Up Shift4Shop Connection
On the Connect Channel screen:
- Enter a Connection Name (e.g., "Shift4Shop Connection").
- Paste the Private Key from your Shift4Shop dashboard.
- Enter your Secure URL (e.g., your Shift4Shop store’s base URL).
- Click Test Connection to verify the setup, then click Save Connection.
- Troubleshooting: If the authentication fails, ensure you’re using the correct Inventory Source app token and connection type.
🔄 Phase 4: Configure Integration Settings
+
Use Channel Wizard
Follow the Channel Wizard prompts to set up each enabled process:
- For Sync Listings, set your Master SKU by selecting a field from your channel or choosing not to set one.
- For Publish Listings, configure settings like product visibility and stock management.
- For Get Orders, select order statuses (e.g., Processing, Pending) and time range for imports.
- For Sync Orders, configure order status updates and shipment syncing.
- Complete each section and click Confirm to proceed through the wizard.
Pro Tip: Double-check your settings in the Channel Wizard to ensure all processes align with your business needs.
✅ Phase 5: Finalize Setup
+
Review and Enable Processes
In the Channel Created screen:
- Review your settings and check boxes to enable processes immediately (e.g., start importing listings or orders).
- Click Confirm & Finish to complete the setup.
Manage Channel
Your Shift4Shop channel is now set up! You can revisit it in Sales Channels to:
- Start Sync Listings to update listings and products in Flxpoint.
- Start Get Orders to import new orders and send back acknowledgments.
- Adjust settings using the Channel Wizard for further configuration.
- Ensure all integrations (e.g., Sync Orders, Publish Listings) are configured for full functionality.
Next Steps: Run each process manually first to test, verify product syncs, and check order processing before enabling automation.
×
![]()
Listing Operations
Import Listings
Not Supported
Sync & Link Listings
Supported | Shift4Shop - Sync & Link Listings
Introduction to Shift4Shop Sync & Link Listings
Welcome to the Shift4Shop (S4S) Sync & Link Listings integration guide! This integration connects your Flxpoint inventory with your Shift4Shop store, keeping product details like price, quantity, and status updated. It ensures seamless inventory management for businesses of all sizes. Let’s get started!
The Shift4Shop Sync & Link Listings integration enables you to:
- Keep Data in Sync: Updates price, quantity, and status between Flxpoint and Shift4Shop.
- Link Listings: Matches Flxpoint listings to Shift4Shop products using identifiers like SKU or advanced suffix options.
- Control Visibility: Hides or delists products on Shift4Shop when they’re out of stock.
- Support Variants: Syncs both simple products and variants, such as a shirt in multiple sizes or colors.
The integration follows these steps:
- 1 Connecting to S4S: Establish a connection using Shift4Shop credentials to access your store.
- 2 Fetching Product Data: A GET call to the Shift4Shop products endpoint retrieves product details, including variants.
- 3 Extracting Product Details: Extract SKU, price, and stock levels from the API response.
- 4 Mapping Data: Map Shift4Shop fields (e.g., Stock, Price) to Flxpoint fields using a mapping template.
- 5 Syncing Data: Import the mapped data into Shift4Shop, updating product records.
- 6 Execution: Run manually with Run Sync or schedule (e.g., daily).
Pro Tip: Schedule regular syncs to maintain real-time inventory accuracy.
Note: API failures pause the integration and trigger notifications.
Customize the integration with these settings:
- Sync Frequency: Choose to sync product data for listings updated within a specific time frame (e.g., last 24 hours).
- Linking Priority: Choose how to match listings, like using Listing Variant SKU as the primary identifier.
- Scheduling: Run manually or schedule (e.g., daily at 6 AM UTC).
- Mapping Template: Define how Shift4Shop fields sync to Flxpoint (e.g., Stock to Quantity).
Note: Jobs may take 2–5 minutes to start and up to 15 minutes to complete.
Follow these steps:
- 1 Add the Integration: Go to Channels > Shift4Shop > Integrations, select “Sync Listings.”
- 2 Connect to S4S: Use your Shift4Shop credentials or set up a new connection.
-
3 Configure Settings:
- Set sync frequency (e.g., last 24 hours).
- Set linking priority (e.g., Listing Variant SKU).
- Configure scheduling.
- 4 Create Mapping Template: Configure field mappings (see Mapping Template Details).
- 5 Run the Integration: Start with Run Sync or schedule.
Control how products appear on Shift4Shop:
Hiding Products
Hiding a variant sets it to “Out of Stock” or “Currently Unavailable” on Shift4Shop, preventing orders when stock is low.
Unhiding Products
Unhiding applies to products already hidden, making them live again on Shift4Shop when stock is available.
Delisting Products
Delisting removes a product from your Shift4Shop store. You’ll need to run a sync/publish job to bring it back.
Mapping templates control which Shift4Shop product data is imported into Flxpoint.
Interface Overview
- Screen labeled “Sync Listings” at the top; name your template (e.g., “S4S Sync Listings 1”).
- Buttons: Delete, Duplicate, Save Mapping.
- Columns: Shift4Shop fields (left), Flxpoint fields (right).
Mapping Options
- Don't Map: Ignore the field (e.g., Price 2).
- Set To Empty: Clear the field in Shift4Shop.
- Field: Map to a specific field in Flxpoint (e.g., Stock to Quantity).
- Value: Set a static value for the field.
- Rules: Add custom rules to transform or filter data (e.g., hide if Quantity < 1).
- Required Fields: Stock, Price.
SKU Mapping Requirement
The SKU field must be mapped to ensure proper product identification.
- Required Field: SKU uniquely identifies the product.
-
Error Scenario: Unmapped SKU may cause:
Invalid request: Missing required field 'SKU' for product sync
- Fix: Go to Channels > Shift4Shop > Templates > Sync Listings > Field Mapping, map SKU to a field, save, and re-run sync.
Recommendation: Always map SKU and Stock for reliable product syncing.
Complete Field Mappings
Below are the fields you can map from Shift4Shop:
Advanced Option Fields
| Shift4Shop Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Cost | Estimated Cost | $10 | Tracks product cost | Optional |
| Price | List Price | $30 | Sets selling price | Required |
| Price 2 to 5 | None | - | Tiered pricing | Optional |
| Stock | Quantity | 50 | Updates stock level | Required |
SKU Info Fields
| Shift4Shop Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Cost | Estimated Cost | $10 | Tracks product cost | Optional |
| Price | List Price | $30 | Sets selling price | Required |
| Retail Price | MSRP | $40 | Sets suggested retail price | Optional |
| Sale Price | List Price | $25 | Sets discounted price | Optional |
| Stock | Quantity | 50 | Updates stock level | Required |
Practice Mapping
Try mapping Shift4Shop - SKU:
Be aware of these limitations:
- API Rate Limits: Exceeding Shift4Shop API limits pauses the integration.
- Data Scope: Only fetches data available via the Shift4Shop products endpoint.
- Required Fields: SKU and Stock must be mapped.
Troubleshoot issues with these steps:
- Connection Issues: Verify Shift4Shop credentials and connectivity.
- API Errors: Ensure the Shift4Shop products endpoint is accessible.
- Missing Data: Check mapping template for mapped fields (e.g., SKU, Stock).
- Rate Limits: Confirm you haven’t hit Shift4Shop API limits.
- Contact Support: Reach out to Shift4Shop support with error details.
Diagnostic Tip: Missing product data often results from unmapped required fields.
Key information:
- Date: As of 08:24 PM -04, June 01, 2025, this integration is operational.
- Required Fields: SKU and Stock must be mapped.
- API Limits: Monitor to avoid sync interruptions.
Pro Tip: Map all required fields to ensure accurate product syncing.
Conclusion
The Shift4Shop Sync & Link Listings integration automates inventory syncing, ensuring your store reflects accurate product details. Customize mappings and schedules to fit your workflow, streamlining inventory management. Happy syncing!
Publish Listings
Supported | Shift4Shop - Publish Listings
Introduction to Shift4Shop Publish Listings
Welcome to the Shift4Shop (S4S) Publish Listings integration guide! This integration allows you to create and update product listings on your Shift4Shop store directly from Flxpoint. It ensures accurate product details and supports both simple products and variants. Let’s get started!
The Shift4Shop Publish Listings integration enables you to:
- Create New Listings: Publish new products from Flxpoint to your Shift4Shop store.
- Support Variants: Publish products with variants, like a shirt in multiple sizes or colors.
- Overwrite Existing Listings: Update details of already published variants, such as title, description, or price.
- Customize Data: Use a mapping template to control which Flxpoint data is sent to Shift4Shop fields.
The integration follows these steps:
- 1 Connecting to S4S: Establish a connection using Shift4Shop credentials to access your store.
- 2 Fetching Product Data: A GET call to the Flxpoint inventory endpoint retrieves product details, including variants.
- 3 Extracting Product Details: Extract SKU, title, price, and images from the response.
- 4 Mapping Data: Map Flxpoint fields (e.g., Title, Price) to Shift4Shop fields using a mapping template.
- 5 Syncing Data: Publish the mapped data to Shift4Shop, creating or updating product listings.
- 6 Execution: Run manually with Run Sync or schedule (e.g., daily).
Pro Tip: Schedule regular publishes to keep your Shift4Shop catalog up to date.
Note: API or FTP failures pause the integration and trigger notifications.
Customize the integration with these settings:
- Sync Frequency: Choose to publish product data for listings updated within a specific time frame (e.g., last 24 hours).
- FTP Setup: Configure FTP settings for image uploads, including server, username, password, subfolder, port, and protocol.
- Scheduling: Run manually or schedule (e.g., daily at 6 AM UTC).
- Mapping Template: Define how Flxpoint fields map to Shift4Shop fields (e.g., Title to Title).
Note: Jobs may take 2–5 minutes to start and up to 15 minutes to complete.
Follow these steps:
- 1 Add the Integration: Go to Channels > Shift4Shop > Integrations, select “Publish Listings.”
- 2 Connect to S4S: Use your Shift4Shop credentials or set up a new connection.
-
3 Configure Settings:
- Set sync frequency (e.g., last 24 hours).
- Configure FTP settings for image uploads.
- Configure scheduling.
- 4 Create Mapping Template: Configure field mappings (see Mapping Template Details).
- 5 Run the Integration: Start with Run Sync or schedule.
Shift4Shop requires FTP for uploading product images. Configure these settings in Flxpoint:
- Image FTP Server: The server address, such as ftp2.3dcartstores.com.
- Image FTP Protocol: Typically Implicit FTPS.
- Image FTP Username: Your FTP username provided by Shift4Shop.
- Image FTP Password: Your FTP password provided by Shift4Shop.
- Image FTP Subfolder: The subfolder for images, such as /web/assets/images/.
- Image FTP Port: Typically 22.
Pro Tip: Verify FTP credentials in Shift4Shop’s email to ensure successful image uploads.
Overwrite Functionality
Update details of already published variants, such as title, description, categories, MPN, UPC, GTIN, and images.
- Example: If a product’s title changes from “Blue T-Shirt” to “Navy T-Shirt,” the overwrite updates the title on Shift4Shop.
Limitations
- Product Deletion: Flxpoint cannot delete product listings on Shift4Shop; deletions must be done directly in your store.
- Product Creation: Products must be set up in Shift4Shop; Flxpoint only creates or updates listings.
Mapping templates control which Flxpoint product data is published to Shift4Shop.
Interface Overview
- Screen labeled “Publish Listings” at the top; name your template (e.g., “S4S Publish Listings 1”).
- Buttons: Delete, Duplicate, Save Mapping.
- Columns: Flxpoint fields (left), Shift4Shop fields (right).
Mapping Options
- Don't Map: Ignore the field (e.g., Extra Field 2).
- Set To Empty: Clear the field in Shift4Shop.
- Field: Map to a specific field in Shift4Shop (e.g., Title to Title).
- Value: Set a static value for the field.
- Mapping Set: Apply a predefined mapping set for complex mappings.
- Direct Copy: Copy data directly, often for images or options.
- Rules: Add custom rules to transform data (e.g., set field based on condition).
- Required Fields: SKU, Title, Price.
SKU Mapping Requirement
The SKU field must be mapped to ensure proper product identification.
- Required Field: SKU uniquely identifies the product.
-
Error Scenario: Unmapped SKU may cause:
Invalid request: Missing required field 'SKU' for product publish
- Fix: Go to Channels > Shift4Shop > Templates > Publish Listings > Field Mapping, map SKU to a field, save, and re-run sync.
Recommendation: Always map SKU, Title, and Price for reliable product publishing.
Complete Field Mappings
Below are the fields you can map to Shift4Shop:
Categories Fields
| Shift4Shop Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Category 1–3 | Category 1–3 | Clothing | Assigns product category | Optional |
Product Fields
| Shift4Shop Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| All Images | Image | image.jpg | Adds product images | Optional |
| All Options | Option | Size: M | Defines variant options | Optional |
| Attributes | Attribute | Material: Cotton | Adds product features | Optional |
| Cost | Estimated Cost | $10 | Tracks product cost | Optional |
| Description | Description | Cotton T-Shirt | Provides product details | Optional |
| GTIN | GTIN | 123456789012 | Identifies product globally | Optional |
| Height | Height | 10 | Sets product dimension | Optional |
| Length | Length | 20 | Sets product dimension | Optional |
| Width | Width | 15 | Sets product dimension | Optional |
| MPN | MPN | ABC123 | Identifies manufacturer part | Optional |
| Price | List Price | $30 | Sets selling price | Required |
| Retail Price | MSRP | $40 | Sets suggested retail price | Optional |
| Sale Price | List Price | $25 | Sets discounted price | Optional |
| SKU | SKU | TSHIRT001 | Identifies product | Required |
| Stock | Quantity | 50 | Updates stock level | Optional |
| Title | Title | Navy T-Shirt | Sets product title | Required |
| UPC | UPC | 012345678905 | Identifies product | Optional |
| Weight | Weight | 0.5 | Sets product weight | Optional |
Extra Fields
| Shift4Shop Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Extra Field 1–3 | Custom Field | Test | Adds custom data | Optional |
Practice Mapping
Try mapping Shift4Shop - SKU:
Troubleshoot issues with these steps:
- Connection Issues: Verify Shift4Shop credentials and FTP connectivity.
- API Errors: Ensure the Shift4Shop products endpoint is accessible.
- Missing Data: Check mapping template for mapped fields (e.g., SKU, Title).
- FTP Issues: Confirm FTP server, username, password, subfolder, port, and protocol are correct.
- Contact Support: Reach out to Shift4Shop support with error details.
Diagnostic Tip: Missing images often result from incorrect FTP settings.
Key information:
- Date: As of 08:25 PM -04, June 01, 2025, this integration is operational.
- Required Fields: SKU, Title, and Price must be mapped.
- API Limits: Monitor to avoid sync interruptions.
Pro Tip: Map all required fields to ensure accurate product publishing.
Conclusion
The Shift4Shop Publish Listings integration automates product listing creation and updates, ensuring your store reflects accurate product details. Customize mappings, FTP settings, and schedules to fit your workflow, streamlining catalog management. Happy publishing!
Order Operations
Get Orders
Supported | Shift4Shop - Get Orders
Introduction to Shift4Shop Get Orders
Welcome to the Shift4Shop (S4S) Get Orders integration guide! This integration retrieves new orders from your Shift4Shop store into Flxpoint and sends acknowledgments back if needed. It ensures seamless order management for businesses of all sizes. Let’s get started!
The Shift4Shop Get Orders integration enables you to:
- Retrieve New Orders: Import new orders from Shift4Shop into Flxpoint for processing.
- Acknowledge Orders: Send confirmation back to Shift4Shop to update order status.
- Filter by Status: Fetch orders based on specific statuses, like "New" or "Processing."
- Map Order Data: Use a mapping template to align Shift4Shop order data with Flxpoint fields.
The integration follows these steps:
- 1 Connecting to S4S: Establish a connection using Shift4Shop credentials to access your store.
- 2 Fetching Order Data: A GET call to the Shift4Shop orders endpoint retrieves order details based on selected status.
- 3 Extracting Order Details: Extract billing address, shipment details, and item data from the API response.
- 4 Mapping Data: Map Shift4Shop fields (e.g., Billing Address, Item SKU) to Flxpoint fields using a mapping template.
- 5 Syncing Data: Import the mapped data into Flxpoint, creating order records.
- 6 Execution: Run manually with Run Sync or schedule (e.g., every 10 minutes).
Pro Tip: Schedule frequent syncs to ensure timely order processing.
Note: API failures pause the integration and trigger notifications.
Customize the integration with these settings:
- Order Status: Select statuses to fetch, such as "New," "Processing," or "Shipped."
- PII Retention: Choose retention period for personal data, like "Indefinitely" or "30 Days After Shipment."
- Scheduling: Run manually or schedule (e.g., every 10 minutes).
- Mapping Template: Define how Shift4Shop order fields map to Flxpoint (e.g., Billing Address to Address Line 1).
Note: Jobs may take 2–5 minutes to start and up to 15 minutes to complete.
Follow these steps:
- 1 Add the Integration: Go to Channels > Shift4Shop > Integrations, select “Get Orders.”
- 2 Connect to S4S: Use your Shift4Shop credentials or set up a new connection.
-
3 Configure Settings:
- Select order status (e.g., "New").
- Set PII retention period.
- Configure scheduling.
- 4 Create Mapping Template: Configure field mappings (see Mapping Template Details).
- 5 Run the Integration: Start with Run Sync or schedule.
Order Status Filtering
Filter orders by status, such as "New," "Processing," or "Shipped." Only orders in the selected status are imported.
- Example: Selecting "New" imports only new orders for processing.
Personal Identifying Information (PII) Retention
Choose how long to retain customer data, like names and addresses. Options include "Indefinitely," "30 Days After Shipment," or "90 Days After Shipment." Data is redacted after the period for privacy.
Mapping templates control which Shift4Shop order data is imported into Flxpoint.
Interface Overview
- Screen labeled “Get Orders” at the top; name your template (e.g., “S4S Get Orders 1”).
- Buttons: Delete, Duplicate, Save Mapping.
- Columns: Shift4Shop fields (left), Flxpoint fields (right).
Mapping Options
- Don't Map: Ignore the field (e.g., Billing Company).
- Set To Empty: Clear the field in Flxpoint.
- Field: Map to a specific field in Flxpoint (e.g., Billing Address 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., map based on condition).
- Required Fields: External Order Number, Item SKU.
External Order Number Mapping Requirement
The External Order Number field must be mapped to ensure proper order identification.
- Required Field: External Order Number uniquely identifies the order.
-
Error Scenario: Unmapped External Order Number may cause:
Invalid request: Missing required field 'External Order Number' for order sync
- Fix: Go to Channels > Shift4Shop > Templates > Get Orders > Field Mapping, map External Order Number to a field, save, and re-run sync.
Recommendation: Always map External Order Number and Item SKU for reliable order syncing.
Complete Field Mappings
Below are the fields you can map from Shift4Shop:
Billing Address Fields
| Shift4Shop Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Billing Address | Address Line 1 | 123 Main St | Primary billing address | Optional |
| Billing Address 2 | Address Line 2 | Apt 4B | Secondary billing address | Optional |
| Billing City | City | New York | Billing city | Optional |
| Billing Company | Company | ABC Corp | Billing company name | Optional |
| Billing Country | Country | USA | Billing country | Optional |
| Billing Email | user@example.com | Billing email | Optional | |
| Billing First Name | First Name | John | Billing first name | Optional |
| Billing Last Name | Last Name | Doe | Billing last name | Optional |
| Billing Phone Number | Phone | 555-123-4567 | Billing phone | Optional |
| Billing Zip Code | Postal Code | 10001 | Billing zip code | Optional |
| Billing State | State | NY | Billing state | Optional |
Order Fields
| Shift4Shop Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Invoice Number | External Order Number | ORD12345 | Identifies order | Required |
| Order Amount | Order Amount | 99.99 | Total order value | Optional |
| Order Date | Order Date | 2025-06-01 | Date order placed | Optional |
Order Item Fields
| Shift4Shop Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Item ID | External Item ID | ITEM123 | Identifies item | Optional |
| Item Unit Cost | Item Cost | 20.00 | Cost per item | Optional |
| Item Description | Item Description | Blue T-Shirt | Describes item | Optional |
| Item Unit Price | Item Price | 25.00 | Price per item | Optional |
| Item Quantity | Item Quantity | 2 | Quantity ordered | Optional |
| Catalog ID | Item SKU | TSHIRT001 | Identifies item | Required |
| Item Weight | Item Weight | 0.5 | Item weight | Optional |
Shipment Address Fields
| Shift4Shop Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Shipment Address 1 | Address Line 1 | 456 Oak St | Primary shipping address | Optional |
| Shipment Address 2 | Address Line 2 | Suite 5 | Secondary shipping address | Optional |
| Shipment City | City | Los Angeles | Shipping city | Optional |
| Shipment Company | Company | XYZ Inc | Shipping company name | Optional |
| Shipment Country | Country | USA | Shipping country | Optional |
| Shipment Email | user@example.com | Shipping email | Optional | |
| Shipment First Name | First Name | Jane | Shipping first name | Optional |
| Shipment Last Name | Last Name | Smith | Shipping last name | Optional |
| Shipment Phone | Phone | 555-987-6543 | Shipping phone | Optional |
| Shipment Zip Code | Postal Code | 90001 | Shipping zip code | Optional |
| Shipment Cost | Shipping Cost | 10.00 | Cost of shipping | Optional |
| Shipment Method Name | Shipping Method | Standard | Shipping method | Optional |
| Shipment State | State | CA | Shipping state | Optional |
| Shipment Tracking Code | Tracking Number | 1Z9999 | Tracks shipment | Optional |
Practice Mapping
Try mapping Shift4Shop - Invoice Number:
Be aware of these limitations:
- API Rate Limits: Exceeding Shift4Shop API limits pauses the integration.
- Data Scope: Only fetches orders available via the Shift4Shop orders endpoint.
- Required Fields: External Order Number and Item SKU must be mapped.
Troubleshoot issues with these steps:
- Connection Issues: Verify Shift4Shop credentials and connectivity.
- API Errors: Ensure the Shift4Shop orders endpoint is accessible.
- Missing Data: Check mapping template for mapped fields (e.g., External Order Number, Item SKU).
- Order Status Issues: Confirm selected status matches expected orders.
- Contact Support: Reach out to Shift4Shop support with error details.
Diagnostic Tip: Missing orders often result from incorrect status filtering or unmapped required fields.
Key information:
- Date: As of 08:34 PM -04, June 01, 2025, this integration is operational.
- Required Fields: External Order Number and Item SKU must be mapped.
- API Limits: Monitor to avoid sync interruptions.
Pro Tip: Map all required fields to ensure accurate order syncing.
Conclusion
The Shift4Shop Get Orders integration automates order retrieval and acknowledgment, ensuring your Flxpoint system reflects accurate order details. Customize status filters, PII retention, and mappings to fit your workflow, streamlining order management. Happy syncing!
Sync Orders
Supported | Shift4Shop - Sync Orders
Introduction to Shift4Shop Sync Orders
Welcome to the Shift4Shop (S4S) Sync Orders integration guide! This integration updates existing orders on Shift4Shop with changes made in Flxpoint, primarily focusing on syncing tracking information. It ensures Shift4Shop reflects the latest shipment details for seamless order management. Let’s get started!
The Shift4Shop Sync Orders integration enables you to:
- Update Tracking Information: Sync tracking numbers and shipping details to Shift4Shop.
- Keep Orders in Sync: Ensure Shift4Shop reflects the latest order updates from Flxpoint.
- Map Shipment Data: Use a mapping template to control which Flxpoint data updates Shift4Shop fields.
The integration follows these steps:
- 1 Connecting to S4S: Establish a connection using Shift4Shop credentials to access your store.
- 2 Fetching Shipment Data: A GET call to the Flxpoint shipment endpoint retrieves updated shipment details, such as tracking numbers.
- 3 Extracting Shipment Details: Extract tracking number, carrier, and shipping method from the response.
- 4 Mapping Data: Map Flxpoint fields (e.g., Tracking Number, Method) to Shift4Shop fields using a mapping template.
- 5 Syncing Data: Update Shift4Shop with the mapped data, reflecting changes in order records.
- 6 Execution: Run manually with Run Sync or schedule (e.g., every 10 minutes).
Pro Tip: Schedule frequent syncs to keep tracking information current.
Note: API failures pause the integration and trigger notifications.
Customize the integration with these settings:
- Shipping Methods Setup: Configure shipping methods in Shift4Shop to ensure accurate mapping of carrier and method details.
- Scheduling: Run manually or schedule (e.g., every 10 minutes).
- Mapping Template: Define how Flxpoint shipment fields map to Shift4Shop (e.g., Tracking Number to Shipment Tracking Code).
Note: Jobs may take 2–5 minutes to start and up to 15 minutes to complete.
Follow these steps:
- 1 Add the Integration: Go to Channels > Shift4Shop > Integrations, select “Sync Orders.”
- 2 Connect to S4S: Use your Shift4Shop credentials or set up a new connection.
-
3 Configure Settings:
- Ensure shipping methods are set up in Shift4Shop.
- Configure scheduling.
- 4 Create Mapping Template: Configure field mappings (see Mapping Template Details).
- 5 Run the Integration: Start with Run Sync or schedule.
Configure shipping methods in Shift4Shop to ensure accurate syncing:
- 1 Access Shipping Methods: Navigate to “Settings” > “Shipping” > “Shipping Methods.”
- 2 Add or Edit Methods: Click “Add New” or edit existing methods like “UPS” or “FedEx.”
- 3 Configure Details: Set method name, customer group, region, and order amount limits.
- 4 Save Changes: Click “Save” to apply configurations.
Example: If using “UPS,” ensure it’s listed in Shift4Shop for accurate mapping.
Mapping templates control which Flxpoint shipment data is synced to Shift4Shop.
Interface Overview
- Screen labeled “Sync Orders” at the top; name your template (e.g., “S4S Sync Orders 1”).
- Buttons: Delete, Duplicate, Save Mapping.
- Columns: Flxpoint fields (left), Shift4Shop fields (right).
Mapping Options
- Don't Map: Ignore the field (e.g., Shipment Company).
- Set To Empty: Clear the field in Shift4Shop.
- Field: Map to a specific field in Shift4Shop (e.g., Tracking Number to Shipment Tracking Code).
- Value: Set a static value for the field.
- Mapping Set: Apply a predefined mapping set for complex mappings.
- Rules: Add custom rules to transform data (e.g., map based on condition).
- Required Fields: Shipment Tracking Code.
Shipment Tracking Code Mapping Requirement
The Shipment Tracking Code field must be mapped to ensure proper tracking updates.
- Required Field: Shipment Tracking Code identifies the shipment.
-
Error Scenario: Unmapped Shipment Tracking Code may cause:
Invalid request: Missing required field 'Shipment Tracking Code' for order sync
- Fix: Go to Channels > Shift4Shop > Templates > Sync Orders > Field Mapping, map Shipment Tracking Code to a field, save, and re-run sync.
Recommendation: Always map Shipment Tracking Code for reliable tracking updates.
Complete Field Mappings
Below are the fields you can map to Shift4Shop:
Shipment Fields
| Shift4Shop Field | Maps To | Example | Purpose | Status |
|---|---|---|---|---|
| Shipment Address 1 | Address Line 1 | 123 Main St | Primary shipping address | Optional |
| Shipment Address 2 | Address Line 2 | Apt 4B | Secondary shipping address | Optional |
| Shipment City | City | New York | Shipping city | Optional |
| Shipment Company | Company Name | ABC Corp | Shipping company name | Optional |
| Shipment Country | Country | USA | Shipping country | Optional |
| Shipment Email | user@example.com | Shipping email | Optional | |
| Shipment First Name | First Name | John | Shipping first name | Optional |
| Shipment Last Name | Last Name | Doe | Shipping last name | Optional |
| Shipment Method Name | Method | UPS | Shipping method | Optional |
| Shipment Phone | Phone | 555-123-4567 | Shipping phone | Optional |
| Shipment State | State | NY | Shipping state | Optional |
| Shipment Tracking Code | Tracking Number | 1Z9999W999999999 | Tracks shipment | Required |
| Shipment Zip Code | Postal Code | 10001 | Shipping zip code | Optional |
Practice Mapping
Try mapping Shift4Shop - Shipment Tracking Code:
Be aware of these limitations:
- API Rate Limits: Exceeding Shift4Shop API limits pauses the integration.
- Data Scope: Only syncs shipment data available via the Flxpoint shipment endpoint.
- Required Fields: Shipment Tracking Code must be mapped.
Troubleshoot issues with these steps:
- Connection Issues: Verify Shift4Shop credentials and connectivity.
- API Errors: Ensure the Shift4Shop orders endpoint is accessible.
- Missing Data: Check mapping template for mapped fields (e.g., Shipment Tracking Code).
- Shipping Method Issues: Confirm Flxpoint shipping methods match those in Shift4Shop.
- Contact Support: Reach out to Shift4Shop support with error details.
Diagnostic Tip: Missing tracking data often results from unmapped Shipment Tracking Code or mismatched shipping methods.
Key information:
- Date: As of 08:37 PM -04, June 01, 2025, this integration is operational.
- Required Fields: Shipment Tracking Code must be mapped.
- API Limits: Monitor to avoid sync interruptions.
Pro Tip: Map all required fields to ensure accurate tracking updates.
Conclusion
The Shift4Shop Sync Orders integration automates the updating of order details, particularly tracking information, ensuring your Shift4Shop store reflects accurate shipment data. Customize shipping methods and mappings to fit your workflow, streamlining order synchronization. Happy syncing!