Shopify Integration

Shopify Setup Guide, this page provides step-by-step guidance on obtaining credentials, which are essential for the setup process.

Last updated 3 months ago

Installing the Shopify Sales Channel

To add the Shopify sales channel to your Neuro account, kindly adhere to the following steps:

  1. Access your account and go to the left side of the screen. Click the "Stores" button.

  2. If you already have a store, click "View Store" on the right side of the screen to access it.

  3. To edit an existing store, click the edit button on the right side.

  4. If you need to create a new store, click "+ ADD" above, name it, and use the edit button to make changes.

  5. Click "+ ADD" in the channels section to begin the installation.

  6. A window will appear in the centre of the screen. Search and choose "Shopify" from the available channels list.

  7. Provide the required information:

    • Channel Name: Enter any meaningful name, e.g., "Shopify."

    • Account Nominal Code: This is optional and used for accounting.

    • Hostname: Use your Shopify platform's hostname from the URL, like "hostname.myshopify.com."

  8. Choose to “Use Neuro’s App for Connection” or “Use Access Token” to connect by inserting your API Key and Password.
    …..

  9. Choose how to customise your sales channel with the settings below: Customise your settings.
    ……

  10. After filling out the fields, customise other options, then click "Save" in the bottom-right corner.

  11. Click "Copy Connect Link" to copy a URL. Paste it in your browser's navigation bar to reach the Shopify connection page.

  12. Follow the channel connection page instructions:

    • Click "Connect."

    • If logged in to Shopify, it connects automatically. If not, log in.

  13. Once connected, return to channels by clicking "Continue."

  14. You'll be back in the recently installed channel. Activate it at the top of the screen using the "Is Active" button.

Congratulations! You've successfully set up your Shopify sales channel on Neuro.

You can now sell products on Shopify and manage orders from your Neuro dashboard.

Click to Maximise the Video.

Installing Shopify in Hosted Pages

When you install this sales channel via hosted pages, you will need to provide the same required information as above. Once you've saved this information, the channel will establish an automatic connection to the platform on its own.

Overview

The elements on this page encompass functionalities typically attainable through API calls. Nevertheless, we've developed this graphical interface tool to expedite your development efforts. This page serves as a comprehensive guide, delineating each element and elucidating the step-by-step potential it offers.

Accessing the Hosted Pages

To access the companies section, begin by selecting your username, located in the upper right corner. Then, from the ensuing menu, choose "Hosted Pages."

Hosted Pages Explained

In the initial section, referred to as "Active Links," you can choose a specific store and generate an invitation link for that store by clicking the "+ Generate" button. Please note that the generated link remains valid and accessible for just one hour. After this period elapses, you will need to create a new connection should you wish to share it. Upon clicking this link, users will be directed to a new page where they can either choose to install the channels you've configured or modify the channels they have previously installed for this store.

In the final production stage, you are expected to automatically generate and display the hosted page URL as needed by utilising the following API request: referenced in the Hosted Pages Documentation.

Moving on to the "Branding & Personalisation" section, you can customise various aspects. You can upload a custom logo using a URL, opt to display or hide the search bar for the channels or adjust the page's overall colour scheme and font size. In the "Available Channels" section, by toggling the checkboxes, you can make channels either available for installation or hide them. Collectively, this section empowers you to modify the visual appearance and filter the available channels.

Beneath "Customise Inputs," you can click the "+New Customisation" button to tailor individual channels and their respective input fields. You have the flexibility to modify several elements, such as the field name, placeholder text (the text that appears when you hover the cursor over the field), the error message displayed when incorrect information is entered, and a default value. Alternatively, you can choose to turn off an input field entirely, preventing it from being displayed when users interact with it. By using the disable option, you can create your personalised channel connections and match them with your internal infrastructure.

Recommended logo dimensions are 230 pixels in width and 40 pixels in height.

Finally, under the "Select Hidden Inputs" section, you can also select specific inputs from each channel and choose to hide them during the channel installation process.

Customising a Sales Channel

The Grand Compendium of Switches, Toggles, and Tactical Tomfoolery

Welcome to the orchestration of a customising a sales channel - a symphony of checkboxes, text fields, and mildly intimidating jargon.

Below, we explain each setting by name, what it actually does, and when a sensible human (that’s you) might deploy it.

Channel Identity & Connection

Is Active

Enables or disables the channel. If off, nothing syncs; if on, the show begins.

When to use:
Turn on when your credentials and rules are set. Switch off during maintenance, testing, or when the channel should not transact.

Channel Name

The human-friendly label for the channel.

When to use:
Use clear, business-relevant names (e.g., “Shopify UK Retail”) to distinguish from other regions or storefronts.

Account Nominal Code

Assigns the ledger/account code for finance systems.

When to use:
Populate with your accounting team’s designated nominal code for this channel’s revenue or transactions.

Hostname

Identifies the store domain the integration will talk to.
Format typically: {hostname}.myshopify.com

When to use:
Enter your store’s exact hostname. Essential for API handshakes and correct data routing.

Use Neuro’s App for Connection

Connects via Neuro’s managed application rather than your own custom app.

When to use:
Enable for simplest setup, auto-managed permissions, and fewer moving parts. Disable if you require a bespoke app with custom scopes or unique security policies.

Use Access Token

What it does: Signals you’ll authenticate using your own app’s access token, rather than Neuro’s app.

When to use:
Enable when your internal policies dictate custom apps, or you need fine-grained control. Provide the Access Token below.

Access Token

Stores your custom app token used for authenticated API calls.

When to use:
Paste the token generated by your platform app. Keep secret, rotate regularly, and restrict scopes to least privilege.

Location Management

Select Default Location

Sets the default warehouse/store location for order fulfilment and stock updates.

When to use:
Choose the location you most commonly ship from. This serves as a fallback when orders don’t specify a location.

Restrict Orders by Location

Only fetches orders associated with specific locations.

When to use:
Enable when multi-location operations require tight separation (e.g., only process orders from “UK Warehouse”).

Restrict Products by Location

Limits product sync to items assigned to selected locations.

When to use:
Enable to avoid cross-region pollution - ideal for region-specific listings or compliance constraints.

Use Multiple Fulfilment Tracking

Supports multiple fulfilment events per order (e.g., split shipments).

When to use:
Enable if orders often ship from different locations or in multiple waves. Disable for simple, single-drop shipments.

Order Management

Get Orders

Retrieves orders from the channel.

When to use:
Enable to start the order flow. Without this, nothing comes in.

Only Get Order Data Changes

Polls incremental changes only, marking updated orders without re-pulling everything.

When to use:
Enable to reduce API load and speed syncing when your pipeline is already populated.

Fetch Shipped Orders

Includes orders whose status is shipped.

When to use:
Enable if you need shipment audits, reconciliation, or to sync tracking post-shipment. Disable if you only want unfulfilled/new orders.

Fetch POS (Point of Sale) Orders

Includes in-person POS orders.

When to use:
Enable for unified reporting and stock updates across retail + online. Disable for online-only operations.

Fetch Partially Paid Orders

Retrieves orders that are not fully paid.

When to use:
Enable for wholesale, deposits, or layaway models. Disable if your fulfilment requires full payment.

Use “Local Pickup” Feature

Adds a Local Pickup workflow - notify customers when orders are ready or collected.

When to use:
Enable if you offer pickup. Use the button in order detail to inform customers; track readiness and collection.

Use Xendo Plugin

If using the Shopify Xendo plugin, imports IOSs/IO data into Xendo.

When to use:
Enable only if Xendo is active in your stack and you want data to flow accordingly.

Get Pending Orders

Gets orders in a pending state.

When to use:
Enable if you need early visibility, fraud screening, or pre-allocation. Disable when you only work with authorised/paid orders.

Get Authorised Orders

Gets orders that are payment-authorised but not captured.

When to use:
Enable for operations that reserve stock at authorisation. Disable to avoid holding inventory prematurely.

Fetch Cancelled Orders

Retrieves cancelled orders.

When to use:
Enable for accurate reporting, stock returns, and customer service workflows.

Fetch Order Cancellation Data

Updates orders to cancelled in your system when cancelled on the channel.

When to use:
Enable to maintain status parity and trigger downstream actions (restock, notifications).

Fetch Order Refund Information

Retrieves refund details from the channel.

When to use:
Enable for ledger accuracy, customer support, and returns workflows.

Auto Sync Orders

Marks orders as “synced” once fetched via API so duplicates don’t reappear.

When to use:
Enable in nearly all production environments for sane data hygiene.

Auto Hold Aged Orders

Automatically holds any order more than “24 hours” old at import.

When to use:
Enable if you need manual review on older orders (fraud checks, fulfilment viability). Disable for fast-moving ops.

Use Default Get Orders Interval

Applies the system’s standard polling cadence for order retrieval.

When to use:
Enable to keep it simple. Disable if you’ll set custom intervals elsewhere.

Add Prefix to the Beginning of Order Numbers

Prepends a custom prefix to order numbers.

When to use:
Enable for multi-channel disambiguation (e.g., “UK-1234”). Use letters and dashes only. Fill “Prefix Value for Order Numbers”.

Exclude Fulfilled Order Items

Filters out items already fulfilled on the channel.

When to use:
Enable to avoid double-shipping or duplicative fulfilment events during reimports or migrations.

Use Default Order Import Delay

Applies a standard delay before importing new orders.

When to use:
Enable to let payment/fraud signals settle. Useful for channels prone to rapid state changes.

Use Default Order Sent Via Webhook Delay

Applies a standard delay before sending order events via webhook.

When to use:
Enable to batch events and avoid noisy downstream triggers.

Ignore Orders Created Before / Set Ignore Orders Created Before Date

Ignores orders created earlier than your specified date.

When to use:
Use during migrations - to bring in only fresh orders post-go-live.

Use Fulfilment Delay / Delay Hours

Delays fulfilment updates by a set number of hours.

When to use:
Enable if couriers or warehouses need buffer time to confirm packing/pickup before the platform is told.

Disable Fulfilment

Prevents sending fulfilment updates to the channel.

When to use:
Enable for test phases or manual fulfilment situations. Disable in normal operations.

Notify Customer

Sends customer notifications when fulfilment info updates.

When to use:
Enable for proactive CX. Disable when communications are handled by a different CRM or bespoke routine.

Use Default Shipping Method / Default Shipping Method

Sets a fallback shipping method when the order lacks one.

When to use:
Enable and specify a value to keep rates and rules consistent (e.g., “Standard Tracked”).

Fetch Order Meta Fields

Retrieves order-level metadata from the channel (notes, custom fields).

When to use:
Enable if you rely on meta-fields for routing, packaging, or bespoke workflows.

Fraud & Safety

Auto Hold Fraud Orders / Fraud Score Threshold

Holds orders whose fraud score exceeds your threshold at import.

When to use:
Enable with a sensible numeric threshold. Excellent for preventing dispatch before review.

Use What3Words

Enhances address precision using three-word geocodes.

When to use:
Enable for rural deliveries, geospatial routing, or where address quality is suspect.

Polling & IDs

Order Polling / Set Poll Time To

Enables periodic polling and lets you set the polling interval.

When to use:
Enable when webhooks are insufficient or you need cadence-based checks. “Set Poll Time To” defines the interval (e.g., “5m”).

Fetch PUDO ID

Retrieves “Pick Up/Drop Off” identifiers for lockers or pickup points.

When to use:
Enable if you use out-of-home delivery options. Pair with PUDO ID Mappings.

PUDO ID Mappings

Maps courier names to metafield keys where PUDO IDs live.

When to use:
Add rows for each courier (e.g., “DPD” → “order.metafields.pickup.pudo”). Critical for correct label generation and routing.

Stock Management

Download Products

Pulls products from the channel.

When to use:
Enable to import listings for matching, enrichment, or auditing.

Auto Match Product

Automatically pairs channel products to your master catalogue.

When to use:
Enable to accelerate setup. Review matches for accuracy if SKUs are messy.

Download Product Images

Imports product imagery from the channel.

When to use:
Enable if you need images in your catalogue for consistency or downstream systems.

Download Product Dimensions & Weights

Imports physical specs for products.

When to use:
Enable for accurate shipping calculations and packaging automation.

Download Product Customs Information

Imports HS Codes and Country of Origin.

When to use:
Enable for cross-border compliance, duties calculation, and customs documentation.

Add To Products

Inserts downloaded products into your main product list.

When to use:
Enable if the channel should seed/expand your catalogue. Disable if you merely want to reference channel listings.

Overwrite Stock Levels

Sets initial stock levels of products via this channel. (Overwrites.)

When to use:
Enable during first-time setup to push a baseline. Use with caution - this can clobber existing figures.

Auto Sync Stock

Automatically syncs stock changes from your master catalogue to the channel.

When to use:
Enable in almost all cases to prevent overselling or underselling.

Push Stock Levels

Pushes master product stock to channel product stock on demand.

When to use:
Enable to allow manual or scheduled pushes, especially after inventory audits.

Auto Deduct Stock For Orders

Reduces stock automatically when an order arrives.

When to use:
Enable to maintain real-time availability. Disable if stock movement is handled by a separate ERP.

Refetch Products

Immediately resynchronises all products from the channel.

When to use:
Use for emergency reindexing after bulk edits or structural changes. Expect load; plan off-peak.

Refetch Location Levels

Retrieves stock levels for all products regardless of last update.

When to use:
Use to correct drift or after warehouse recounts.

Use Stock Allocation Rate / Stock Allocation Rate (0–1)

Restricts the percentage of master stock made available to the channel 0.5 means 50%.

When to use:
Enable for marketplace risk management, promotional scarcity, or multi-channel balancing. Enter a decimal between 0 and 1.

Allow Increase/Decrease Stock Levels

Permits the channel to update stock based on configured increase/decrease operations.

When to use:
Enable when the channel should be allowed to bump stock up or down (e.g., marketplace buffer management).

Use Default Get Products Interval

Applies the standard cadence for product retrieval.

When to use:
Enable for simple operations. Customise when you need faster or slower product syncs.

Enable Low Stock Buffer / Buffer Stock Limit

Sets channel stock to 0 when master stock is at or below a defined threshold.

When to use:
Enable to avoid overselling on volatile SKUs. Choose a buffer limit appropriate to picking accuracy and order velocity.

Enable Max Stock Level / Max Stock Level

Caps channel stock to a fixed quantity when master stock is at or above your threshold.

When to use:
Enable to present a controlled inventory number (e.g., always show 10 available) for merchandising or risk control.

Pragmatic Setup Patterns

A) Minimalist Launch (fast and safe)

  • Is Active: On

  • Use Neuro’s App for Connection: On

  • Get Orders: On

  • Auto Sync Orders: On

  • Auto Deduct Stock For Orders: On

  • Auto Sync Stock: On

  • Default Shipping Method: Set

  • Notify Customer: On

  • Fetch Order Meta Fields: On

  • Fraud Hold: On with moderate threshold

  • Stock Allocation Rate: 0.7 if marketplaces are greedy

B) Multi-Location Maestro

  • Select Default Location: Set primary site

  • Restrict Orders by Location: On

  • Restrict Products by Location: On

  • Use Multiple Fulfilment Tracking: On

  • Refetch Location Levels: Run after warehouse changes

C) Migration & Cleanup

  • Ignore Orders Created Before: Set go-live date

  • Use Default Order Import Delay: On

  • Exclude Fulfilled Order Items: On

  • Add Prefix to Order Numbers: On (“MIG-”)

  • Refetch Products: Run once post-mapping

D) High-Control Finance & Compliance

  • Account Nominal Code: Set by finance

  • Download Customs Information: On

  • Fetch Refund Information: On

  • Get Cancelled Orders + Cancellation Data: On

Final Thoughts

Begin with simplicity, then layer sophistication.

Document your defaults, thresholds, and intervals. Resist the siren song of toggling everything to “On”.

Choose the levers that align with your operations, your risk appetite, and your customers’ patience. Your future self will thank you.

For additional support, contact the Neuro Support Team.