API Reference
Start developing plugins for BizFusion.

 
Product (ProductDTO)

You can register three types of products in BizFusion:

1. Physical Products
2. Services
3. Non-Inventory Products (digital products)

BizFusion assumes that all prices include VAT.

Note that product group, brand and product variants are not required.

Product variants contain the product options.
E.g. a T-Shirt can have the product options Size and Color.

The following relationship exists between products and variants:
Product > Product Variant > Variant > Variant Value


Properties
property data type reference
ProductId Int32 Primary Key
ProductTypeId Int32 ProductTypeDTO
ProductName String
Description String
Price Decimal
VatId Int32 VatDTO
BrandId Int32? (optional) BrandDTO
ProductGroupId Int32? (optional) ProductGroupDTO
Timestamp String
Barcode String
MinStockLevel Int32
MaxStockLevel Int32
PurchasePrice Decimal
ProductVariant Array of: ProductVariantDTO


Methods
method parameters URL
Get
/api/Product
Get
Int32 id
/api/Product?id={value}
Get
Int32 pageIndex, Int32 recordsPerPage
/api/Product?pageIndex={value}&recordsPerPage={value}
Post /api/Product
Put
Int32 id, ProductDTO record
/api/Product?id={value}
Delete
Int32 id, String timestamp
/api/Product?id={value}&timestamp={value}
GetRecordCount
/api/ProductSet/RecordCount
GetByField
String field, String value
/api/ProductSet/ByField?field={value}&value={value}
GetAfterId
Int32 id
/api/ProductSet/AfterId?id={value}
GetBeforeId
Int32 id
/api/ProductSet/BeforeId?id={value}
GetMaxId
/api/ProductSet/MaxId


JSON sample
{
  "Timestamp": "AQIDEw==",
  "ProductId": 1,
  "ProductTypeId": 2,
  "ProductName": "Playstation 4",
  "Description": "Playstation 4",
  "Price": 299.0,
  "VatId": 2,
  "BrandId": 1,
  "ProductGroupId": null,
  "Barcode": null,
  "MinStockLevel": 0,
  "MaxStockLevel": 0,
  "PurchasePrice": 0.0,
  "ProductVariant": []
}


General Info

- Numbers should be in English format: 124.99
- Dates look like: 2014-12-31T00:00:00
- Time information is ignored.
- Concurrency is handled through timestamps

Create Record (POST)

- Primary keys are not required when doing a post.
- Timestamps are not required when doing a post.
- Provide the JSON record in the body of the post request.

Update Record (PUT)

- Timestamps are required.
- Provide the JSON record in the body of the put request.

Delete Record (DELETE)

- Primary key and Timestamp are required.