Unleashed MCP

An Unleashed MCP connector for stock, products, sales orders and purchasing. Explore the coverage and join the access waitlist.

Inventory and orders

What is Unleashed MCP?

MCP XYZ is building an independent Unleashed MCP connector so an AI assistant can work with authorised inventory and order records through the Model Context Protocol. The connector covers documented Unleashed API operations; new access is by invitation from the waitlist, and live business workflows still need validation.

Use the catalogue to check the operations and fields your work needs. If an existing connector is missing a useful action, tell us about it when joining the waitlist. Your software’s permissions and API limits still apply.

Unleashed workflows to explore

Check stock and warehouse records

Explore documented product, stock-on-hand and warehouse operations for questions about inventory across your business.

Inspect documented operations →

Find sales orders and line items

Inspect sales-order and customer operations, including the products, quantities and prices retained in their documented fields.

Inspect documented operations →

Work with purchasing and supplier records

Review the purchase-order, receipt and supplier coverage before planning an authorised purchasing workflow.

Inspect documented operations →

Example request to try after setup and validation

“Show stock on hand by warehouse for this product.”

Getting access to Unleashed MCP

New access starts with the Unleashed waitlist. Tell us which assistant you use and the work you want to do. We’ll contact you about relevant access updates; joining does not create an account or guarantee an invitation date.

Once invited, sign in to MCP XYZ, choose your workspace and add the API ID and key for your authorised Unleashed account. Run the connection check, then add its MCP URL to your assistant. Saved credentials alone do not verify a connection.

Unleashed API documentation ↗

Start with read-only access while you explore. Jiffi can handle setup with you. Live business workflows still need validation against an authorised account.

In Claude Desktop or web, open Settings → Connectors → Add custom connector, enter your connection’s MCP URL, then connect and choose access in MCP XYZ.

Join the Unleashed waitlist Existing user? Log in →

Unleashed MCP questions

What is the Unleashed MCP from MCP XYZ?

It is an independent connector being built by Jiffi to expose documented Unleashed API operations through the Model Context Protocol. It is intended to let an authorised AI assistant request inventory, customer, supplier and order information from your Unleashed account.

Can I use Unleashed MCP with Claude or ChatGPT?

MCP XYZ connection and tool-discovery flows have been tested with Claude Desktop and web, Codex and Claude Code. Those checks did not verify live Unleashed business requests. ChatGPT acceptance has not yet been verified. Tell us which assistant you use when joining the waitlist.

What Unleashed access will I need?

After an access invitation, setup requires an authorised Unleashed account with API access, its API ID and API key, and an MCP XYZ workspace. Your account permissions and the provider’s API limits still apply. Never put API keys into the waitlist form.

Can this connector update orders or inventory?

The documented catalogue includes reads and writes. A documented write does not establish a tested business workflow. Changes require the relevant permissions and validation in an authorised scope; ambiguous mutating requests are not automatically retried.

How do I get access, and what does it cost?

Join the Unleashed waitlist and describe the job you want to do. We will contact you about access; joining does not create an account or guarantee a launch date. MCP access is included for clients under contract with Jiffi. Standalone access and any applicable terms are discussed before activation.

Read the AI client guide → How access and permissions work →

Documented coverage

Operations and fields

View a Product with the specified Guid

/Products/{productGuid}Inspect fields and contract →

Documented contract, live behaviour unverified

View a Product with the specified Guid

unleashed_get_products

GET/Products/{productGuid}

Read the provider documentation ↗

Unresolved behaviour

No authenticated sandbox or production request has verified this operation.

Path parameters

Parameter	Required	Provider description
`productGuid`	Yes	Provider identifier from the corresponding resource; preserve the documented identifier type.

Query parameters and filters

Parameter	Required	Provider description
`brief`	No	If set to true , returns a brief summary of the Product list that only includes: Guid, ProductCode, ProductDescription, DefaultPurchasePrice, DefaultSellPrice, SellPriceTier1, DefaultSupplierId.
`customerCode`	No	If you have added customer specific product prices, the list of Product(s) will be displayed. The CustomerSellPrice field will display the customer price.
`excludeAssembled`	No	If set to true , assembled Products will not be displayed.
`excludeComponents`	No	If set to true , component Products will not be displayed.
`includeAttributes`	No	If set to true , returns the attributes associated with the requested Product.
`includeObsolete`	No	If set to true , returns all Products, including obsolete. If set to false or if it is not specified then returns only active (i.e. non-obsolete) Products.
`modifiedSince`	No	Returns Products created or modified since the specified date.
`orderBy`	No	Orders the list by LastModifiedOn or CreatedOn date. By default the list is ordered by `ProductCode`.
`pageSize`	No	Specifies the page size for pagination. Default page size is 200 Products. Note: Requesting large numbers of products can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
`product`	No	Only returns Products that contain the term in the code or description.
`ProductBarcode`	No	Only returns Products with the specific product barcode.
`productBrand`	No	Only returns Products with the specific product brand.
`productCode`	No	Returns Products that start with the specific product code.
`productDescription`	No	Returns Products that start with the specific product description.
`productGroup`	No	Returns Products with the specific product group. Does not work for sub groups.
`productId`	No	Returns Products with the specific product id. You can enter multiple product Ids separated by commas.
`smart`	No	If set to true , overrides all other filters and returns all Products currently in stock, and those that have been in stock in the last 6 months.
`sort`	No	Orders the list by CreatedOn date sorted in ascending or descending order.

Retained Products field and filter tables

These source tables cover the resource’s documented methods. Read each table’s heading for its request or response context.

Available Fields for GET Products

GET Products

Property	Type	Length
AlternateUnitsOfMeasure	AlternateUnitOfMeasure collection
AutomaticChargeCost	Nullable Decimal
AverageLandPrice	Nullable Decimal
Barcode	String	200
BinLocation	String	50
CommerceCode	String	14
Comments	String	1024
CopyCommentsForPurchases	Boolean
CopyCommentsForSales	Boolean
CreatedBy	String	50
CreatedOn	Nullable DateTime
CustomerSellPrice	Nullable Decimal
CustomsDescription	String	500
DefaultPurchasePrice	Nullable Decimal
DefaultSellPrice	Nullable Decimal
Depth	Nullable Decimal
DefaultPurchasesUnitOfMeasure	UnitOfMeasure
Guid	Guid
Height	Nullable Decimal
ICCCountryCode	String	2
ICCCountryName	String	100
Images	Image collection
ImageUrl	String
InventoryDetails	InventoryDetail collection
IsAssembledProduct	Boolean	true , false
IsBatchTracked	Boolean	true , false
IsComponent	Boolean	true , false
IsSellable	Boolean	true , false
IsPurchasable	Boolean	true , false
IsSerialized	Boolean	true , false
LastCost	Nullable Decimal
LastModifiedBy	String	50
LastModifiedOn	Nullable DateTime
MaxStockAlertLevel	Nullable Decimal
MinStockAlertLevel	Nullable Decimal
MinimumOrderQuantity	Nullable Decimal
MinimumSaleQuantity	Nullable Decimal
MinimumSellPrice	Nullable Decimal
NeverDiminishing	Nullable Boolean	true , false
NominalCost	Nullable Decimal
Notes	String	1024
Obsolete	Boolean	true , false
PackSize	Nullable Decimal
ProductBrand	ProductBrand
ProductCode	String	100
ProductDescription	String	500
ProductGroup	ProductGroup
ProductSubGroup	ProductGroup
PurchaseAccount	String	50
Reminder	String	1024
SellPriceTier1	SellPriceTier
SellPriceTier2	SellPriceTier
SellPriceTier3	SellPriceTier
SellPriceTier4	SellPriceTier
SellPriceTier5	SellPriceTier
SellPriceTier6	SellPriceTier
SellPriceTier7	SellPriceTier
SellPriceTier8	SellPriceTier
SellPriceTier9	SellPriceTier
SellPriceTier10	SellPriceTier
SourceId	String	500
SourceVariantParentId	String
SupplementaryClassificationAbbreviation	String
Supplier	SupplierWithProductCode
TaxablePurchase	Nullable Boolean	true , false
TaxableSales	Nullable Boolean	true , false
UnitOfMeasure	UnitOfMeasure
Weight	Nullable Decimal
Width	Nullable Decimal
XeroCostOfGoodsAccount	String	50
XeroSalesAccount	String	50
XeroSalesTaxCode	String	50
XeroSalesTaxRate	Nullable Decimal
XeroTaxCode	String	50
XeroTaxRate	Nullable Decimal

Available Fields for Alternate Unit Of Measure

GET Products

Property	Type	Length
Barcode	String	200
ConversionRate	Decimal
CubicTotal	Nullable Decimal
Depth	Nullable Decimal
ForPurchases	Boolean
Guid	Guid
Height	Nullable Decimal
Name	String	20
PackSize	Nullable Decimal
Weight	Nullable Decimal
Width	Nullable Decimal

Available Fields for Image

GET Products

Property	Type	Length
IsDefault	Boolean	true , false
Url	String

Available Fields for Inventory Detail

GET Products

Property	Type	Length
BinLocation	String	50
WarehouseMinStockAlertLevel	Nullable Decimal
WarehouseMaxStockAlertLevel	Nullable Decimal
Warehouse	Warehouse

Available Fields for Product Brand

GET Products

Property	Type	Length
BrandName	String	50
Guid	Guid
LastModifiedOn	Nullable DateTime

Available Fields for Product Group

GET Products

Property	Type	Length
Guid	Guid
GroupName	String	450
LastModifiedOn	Nullable DateTime
ParentGroupGuid	Guid

Available Fields for Supplier With Product Code

GET Products

Property	Type	Length
Guid	Guid
LeadTimeDays	Nullable Integer
MinimumOrderQuantity	Nullable Decimal
SupplierCode	String	500
SupplierName	String	500
SupplierProductCode	String	100
SupplierProductDescription	String	500
SupplierProductPrice	Nullable Decimal
UnitOfMeasure	UnitOfMeasure

Available Fields for Unit Of Measure

GET Products

Property	Type	Length
Guid	Guid
Name	String	20
Obsolete	Boolean

Available Fields for Warehouse

GET Products

Property	Type	Length
Guid	Guid
WarehouseCode	String	15
WarehouseName	String	100

Available Request Fields for POST Products

POST Products

Property	Type	Length	Required	Notes
AlternateUnitsOfMeasure	AlternateUnitOfMeasure collection
AutomaticChargeCost	Nullable Decimal			Only applicable if Automatic Product Charge is toggled on.
Barcode	String	200		If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the "EA" unit.
BinLocation	String	50		Only applicable if Per Warehouse Controls are toggled off.
CommerceCode	String	14		'International Commerce Codes' setting must be enabled to update this field. Only digits 0 - 9 can be entered.
Comments	String	1024
CopyCommentsForPurchases	Boolean
CopyCommentsForSales	Boolean
CustomsDescription	String	500		'International Commerce Codes' setting must be enabled to update this field. A simplified description of the product to appear on a commercial invoice.
DefaultPurchasePrice	Nullable Decimal
DefaultSellPrice	Nullable Decimal
Depth	Nullable Decimal			If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the "EA" unit.
DefaultPurchasesUnitOfMeasure	UnitOfMeasure			The Purchasing default unit of measure. Must be either the base UoM or a valid Alternate UoM.
Guid	Guid		Optional	Required to update an existing Product if not provided in the URI. Automatically generates a Guid if not provided when creating a new Product.
Height	Nullable Decimal			If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the "EA" unit.
ICCCountryCode	String	2		'International Commerce Codes' setting must be enabled to update this field. Use 2 two-letter country codes following ISO 3166-1 alpha-2.
ICCCountryName	String	100		'International Commerce Codes' setting must be enabled to update this field. We will apply the correct ICC country based on the ICCCountryCode.
IsAssembledProduct	Boolean	true , false		If omitted or null will be set to false . Cannot be set to true if NeverDiminishing is true . Cannot be updated to false while the product has an active BOM.
IsBatchTracked	Boolean	true , false		Mututally exclusive from IsSerialized and IsNeverDiminishing. If omitted or null will be set to false . Cannot be changed while Product has open transactions or SOH > 0.
IsComponent	Boolean	true , false
IsSellable	Boolean	true , false		Default is True. If you do not want the product to be available on the Sales Quotes / Sales Orders, you must set it to False.
IsSerialized	Boolean	true , false		Mututally exclusive from IsBatchTracked and IsNeverDiminishing. If omitted or null will be set to false . Cannot be changed while Product has open transactions or SOH > 0.
IsPurchasable	Boolean	true , false		Default is True. If you do not want the product to be available to Purchase, you must set it to False.
LastCost	Nullable Decimal			Only updatable if the product is Never Diminishing AND Stock On Hand is zero.
MaxStockAlertLevel	Nullable Decimal
MinStockAlertLevel	Nullable Decimal
MinimumOrderQuantity	Nullable Decimal			Null or missing property will not override existing information.
MinimumSaleQuantity	Nullable Decimal			Null or missing property will not override existing information.
MinimumSellPrice	Nullable Decimal			Null or missing property will not override existing information. Products will not be sold below this amount. The value cannot be lower than the default sell price.
NeverDiminishing	Nullable Boolean	true , false		Mutually exclusive from IsSerialized and IsBatchTracked. Cannot be enabled while Product has open transactions or SOH > 0.
NominalCost	Nullable Decimal
Notes	String
Obsolete	Boolean	true , false		Cannot be set to true while Product has open transactions or SOH > 0
PackSize	Nullable Decimal			If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the "EA" unit.
ProductBrand	ProductBrand
ProductCode	String	100	Yes	Unique code. Can only be set when adding a record.
ProductDescription	String	500	Yes
ProductGroup	ProductGroup
ProductSubGroup	ProductGroup			Must be a child of the provided ProductGroup.
PurchaseAccount	String	50
Reminder	String	1024
SellPriceTier1	SellPriceTier
SellPriceTier2	SellPriceTier
SellPriceTier3	SellPriceTier
SellPriceTier4	SellPriceTier
SellPriceTier5	SellPriceTier
SellPriceTier6	SellPriceTier
SellPriceTier7	SellPriceTier
SellPriceTier8	SellPriceTier
SellPriceTier9	SellPriceTier
SellPriceTier10	SellPriceTier
SupplementaryClassificationAbbreviation	String	2		'International Commerce Codes' setting must be enabled to update this field. Not required but validated. Refer to the drop-down lists on any Product page for accepted values, or leave the field blank.
Supplier	SupplierWithProductCode			The Purchasing default Supplier, cannot be an obsolete Supplier.
TaxablePurchase	Nullable Boolean	true , false		Will be set to true when XeroTaxRate > 0 even if posting false . Will be set to true when both XeroTaxCode & XeroTaxRate are null
TaxableSales	Nullable Boolean	true , false		Will be set to true when XeroSalesTaxRate > 0 even if posting false . Will be set to true when both XeroSalesTaxCode & XeroSalesTaxRate are null
UnitOfMeasure	UnitOfMeasure		*See Notes	Cannot update while Product has Alternate Units of Measure. If left unspecified and a dimension is given then will be set to the "EA" unit.
Weight	Nullable Decimal			If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the "EA" unit.
Width	Nullable Decimal			If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the "EA" unit.
XeroCostOfGoodsAccount	String	50
XeroSalesAccount	String	50
XeroSalesTaxCode	String	50
XeroSalesTaxRate	Nullable Decimal
XeroTaxCode	String	50
XeroTaxRate	Nullable Decimal

Available Request Fields for Alternate Unit Of Measure

POST Products

Property	Type	Length	Required	Notes
Barcode	String	200
ConversionRate	Decimal		Yes
Depth	Decimal
ForPurchases	Boolean		Yes	Defaults to true
Guid	Guid
Height	Decimal
Name	String	20
PackSize	Decimal
Weight	Decimal
Width	Decimal

Available Request Fields for Product Brand

POST Products

Property	Type	Length	Required
BrandName	String	50
Guid	Guid		Yes

Available Request Fields for Product Group

POST Products

Property	Type	Length	Required
GroupName	String	450
Guid	Guid		Yes

Available Request Fields for Supplier With Product Code

POST Products

Property	Type	Length	Required	Notes
Guid	Guid		Yes
LeadTimeDays	Integer
MinimumOrderQuantity	Decimal			Cannot be negative.
SupplierCode	String	500
SupplierName	String	500
SupplierProductCode	String	100		If empty or whitespace will overwrite existing value
SupplierProductDescription	String	500
SupplierProductPrice	Decimal			Cannot be negative unless the Product is Never Diminishing.
UnitOfMeasure	UnitOfMeasure			Must be either the base UoM or a valid Alternate UoM.

Available Request Fields for Unit Of Measure

POST Products

Property	Type	Length
Guid	Guid
Name	String	20
Obsolete	Boolean

Available Filters for GET Products

GET Products

Filter	Description
brief	If set to true , returns a brief summary of the Product list that only includes: Guid, ProductCode, ProductDescription, DefaultPurchasePrice, DefaultSellPrice, SellPriceTier1, DefaultSupplierId.
customerCode	If you have added customer specific product prices, the list of Product(s) will be displayed. The CustomerSellPrice field will display the customer price.
excludeAssembled	If set to true , assembled Products will not be displayed.
excludeComponents	If set to true , component Products will not be displayed.
includeAttributes	If set to true , returns the attributes associated with the requested Product.
includeObsolete	If set to true , returns all Products, including obsolete. If set to false or if it is not specified then returns only active (i.e. non-obsolete) Products.
modifiedSince	Returns Products created or modified since the specified date.
orderBy	Orders the list by LastModifiedOn or CreatedOn date. By default the list is ordered by `ProductCode`.
pageSize	Specifies the page size for pagination. Default page size is 200 Products. Note: Requesting large numbers of products can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.
product	Only returns Products that contain the term in the code or description.
ProductBarcode	Only returns Products with the specific product barcode.
productBrand	Only returns Products with the specific product brand.
productCode	Returns Products that start with the specific product code.
productDescription	Returns Products that start with the specific product description.
productGroup	Returns Products with the specific product group. Does not work for sub groups.
productId	Returns Products with the specific product id. You can enter multiple product Ids separated by commas.
smart	If set to true , overrides all other filters and returns all Products currently in stock, and those that have been in stock in the last 6 months.
sort	Orders the list by CreatedOn date sorted in ascending or descending order.

Inspect the complete operation contract

The exact retained JSON includes schemas, nested fields, notes, source evidence and unresolved questions. It is a documented contract, not a live response.

{
  "id": "get_products",
  "name": "unleashed_get_products",
  "resourceId": "Products",
  "description": "View a Product with the specified Guid",
  "method": "GET",
  "path": "/Products/{productGuid}",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/Products",
  "readOnly": true,
  "destructive": false,
  "idempotent": true,
  "pathParameters": [
    {
      "name": "productGuid",
      "required": true,
      "schema": {
        "type": "string",
        "minLength": 1
      },
      "description": "Provider identifier from the corresponding resource; preserve the documented identifier type."
    }
  ],
  "queryParameters": [
    {
      "name": "brief",
      "required": false,
      "description": "If set to true , returns a brief summary of the Product list that only includes: Guid, ProductCode, ProductDescription, DefaultPurchasePrice, DefaultSellPrice, SellPriceTier1, DefaultSupplierId.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "If set to true , returns a brief summary of the Product list that only includes: Guid, ProductCode, ProductDescription, DefaultPurchasePrice, DefaultSellPrice, SellPriceTier1, DefaultSupplierId."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "customerCode",
      "required": false,
      "description": "If you have added customer specific product prices, the list of Product(s) will be displayed. The CustomerSellPrice field will display the customer price.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "If you have added customer specific product prices, the list of Product(s) will be displayed. The CustomerSellPrice field will display the customer price."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "excludeAssembled",
      "required": false,
      "description": "If set to true , assembled Products will not be displayed.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "If set to true , assembled Products will not be displayed."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "excludeComponents",
      "required": false,
      "description": "If set to true , component Products will not be displayed.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "If set to true , component Products will not be displayed."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "includeAttributes",
      "required": false,
      "description": "If set to true , returns the attributes associated with the requested Product.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "If set to true , returns the attributes associated with the requested Product."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "includeObsolete",
      "required": false,
      "description": "If set to true , returns all Products, including obsolete. If set to false or if it is not specified then returns only active (i.e. non-obsolete) Products.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "If set to true , returns all Products, including obsolete. If set to false or if it is not specified then returns only active (i.e. non-obsolete) Products."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "modifiedSince",
      "required": false,
      "description": "Returns Products created or modified since the specified date.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns Products created or modified since the specified date."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "orderBy",
      "required": false,
      "description": "Orders the list by LastModifiedOn or CreatedOn date. By default the list is ordered by `ProductCode`.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Orders the list by LastModifiedOn or CreatedOn date. By default the list is ordered by `ProductCode`."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "pageSize",
      "required": false,
      "description": "Specifies the page size for pagination. Default page size is 200 Products. Note: Requesting large numbers of products can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests.",
      "schema": {
        "type": "integer",
        "minimum": 1,
        "maximum": 1000,
        "description": "Specifies the page size for pagination. Default page size is 200 Products. Note: Requesting large numbers of products can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "product",
      "required": false,
      "description": "Only returns Products that contain the term in the code or description.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Only returns Products that contain the term in the code or description."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "ProductBarcode",
      "required": false,
      "description": "Only returns Products with the specific product barcode.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Only returns Products with the specific product barcode."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "productBrand",
      "required": false,
      "description": "Only returns Products with the specific product brand.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Only returns Products with the specific product brand."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "productCode",
      "required": false,
      "description": "Returns Products that start with the specific product code.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns Products that start with the specific product code."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "productDescription",
      "required": false,
      "description": "Returns Products that start with the specific product description.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns Products that start with the specific product description."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "productGroup",
      "required": false,
      "description": "Returns Products with the specific product group. Does not work for sub groups.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns Products with the specific product group. Does not work for sub groups."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "productId",
      "required": false,
      "description": "Returns Products with the specific product id. You can enter multiple product Ids separated by commas.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Returns Products with the specific product id. You can enter multiple product Ids separated by commas."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "smart",
      "required": false,
      "description": "If set to true , overrides all other filters and returns all Products currently in stock, and those that have been in stock in the last 6 months.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "If set to true , overrides all other filters and returns all Products currently in stock, and those that have been in stock in the last 6 months."
      },
      "sourceSection": "Available Filters for GET Products"
    },
    {
      "name": "sort",
      "required": false,
      "description": "Orders the list by CreatedOn date sorted in ascending or descending order.",
      "schema": {
        "type": [
          "string",
          "number",
          "boolean"
        ],
        "description": "Orders the list by CreatedOn date sorted in ascending or descending order."
      },
      "sourceSection": "Available Filters for GET Products"
    }
  ],
  "requestBodySchema": null,
  "responseSchema": null,
  "pagination": null,
  "notes": [],
  "provenance": [
    {
      "sourceUrl": "https://apidocs.unleashedsoftware.com/Products",
      "sourceSha256": "dcca8be715459fd3fc595a6d0f3f8e795112fbc14805f09b421e4f97e47209a4",
      "section": "The full range of URIs and HTTP Verbs supported are",
      "evidence": "GET /Products/{productGuid}",
      "operationDescriptions": [
        "View a Product with the specified Guid"
      ]
    }
  ],
  "confidence": "documented-route",
  "unresolved": [
    "No authenticated sandbox or production request has verified this operation."
  ],
  "requestFieldTable": null,
  "responseFieldTable": "Available Fields for GET Products"
}

Inspect the complete resource record

{
  "id": "Products",
  "name": "Products",
  "group": "Editable resources",
  "documentationUrl": "https://apidocs.unleashedsoftware.com/Products",
  "snapshot": "snapshots/Products.html",
  "sourceSha256": "dcca8be715459fd3fc595a6d0f3f8e795112fbc14805f09b421e4f97e47209a4",
  "fetchedAt": "2026-10-23T14:00:32.676308+00:00",
  "operationIds": [
    "list_products",
    "get_products",
    "create_or_update_products",
    "create_or_update_products_with_guid",
    "obsolete_products"
  ],
  "fieldTables": [
    {
      "heading": "GET Products",
      "anchor": "get-products",
      "summary": "Available Fields for GET Products",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "AlternateUnitsOfMeasure",
          "AlternateUnitOfMeasure collection",
          ""
        ],
        [
          "AutomaticChargeCost",
          "Nullable Decimal",
          ""
        ],
        [
          "AverageLandPrice",
          "Nullable Decimal",
          ""
        ],
        [
          "Barcode",
          "String",
          "200"
        ],
        [
          "BinLocation",
          "String",
          "50"
        ],
        [
          "CommerceCode",
          "String",
          "14"
        ],
        [
          "Comments",
          "String",
          "1024"
        ],
        [
          "CopyCommentsForPurchases",
          "Boolean",
          ""
        ],
        [
          "CopyCommentsForSales",
          "Boolean",
          ""
        ],
        [
          "CreatedBy",
          "String",
          "50"
        ],
        [
          "CreatedOn",
          "Nullable DateTime",
          ""
        ],
        [
          "CustomerSellPrice",
          "Nullable Decimal",
          ""
        ],
        [
          "CustomsDescription",
          "String",
          "500"
        ],
        [
          "DefaultPurchasePrice",
          "Nullable Decimal",
          ""
        ],
        [
          "DefaultSellPrice",
          "Nullable Decimal",
          ""
        ],
        [
          "Depth",
          "Nullable Decimal",
          ""
        ],
        [
          "DefaultPurchasesUnitOfMeasure",
          "UnitOfMeasure",
          ""
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "Height",
          "Nullable Decimal",
          ""
        ],
        [
          "ICCCountryCode",
          "String",
          "2"
        ],
        [
          "ICCCountryName",
          "String",
          "100"
        ],
        [
          "Images",
          "Image collection",
          ""
        ],
        [
          "ImageUrl",
          "String",
          ""
        ],
        [
          "InventoryDetails",
          "InventoryDetail collection",
          ""
        ],
        [
          "IsAssembledProduct",
          "Boolean",
          "true , false"
        ],
        [
          "IsBatchTracked",
          "Boolean",
          "true , false"
        ],
        [
          "IsComponent",
          "Boolean",
          "true , false"
        ],
        [
          "IsSellable",
          "Boolean",
          "true , false"
        ],
        [
          "IsPurchasable",
          "Boolean",
          "true , false"
        ],
        [
          "IsSerialized",
          "Boolean",
          "true , false"
        ],
        [
          "LastCost",
          "Nullable Decimal",
          ""
        ],
        [
          "LastModifiedBy",
          "String",
          "50"
        ],
        [
          "LastModifiedOn",
          "Nullable DateTime",
          ""
        ],
        [
          "MaxStockAlertLevel",
          "Nullable Decimal",
          ""
        ],
        [
          "MinStockAlertLevel",
          "Nullable Decimal",
          ""
        ],
        [
          "MinimumOrderQuantity",
          "Nullable Decimal",
          ""
        ],
        [
          "MinimumSaleQuantity",
          "Nullable Decimal",
          ""
        ],
        [
          "MinimumSellPrice",
          "Nullable Decimal",
          ""
        ],
        [
          "NeverDiminishing",
          "Nullable Boolean",
          "true , false"
        ],
        [
          "NominalCost",
          "Nullable Decimal",
          ""
        ],
        [
          "Notes",
          "String",
          "1024"
        ],
        [
          "Obsolete",
          "Boolean",
          "true , false"
        ],
        [
          "PackSize",
          "Nullable Decimal",
          ""
        ],
        [
          "ProductBrand",
          "ProductBrand",
          ""
        ],
        [
          "ProductCode",
          "String",
          "100"
        ],
        [
          "ProductDescription",
          "String",
          "500"
        ],
        [
          "ProductGroup",
          "ProductGroup",
          ""
        ],
        [
          "ProductSubGroup",
          "ProductGroup",
          ""
        ],
        [
          "PurchaseAccount",
          "String",
          "50"
        ],
        [
          "Reminder",
          "String",
          "1024"
        ],
        [
          "SellPriceTier1",
          "SellPriceTier",
          ""
        ],
        [
          "SellPriceTier2",
          "SellPriceTier",
          ""
        ],
        [
          "SellPriceTier3",
          "SellPriceTier",
          ""
        ],
        [
          "SellPriceTier4",
          "SellPriceTier",
          ""
        ],
        [
          "SellPriceTier5",
          "SellPriceTier",
          ""
        ],
        [
          "SellPriceTier6",
          "SellPriceTier",
          ""
        ],
        [
          "SellPriceTier7",
          "SellPriceTier",
          ""
        ],
        [
          "SellPriceTier8",
          "SellPriceTier",
          ""
        ],
        [
          "SellPriceTier9",
          "SellPriceTier",
          ""
        ],
        [
          "SellPriceTier10",
          "SellPriceTier",
          ""
        ],
        [
          "SourceId",
          "String",
          "500"
        ],
        [
          "SourceVariantParentId",
          "String",
          ""
        ],
        [
          "SupplementaryClassificationAbbreviation",
          "String",
          ""
        ],
        [
          "Supplier",
          "SupplierWithProductCode",
          ""
        ],
        [
          "TaxablePurchase",
          "Nullable Boolean",
          "true , false"
        ],
        [
          "TaxableSales",
          "Nullable Boolean",
          "true , false"
        ],
        [
          "UnitOfMeasure",
          "UnitOfMeasure",
          ""
        ],
        [
          "Weight",
          "Nullable Decimal",
          ""
        ],
        [
          "Width",
          "Nullable Decimal",
          ""
        ],
        [
          "XeroCostOfGoodsAccount",
          "String",
          "50"
        ],
        [
          "XeroSalesAccount",
          "String",
          "50"
        ],
        [
          "XeroSalesTaxCode",
          "String",
          "50"
        ],
        [
          "XeroSalesTaxRate",
          "Nullable Decimal",
          ""
        ],
        [
          "XeroTaxCode",
          "String",
          "50"
        ],
        [
          "XeroTaxRate",
          "Nullable Decimal",
          ""
        ]
      ]
    },
    {
      "heading": "GET Products",
      "anchor": "get-products",
      "summary": "Available Fields for Alternate Unit Of Measure",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Barcode",
          "String",
          "200"
        ],
        [
          "ConversionRate",
          "Decimal",
          ""
        ],
        [
          "CubicTotal",
          "Nullable Decimal",
          ""
        ],
        [
          "Depth",
          "Nullable Decimal",
          ""
        ],
        [
          "ForPurchases",
          "Boolean",
          ""
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "Height",
          "Nullable Decimal",
          ""
        ],
        [
          "Name",
          "String",
          "20"
        ],
        [
          "PackSize",
          "Nullable Decimal",
          ""
        ],
        [
          "Weight",
          "Nullable Decimal",
          ""
        ],
        [
          "Width",
          "Nullable Decimal",
          ""
        ]
      ]
    },
    {
      "heading": "GET Products",
      "anchor": "get-products",
      "summary": "Available Fields for Image",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "IsDefault",
          "Boolean",
          "true , false"
        ],
        [
          "Url",
          "String",
          ""
        ]
      ]
    },
    {
      "heading": "GET Products",
      "anchor": "get-products",
      "summary": "Available Fields for Inventory Detail",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "BinLocation",
          "String",
          "50"
        ],
        [
          "WarehouseMinStockAlertLevel",
          "Nullable Decimal",
          ""
        ],
        [
          "WarehouseMaxStockAlertLevel",
          "Nullable Decimal",
          ""
        ],
        [
          "Warehouse",
          "Warehouse",
          ""
        ]
      ]
    },
    {
      "heading": "GET Products",
      "anchor": "get-products",
      "summary": "Available Fields for Product Brand",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "BrandName",
          "String",
          "50"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "LastModifiedOn",
          "Nullable DateTime",
          ""
        ]
      ]
    },
    {
      "heading": "GET Products",
      "anchor": "get-products",
      "summary": "Available Fields for Product Group",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "GroupName",
          "String",
          "450"
        ],
        [
          "LastModifiedOn",
          "Nullable DateTime",
          ""
        ],
        [
          "ParentGroupGuid",
          "Guid",
          ""
        ]
      ]
    },
    {
      "heading": "GET Products",
      "anchor": "get-products",
      "summary": "Available Fields for Supplier With Product Code",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "LeadTimeDays",
          "Nullable Integer",
          ""
        ],
        [
          "MinimumOrderQuantity",
          "Nullable Decimal",
          ""
        ],
        [
          "SupplierCode",
          "String",
          "500"
        ],
        [
          "SupplierName",
          "String",
          "500"
        ],
        [
          "SupplierProductCode",
          "String",
          "100"
        ],
        [
          "SupplierProductDescription",
          "String",
          "500"
        ],
        [
          "SupplierProductPrice",
          "Nullable Decimal",
          ""
        ],
        [
          "UnitOfMeasure",
          "UnitOfMeasure",
          ""
        ]
      ]
    },
    {
      "heading": "GET Products",
      "anchor": "get-products",
      "summary": "Available Fields for Unit Of Measure",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "Name",
          "String",
          "20"
        ],
        [
          "Obsolete",
          "Boolean",
          ""
        ]
      ]
    },
    {
      "heading": "GET Products",
      "anchor": "get-products",
      "summary": "Available Fields for Warehouse",
      "rows": [
        [
          "Property",
          "Type",
          "Length"
        ],
        [
          "Guid",
          "Guid",
          ""
        ],
        [
          "WarehouseCode",
          "String",
          "15"
        ],
        [
          "WarehouseName",
          "String",
          "100"
        ]
      ]
    },
    {
      "heading": "POST Products",
      "anchor": "post-products",
      "summary": "Available Request Fields for POST Products",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Required",
          "Notes"
        ],
        [
          "AlternateUnitsOfMeasure",
          "AlternateUnitOfMeasure collection",
          "",
          "",
          ""
        ],
        [
          "AutomaticChargeCost",
          "Nullable Decimal",
          "",
          "",
          "Only applicable if Automatic Product Charge is toggled on."
        ],
        [
          "Barcode",
          "String",
          "200",
          "",
          "If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the \"EA\" unit."
        ],
        [
          "BinLocation",
          "String",
          "50",
          "",
          "Only applicable if Per Warehouse Controls are toggled off."
        ],
        [
          "CommerceCode",
          "String",
          "14",
          "",
          "'International Commerce Codes' setting must be enabled to update this field. Only digits 0 - 9 can be entered."
        ],
        [
          "Comments",
          "String",
          "1024",
          "",
          ""
        ],
        [
          "CopyCommentsForPurchases",
          "Boolean",
          "",
          "",
          ""
        ],
        [
          "CopyCommentsForSales",
          "Boolean",
          "",
          "",
          ""
        ],
        [
          "CustomsDescription",
          "String",
          "500",
          "",
          "'International Commerce Codes' setting must be enabled to update this field. A simplified description of the product to appear on a commercial invoice."
        ],
        [
          "DefaultPurchasePrice",
          "Nullable Decimal",
          "",
          "",
          ""
        ],
        [
          "DefaultSellPrice",
          "Nullable Decimal",
          "",
          "",
          ""
        ],
        [
          "Depth",
          "Nullable Decimal",
          "",
          "",
          "If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the \"EA\" unit."
        ],
        [
          "DefaultPurchasesUnitOfMeasure",
          "UnitOfMeasure",
          "",
          "",
          "The Purchasing default unit of measure. Must be either the base UoM or a valid Alternate UoM."
        ],
        [
          "Guid",
          "Guid",
          "",
          "Optional",
          "Required to update an existing Product if not provided in the URI. Automatically generates a Guid if not provided when creating a new Product."
        ],
        [
          "Height",
          "Nullable Decimal",
          "",
          "",
          "If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the \"EA\" unit."
        ],
        [
          "ICCCountryCode",
          "String",
          "2",
          "",
          "'International Commerce Codes' setting must be enabled to update this field. Use 2 two-letter country codes following ISO 3166-1 alpha-2."
        ],
        [
          "ICCCountryName",
          "String",
          "100",
          "",
          "'International Commerce Codes' setting must be enabled to update this field. We will apply the correct ICC country based on the ICCCountryCode."
        ],
        [
          "IsAssembledProduct",
          "Boolean",
          "true , false",
          "",
          "If omitted or null will be set to false . Cannot be set to true if NeverDiminishing is true . Cannot be updated to false while the product has an active BOM."
        ],
        [
          "IsBatchTracked",
          "Boolean",
          "true , false",
          "",
          "Mututally exclusive from IsSerialized and IsNeverDiminishing. If omitted or null will be set to false . Cannot be changed while Product has open transactions or SOH > 0."
        ],
        [
          "IsComponent",
          "Boolean",
          "true , false",
          "",
          ""
        ],
        [
          "IsSellable",
          "Boolean",
          "true , false",
          "",
          "Default is True. If you do not want the product to be available on the Sales Quotes / Sales Orders, you must set it to False."
        ],
        [
          "IsSerialized",
          "Boolean",
          "true , false",
          "",
          "Mututally exclusive from IsBatchTracked and IsNeverDiminishing. If omitted or null will be set to false . Cannot be changed while Product has open transactions or SOH > 0."
        ],
        [
          "IsPurchasable",
          "Boolean",
          "true , false",
          "",
          "Default is True. If you do not want the product to be available to Purchase, you must set it to False."
        ],
        [
          "LastCost",
          "Nullable Decimal",
          "",
          "",
          "Only updatable if the product is Never Diminishing AND Stock On Hand is zero."
        ],
        [
          "MaxStockAlertLevel",
          "Nullable Decimal",
          "",
          "",
          ""
        ],
        [
          "MinStockAlertLevel",
          "Nullable Decimal",
          "",
          "",
          ""
        ],
        [
          "MinimumOrderQuantity",
          "Nullable Decimal",
          "",
          "",
          "Null or missing property will not override existing information."
        ],
        [
          "MinimumSaleQuantity",
          "Nullable Decimal",
          "",
          "",
          "Null or missing property will not override existing information."
        ],
        [
          "MinimumSellPrice",
          "Nullable Decimal",
          "",
          "",
          "Null or missing property will not override existing information. Products will not be sold below this amount. The value cannot be lower than the default sell price."
        ],
        [
          "NeverDiminishing",
          "Nullable Boolean",
          "true , false",
          "",
          "Mutually exclusive from IsSerialized and IsBatchTracked. Cannot be enabled while Product has open transactions or SOH > 0."
        ],
        [
          "NominalCost",
          "Nullable Decimal",
          "",
          "",
          ""
        ],
        [
          "Notes",
          "String",
          "",
          "",
          ""
        ],
        [
          "Obsolete",
          "Boolean",
          "true , false",
          "",
          "Cannot be set to true while Product has open transactions or SOH > 0"
        ],
        [
          "PackSize",
          "Nullable Decimal",
          "",
          "",
          "If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the \"EA\" unit."
        ],
        [
          "ProductBrand",
          "ProductBrand",
          "",
          "",
          ""
        ],
        [
          "ProductCode",
          "String",
          "100",
          "Yes",
          "Unique code. Can only be set when adding a record."
        ],
        [
          "ProductDescription",
          "String",
          "500",
          "Yes",
          ""
        ],
        [
          "ProductGroup",
          "ProductGroup",
          "",
          "",
          ""
        ],
        [
          "ProductSubGroup",
          "ProductGroup",
          "",
          "",
          "Must be a child of the provided ProductGroup."
        ],
        [
          "PurchaseAccount",
          "String",
          "50",
          "",
          ""
        ],
        [
          "Reminder",
          "String",
          "1024",
          "",
          ""
        ],
        [
          "SellPriceTier1",
          "SellPriceTier",
          "",
          "",
          ""
        ],
        [
          "SellPriceTier2",
          "SellPriceTier",
          "",
          "",
          ""
        ],
        [
          "SellPriceTier3",
          "SellPriceTier",
          "",
          "",
          ""
        ],
        [
          "SellPriceTier4",
          "SellPriceTier",
          "",
          "",
          ""
        ],
        [
          "SellPriceTier5",
          "SellPriceTier",
          "",
          "",
          ""
        ],
        [
          "SellPriceTier6",
          "SellPriceTier",
          "",
          "",
          ""
        ],
        [
          "SellPriceTier7",
          "SellPriceTier",
          "",
          "",
          ""
        ],
        [
          "SellPriceTier8",
          "SellPriceTier",
          "",
          "",
          ""
        ],
        [
          "SellPriceTier9",
          "SellPriceTier",
          "",
          "",
          ""
        ],
        [
          "SellPriceTier10",
          "SellPriceTier",
          "",
          "",
          ""
        ],
        [
          "SupplementaryClassificationAbbreviation",
          "String",
          "2",
          "",
          "'International Commerce Codes' setting must be enabled to update this field. Not required but validated. Refer to the drop-down lists on any Product page for accepted values, or leave the field blank."
        ],
        [
          "Supplier",
          "SupplierWithProductCode",
          "",
          "",
          "The Purchasing default Supplier, cannot be an obsolete Supplier."
        ],
        [
          "TaxablePurchase",
          "Nullable Boolean",
          "true , false",
          "",
          "Will be set to true when XeroTaxRate > 0 even if posting false . Will be set to true when both XeroTaxCode & XeroTaxRate are null"
        ],
        [
          "TaxableSales",
          "Nullable Boolean",
          "true , false",
          "",
          "Will be set to true when XeroSalesTaxRate > 0 even if posting false . Will be set to true when both XeroSalesTaxCode & XeroSalesTaxRate are null"
        ],
        [
          "UnitOfMeasure",
          "UnitOfMeasure",
          "",
          "*See Notes",
          "Cannot update while Product has Alternate Units of Measure. If left unspecified and a dimension is given then will be set to the \"EA\" unit."
        ],
        [
          "Weight",
          "Nullable Decimal",
          "",
          "",
          "If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the \"EA\" unit."
        ],
        [
          "Width",
          "Nullable Decimal",
          "",
          "",
          "If provided with no UnitOfMeasure, then UnitOfMeasure will be set to the \"EA\" unit."
        ],
        [
          "XeroCostOfGoodsAccount",
          "String",
          "50",
          "",
          ""
        ],
        [
          "XeroSalesAccount",
          "String",
          "50",
          "",
          ""
        ],
        [
          "XeroSalesTaxCode",
          "String",
          "50",
          "",
          ""
        ],
        [
          "XeroSalesTaxRate",
          "Nullable Decimal",
          "",
          "",
          ""
        ],
        [
          "XeroTaxCode",
          "String",
          "50",
          "",
          ""
        ],
        [
          "XeroTaxRate",
          "Nullable Decimal",
          "",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "POST Products",
      "anchor": "post-products",
      "summary": "Available Request Fields for Alternate Unit Of Measure",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Required",
          "Notes"
        ],
        [
          "Barcode",
          "String",
          "200",
          "",
          ""
        ],
        [
          "ConversionRate",
          "Decimal",
          "",
          "Yes",
          ""
        ],
        [
          "Depth",
          "Decimal",
          "",
          "",
          ""
        ],
        [
          "ForPurchases",
          "Boolean",
          "",
          "Yes",
          "Defaults to true"
        ],
        [
          "Guid",
          "Guid",
          "",
          "",
          ""
        ],
        [
          "Height",
          "Decimal",
          "",
          "",
          ""
        ],
        [
          "Name",
          "String",
          "20",
          "",
          ""
        ],
        [
          "PackSize",
          "Decimal",
          "",
          "",
          ""
        ],
        [
          "Weight",
          "Decimal",
          "",
          "",
          ""
        ],
        [
          "Width",
          "Decimal",
          "",
          "",
          ""
        ]
      ]
    },
    {
      "heading": "POST Products",
      "anchor": "post-products",
      "summary": "Available Request Fields for Product Brand",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Required"
        ],
        [
          "BrandName",
          "String",
          "50",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Yes"
        ]
      ]
    },
    {
      "heading": "POST Products",
      "anchor": "post-products",
      "summary": "Available Request Fields for Product Group",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Required"
        ],
        [
          "GroupName",
          "String",
          "450",
          ""
        ],
        [
          "Guid",
          "Guid",
          "",
          "Yes"
        ]
      ]
    },
    {
      "heading": "POST Products",
      "anchor": "post-products",
      "summary": "Available Request Fields for Supplier With Product Code",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Required",
          "Notes"
        ],
        [
          "Guid",
          "Guid",
          "",
          "Yes",
          ""
        ],
        [
          "LeadTimeDays",
          "Integer",
          "",
          "",
          ""
        ],
        [
          "MinimumOrderQuantity",
          "Decimal",
          "",
          "",
          "Cannot be negative."
        ],
        [
          "SupplierCode",
          "String",
          "500",
          "",
          ""
        ],
        [
          "SupplierName",
          "String",
          "500",
          "",
          ""
        ],
        [
          "SupplierProductCode",
          "String",
          "100",
          "",
          "If empty or whitespace will overwrite existing value"
        ],
        [
          "SupplierProductDescription",
          "String",
          "500",
          "",
          ""
        ],
        [
          "SupplierProductPrice",
          "Decimal",
          "",
          "",
          "Cannot be negative unless the Product is Never Diminishing."
        ],
        [
          "UnitOfMeasure",
          "UnitOfMeasure",
          "",
          "",
          "Must be either the base UoM or a valid Alternate UoM."
        ]
      ]
    },
    {
      "heading": "POST Products",
      "anchor": "post-products",
      "summary": "Available Request Fields for Unit Of Measure",
      "rows": [
        [
          "Property",
          "Type",
          "Length",
          "Required"
        ],
        [
          "Guid",
          "Guid",
          "",
          ""
        ],
        [
          "Name",
          "String",
          "20",
          ""
        ],
        [
          "Obsolete",
          "Boolean",
          "",
          ""
        ]
      ]
    }
  ],
  "filterTables": [
    {
      "heading": "GET Products",
      "anchor": "get-products",
      "summary": "Available Filters for GET Products",
      "rows": [
        [
          "Filter",
          "Description"
        ],
        [
          "brief",
          "If set to true , returns a brief summary of the Product list that only includes: Guid, ProductCode, ProductDescription, DefaultPurchasePrice, DefaultSellPrice, SellPriceTier1, DefaultSupplierId."
        ],
        [
          "customerCode",
          "If you have added customer specific product prices, the list of Product(s) will be displayed. The CustomerSellPrice field will display the customer price."
        ],
        [
          "excludeAssembled",
          "If set to true , assembled Products will not be displayed."
        ],
        [
          "excludeComponents",
          "If set to true , component Products will not be displayed."
        ],
        [
          "includeAttributes",
          "If set to true , returns the attributes associated with the requested Product."
        ],
        [
          "includeObsolete",
          "If set to true , returns all Products, including obsolete. If set to false or if it is not specified then returns only active (i.e. non-obsolete) Products."
        ],
        [
          "modifiedSince",
          "Returns Products created or modified since the specified date."
        ],
        [
          "orderBy",
          "Orders the list by LastModifiedOn or CreatedOn date. By default the list is ordered by `ProductCode`."
        ],
        [
          "pageSize",
          "Specifies the page size for pagination. Default page size is 200 Products. Note: Requesting large numbers of products can be susceptible to poor network performance. Please reduce the page size if you experience delayed requests."
        ],
        [
          "product",
          "Only returns Products that contain the term in the code or description."
        ],
        [
          "ProductBarcode",
          "Only returns Products with the specific product barcode."
        ],
        [
          "productBrand",
          "Only returns Products with the specific product brand."
        ],
        [
          "productCode",
          "Returns Products that start with the specific product code."
        ],
        [
          "productDescription",
          "Returns Products that start with the specific product description."
        ],
        [
          "productGroup",
          "Returns Products with the specific product group. Does not work for sub groups."
        ],
        [
          "productId",
          "Returns Products with the specific product id. You can enter multiple product Ids separated by commas."
        ],
        [
          "smart",
          "If set to true , overrides all other filters and returns all Products currently in stock, and those that have been in stock in the last 6 months."
        ],
        [
          "sort",
          "Orders the list by CreatedOn date sorted in ascending or descending order."
        ]
      ]
    }
  ],
  "documentationNotes": [
    "The Products resource allows products to be listed, viewed, created, and updated. An individual product’s details can be viewed or updated by appending its identifier (a GUID formatted as XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX ) to the URI.",
    "Note: InventoryDetail require Per Warehouse Controls to be toggled on.",
    "Note: InventoryDetail require Per Warehouse Controls to be toggled on.",
    "Note: Updates made to existing Products will overwrite existing information, fields left blank will be removed.",
    "Note: At a minimum, a valid Guid or Name is required.",
    "Note: At a minimum, a valid Guid or BrandName is required.",
    "Note: At a minimum, a valid Guid or Name is required.",
    "Note: At a minimum, a valid Guid or Name is required."
  ]
}

What has been verified

Documented coverage: 145 operation variants retained from official provider documentation, with 43 resource records and their field and filter tables. These counts describe documentation, not proven live workflows.
Agent connection: Actual Claude Desktop and web connection, model-selected platform utility calls, renewal after natural token expiry and revoked-access rejection passed. Codex and Claude Code authentication and discovery were also checked. These tests made no provider business requests.
Live business workflows: Awaiting an authorised Unleashed account. Provider reads, writes and business workflows are not yet verified.

More software, the same workspace

Explore Procore MCP

Inspect the Procore catalogue and the approval and account requirements while live acceptance is still pending.

Explore Procore →