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

# Unleashed

> How to set up the Unleashed connector, plus the actions and events that are available.

![Unleashed](https://stackone-logos.com/api/unleashed/filled/svg)

v1.2.1[See changelog](https://docs.stackone.com/connectors/unleashed/changelog.md)

[66 actions](#actions) · [24 events](#events) · 1 auth method

ERP

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/unleashed/guides/connector-profile/api-key.md)
>
> Requires an Unleashed API Id and API Key (HMAC-SHA256 signed requests). Generated from the Unleashed app under Integrati...

Optionally, configure receiving Events for Unleashed into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/unleashed/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/unleashed/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

66 actions

ActionDescription

List Accounts`unleashed_list_accounts`

List accounts (chart of accounts)

List Assemblies`unleashed_list_assemblies`

List assembly orders for manufacturing finished goods from components

Create Assembly`unleashed_create_assembly`

Create a new assembly order

Get Assembly`unleashed_get_assembly`

Retrieve a single assembly by GUID

Complete Assembly`unleashed_complete_assembly`

Complete a parked assembly so the build is made

List Bill Of Materials`unleashed_list_bill_of_materials`

List bills of materials defining product compositions

Create Bill Of Materials`unleashed_create_bill_of_materials`

Create a new bill of materials

Get Bill Of Materials`unleashed_get_bill_of_materials`

Retrieve a single BOM by GUID

List Customers`unleashed_list_customers`

List customers with filtering and pagination

Get Customer`unleashed_get_customer`

Retrieve a single customer by GUID

Create Customer`unleashed_create_customer`

Create a new customer record

Update Customer`unleashed_update_customer`

Update an existing customer (full overwrite)

List Customer Contacts`unleashed_list_customer_contacts`

List contacts for a customer

Create Customer Contact`unleashed_create_customer_contact`

Add a new contact to a customer

Update Customer Contact`unleashed_update_customer_contact`

Update an existing customer contact

Delete Customer Contact`unleashed_delete_customer_contact`

Delete a customer contact

List Delivery Methods`unleashed_list_delivery_methods`

List delivery methods configured for sales

List Invoices`unleashed_list_invoices`

List sales invoices

Get Invoice`unleashed_get_invoice`

Retrieve a single invoice by GUID

List Payment Terms`unleashed_list_payment_terms`

List payment terms configured in the account

List Product Brands`unleashed_list_product_brands`

List product brands

List Product Groups`unleashed_list_product_groups`

List product groups (including nested sub-groups)

List Products`unleashed_list_products`

List products with filtering and pagination

Get Product`unleashed_get_product`

Retrieve a single product by GUID

Create Product`unleashed_create_product`

Create a new product record

Update Product`unleashed_update_product`

Update an existing product (full overwrite)

Obsolete Product`unleashed_obsolete_product`

Mark a product as obsolete

List Purchase Orders`unleashed_list_purchase_orders`

List purchase orders with filtering and pagination

Get Purchase Order`unleashed_get_purchase_order`

Retrieve a single purchase order by GUID

Create Purchase Order`unleashed_create_purchase_order`

Create a new purchase order

Update Purchase Order`unleashed_update_purchase_order`

Update an existing purchase order

Delete Purchase Order`unleashed_delete_purchase_order`

Delete a purchase order

Receipt Purchase Order`unleashed_receipt_purchase_order`

Mark a purchase order as receipted (received)

Create Purchase Order Line`unleashed_create_purchase_order_line`

Add a line item to an existing purchase order

Complete Purchase Order`unleashed_complete_purchase_order`

Mark a purchase order as completed

Update Purchase Order Line`unleashed_update_purchase_order_line`

Update a single line on a purchase order

List Sales Order Groups`unleashed_list_sales_order_groups`

List sales order groups configured in the account

List Sales Orders`unleashed_list_sales_orders`

List sales orders with filtering and pagination

Get Sales Order`unleashed_get_sales_order`

Retrieve a single sales order by GUID

Create Sales Order`unleashed_create_sales_order`

Create a new sales order

Update Sales Order`unleashed_update_sales_order`

Update an existing sales order

Create Sales Order Line`unleashed_create_sales_order_line`

Add a line item to an existing sales order

Delete Sales Order`unleashed_delete_sales_order`

Delete a sales order

Complete Sales Order`unleashed_complete_sales_order`

Mark a sales order as completed

List Sales Shipments`unleashed_list_sales_shipments`

List sales shipments associated with sales orders

Get Sales Shipment`unleashed_get_sales_shipment`

Retrieve a single shipment by GUID

List Salespersons`unleashed_list_salespersons`

List salespersons configured in the account

List Sell Price Tiers`unleashed_list_sell_price_tiers`

List configured sell price tiers

List Stock Adjustments`unleashed_list_stock_adjustments`

List stock adjustments made to inventory levels

Create Stock Adjustment`unleashed_create_stock_adjustment`

Create a stock adjustment to modify inventory levels

Get Stock Adjustment`unleashed_get_stock_adjustment`

Retrieve a single stock adjustment by GUID

List Stock Counts`unleashed_list_stock_counts`

List stock count records for inventory reconciliation

Get Stock Count`unleashed_get_stock_count`

Retrieve a single stock count by GUID

List Stock On Hand`unleashed_list_stock_on_hand`

List current inventory levels across products and warehouses

Get Stock On Hand`unleashed_get_stock_on_hand`

Retrieve stock on hand for a specific product (default warehouse)

List Stock On Hand For Product Across All Warehouses`unleashed_list_stock_on_hand_all_warehouses`

Retrieve stock on hand quantities for one product across every warehouse

List Suppliers`unleashed_list_suppliers`

List suppliers configured in Unleashed

Get Supplier`unleashed_get_supplier`

Retrieve a single supplier by GUID

List Supplier Return Reasons`unleashed_list_supplier_return_reasons`

List supplier return reasons

List Taxes`unleashed_list_taxes`

List configured taxes

List Units Of Measure`unleashed_list_unit_of_measures`

List units of measure

List Warehouse Stock Transfers`unleashed_list_warehouse_stock_transfers`

List stock transfer orders between warehouses

Create Warehouse Stock Transfer`unleashed_create_warehouse_stock_transfer`

Create a stock transfer order between warehouses

Get Warehouse Stock Transfer`unleashed_get_warehouse_stock_transfer`

Retrieve a single transfer by GUID

Complete Warehouse Stock Transfer`unleashed_complete_warehouse_stock_transfer`

Complete a parked transfer so the stock moves between warehouses

List Warehouses`unleashed_list_warehouses`

List warehouses configured for inventory

## Events

Tags

Select all
|
Clear

Assemblies

Credit Notes

Customers

Products

Purchase Orders

Sales Orders

Sales Shipments

Supplier Returns

Warehouse Stock Transfers

Webhooks

No tags found

24 events

EventDescriptionTags

Ping`unleashed_webhook_ping`

Responds with 200 OK to any request without an EventType, without emitting an event.

Webhooks

Assembly Updated`unleashed_webhook_assembly_updated`

Fired when an assembly is changed in Unleashed.

AssembliesWebhooks

Assembly Deleted`unleashed_webhook_assembly_deleted`

Fired when an assembly is deleted in Unleashed.

AssembliesWebhooks

Credit Note Created`unleashed_webhook_credit_note_created`

Fired when a credit note is created in Unleashed.

Credit NotesWebhooks

Credit Note Deleted`unleashed_webhook_credit_note_deleted`

Fired when a credit note is deleted in Unleashed.

Credit NotesWebhooks

Customer Created`unleashed_webhook_customer_created`

Fired when a customer is created in Unleashed.

CustomersWebhooks

Customer Updated`unleashed_webhook_customer_updated`

Fired when a customer is changed in Unleashed.

CustomersWebhooks

Customer Deleted`unleashed_webhook_customer_deleted`

Fired when a customer is deleted in Unleashed.

CustomersWebhooks

Product Created`unleashed_webhook_product_created`

Fired when a product is created in Unleashed.

ProductsWebhooks

Product Updated`unleashed_webhook_product_updated`

Fired when a product is changed in Unleashed.

ProductsWebhooks

Product Deleted`unleashed_webhook_product_deleted`

Fired when a product is deleted in Unleashed.

ProductsWebhooks

Purchase Order Created`unleashed_webhook_purchase_order_created`

Fired when a purchase order is created in Unleashed.

Purchase OrdersWebhooks

Purchase Order Deleted`unleashed_webhook_purchase_order_deleted`

Fired when a purchase order is deleted in Unleashed.

Purchase OrdersWebhooks

Sales Order Created`unleashed_webhook_sales_order_created`

Fired when a sales order is created in Unleashed.

Sales OrdersWebhooks

Sales Order Updated`unleashed_webhook_sales_order_updated`

Fired when a sales order is changed in Unleashed.

Sales OrdersWebhooks

Sales Order Deleted`unleashed_webhook_sales_order_deleted`

Fired when a sales order is deleted in Unleashed.

Sales OrdersWebhooks

Sales Shipment Created`unleashed_webhook_sales_shipment_created`

Fired when a sales shipment is created in Unleashed.

Sales ShipmentsWebhooks

Sales Shipment Updated`unleashed_webhook_sales_shipment_updated`

Fired when a sales shipment is changed in Unleashed.

Sales ShipmentsWebhooks

Sales Shipment Deleted`unleashed_webhook_sales_shipment_deleted`

Fired when a sales shipment is deleted in Unleashed.

Sales ShipmentsWebhooks

Supplier Return Created`unleashed_webhook_supplier_return_created`

Fired when a supplier return is created in Unleashed.

Supplier ReturnsWebhooks

Supplier Return Updated`unleashed_webhook_supplier_return_updated`

Fired when a supplier return is changed in Unleashed.

Supplier ReturnsWebhooks

Supplier Return Deleted`unleashed_webhook_supplier_return_deleted`

Fired when a supplier return is deleted in Unleashed.

Supplier ReturnsWebhooks

Warehouse Stock Transfer Updated`unleashed_webhook_warehouse_stock_transfer_updated`

Fired when a warehouse stock transfer is changed in Unleashed.

Warehouse Stock TransfersWebhooks

Warehouse Stock Transfer Deleted`unleashed_webhook_warehouse_stock_transfer_deleted`

Fired when a warehouse stock transfer is deleted in Unleashed.

Warehouse Stock TransfersWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.