Products

Name	Type	Path
GetProducts	GET	/api/Product
		Get a list of products with a search filter.
GetProduct	GET	/api/Product/{idOrCode}
		Get a product.
CreateProduct	POST	/api/Product
		Create a product.
LockProduct	POST	/api/Product/{id}/lock
		Lock a product.
UpdateProduct	PATCH	/api/Product/{idOrCode}
		Update a product.
DeleteProduct	DELETE	/api/Product/{id}
		Permanently delete a product.

Further information:

Creating a new product

POST /api/product

{
  "Code": "BAT1",
  "Description": "Battery 1",
  "ProductGroupId": "BATTERIES",
  "Purchase": { "IsActive": true },
  "Sale": { "IsActive": true }
}

This creates a new product valid for purchases and sales. Accounting configuration is defaulted from the product group.

Reference: POST /api/Product

Updating a product

PATCH /api/product/BAT1

{
  "Description": "API 123",
  "Purchase": {
    "AccountId": "2001"
  },
  "Sale": {
    "IsActive": false
  }
}

Reference: PATCH /api/product/(idOrCode)

Retrieving a product

GET /api/product/BAT1?include=ext

Sample response:

{
  "id": "5d4dd32b-4af7-4eb7-95a2-f0513a827192",
  "code": "BAT1",
  "description": "API 123",
  "productGroupId": "ab374f8d-2cc1-4bde-85de-4b270d4a3938",
  "productType": "O",
	"uomId": "d37779ea-8275-423b-b52a-f4aada53c273",
	"uomGroupId": "dde6579a-5169-424f-9ff7-f5e9f99c1a18",
  "purchase": {
    "isActive": true,
    "accountId": "c3e79906-95df-444a-a0ee-6f23babf107d"
  },
  "sale": {
    "isActive": false
  },
  "lastModified": "2024-05-24T16:17:53.55",
	"lastModifiedBy": "apiuser",
  "ext": { 
    "Custom1": "B" 
  }
}

Reference: GET /api/product/(idOrCode)

---

Updated September 2025