VismaBouwsoftAPICalls.v1_POST_Products Method
v1_POST_Products() as String

This API call is used to add a(n) Product

General Description

HTTP method API version
POST v1

Don’t forget to put the Authorization field in the header

API Path: /Products
or
API Path: /Products/{id}/Upload

Fields

The following fields are available:

Field Name Type Name Length Required Writeable Force Write Link
list tpString 50 No Yes No
group tpString 50 No Yes No
nr1 tpString 100 No Yes No
nr2 tpString 100 No Yes No
description tpString 0 No Yes No
price_cost tpCurrencyHD 0 No Yes No
price_catalogue tpCurrencyHD 0 No Yes No
price_sales1 tpCurrencyHD 0 No Yes No
price_sales2 tpCurrencyHD 0 No Yes No
price_sales3 tpCurrencyHD 0 No Yes No
margin_catalogue tpCurrencyHD 0 No Yes No
margin1 tpCurrencyHD 0 No Yes No
margin2 tpCurrencyHD 0 No Yes No
margin3 tpCurrencyHD 0 No Yes No
discount1 tpCurrencyHD 0 No Yes No
discount2 tpCurrencyHD 0 No Yes No
discount3 tpCurrencyHD 0 No Yes No
brand tpString 150 No Yes No
type tpString 0 No Yes No
unit tpString 10 No Yes No
salesunit_id tpLong 0 No Yes No
salesunit tpString 10 No No No
purchaseunit_id tpLong 0 No Yes No
purchaseunit tpString 10 No No No
unit_localized tpString 10 No No No
salesunit_localized tpString 10 No No No
purchaseunit_localized tpString 10 No No No
active tpBool 0 No Yes No
barcode tpString 0 No Yes No
activesupplier_id tpLong 0 No Yes No Addresses
activesupplier_name tpString 150 No No No
ts_lastupdate tpDate 0 No No No

/Products

API Path: /Products/

If everything succeeds the HTTP response status is 201
(201 CREATED)

If you forget to send the Authorization, the response status and code is 401
(401 Unauthorized)

For an explanation of all possible errors, please consult our section on possible answers to API calls here

Examples:

https://ra.bouwsoft.be/api/v1/Products

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: VItfWxfbrfzSfbVlVfzRqDrUfVrjfGfPfPbkzDmmjfVGDGGbbb

Query Parameters :
ParameterName: columns, ParameterValue: description=’Accumulatoren Blue’

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 2832376,
    "list": "ALGEMEEN",
    "group": "",
    "nr1": "190181",
    "nr2": "",
    "description": "Accumulatoren Blue",
    "price_cost": 0.0,
    "price_catalogue": 0.0,
    "price_sales1": 0.0,
    "price_sales2": 0.0,
    "price_sales3": 0.0,
    "margin_catalogue": 23.0,
    "margin1": 25.0,
    "margin2": 20.0,
    "margin3": 15.0,
    "discount1": 0.0,
    "discount2": 0.0,
    "discount3": 0.0,
    "brand": "",
    "type": "",
    "unit": "st.",
    "salesunit_id": 0,
    "salesunit": "st.",
    "purchaseunit_id": 0,
    "purchaseunit": "st.",
    "unit_localized": "pc.",
    "salesunit_localized": "pc.",
    "purchaseunit_localized": "pc.",
    "active": true,
    "barcode": "",
    "activesupplier_id": 0,
    "activesupplier_name": "",
    "ts_lastupdate": "2026–04–08 08:37:53"
  }
]
}

https://ra.bouwsoft.be/api/v1/Products

with the following parameters :

Header Parameters :
ParameterName: AccessToken, ParameterValue: mrVfWxfDDGzSfljkGtzRqIPbfPbjIOkjjVVtzOjVOUIGfmVbkj
ParameterName: Clientnr, ParameterValue: 115

Query Parameters :
ParameterName: columns, ParameterValue: description=’Accumulatoren Green’

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "id": 2832377,
    "list": "ALGEMEEN",
    "group": "",
    "nr1": "190181",
    "nr2": "",
    "description": "Accumulatoren Green",
    "price_cost": 0.0,
    "price_catalogue": 0.0,
    "price_sales1": 0.0,
    "price_sales2": 0.0,
    "price_sales3": 0.0,
    "margin_catalogue": 23.0,
    "margin1": 25.0,
    "margin2": 20.0,
    "margin3": 15.0,
    "discount1": 0.0,
    "discount2": 0.0,
    "discount3": 0.0,
    "brand": "",
    "type": "",
    "unit": "st.",
    "salesunit_id": 0,
    "salesunit": "st.",
    "purchaseunit_id": 0,
    "purchaseunit": "st.",
    "unit_localized": "pc.",
    "salesunit_localized": "pc.",
    "purchaseunit_localized": "pc.",
    "active": true,
    "barcode": "",
    "activesupplier_id": 0,
    "activesupplier_name": "",
    "ts_lastupdate": "2026–04–08 08:51:29"
  }
]
}

/Products/{id}/Upload

If everything succeeds the HTTP response status is 200
(200 OK)

If there is something wrong with the request, the response status and code is 400
(400 Bad Request)

If there is no record that has the requested id the HTTP response status and code is 404
(404 Not found)

If you forget to send the Authorization, the response status is 401
(401 Unauthorized)

If what you sent can’t be processed, the response status is 500
(500 Internal Server Error)

For an explanation of all possible errors, please consult our section on possible answers to API calls here

Examples:

https://ra.bouwsoft.be/api/v1/Products/2832376/Upload

with the following parameters :

Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: DDkfWxfrOfzSftrfPfzRqbmDfrmffGkIfADkzIbDObAGkDktOt

Body Parameters :
ParameterName: fileParameterValue: tptype.txt

Success gives statuscode 500 And the following result

{“RecordChanges”: [
  {
    "Code": "500",
    "Message": "Upload failed",
    "Description": "Cannot upload file",
    "RequestId": "115-df880344–99ba–4bd3-a056-f4b367a28336–260408–083902"
  }
]
}

https://ra.bouwsoft.be/api/v1/Products/2832377/Upload

with the following parameters :

Header Parameters :
ParameterName: AccessToken, ParameterValue: VjDfWxfbAOzSfmIljtzRqbPAfftIIOrkjfrtzIDIIAAGtIkDjf
ParameterName: Clientnr, ParameterValue: 115

Body Parameters :
ParameterName: fileParameterValue: tptype.txt

Success gives statuscode 201 And the following result

{“RecordChanges”: [
  {
    "name": "tptype.txt",
    "path_display": "",
    "path_lower": "",
    "id": "",
    "client_modified": "2026–04–08T08:51:32Z",
    "server_modified": "2026–04–08T08:51:32Z",
    "rev": "",
    "size": 425,
    "is_downloadable": true,
    "checksum": "6LKyoK8TUtW+b5qRPOvdVxgRxVmKXlETEQIUasYKvV8="
  }
]
}