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 String
path_lower String
path_display String
id String
client_modified String
server_modified String
rev String
size Number
is_downloadable Boolean
content_hash String
list String
group String
nr1 String
nr2 String
description String
price_cost Number
price_catalogue Number
price_sales1 Number
price_sales2 Number
price_sales3 Number
margin_catalogue Number
margin1 Number
margin2 Number
margin3 Number
discount1 Number
discount2 Number
discount3 Number
brand String
type String
unit String
salesunit_id Number
salesunit String
purchaseunit_id Number
purchaseunit String
unit_localized String
salesunit_localized String
purchaseunit_localized String
active Boolean
barcode String
activesupplier_id Number
activesupplier_name String
ts_lastupdate String

/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": 2809432,
    "list": "ALGEMEEN",
    "group": "",
    "nr1": "190165",
    "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": "2025–02–12 14:26:43"
  }
]
}

/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: 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-e270a0e2-d79c–4a7a–8d94-d6f5da962683–250212–142744"
  }
]
}