Setting Up Integrations

Setting Up Integrations guides you through the complete process of configuring integrations in ShipEdge Core. Whether you need to import orders from CSV files or connect your Shopify or Amazon store, this guide will show you how to do it step by step.

There are two main methods for configuring integrations: creating a CSV template for manual import or configuring a direct API connection with eCommerce platforms. Both methods allow you to automatically sync orders and inventory.

Quick Start

For API integrations (Amazon, Shopify, etc.), go directly to My Account > Preferences > Channel Automation. For CSV imports, use Integrations > Add Template.

Configuration Methods

ShipEdge Core offers two main ways to configure integrations:

CSV Templates

Create templates to import orders from CSV files. Ideal for custom systems or platforms without direct API.

API Connections

Connect directly with platforms like Amazon, Shopify, or Walmart using their official APIs for automatic synchronization.

---

Configure Integration by CSV Template

This method is ideal when you need to import orders from CSV files generated by external systems or platforms that don’t have direct API integration.

Step 1: Create the Template

1. Access Add Template

   In the Integrations view, click the “Add Template” button located at the top of the page.

2. Complete Basic Information

   Complete the form with the following information:

   • Name: Descriptive name for the integration (e.g., “My Store CSV”, “Manual Import”)
   • header Line [1 to N]: Line number where data begins in the CSV (usually 1 or 2 if there are headers)
   • Multi-line Orders (N lines, N SKUs): Check this box if each order can have multiple lines (one SKU per line)
   • Template: Select the template type that best fits your file format
   • Active: Check this box to activate the integration immediately
   • Description: Optional integration description

3. Save the Template

   Click the “Add” button to create the template.

Step 2: Configure File Fields

Once the template is created, you must configure how CSV fields map to ShipEdge fields:

1. Access Config Input File

   In the Integrations view, find your newly created integration and click the actions menu (spreadsheet icon). Select “Config Input File”.

2. Map Fields

   The system will show a list of available fields in ShipEdge. For each field you want to import:

   • Enter the exact column header name from your CSV file
   • Or select from a list of common fields if available

   Common fields to map:

   • Order Number / Order ID
   • Customer Name / First Name / Last Name
   • Email
   • Address fields (Address1, Address2, City, State, ZIP, Country)
   • SKU
   • Quantity
   • Price
   • Shipping Method
   • Order Date

3. Save Configuration

   Save the field mappings. The system will remember this configuration for future imports.

Step 3: Download Example Template

To see the exact format required:

1. Download Template

   In the Integrations view, click “Download Template” for the integration you just created.

2. Review Format

   A CSV file will be downloaded with the exact column names you must use in your files.

3. Prepare Your Files

   Use this template as a reference when preparing your CSV files for import.

---

Configure API Integration (Channel Automation)

This method connects directly with eCommerce platforms using their official APIs. It’s the recommended method for major platforms like Amazon, Shopify, Walmart, etc.

Step 1: Access Channel Automation

1. Go to Preferences

   From the main menu, navigate to My Account > Preferences.

2. Find Channel Automation

   On the Preferences page, look for the “Channel Automation” section or use the direct link from the Integrations view.

3. View Available Integrations

   You’ll see a list of all available platforms to connect.

Step 2: Configure the Connection

The exact process varies by platform, but generally includes:

1. Select Platform

   Click on the platform you want to connect (Amazon, Shopify, Walmart, etc.).

2. Provide Credentials

   Enter the required API credentials:

   • Amazon SP-API: Access Key ID, Secret Access Key, Refresh Token
   • Shopify: Store URL, API Key, API Secret
   • Walmart: Client ID, Client Secret
   • Other platforms according to their specific requirements

3. Authorize Access

   Some platforms require OAuth authorization. Follow the on-screen instructions to authorize access.

4. Configure Options

   Configure what to sync:

   • Orders (automatic import)
   • Inventory (bidirectional synchronization)
   • Products (catalog synchronization)

5. Activate Integration

   Check the “Active” box to activate the integration.

API Credentials

API credentials are generally obtained from the platform’s admin panel (Amazon Seller Central, Shopify Admin, etc.). Consult each platform’s specific documentation for detailed instructions.

---

Configure Advanced Options

Once the integration is created, you can configure advanced options from the Integrations view:

Order Entry Options

Hold Entry:

• What it does: Orders enter in “waiting” status for review before being sent to the warehouse
• When to use it: For new integrations or when you need to manually validate orders
• Configuration: Enable from the configuration menu (wrench icon)

Hold if over sold price:

• What it does: Automatically holds orders whose sale price exceeds a specific amount
• Configuration: Enter the maximum amount in the corresponding field

Address Validation:

• What it does: Validates addresses against the USPS database and updates them automatically
• When to use it: To reduce delivery errors and ensure correct addresses
• Important: Orders that fail validation will enter with “address-error” status

Residential Check:

• What it does: Verifies whether the address is residential or commercial
• When to use it: When you need to apply different rates based on address type

Synchronization Options

Add Suffix:

• What it does: Adds the Channel ID as a suffix to the order number
• When to use it: When you have multiple stores of the same platform
• Example: “ORD-001” becomes “ORD-001#123”

Divide Available:

• What it does: Divides available inventory among multiple channels when you have the same integration configured multiple times
• When to use it: When you sell the same product in multiple stores and need to distribute stock

Reserve Percentage:

• What it does: Reserves a percentage of inventory during synchronization
• Configuration: Use the slider to set a percentage from 0% to 100%
• When to use it: To maintain safety stock that doesn’t sync with channels

Signature Amount:

• What it does: Requires delivery signature if the order value exceeds a specific amount
• When to use it: To protect high-value orders

---

Configure Communication Templates

Communication templates allow you to customize how ShipEdge communicates with platforms:

1. Access Communications Templates

   In the Integrations view, click the actions menu and select “Communications Templates”.

2. Configure Templates

   Configure templates for:

   • Order confirmations
   • Shipping status updates
   • Tracking notifications
   • Custom messages according to the platform

3. Save Configuration

   Save the templates so they’re automatically used in future communications.

---

Configure ShipMethod Translator

The ShipMethod Translator translates shipping methods between the platform and ShipEdge:

1. Access ShipMethod Translator

   In the Integrations view, click the actions menu and select “ShipMethod Translator”.

2. Map Methods

   For each platform shipping method, select the corresponding method in ShipEdge:

   • Platform: “Standard Shipping” → ShipEdge: “Ground”
   • Platform: “Express” → ShipEdge: “Express”
   • And so on

3. Save Mappings

   Save the mappings so they’re automatically applied to all imported orders.

---

Configure 3PT (Third Party) for FedEx/UPS

For integrations that send information to carriers like FedEx or UPS:

1. Access 3PT Configuration

   In the Integrations view, click the actions menu and select “3PT Configuration”.

2. Select Carrier

   Select the carrier (FedEx or UPS) for which you want to configure information.

3. Complete Information

   Complete all required fields:

   • Carrier Pay Account: Carrier account number
   • Company Name: Company name
   • First Name and Last Name: Full contact name
   • Address: Complete address (Address1, Address2, City, State, ZIP, Country)
   • Phone Number: Phone number
   • Use it for duty payment: Check if this account is used for tax payment

4. Activate

   Check the “Active” box to activate this configuration.

5. Save

   Click “Add” or “Update” to save the configuration.

---

Configure International Settings

For integrations that handle international shipments:

1. Access International Settings

   In the Integrations view, click the actions menu and select “International Settings”.

2. Configure Incoterms

   Select the international commercial terms (Incoterms) that will apply by default.

3. Configure Tax Identifiers

   Configure tax identifiers if required:

   • Entity: Tax entity
   • Tax ID: Tax identification number
   • Tax ID Type: Identification type
   • Issuing Country: Issuing country

4. Save Configuration

   Save the configuration so it applies to all international orders for this integration.

---

Verify and Test the Integration

After configuring the integration, it’s important to verify that it works correctly:

For CSV Integrations

1. Prepare Test File

   Create a small CSV file with one or two test orders using the format from the downloaded template.

2. Upload File

   Upload the file using the configured method (manual upload or FTP).

3. Verify Import

   Go to the Orders view and verify that test orders appear correctly.

4. Review Data

   Open a test order and verify that all fields have been mapped correctly.

For API Integrations

1. Use Get Orders

   In the Integrations view, click “Get Orders!” for the configured integration.

2. Wait for Processing

   The process generally takes 2 to 15 minutes. The system will show the date of the last synchronization.

3. Verify Orders

   Go to the Orders view and verify that orders have been imported correctly.

4. Test Inventory Synchronization

   If you configured inventory synchronization, click “Sync All Inventory!” and verify that quantities update on the platform.

---

💡 Best Practices

Start with Hold Entry

Enable “Hold Entry” for new integrations until you confirm orders are importing correctly.

Validate Addresses

Enable “Address Validation” from the start to reduce delivery errors and keep addresses updated.

Test with Real Data

Use small real orders to test before activating full synchronization.

Review Logs Regularly

Review synchronization logs periodically to detect problems early.

Document Configuration

Use the “Description” field to document important details about each integration’s configuration.

Keep Credentials Secure

Never share API credentials. If you need to rotate credentials, update them in Preferences immediately.

---

Common Troubleshooting

Orders Are Not Importing

Possible causes:

• The integration is disabled (Active = N)
• The CSV format doesn’t match the configured template
• Fields are not mapped correctly
• API credentials have expired

Solution:

1. Verify that the integration is active
2. Review the CSV format against the downloaded template
3. Verify field mappings in “Config Input File”
4. For APIs, verify credentials in Preferences

Fields Are Incorrect

Cause: Column names in the CSV don’t match those configured in “Config Input File”.

Solution:

1. Go to “Config Input File” for the integration
2. Verify that column names match exactly (uppercase/lowercase, spaces)
3. Update mappings if necessary

Inventory Synchronization Doesn’t Work

Possible causes:

• Inventory synchronization is not enabled in Preferences
• The reserve percentage is configured incorrectly
• There’s an error in the last synchronization

Solution:

1. Verify configuration in Preferences > Channel Automation
2. Review the reserve percentage in advanced options
3. Use “Sync All Inventory” to force a manual synchronization
4. Review logs to see specific errors

I Can’t Configure Advanced Options

Cause: Some options are only available for API integrations (with Channel ID).

Solution: Options like “Reserve Percentage” and “Add Suffix” are only available for API-connected integrations. For CSV integrations, use the basic options available.

---

Related Links

• Integrations Overview - Overview of the integrations system
• Order Rules (Automation) - Configure automatic rules for orders
• Preferences - General account configuration
• Orders Overview - View and manage imported orders

---

Next Step: Order Rules (Automation) - Configure automatic rules to process imported orders