> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runalloy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Mintsoft

> Integration details and setup guide for the Mintsoft connector in Alloy Automation.

## Pre-Built Tooling

| Category                            | Details                                                         |
| ----------------------------------- | --------------------------------------------------------------- |
| **Authentication**                  | API Key (Header-based)                                          |
| **Two-Way Sync**                    | No                                                              |
| **Events Supported**                | Yes (via webhooks)                                              |
| **Realtime**                        | Yes (webhooks for inventory and order updates)                  |
| **Supports Rate Limiting**          | Yes                                                             |
| **Authentication Scopes Supported** | N/A (API key-based authentication provides full account access) |

***

## Objects Supported

Alloy Automation supports syncing the following objects from **Mintsoft**:

Based on the Mintsoft API, typical objects include:

* **Orders**
* **Products**
* **Stock**
* **Warehouses**
* **Shipments**
* **Returns**
* **Suppliers**
* **Customers**

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                       |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| **Offers free trial?**                             | Yes. Mintsoft offers a free trial upon request. [Request free trial](https://www.mintsoft.co.uk/contact-us/) |
| **Requires paid sandbox**                          | No. Trial accounts can be used for testing and development.                                                  |
| **Requires partnership to obtain authentication?** | No. Anyone can sign up and obtain API keys.                                                                  |

***

### Authentication (API Key)

Mintsoft uses API Key authentication passed via custom headers.

#### Obtain your API key

1. Go to **Mintsoft** ([https://www.mintsoft.co.uk/](https://www.mintsoft.co.uk/)) and sign up for an account or log in.
2. Navigate to **Settings** → **Integrations** → **API Settings** in the Mintsoft dashboard.
3. Click **Generate API Key** or view your existing API key.
4. Copy the API key - this is a long alphanumeric string.
5. In Alloy Automation, when configuring the Mintsoft connector, provide the API key.
6. The API key is passed in the `ms-apikey` header for all API requests.

#### Important Notes

* Keep your API key secure - it provides full access to your Mintsoft account.
* API keys do not expire but can be regenerated if compromised.
* There is no OAuth flow - API key authentication is the only supported method.
* The base API URL is `https://api.mintsoft.co.uk/api`.

***

## Use Cases

### 1) E-commerce order fulfillment

Automatically push orders from e-commerce platforms (Shopify, WooCommerce, BigCommerce) to Mintsoft for warehouse processing, picking, packing, and shipping, then sync tracking information back to the storefront.

### 2) Multi-warehouse inventory synchronization

Maintain accurate stock levels across multiple warehouses and sales channels by syncing inventory data from Mintsoft to e-commerce platforms, marketplaces, and ERP systems in real-time.

### 3) Returns management automation

Process customer returns by creating return records in Mintsoft when return requests are submitted through customer service platforms, tracking the return journey and updating inventory upon receipt.

### 4) Supplier purchase order management

Generate and send purchase orders to suppliers based on stock levels in Mintsoft, automatically updating expected delivery dates and creating goods receipt notes when shipments arrive.

### 5) Shipping and logistics integration

Connect Mintsoft with multiple shipping carriers to automatically select the most cost-effective shipping method, print labels, and track parcels throughout the delivery process.

***

## API Gotchas

* The API uses a custom header `ms-apikey` for authentication, not the standard `Authorization` header. Many HTTP clients and testing tools default to `Authorization`, causing authentication failures if you don't explicitly set the correct header name.

* Date formats must be precise and use ISO 8601 format with UTC timezone (`YYYY-MM-DDTHH:mm:ssZ`). Mintsoft is strict about date parsing, and incorrectly formatted dates will cause validation errors rather than being automatically converted.

* Webhook delivery is not guaranteed to be exactly-once. In high-volume scenarios, you may receive duplicate webhook notifications for the same event. Always implement idempotency checks using the event ID or resource timestamp.

* Product SKUs and other identifier fields are case-sensitive and must match exactly. Creating a product with SKU "ABC123" and later querying for "abc123" will fail to find the product, as Mintsoft does not perform case-insensitive matching.

> For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**.