What You Can Do With Neuro API

Neuro’s API is your central switchboard for multi‑channel commerce: create distinct stores for different brands and regions, link them to a wide range of sales channels, and keep product stock perfectly in sync to prevent overselling. You can push fulfilment data with tracking and status updates, add targeted plugins and webhooks for inventory or custom workflows, and generate invoices automatically to tidy your order lifecycle.

With Postman collections ready to import, you’ll be up and calling endpoints in minutes - building a streamlined, auditable pipeline from listing to delivery, all under one controllable roof.

1. Create New Stores

Stores in Neuro allow you to organise and manage different sales channels for various use cases. For example, if you operate multiple brands selling across several platforms, you can utilise Neuro's store management capabilities to group and manage these sales channels seamlessly.

Steps to Create a New Store:

1. Use the Create Store API Endpoint:

   • You can create a store by sending a POST request to the {{api_url}}/stores/create

     endpoint.

2. Configure Store Details:

   • Include essential information such as store name, description, and associated sales channels.

3. Store Integration:

   • After store creation, you can integrate different sales channels using separate API calls, linking each store to its respective channels.

For more information on how to create and manage stores, visit our Store Integration Guide or our Postman Documentation.

2. Integrate With Different Sales Channels

Neuro allows you to integrate with a wide variety of sales channels. You can set up individual POST requests for each sales channel, enabling you to easily connect your e-commerce platforms.

Steps to Integrate with Sales Channels:

1. Identify the Sales Channel:

   • Each sales channel requires a unique POST request.

2. Configure the POST Request:

   • Depending on the sales channel, specify the necessary parameters such as API keys, account details, and integration preferences.

3. Send the POST Request:

   • Send the POST request to integrate the sales channel with your Neuro account.

For a full list of supported channels and their respective POST calls, refer to our API Documentation for Sales Channels.

3. Synchronise Product Stock Levels Across All Sales Channels

With Neuro, you can ensure your product stock levels remain consistent across all sales channels, helping you avoid overselling. The API allows you to manage and synchronise stock data easily.

Steps to Synchronise Stock Levels:

1. Enable Stock Management:

   • In the POST request for setting up your sales channels, ensure you enable the following settings:
     

     Example
     JSON
     Copy
     {
       "stock_management": true,
       "download_products": true,
       "add_to_main_products": true,
       "auto_sync_stock": true
     }
     

2. Sync Stock Levels:

   • Neuro will automatically update the stock levels for all products across the sales channels you're using.

3. Customisation via Hosted Pages:

   • If you're using hosted pages, you can customise the input to include the above settings.

If you are experiencing any issues, check our Troubleshooting Guide.

4. Create Fulfilment Data

Neuro allows you to create and manage fulfilment data using the API. This enables you to streamline the fulfilment process by sending and syncing fulfilment details between your system and sales channels.

Steps to Create Fulfilment Data:

1. Send an API Call to Create Fulfilment Data:

   • You can create fulfilment data by making a POST request to the

     {{api_url}}/orders/fulfillment/create

     endpoint.

   • Example of a fulfilment request:
     

   Example
   JSON
   Copy
   {
     "order_id": "123456",
     "tracking_number": "XYZ123",
     "fulfilment_status": "Shipped"
   }

2. Sync Fulfilment Data:

   • Once created, the fulfilment data is automatically synced with the integrated sales channels.

For further details on creating fulfilment data, refer to the Fulfilment API Guide.

5. Add Plugins or Webhooks

Neuro allows you to extend your system by adding plugins and webhooks for various functionalities such as fulfilment, inventory management, or custom integrations.

Steps to Add Plugins or Webhooks:

1. Identify the Plugin or Webhook:

   • Choose the plugin or webhook you wish to integrate (e.g., a fulfilment centre plugin or a custom webhook for stock updates).

2. Send the Plugin/Post Request:

   • Use the appropriate POST request for each plugin integration. Each plugin has a unique API call.

   • Example plugin request:

     
     

     Example
     JSON
     Copy
     {
       "plugin_type": "fulfilment_center",
       "plugin_name": "ABC_Fulfilment",
       "plugin_url": "https://api.fulfilmentcenter.com"
     }

3. Confirm Plugin/Webhook Activation:

   • Once the plugin or webhook is successfully added, it will be activated and linked to your store.

Learn more about Plugins and Webhook setup in our API docs.

6. Create Invoices

Automating the invoice generation process through the Neuro API helps you save time and reduce manual errors. You can generate invoices for your orders directly through API calls.

Steps to Create an Invoice:

1. API Call to Generate Invoice:

   • You can create an invoice for a specific order by making a POST request to the /createInvoice endpoint.

   • Example invoice request:

     Example
     JSON
     Copy
     {
       "order_id": "123456",
       "invoice_date": "2025-03-20",
       "total_amount": 100.00,
       "currency": "USD"
     }
     

2. Invoice Confirmation:

   • Once the invoice is generated, the status will be updated, and it will be sent to the customer.

For more details on invoice creation, see the Invoice API Documentation.

Installing Postman

To interact with the Neuro API, we recommend using Postman, a popular API testing tool.

Steps to Install Postman:

1. Visit the Official Postman Website:

   • Go to the Postman Downloads Page.

2. Download the Appropriate Version:

   • Choose the version that matches your operating system (Windows, macOS, or Linux).

3. Install Postman:

   • Follow the on-screen instructions to install Postman on your system.

4. Create a Postman Account:

   • To fully utilise Postman’s features, create a Postman Account.

Setting Up Postman for Neuro API

Once Postman is installed, you can begin using it to interact with the Neuro API.

Steps to Set Up Postman:

1. Access Channels API Documentation:

   • Visit our API Documentation Page and save it to your Postman account.

2. Import the Collection:

   • Click the "Run in Postman" button located at the top right corner of the documentation.

3. Choose Your Postman Version:

   • Select your operating system (Windows/Mac/Linux).

4. Import to Your Workspace:

   • Choose a workspace for the collection and confirm.

5. Access API Calls:

   • Once imported, you will have easy access to the full list of API calls and examples directly from your Postman account.

Make sure to obtain your API key from the Neuro UI under Profile > Settings.

Getting Started with the API

For detailed information on how to use the Neuro API, visit our Comprehensive API Documentation. Our support team is available to assist you if you encounter any challenges or have specific questions.

We hope this guide empowers you to effectively integrate and manage your e-commerce processes through the Neuro API. Happy coding!

Next Steps & Support

Need help? Explore more of our documentation, or contact support.