This document provides a comprehensive guide to integrating with the ALMS Marketplace, enabling seamless inventory management, order fulfillment, and shipment tracking. It covers key processes such as retrieving inventory data, sending orders, and syncing shipment details, ensuring your system stays updated with accurate product, pricing, and tracking information. Whether you're new to marketplace integrations or an experienced user, this guide will help you configure connections, map data fields, and troubleshoot issues effectively.
How to connect
Step 1: Log into your Flxpoint account and navigate to the Sources tab.
Step 2: Click on + Add Source (or Configure Single Source) to begin creating a new source for ALMS Marketplace.
Step 3: Provide basic source details (e.g., vendor name "ALMS Marketplace"), then click Save or Next to continue.
Step 4: Follow the Source Wizard prompts. You may see:
Vendor Setup: Indicate if this source is a vendor (e.g., ALMS Marketplace) or an internal warehouse. If vendor, choose whether to enable a Vendor Portal or use integrations.
Assign Vendor: Assign an existing vendor record or create a new one for ALMS Marketplace.
Configure Vendor Portal: If you enable a portal, specify which vendor users can access your inventory/fulfillment requests.
Order Fulfillment: Enable/disable this source for fulfilling sales orders, set up auto-processing, and define your inventory commit strategy.
Shipping Cost Estimations: Choose to use Rate Shopping or Estimates via Rules.
Real-Time Estimates: Optionally integrate with a rate-shopping provider (e.g., ShipEngine).
Order Routing Groups: Add this source to any relevant routing group to prioritize order fulfillment.
Shipping Methods: Define your shipping method name, default carrier code, and whether to use rate-shopped codes.
Source Location: Enter the “Ship From” address (street, city, state, country).
Integration Setup: Once these steps are completed, click Done to finalize your source.
Step 5: Under Integrations, select the process you want to configure:
(GIS: Get Inventory [Primary], GIP: Get Inventory [Secondary], Send Fulfillment Requests, or Get Shipments).
If you see "No integrations have been configured for this process yet", click Start Creating Integrations.
Step 6: Configure the connection based on the process:
For GIS or GIP (Get Inventory [Primary/Secondary]):
In the New ALMS Marketplace Connection form, use the Feed URL field.
Connection Name – a descriptive name (e.g., "ALMS Marketplace Get Inventory").
Feed URL – the URL to retrieve the ALMS Marketplace API for Get Inventory (Primary) and Get Inventory (Secondary).
Click Test Connection to ensure the URL is valid.
For Send Fulfillment Requests or Get Shipments:
In the New ALMS Marketplace Connection form, enter your API Token:
Connection Name – a unique name (e.g., "ALMS Marketplace Fulfillment").
API Token – the token provided by ALMS Marketplace to authenticate with the API.
To obtain the API Token: Log into your ALMS Marketplace account, navigate to the Settings or API Access section, and generate or copy your API token. If you don’t have access, contact ALMS Marketplace support to request the token.
Click Test Connection to ensure your credentials are valid.
Step 7: Once the appropriate details are validated, click Save Connection to store these details in Flxpoint.
Step 8: On the Configure Settings screen:
For GIS or GIP: Specify any additional settings for retrieving ALMS Marketplace’s inventory feed, decide whether to archive older data, and configure shipping/advanced settings as needed.
For Send Fulfillment Requests or Get Shipments: Specify any additional settings for order or shipment processing, decide whether to archive older data, and configure any shipping or advanced settings as needed.
Click Save and Proceed to continue.
Step 9: Next, select or create your Mapping Template. Map ALMS Marketplace’s fields (SKU, quantity, etc.) to the corresponding Flxpoint fields. Click Save and Complete when finished.
Step 10: Your ALMS Marketplace integration for the selected process (GIS, GIP, Send Fulfillment Requests, or Get Shipments) is now active. Flxpoint will begin processing data according to your scheduled settings.
×
![]()
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 | ALMS Marketplace - Get Inventory [Primary]
Introduction to ALMS Marketplace Get Inventory [Primary] Integration
This guide offers a detailed overview of the ALMS Marketplace Get Inventory [Primary] integration, designed to streamline the process of sourcing and managing product inventory from ALMS Marketplace. Whether you're a beginner or an experienced user, this section will guide you through connecting to ALMS Marketplace via API, retrieving product data, configuring settings, and mapping the data into your system. The aim is to ensure your inventory remains accurate and up-to-date, helping your business operate efficiently. Let’s get started with the setup process.
Purpose of This Integration
The ALMS Marketplace Get Inventory [Primary] integration allows you to fetch and process product inventory data from ALMS Marketplace, ensuring your system reflects the latest product details, pricing, and stock levels. This integration:
- Automates the retrieval of product data, including SKUs, titles, descriptions, prices, quantities, and images.
- Processes data to create unified product records for each SKU in your system.
- Applies logic to manage inventory updates, such as archiving or un-archiving products based on availability.
This ensures accurate inventory management, streamlined operations, and up-to-date product listings. How the Integration Works
The integration follows a clear process to retrieve and process inventory data from ALMS Marketplace:
1. Connecting to Data Sources: Establishes a connection to ALMS Marketplace using the ALMS Marketplace API.
2. Retrieving Data: Pull.Concurrent requests are made to the ALMS Marketplace API to fetch product details, including SKUs, titles, descriptions, and quantities.
3. Parsing Data: Interprets the API response data into structured formats for processing.
4. Processing & Mapping: Maps the retrieved data to your system’s inventory fields using a predefined mapping template (e.g., mapping "Product Sku" to "Parent SKU").
5. Saving Data: Saves the processed product records into your system.
6. Post-Processing: Optionally archives or un-archives inventory based on the configured settings.
Note: You’ll need an API key from ALMS Marketplace to access their data. If you don’t have one, contact your support team for assistance. Configuration Options
You can customize the integration with the following settings:
- API Key: The ALMS Marketplace API key for authentication.
- Archive/Un-Archive Inventory: Decide whether to archive inventory not found in the source feed (default: No). Archiving sets the quantity to zero; un-archiving reactivates it with the mapped quantity.
- Scheduling: Set the integration to run manually or on a schedule (e.g., daily at 8 AM UTC).
Setup Instructions
Follow these steps to configure the ALMS Marketplace Get Inventory [Primary] integration:
1. Connect the Integration: Navigate to the "Get Inventory [Primary]" section and select "ALMS Marketplace." Configure the connection by providing:
- API Key: Enter the API key provided by ALMS Marketplace.
Test the connection to ensure it works, then save it. If you don’t have an API key, contact your support team for assistance. 2. Configure Settings: Adjust the following options:
- Enable or disable Archive/Un-Archive Inventory based on your preference. It’s recommended to disable this if ALMS Marketplace is used for secondary inventory updates.
- Set a schedule for automatic runs, if desired (e.g., daily at 8 AM UTC).
3. Define a Mapping Template: Create a mapping template to map ALMS Marketplace’s product data to your system’s fields. This step is detailed below.
4. Run the Integration: Start the integration manually or let it run on your configured schedule.
Data Sources
The integration retrieves data directly from the ALMS Marketplace API, which includes:
- Product Data: Includes fields like Product SKU, Title, Description, UPC, Manufacturer, Weight, and Quantity.
- Pricing Data: Includes Cost, MSRP, and Price.
- Dimensions: Includes Height, Length, and Width.
- Images: Includes image URLs or references for product images.
Mapping Template Details
A mapping template defines how ALMS Marketplace’s product data is mapped to your system’s inventory fields. For example, it determines how ALMS Marketplace’s “Product Sku” field maps to your “Parent SKU” field. This section explains how to set up and use a mapping template, with detailed options for each field.
Interface Overview
- The mapping screen is labeled “ALMS Marketplace - Get Inventory [Primary]” at the top. You can name your template (e.g., “ALMS Marketplace Inventory Mapping 1”).
- There are buttons like Delete (remove the template), Duplicate (make a copy), and Save (save your changes).
- The screen is divided into two columns:
- Left Column (From Value): Lists the data fields from ALMS Marketplace’s API (e.g., “Product Sku,” “Title”).
- Right Column (To Inventory Parent Field): Lists the fields in your system (e.g., “Parent SKU,” “Title”).
Mapping Options For each field, you can choose how to handle the data. Here are the available options:
- Don’t Map: Ignore the field. The data won’t be imported (e.g., ignoring “Cost” if not needed).
- Set To Empty: Clear the field in your system (e.g., setting “Weight” to empty).
- Direct Copy / Field: Copy the data as-is from ALMS Marketplace’s API (e.g., copying “Product Sku” to “Parent SKU”).
- Value: Set a specific value (e.g., setting “Weight Unit” to “pound” for all products).
- Mapping Set: Transform the data using a predefined rule (e.g., converting categories to CamelCase).
- Rules: Apply conditional logic (e.g., “If Quantity < 10, set to 0”). This is for advanced users and can be skipped if you’re new.
Available Source Fields The following fields are available from ALMS Marketplace’s API for mapping:
- Product Fields: Product Sku, Title, Description, UPC, EAN, MPN, Manufacturer, Categories (One, Two, Three), Image URLs.
- Inventory Fields: Quantity.
- Pricing Fields: Cost, MSRP, Price, Estimated Dropship Fee, Estimated Shipping Cost.
- Dimensions: Height, Length, Width, Weight.
Complete Field Mappings Below is a detailed list of key fields you can map to in your system, with explanations and suggested mappings:
Parent SKU: The unique identifier for the product.
- Source: Product Sku (Text).
- Example: “ALM123”
- Suggested Mapping: Map to “Product Sku” using “Direct Copy.”
- Reason: Ensures your system can uniquely identify each product.
Title: The product name.
- Source: Title (Text).
- Example: “Widget Pro 3000”
- Suggested Mapping: Map to “Title” using “Direct Copy.”
- Reason: Provides the product name for your listings.
Description: The product description.
- Source: Description (Text).
- Example: “A high-quality widget for professionals.”
- Suggested Mapping: Map to “Description” using “Direct Copy.”
- Reason: Adds detailed product information to your listings.
UPC: The Universal Product Code.
- Source: Upc (Text).
- Example: “123456789012”
- Suggested Mapping: Map to “Upc” using “Direct Copy.”
- Reason: Helps identify the product universally.
MPN (Manufacturer Part Number): The manufacturer’s part number.
- Source: Mpn (Text).
- Example: “WGT-3000”
- Suggested Mapping: Map to “Mpn” using “Direct Copy.”
- Reason: Provides an additional identifier for the product.
Weight: The product weight.
- Source: Weight (Number).
- Example: “2.5”
- Suggested Mapping: Map to “Weight” using “Direct Copy.”
- Reason: Used to calculate shipping costs.
Weight Unit: The unit of measure for the weight.
- Source: Not directly provided; set manually.
- Example: “pound”
- Suggested Mapping: Set to “pound” using “Option.”
- Reason: Standardizes the weight unit for consistency.
Height, Length, Width: The product dimensions.
- Source: Height, Length, Width (Number).
- Example: “10” (height), “12” (length), “8” (width).
- Suggested Mapping: Map to “Height,” “Length,” and “Width” using “Direct Copy.”
- Reason: Provides dimensions for shipping and storage calculations.
Manufacturer: The product manufacturer.
- Source: Manufacturer (Text).
- Example: “ALMS Corp”
- Suggested Mapping: Map to “Manufacturer” using “Direct Copy.”
- Reason: Identifies the product’s manufacturer.
Category 1, 2, 3: Product categories.
- Source: Category One, Category Two, Category Three (Text).
- Example: “Electronics” (Category 1), “Widgets” (Category 2).
- Suggested Mapping: Map to “Category One,” “Category Two,” and “Category Three” using “Direct Copy.”
- Reason: Organizes products into categories.
Quantity: The available stock quantity.
- Source: Quantity (Number).
- Example: “100”
- Suggested Mapping: Map to “Quantity” using “Direct Copy.”
- Reason: Updates your system with current stock levels.
Cost: The product cost price.
- Source: Cost (Number).
- Example: “20”
- Suggested Mapping: Map to “Cost” using “Direct Copy.”
- Reason: Provides the cost for pricing calculations.
MSRP: The manufacturer’s suggested retail price.
- Source: Msrp (Number).
- Example: “30”
- Suggested Mapping: Map to “Msrp” using “Direct Copy.”
- Reason: Provides the suggested retail price.
Price: The selling price.
- Source: Price (Number).
- Example: “25”
- Suggested Mapping: Map to “Price” using “Direct Copy.”
- Reason: Sets the selling price for your listings.
All Images: Product image URLs.
- Source: All Images.
- Example: Automatically handled by the system.
- Suggested Mapping: Map to “All Images” using “Direct Copy.”
- Reason: Imports all product images for your listings.
Practice Mapping To understand how mapping works, try mapping the “Weight” field for your inventory:
Image Handling Notes
The integration manages product images as follows:
- Source: Images are retrieved directly from the ALMS Marketplace API.
- Mapping: Use the “All Images” field to automatically import all image URLs associated with each product.
- Processing: Images are processed and stored in your system as part of the integration run.
Troubleshooting
If the integration encounters an issue, here are some steps to resolve it:
- Verify that the API connection to ALMS Marketplace is working and that your API key is correct.
- Ensure your mapping template is correctly set up (e.g., “Product Sku” to “Parent SKU”).
- Check if the “Archive/Un-Archive Inventory” setting is causing unexpected behavior, and adjust if needed.
- Confirm that the ALMS Marketplace API is returning all expected fields (e.g., Quantity, Price).
If the issue persists, contact your support team for assistance. Conclusion
With your mapping template configured and the integration running, you can now seamlessly retrieve and process inventory data from ALMS Marketplace. Your product listings will stay updated with accurate details, pricing, and stock levels, ensuring your customers have access to the latest inventory. You’re ready to manage your inventory effortlessly!
Get Inventory (Secondary)
Supported | ALMS Marketplace - Get Inventory [Secondary]
Introduction to ALMS Marketplace Get Inventory [Secondary] Integration
This guide provides a comprehensive overview of the ALMS Marketplace Get Inventory [Secondary] integration, designed to help you update and manage variant-level inventory data from ALMS Marketplace. This integration complements the primary inventory integration by focusing on variant-specific details such as SKU, cost, MAP, MSRP, quantity, and shipping costs. Whether you're new to inventory management or an experienced user, this section will guide you through connecting to ALMS Marketplace via API, configuring settings, and mapping variant data into your system. Let’s dive into the setup and configuration process.
Purpose of This Integration
The ALMS Marketplace Get Inventory [Secondary] integration is designed to update variant-level inventory data from ALMS Marketplace, ensuring your system reflects the latest pricing, stock levels, and other variant-specific details. This integration:
- Updates existing products with variant-specific data like SKU, cost, MAP, MSRP, quantity, and shipping costs.
- Optionally creates new variants if enabled in the settings.
- Manages inventory availability by archiving or un-archiving variants based on the source feed.
This ensures your inventory remains accurate and up-to-date at the variant level, complementing the primary inventory data. How the Integration Works
The integration follows a structured process to retrieve and update variant-level inventory data from ALMS Marketplace:
1. Connecting to Data Sources: Establishes a connection to ALMS Marketplace using the ALMS Marketplace API.
2. Retrieving Data: Makes API requests to fetch variant-level data, including SKU, cost, MAP, MSRP, quantity, and shipping costs.
3. Parsing Data: Interprets the API response data into structured formats for processing.
4. Processing & Mapping: Maps the retrieved data to your system’s variant fields using a predefined mapping template (e.g., mapping "Sku" to "SKU").
5. Updating Data: Updates existing products with the new variant data or creates new variants if enabled.
6. Post-Processing: Optionally archives or un-archives variants based on the configured settings.
Note: You’ll need an API key from ALMS Marketplace to access their data. If you don’t have one, contact your support team for assistance. Configuration Options
You can customize the integration with the following settings:
- API Key: The ALMS Marketplace API key for authentication.
- Archive/Un-Archive Inventory: Decide whether to archive inventory not found in the source feed (default: No). Archiving sets the quantity to zero; un-archiving reactivates it with the mapped quantity.
- Allow Create Variant: Enable or disable the creation of new variants during the integration run (default: No).
- Scheduling: Set the integration to run manually or on a schedule (e.g., daily at 8 AM UTC).
Setup Instructions
Follow these steps to configure the ALMS Marketplace Get Inventory [Secondary] integration:
1. Connect the Integration: Navigate to the "Get Inventory [Secondary]" section and select "ALMS Marketplace." Configure the connection by providing:
- API Key: Enter the API key provided by ALMS Marketplace.
Test the connection to ensure it works, then save it. If you don’t have an API key, contact your support team for assistance. 2. Configure Settings: Adjust the following options:
- Enable or disable Archive/Un-Archive Inventory. It’s recommended to disable this if ALMS Marketplace is your secondary source and you’ve already enabled it in the primary integration.
- Enable or disable Allow Create Variant based on whether you want new variants to be created.
- Set a schedule for automatic runs, if desired (e.g., daily at 8 AM UTC).
3. Define a Mapping Template: Create a mapping template to map ALMS Marketplace’s variant data to your system’s fields. This step is detailed below.
4. Run the Integration: Start the integration manually or let it run on your configured schedule.
Data Sources
The integration retrieves data directly from the ALMS Marketplace API, which includes:
- Variant Data: Includes fields like SKU, Cost, MAP, MSRP, Quantity, and Estimated Shipping Cost.
- Additional Fields: Includes Estimated Dropship Fee, Height, Length, Width, and Weight for potential variant updates.
Mapping Template Details
A mapping template defines how ALMS Marketplace’s variant data is mapped to your system’s inventory variant fields. For example, it determines how ALMS Marketplace’s “Sku” field maps to your “SKU” field. This section explains how to set up and use a mapping template, with detailed options for each field.
Interface Overview
- The mapping screen is labeled “ALMS Marketplace - Get Inventory [Secondary]” at the top. You can name your template (e.g., “ALMS Marketplace Inventory Secondary Mapping 1”).
- There are buttons like Delete (remove the template), Duplicate (make a copy), and Save (save your changes).
- The screen is divided into two columns:
- Left Column (From Value): Lists the data fields from ALMS Marketplace’s API (e.g., “Sku,” “Price”).
- Right Column (To Inventory Variant Field): Lists the variant fields in your system (e.g., “SKU,” “Cost”).
Mapping Options For each field, you can choose how to handle the data. Here are the available options:
- Don’t Map: Ignore the field. The data won’t be imported (e.g., ignoring “Estimated Shipping Cost” if not needed).
- Set To Empty: Clear the field in your system (e.g., setting “Cost” to empty).
- Direct Copy / Field: Copy the data as-is from ALMS Marketplace’s API (e.g., copying “Sku” to “SKU”).
- Value: Set a specific value (e.g., setting “Quantity” to “0” for all variants).
- Mapping Set: Transform the data using a predefined rule (e.g., adjusting prices based on a formula).
- Rules: Apply conditional logic (e.g., “If Quantity < 5, set to 0”). This is for advanced users and can be skipped if you’re new.
Available Source Fields The following fields are available from ALMS Marketplace’s API for mapping to your system’s variant fields:
- Variant Fields: Sku, Cost, MAP, Msrp, Price, Quantity, Estimated Shipping Cost, Estimated Dropship Fee.
- Additional Fields: Height, Length, Width, Weight (for potential variant updates).
Complete Field Mappings Below is a detailed list of key variant fields you can map to in your system, with explanations and suggested mappings:
SKU: The unique identifier for the variant.
- Source: Sku (Text).
- Example: “ALM123-V1”
- Suggested Mapping: Map to “Sku” using “Direct Copy.”
- Reason: Ensures your system can uniquely identify each variant.
Cost: The variant cost price.
- Source: Price (Number).
- Example: “15”
- Suggested Mapping: Map to “Price” using “Direct Copy.”
- Reason: Updates the cost for pricing calculations at the variant level.
MAP: The minimum advertised price for the variant.
- Source: Map (Number).
- Example: “20”
- Suggested Mapping: Map to “Map” using “Direct Copy.”
- Reason: Ensures compliance with minimum pricing rules for the variant.
MSRP: The manufacturer’s suggested retail price for the variant.
- Source: Msrp (Number).
- Example: “25”
- Suggested Mapping: Map to “Msrp” using “Direct Copy.”
- Reason: Provides the suggested retail price for the variant.
Quantity: The available stock quantity for the variant.
- Source: Quantity (Number).
- Example: “50”
- Suggested Mapping: Map to “Quantity” using “Direct Copy.”
- Reason: Updates your system with current stock levels for the variant.
Shipping Cost: The estimated shipping cost for the variant.
- Source: Estimated Shipping Cost (Number).
- Example: “10”
- Suggested Mapping: Map to “Estimated Shipping Cost” using “Direct Copy.”
- Reason: Provides accurate shipping costs for the variant.
Practice Mapping To understand how mapping works, try mapping the “Quantity” field for your variant inventory:
Troubleshooting
If the integration encounters an issue, here are some steps to resolve it:
- Verify that the API connection to ALMS Marketplace is working and that your API key is correct.
- Ensure your mapping template is correctly set up (e.g., “Sku” to “SKU”).
- Check if the “Archive/Un-Archive Inventory” setting is causing unexpected behavior, and adjust if needed.
- Confirm that the “Allow Create Variant” setting aligns with your needs (e.g., disable if you don’t want new variants created).
- Verify that the ALMS Marketplace API is returning all expected fields (e.g., Quantity, Price).
If the issue persists, contact your support team for assistance. Conclusion
With your mapping template configured and the integration running, you can now seamlessly update variant-level inventory data from ALMS Marketplace. Your product variants will stay updated with accurate pricing, stock levels, and other details, ensuring your customers have access to the latest inventory information. You’re ready to manage your variant inventory with ease!
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 | ALMS Marketplace - Send Fulfillment Requests
Introduction to ALMS Marketplace Send Fulfillment Requests Integration
This guide provides a detailed overview of the ALMS Marketplace Send Fulfillment Requests integration, designed to streamline the process of sending purchase orders (POs) or fulfillment requests (FRs) to ALMS Marketplace for order fulfillment. This integration helps you automate the submission of orders, ensuring accurate and timely fulfillment by ALMS Marketplace. Whether you're new to order fulfillment or an experienced user, this section will guide you through connecting to ALMS Marketplace via API, configuring settings, and mapping order data to the required format. Let’s get started with the setup process.
Purpose of This Integration
The ALMS Marketplace Send Fulfillment Requests integration enables you to send purchase orders or fulfillment requests to ALMS Marketplace, ensuring seamless order fulfillment. This integration:
- Automates the submission of order details, including shipping address, billing address, items, and shipping methods.
- Maps your system's order data to ALMS Marketplace’s required format for fulfillment requests.
- Allows scheduling of requests during specific hours to align with business operations.
This ensures efficient communication with ALMS Marketplace for order fulfillment, reducing manual effort and errors. How the Integration Works
The integration follows a structured process to send fulfillment requests to ALMS Marketplace:
1. Connecting to Data Sources: Establishes a connection to ALMS Marketplace using the ALMS Marketplace Order API.
2. Retrieving Order Data: Pulls order data from your system, including shipping and billing addresses, items, and shipping methods.
3. Mapping Data: Maps the order data to ALMS Marketplace’s required format using a predefined mapping template (e.g., mapping "Fulfillment Request Number" to "Order Number").
4. Sending Requests: Submits the mapped fulfillment requests to ALMS Marketplace via API, adhering to any configured scheduling settings.
5. Confirmation: Logs the sent requests and updates your system with the status (e.g., "Sent At" timestamp).
Note: You’ll need an API key from ALMS Marketplace to send requests. If you don’t have one, contact your support team for assistance. Configuration Options
You can customize the integration with the following settings:
- API Key: The ALMS Marketplace API key for authentication.
- Hold for X Hours: Specify a hold period (in hours) to delay sending POs/FRs, useful if you need time to review orders before submission (default: 0).
- Send During Business Hours: Option to restrict sending requests to business hours (default: No).
- Scheduling: Set the integration to run manually or on a schedule (e.g., hourly at the start of each hour, UTC).
Setup Instructions
Follow these steps to configure the ALMS Marketplace Send Fulfillment Requests integration:
1. Connect the Integration: Navigate to the "Send Fulfillment Requests" section and select "ALMS Marketplace." Configure the connection by providing:
- API Key: Enter the API key provided by ALMS Marketplace.
Test the connection to ensure it works, then save it. If you don’t have an API key, contact your support team for assistance. 2. Configure Settings: Adjust the following options:
- Set Hold for X Hours to delay sending requests if needed (e.g., set to 2 hours to review orders before submission).
- Enable Send During Business Hours if you want to restrict sending to business hours.
- Set a schedule for automatic runs, if desired (e.g., hourly at the start of each hour, UTC).
3. Define a Mapping Template: Create a mapping template to map your system’s order data to ALMS Marketplace’s required fields. This step is detailed below.
4. Run the Integration: Start the integration manually or let it run on your configured schedule.
Data Sources
The integration uses data from your system and sends it to the ALMS Marketplace API. The data includes:
- Fulfillment Request Data: Fulfillment Request Number, Note, Estimated Dropship Fee, Estimated Shipping Cost, Total Cost, Total Weight, Generated At, Sent At.
- Shipping and Billing Address: Address Line 1, Address Line 2, City, State, State Code, Postal Code, Country, Country Code, First Name, Last Name, Full Name, Company Name, Email, Phone.
- Fulfillment Request Items: SKU, Quantity, Cost, Subtotal, Title, UPC, MPN, PO Line Item #, Bin Location.
- Source Shipping Method: Carrier, Method, Shipping Code, Description.
Mapping Template Details
A mapping template defines how your system’s order data is mapped to ALMS Marketplace’s required order fields for fulfillment requests. For example, it determines how your "Order Number" field maps to ALMS Marketplace’s “Fulfillment Request Number” field. This section explains how to set up and use a mapping template, with detailed options for each field.
Interface Overview
- The mapping screen is labeled “ALMS Marketplace - Send FRs” at the top. You can name your template (e.g., “ALMS Marketplace Send FRs 1”).
- There are buttons like Delete (remove the template), Duplicate (make a copy), and Save (save your changes).
- The screen is divided into two columns:
- Left Column (From Value): Lists the data fields from your system (e.g., “Fulfillment Request Number,” “Shipping Address State”).
- Right Column (To Order Field): Lists the fields required by ALMS Marketplace (e.g., “Order Number,” “State”).
Mapping Options For each field, you can choose how to handle the data. Here are the available options:
- Don’t Map: Ignore the field. The data won’t be sent (e.g., ignoring “Note” if not needed).
- Set To Empty: Send an empty value for the field (e.g., setting “State” to empty).
- Direct Copy / Field: Copy the data as-is from your system (e.g., copying “Fulfillment Request Number” to “Order Number”).
- Value: Set a specific value (e.g., setting “Note” to “Urgent Order” for all requests).
- Mapping Set: Transform the data using a predefined rule (e.g., converting state names to state codes).
- Rules: Apply conditional logic (e.g., “If Total Cost > 100, set Note to ‘High Value Order’”). This is for advanced users and can be skipped if you’re new.
Available Source Fields The following fields are available from your system for mapping to ALMS Marketplace’s order fields:
- Fulfillment Request Fields: Fulfillment Request Number, Note, Estimated Dropship Fee, Estimated Shipping Cost, Total Cost, Total Weight (lbs), Generated At, Sent At.
- Shipping and Billing Address Fields: Address Line 1, Address Line 2, City, State, State Code, Postal Code, Country, Country Code, First Name, Last Name, Full Name, Company Name, Email, Phone.
- Fulfillment Request Item Fields: SKU, Quantity, Cost, Subtotal, Title, UPC, MPN, PO Line Item #, Bin Location.
- Source Shipping Method Fields: Carrier, Method, Shipping Code, Description.
Complete Field Mappings Below is a detailed list of key fields you can map to in ALMS Marketplace’s order format, with explanations and suggested mappings:
Order Number: The unique identifier for the fulfillment request.
- Source: Fulfillment Request Number (Text).
- Example: “FR12345”
- Suggested Mapping: Map to “Fulfillment Request Number” using “Direct Copy.”
- Reason: Ensures ALMS Marketplace can uniquely identify each fulfillment request.
Note: Additional notes for the order.
- Source: Note (Text).
- Example: “Please ship ASAP”
- Suggested Mapping: Map to “Note” using “Direct Copy.”
- Reason: Provides any special instructions for the fulfillment request.
State: The state for the shipping address.
- Source: Shipping Address State (Text).
- Example: “California”
- Suggested Mapping: Map to “Shipping Address State” using “Direct Copy.” Either State or State Code must be mapped.
- Reason: Ensures accurate shipping address information for fulfillment.
State Code: The state code for the shipping address.
- Source: Shipping Address State Code (Text).
- Example: “CA”
- Suggested Mapping: Map to “Shipping Address State Code” using “Direct Copy.” Either State or State Code must be mapped.
- Reason: Provides an alternative to the full state name for the shipping address.
Address Line 1: The first line of the shipping address.
- Source: Shipping Address Address Line 1 (Text).
- Example: “123 Main St”
- Suggested Mapping: Map to “Shipping Address Address Line 1” using “Direct Copy.”
- Reason: Ensures accurate delivery address for the order.
City: The city for the shipping address.
- Source: Shipping Address City (Text).
- Example: “San Francisco”
- Suggested Mapping: Map to “Shipping Address City” using “Direct Copy.”
- Reason: Ensures accurate delivery address for the order.
Postal Code: The postal code for the shipping address.
- Source: Shipping Address Postal Code (Text).
- Example: “94105”
- Suggested Mapping: Map to “Shipping Address Postal Code” using “Direct Copy.”
- Reason: Ensures accurate delivery address for the order.
Country: The country for the shipping address.
- Source: Shipping Address Country (Text).
- Example: “United States”
- Suggested Mapping: Map to “Shipping Address Country” using “Direct Copy.”
- Reason: Ensures accurate delivery address for the order.
SKU: The SKU of an item in the fulfillment request.
- Source: Fulfillment Request Item SKU (Text).
- Example: “ALM123”
- Suggested Mapping: Map to “Fulfillment Request Item SKU” using “Direct Copy.”
- Reason: Identifies the specific product to be fulfilled.
Quantity: The quantity of an item in the fulfillment request.
- Source: Fulfillment Request Item Quantity (Number).
- Example: “2”
- Suggested Mapping: Map to “Fulfillment Request Item Quantity” using “Direct Copy.”
- Reason: Specifies how many units of the product to fulfill.
Practice Mapping To understand how mapping works, try mapping the “State” field for your order:
Troubleshooting
If the integration encounters an issue, here are some steps to resolve it:
- Verify that the API connection to ALMS Marketplace is working and that your API key is correct.
- Ensure your mapping template is correctly set up (e.g., “Fulfillment Request Number” to “Order Number”).
- Check if the “Hold for X Hours” or “Send During Business Hours” settings are delaying requests unexpectedly, and adjust if needed.
- Confirm that required fields like State or State Code are mapped, as at least one must be provided.
- Verify that your system’s order data includes all necessary fields (e.g., Shipping Address, Items).
If the issue persists, contact your support team for assistance. Conclusion
With your mapping template configured and the integration running, you can now seamlessly send fulfillment requests to ALMS Marketplace. Your orders will be submitted accurately and on schedule, ensuring efficient fulfillment and a smooth customer experience. You’re ready to automate your order fulfillment process with ease!
Get Shipments
Supported | ALMS Marketplace - Get Shipments
Introduction to ALMS Marketplace Get Shipments Integration
This guide provides a detailed overview of the ALMS Marketplace Get Shipments integration, designed to retrieve shipment data from ALMS Marketplace and update your system with tracking and fulfillment details. This integration helps you keep your order fulfillment records up-to-date by pulling shipment information such as tracking numbers, carrier details, and shipped items. Whether you're new to shipment tracking or an experienced user, this section will guide you through connecting to ALMS Marketplace via API, setting up the integration, and mapping shipment data into your system. Let’s get started with the setup process.
Purpose of This Integration
The ALMS Marketplace Get Shipments integration allows you to fetch shipment data from ALMS Marketplace, ensuring your system reflects the latest tracking and fulfillment details for orders. This integration:
- Retrieves shipment details, including carrier, method, tracking number, tracking URL, shipping cost, and shipped-at date.
- Processes shipment items, including SKU, quantity, and external order item IDs.
- Updates your system with shipment data, linking it to the corresponding fulfillment requests.
This ensures accurate tracking information and seamless order fulfillment updates for your business. How the Integration Works
The integration follows a structured process to retrieve and process shipment data from ALMS Marketplace:
1. Connecting to Data Sources: Establishes a connection to ALMS Marketplace using the ALMS Marketplace Order API.
2. Retrieving Data: Makes API requests to fetch shipment details, including tracking information, carrier details, and shipped items, linked to fulfillment requests.
3. Parsing Data: Interprets the API response data into structured formats for processing.
4. Processing & Mapping: Maps the retrieved data to your system’s shipment fields using a predefined mapping template (e.g., mapping "Tracking Number" to "Shipment Tracking Number").
5. Saving Data: Saves the processed shipment records into your system, linking them to the corresponding orders or fulfillment requests.
Note: You’ll need an API key from ALMS Marketplace to access their data. If you don’t have one, contact your support team for assistance. Configuration Options
The ALMS Marketplace Get Shipments integration in FIXpoint has no additional configuration settings. Once connected, it is ready to run manually or on a schedule:
- API Key: The ALMS Marketplace API key for authentication (required during setup).
- Scheduling: Set the integration to run manually or on a schedule (e.g., daily at 8 AM UTC).
Setup Instructions
Follow these steps to configure the ALMS Marketplace Get Shipments integration:
1. Connect the Integration: Navigate to the "Get Shipments" section and select "ALMS Marketplace." Configure the connection by providing:
- API Key: Enter the API key provided by ALMS Marketplace.
Test the connection to ensure it works, then save it. If you don’t have an API key, contact your support team for assistance. 2. Configure Settings: There are no additional settings to configure for this integration in FIXpoint. You can proceed directly to the next step.
3. Define a Mapping Template: Create a mapping template to map ALMS Marketplace’s shipment data to your system’s fields. This step is detailed below.
4. Run the Integration: Start the integration manually or let it run on your configured schedule (e.g., daily at 8 AM UTC).
Data Sources
The integration retrieves data directly from the ALMS Marketplace API, which includes:
- Shipment Data: Carrier, Method, Note, Return PO Number, Shipped At, Shipping Cost, Tracking Number, Tracking URL, Shipment ID.
- Shipment Item Data: SKU, Quantity, External Order Item ID, Shipment Item ID.
Mapping Template Details
A mapping template defines how ALMS Marketplace’s shipment data is mapped to your system’s shipment fields. For example, it determines how ALMS Marketplace’s “Tracking Number” field maps to your “Shipment Tracking Number” field. This section explains how to set up and use a mapping template, with detailed options for each field.
Interface Overview
- The mapping screen is labeled “ALMS Marketplace - Get Shipments” at the top. You can name your template (e.g., “ALMS Marketplace Get Shipments 1”).
- There are buttons like Delete (remove the template), Duplicate (make a copy), and Save (save your changes).
- The screen is divided into two sections:
- Shipment Fields: Maps data like Carrier, Tracking Number, and Shipped At to your system’s shipment fields.
- Shipment Item Fields: Maps item-specific data like SKU and Quantity to your system’s shipment item fields.
- Each section has two columns:
- Left Column (From Value): Lists the data fields from ALMS Marketplace’s API (e.g., “Carrier,” “Tracking Number”).
- Right Column (To Shipment/Shipment Item Field): Lists the fields in your system (e.g., “Shipment Carrier,” “Shipment Item SKU”).
Mapping Options For each field, you can choose how to handle the data. Here are the available options:
- Don’t Map: Ignore the field. The data won’t be imported (e.g., ignoring “Note” if not needed).
- Set To Empty: Clear the field in your system (e.g., setting “Tracking Number” to empty).
- Direct Copy / Field: Copy the data as-is from ALMS Marketplace’s API (e.g., copying “Tracking Number” to “Shipment Tracking Number”).
- Value: Set a specific value (e.g., setting “Carrier” to “UPS” for all shipments).
- Mapping Set: Transform the data using a predefined rule (e.g., converting carrier names to a standard format).
- Rules: Apply conditional logic (e.g., “If Shipping Cost > 50, set Note to ‘High Shipping Cost’”). This is for advanced users and can be skipped if you’re new.
Available Source Fields The following fields are available from ALMS Marketplace’s API for mapping to your system’s shipment and shipment item fields:
- Shipment Fields: Carrier, Method, Note, Return PO Number, Shipped At, Shipping Cost, Tracking Number, Tracking URL, Shipment ID.
- Shipment Item Fields: SKU, Quantity, External Order Item ID, Shipment Item ID.
Complete Field Mappings Below is a detailed list of key fields you can map to in your system, with explanations and suggested mappings:
Shipment Fields:
Fulfillment Request Number: The identifier linking the shipment to a fulfillment request.
- Source: Return PO Number (Text).
- Example: “FR12345”
- Suggested Mapping: Map to “Return PO Number” using “Direct Copy.”
- Reason: Links the shipment to the corresponding fulfillment request in your system.
Carrier: The carrier used for the shipment.
- Source: Carrier (Text).
- Example: “UPS”
- Suggested Mapping: Map to “Carrier” using “Direct Copy.”
- Reason: Identifies the carrier for tracking and customer updates.
Method: The shipping method used.
- Source: Method (Text).
- Example: “Ground”
- Suggested Mapping: Map to “Method” using “Direct Copy.”
- Reason: Specifies the shipping method for the shipment.
Note: Additional notes about the shipment.
- Source: Note (Text).
- Example: “Fragile items, handle with care”
- Suggested Mapping: Map to “Note” using “Direct Copy.”
- Reason: Provides any special instructions or details about the shipment.
Shipped At: The date and time the shipment was sent.
- Source: Shipped At (Date).
- Example: “2025-04-27T14:30:00Z”
- Suggested Mapping: Map to “Shipped At” using “Direct Copy.”
- Reason: Updates your system with the shipment dispatch date.
Shipping Cost: The cost of shipping.
- Source: Shipping Cost (Number).
- Example: “15.99”
- Suggested Mapping: Map to “Shipping Cost” using “Direct Copy.”
- Reason: Records the shipping cost for accounting and tracking purposes.
Tracking Number: The tracking number for the shipment.
- Source: Tracking Number (Text).
- Example: “1Z9999W99999999999”
- Suggested Mapping: Map to “Tracking Number” using “Direct Copy.”
- Reason: Allows tracking of the shipment and updates for customers.
Tracking URL: The URL to track the shipment.
- Source: Tracking URL (Text).
- Example: “https://www.ups.com/track?tracknum=1Z9999W99999999999”
- Suggested Mapping: Map to “Tracking URL” using “Direct Copy.”
- Reason: Provides a direct link for tracking the shipment.
Shipment Item Fields:
SKU: The SKU of the shipped item.
- Source: SKU (Text).
- Example: “ALM123”
- Suggested Mapping: Map to “SKU” using “Direct Copy.”
- Reason: Identifies the specific product that was shipped.
Quantity: The quantity of the item shipped.
- Source: Quantity (Number).
- Example: “2”
- Suggested Mapping: Map to “Quantity” using “Direct Copy.”
- Reason: Updates your system with the number of units shipped for the item.
Practice Mapping To understand how mapping works, try mapping the “Tracking Number” field for your shipment:
Troubleshooting
If the integration encounters an issue, here are some steps to resolve it:
- Verify that the API connection to ALMS Marketplace is working and that your API key is correct.
- Ensure your mapping template is correctly set up (e.g., “Tracking Number” to “Shipment Tracking Number”).
- Confirm that the ALMS Marketplace API is returning all expected fields (e.g., Tracking Number, Carrier).
- Check that the “Return PO Number” field is mapped correctly to link shipments to the corresponding fulfillment requests.
If the issue persists, contact your support team for assistance. Conclusion
With your mapping template configured and the integration running, you can now seamlessly retrieve shipment data from ALMS Marketplace. Your system will stay updated with accurate tracking information, carrier details, and shipped items, ensuring a smooth fulfillment process and improved customer experience. You’re ready to manage your shipment data with ease!