Create a new Product
/ProductsInspect fields and contract →
An Unleashed MCP connector for stock, products, sales orders and purchasing. Explore the coverage and join the access waitlist.
Inventory and orders
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.
Explore documented product, stock-on-hand and warehouse operations for questions about inventory across your business.
Inspect documented operations →Inspect sales-order and customer operations, including the products, quantities and prices retained in their documented fields.
Inspect documented operations →Review the purchase-order, receipt and supplier coverage before planning an authorised purchasing workflow.
Inspect documented operations →“Show stock on hand by warehouse for this product.”
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.
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.
Read the AI client guide → How access and permissions work →
Documented coverage
145 documented operation variants. Open a contract to inspect its parameters, fields, sources and unresolved behaviour. No provider request is made here.
145 operations match. Showing 41–60.
/ProductsInspect fields and contract →/Products/{productGuid}Inspect fields and contract →/Products/Obsolete/{productGuid}Inspect fields and contract →/PurchaseOrdersInspect fields and contract →/PurchaseOrders/{orderGuid}Inspect fields and contract →/PurchaseOrders/{orderGuid}/CostsInspect fields and contract →/PurchaseOrdersInspect fields and contract →/PurchaseOrders/{orderGuid}Inspect fields and contract →/PurchaseOrders/{orderGuid}/LinesInspect fields and contract →/PurchaseOrders/{orderGuid}/ReceiptInspect fields and contract →/PurchaseOrders/{orderGuid}/CompleteInspect fields and contract →/PurchaseOrders/{orderGuid}Inspect fields and contract →/PurchaseOrders/{orderGuid}/Lines/{lineGuid}Inspect fields and contract →/PurchaseOrders/{orderGuid}Inspect fields and contract →/PurchaseOrders/{orderGuid}/Lines/{lineGuid}Inspect fields and contract →/SalesOrdersInspect fields and contract →/SalesOrders/{orderGuid}Inspect fields and contract →/SalesOrdersInspect fields and contract →/SalesOrders/{orderGuid}Inspect fields and contract →/SalesOrders/{orderGuid}/LinesInspect fields and contract →Documented contract, live behaviour unverified
unleashed_obsolete_productsRead the provider documentation ↗
| Parameter | Required | Provider description |
|---|---|---|
productGuid | Yes | Provider identifier from the corresponding resource; preserve the documented identifier type. |
These source tables cover the resource’s documented methods. Read each table’s heading for its request or response context.
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 |
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 |
GET Products
| Property | Type | Length |
|---|---|---|
| IsDefault | Boolean | true , false |
| Url | String |
GET Products
| Property | Type | Length |
|---|---|---|
| BinLocation | String | 50 |
| WarehouseMinStockAlertLevel | Nullable Decimal | |
| WarehouseMaxStockAlertLevel | Nullable Decimal | |
| Warehouse | Warehouse |
GET Products
| Property | Type | Length |
|---|---|---|
| BrandName | String | 50 |
| Guid | Guid | |
| LastModifiedOn | Nullable DateTime |
GET Products
| Property | Type | Length |
|---|---|---|
| Guid | Guid | |
| GroupName | String | 450 |
| LastModifiedOn | Nullable DateTime | |
| ParentGroupGuid | Guid |
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 |
GET Products
| Property | Type | Length |
|---|---|---|
| Guid | Guid | |
| Name | String | 20 |
| Obsolete | Boolean |
GET Products
| Property | Type | Length |
|---|---|---|
| Guid | Guid | |
| WarehouseCode | String | 15 |
| WarehouseName | String | 100 |
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 |
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 |
POST Products
| Property | Type | Length | Required |
|---|---|---|---|
| BrandName | String | 50 | |
| Guid | Guid | Yes |
POST Products
| Property | Type | Length | Required |
|---|---|---|---|
| GroupName | String | 450 | |
| Guid | Guid | Yes |
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. |
POST Products
| Property | Type | Length | Required |
|---|---|---|---|
| Guid | Guid | ||
| Name | String | 20 | |
| Obsolete | Boolean |
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. |
The exact retained JSON includes schemas, nested fields, notes, source evidence and unresolved questions. It is a documented contract, not a live response.
{
"id": "obsolete_products",
"name": "unleashed_obsolete_products",
"resourceId": "Products",
"description": "Obsolete a Product",
"method": "POST",
"path": "/Products/Obsolete/{productGuid}",
"documentationUrl": "https://apidocs.unleashedsoftware.com/Products",
"readOnly": false,
"destructive": true,
"idempotent": false,
"pathParameters": [
{
"name": "productGuid",
"required": true,
"schema": {
"type": "string",
"minLength": 1
},
"description": "Provider identifier from the corresponding resource; preserve the documented identifier type."
}
],
"queryParameters": [],
"requestBodySchema": null,
"responseSchema": null,
"pagination": null,
"notes": [
"Do not automatically replay after an ambiguous transport failure. The documentation does not establish an idempotency-key contract for this operation.",
"APIChangeLog announces a base-unit-of-measure validation change effective 2026-10-26 for products with Barcode, PackSize, Weight, Height, Width or Depth."
],
"provenance": [
{
"sourceUrl": "https://apidocs.unleashedsoftware.com/Products",
"sourceSha256": "dcca8be715459fd3fc595a6d0f3f8e795112fbc14805f09b421e4f97e47209a4",
"section": "The full range of URIs and HTTP Verbs supported are",
"evidence": "POST /Products/Obsolete/{productGuid}",
"operationDescriptions": [
"Obsolete a Product"
]
}
],
"confidence": "documented-route",
"unresolved": [
"No authenticated sandbox or production request has verified this operation.",
"The documentation lists this action but does not provide a dedicated request-body schema. Confirm empty-body versus entity-body behaviour in a sandbox."
],
"requestFieldTable": null,
"responseFieldTable": null
}{
"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."
]
}Inspect the Procore catalogue and the approval and account requirements while live acceptance is still pending.
Explore Procore →