Shopify Integration

Overview

Ramp’s Shopify integration enables seamless data exchange between your Shopify store and the Ramp platform. This integration ensures that product information and inventory levels remain accurate across both systems - helping you save time, reduce manual work, and maintain up-to-date stock visibility.

Key Features

• Retrieve and Sync Data
  • Imports product fields, location fields and current stock inventory from Shopify
• Update Inventory Levels
  • Push stocktake data back to Shopify to ensure accurate inventory counts across all locations

How It Works

The integration connects to Shopify through its Admin API (REST and GraphQL) using a secure API token.
Ramp uses detailed field mappings between Shopify and Ramp to ensure all information is correctly aligned — from SKUs and locations to stock quantities.

In This Article

1. Retrieving Your Shopify API Access Token

2. Data Mapping

3. Product Integration Details

4. Stocktake Integration Details

5. Current Stock Integration

Retrieving Your Shopify API Access Token

To enable communication between Shopify and Ramp, you must retrieve your Shopify API access token to authenticate data transfer. To do this, follow these steps:

1. Navigate to Shopify Admin Portal
   • Log in to your Shopify account at https://{your-storename}.myshopify.com/admin.
2. Create a private app
   
   • Go to Settings > Apps and Sales Channels > Develop Apps.
   • Click on Create an App and give it a descriptive name
3.  Configure API Permissions
   • We require the following scopes:
     1. read_locations
     2. read_products
     3. read_inventory
     4. write_inventory
4. Retrieve Access Token
   • After saving, click Install App to generate the Admin API Access Token.
   • Save this token securely; it will be used for authentication in API calls.

Product Data Mapping

This section covers the required Shopify fields that Ramp interacts with when syncing your product catalogue. It also outlines how the mapping appears in the Ramp system.

Required Fields

These fields are required from Shopify responses for the Ramp API to sync orders, sync 
current stock and post back inventory levels. These values cannot be null, empty or set as 
any value that does not exist in Shopify.

Product Mapping in Ramp

Each uniquely tagged product type is known as a SKU in the Ramp platform, and the product 
integrator maps the information under the product details. In addition to these standard 
fields, meta fields are also available and can be synced across as well as part of the product 
integrator

Additional Notes

• Combining Fields
  • Fields like Name and Title are combined where necessary for more complete product descriptions in Ramp.
• Barcode Logic
  • If Shopify Barcode values are absent or invalid (i.e. not a GTIN), Ramp generates a unique barcode number to maintain consistency and ensure traceability. This is used to encode the RFID tags.
  • TODO: add information about the meta field for security related products
• Extended Properties
  • Ramp supports additional fields such as Option1, Option2, and Option3 to map product attributes (e.g., Color, Size, Material).
  • These fields are essential for variants and advanced product configurations.
• Inventory Item ID
  • Shopify's Inventory_item_id is critical for real-time inventory updates and product synchronization. This ensures accurate stock levels across platforms.
• Vendor and ProductType
  • Fields like Vendor and ProductType are included for classification and supplier management, which are valuable for reporting and integrations with third-party tools.
• Meta Fields
  • Ramp allows for synchronization of custom meta fields that businesses may configure in Shopify for specific workflows or reporting needs.

Stocktake Integration

When a stocktake is performed using the RFID handheld, it will be synced back to Shopify once it has been completed.

Additional Notes

• Stocktake Completion in Ramp
  • Once a stocktake is completed in Ramp, the system generates a list of
    inventory updates containing:
    • SKU/Inventory Item ID
    • Location ID (PlaceCode)
    • Available Quantity
• Inventory Item ID Mapping
  • Shopify’s inventory_item_id is retrieved from the product variant details and
    stored in Ramp as an extended property for each SKU.
  • This ensures a consistent and direct match between Shopify and Ramp during
    synchronization.
• Handling Missing Inventory Counts
  • If a stocktake only includes counted items, SKUs not present in the stocktake
    are assumed to have a stock level of 0.
  • To account for this, Ramp makes an additional call to Shopify to retrieve
    current stock counts and ensures all SKUs in the store are updated:
    • SKUs counted during the stocktake receive their available quantity.
    • SKUs not counted are explicitly updated to 0 to avoid discrepancies.
• Batching and Rate Limits
  • Shopify imposes API rate limits, so inventory updates are sent in batches to
    avoid throttling.
  • Ramp processes stocktake updates in chunks of up to 1,000 SKUs per
    request.
• Error Handling
  • Any errors during synchronization (e.g., missing inventory_item_id or invalid
    location_id) are logged for review.
  • Failed updates are retried based on the Ramp integration error-handling
    mechanism.

Current Stock Integration

As part of the stocktake integrator, the current stock integrator allows the service to sync
across the current inventory levels.

When a stocktake is performed, you can view the variance report.

This feature also allows you to set up minimum scan requirements. For example, a stocktake can be required to achieve a maximum variance of 2% before it can be completed.

 

Keon Integration

The Keon–Shopify integration connects Keon’s security systems with your Shopify store to synchronise stock information in real time. This integration helps link in-store security events with product data, providing greater visibility into inventory movement and reducing potential stock loss.

For more details, refer to the article Setting up Keon Security System.