VismaBouwsoftAPICalls.v1_PUT_Products | Method |
This API call is used to update fields of a(n) Product
General Description
HTTP method | API version |
---|---|
PUT | v1 |
Don’t forget to put the Authorization field in the header
API Path: /Products/{id}
or
API Path: /Products/{id}/Upload
or
API Path: /Products/{id}/note_plain
You make this API call with the key field id as the path parameter (the id of the Product you want to update)
Fields
The following fields are available:
Field Name | Type |
---|---|
name | String |
path_display | String |
path_lower | String |
id | String |
client_modified | String |
server_modified | String |
rev | String |
size | Number |
is_downloadable | Boolean |
checksum | String |
description | String |
price_cost | Number |
price_catalogue | Number |
price_sales1 | Number |
price_sales2 | Number |
price_sales3 | Number |
margin_catalogue | Number |
margin1 | Number |
margin3 | Number |
discount1 | Number |
discount2 | Number |
discount3 | Number |
ts_lastupdate | String |
lotprice_total | Number |
quantity | Number |
quantity_available | Number |
/Products/{id}
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/2809432
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: lmlfWxfVmkzSfVGOPfzRqIGAfGjIfGGlfrOkzlmtjkIGjrDrGI
Query Parameters :
ParameterName: columns, ParameterValue: description=’Tegels Citroengeel 40*60’,price_cost=12.35,margin1=10,margin2=20,margin3=30,margin_catalogue=40
Success gives statuscode 200 And the following result
{“RecordChanges”:
[
{
"id": 2809432,
"description": "Tegels Citroengeel 40*60",
"price_cost": 12.35,
"price_catalogue": 17.289999999999999,
"price_sales1": 13.585000000000001,
"price_sales2": 14.82,
"price_sales3": 16.055,
"margin_catalogue": 40.0,
"margin1": 10.0,
"margin3": 30.0,
"discount1": 21.428599999999999,
"discount2": 14.2857,
"discount3": 7.1429,
"ts_lastupdate": "2025–02–12 14:27:45"
}
]
}
/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/2809432/Upload
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: UUPfWxflbOzSfDUmUfzRqPjIftmbfGDbfkDkztAOGPkGmbVDbO
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": "2025–02–12T14:26:47Z",
"server_modified": "2025–02–12T14:26:47Z",
"rev": "",
"size": 425,
"is_downloadable": true,
"checksum": "7PdzJswtzRhfcR18hO2exZvkEyOrEmf/LZklKkrxz38="
}
]
}
/Products/{id}/note_plain
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/2809432/note_plain
with the following parameters :
Header Parameters :
ParameterName: Clientnr, ParameterValue: 115
ParameterName: AccessToken, ParameterValue: PPPfWxfOmrzSfUDrDfzRqUGUfGVjkGVOfUAkzDtbVPbIDtbkDr
Body Parameters :
dit is een nota via de api
Success gives statuscode 200 And the following result
dit is een nota via de api