VismaBouwsoftAPICalls.v1_GET_Productstock Method
v1_GET_Productstock() as String

This API call is used to get fields of a(n) Productstock(s)

HTTP method API version
GET v1

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

API Path: /Productstock/
or
API Path: /Productstock/{id}

You can make this API call:
* without the key field id to get a list of Productstock
* with the key field id as the path parameter (the specific id of the Productstock you want to get)

Fields

The following fields are available:

Field Name Type
id Number
list String
group String
nr1 String
nr2 String
brand String
description String
lot_id String
lot_nr String
lot_description String
lot_stocklocationid Number
stock_location String
stock_locationid Number
barcode String
lotprice_unit Number
lotprice_total Number
quantity Number
quantity_reserved Number
quantity_available Number
unit String
purchase_price Number
purchase_unit String
product_id Number

/Productstock/

API Path: /Productstock/

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 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/Productstock

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue:
ParameterName: sort, ParameterValue:

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–32/33”, “Records”: [
  {
    "id": 136,
    "list": "SANICOMFORT",
    "group": "",
    "nr1": "00105571",
    "nr2": "10010000",
    "brand": "HANSGROHE",
    "description": "H.GR. AXOR STARCK WASTAFELMENGKRAAN CHROOM (10010000)",
    "lot_id": "105",
    "lot_nr": "2798708–105",
    "lot_description": "",
    "lot_stocklocationid": 136,
    "stock_location": "Magazijn",
    "stock_locationid": 1,
    "barcode": "",
    "lotprice_unit": 386.120000000000005,
    "lotprice_total": 6564.039999999999964,
    "quantity": 17,
    "quantity_reserved": 0,
    "quantity_available": 17,
    "unit": "st.",
    "purchase_price": 386.120000000000005,
    "purchase_unit": "st.",
    "product_id": 2798708
  },
  {
    "id": 94,
    "list": "TESTDIRK",
    "group": "",
    "nr1": "01.0001",
    "nr2": "",
    "brand": "",
    "description": "MANITOU MAN’GO 12 Categorie: kniktelescopische-hoogwerkers MANITOU MAN’GO 12, Diesel - Dagprijs: € 165, vanaf 2tot4 dagen: € 130, weekprijs: € 490, maandprijs: € 400 /week Accessoires : Operator - CAT 1, Werftank (mazout) 1100 l Vlarem II met tankpistool, Nummerplaat,",
    "lot_id": "71",
    "lot_nr": "2237653–71",
    "lot_description": "",
    "lot_stocklocationid": 94,
    "stock_location": "Magazijn",
    "stock_locationid": 1,
    "barcode": "",
    "lotprice_unit": 15.0,
    "lotprice_total": 150.0,
    "quantity": 10,
    "quantity_reserved": 0,
    "quantity_available": 10,
    "unit": "st.",
    "purchase_price": 15.0,
    "purchase_unit": "st.",
    "product_id": 2237653
  }
,
…
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: quantity_reserved ne 0
ParameterName: limit, ParameterValue:

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–5/6”, “Records”: [
  {
    "id": 134,
    "list": "TEGELS",
    "group": "",
    "nr1": "ch001",
    "nr2": "",
    "brand": "Coca-Cola",
    "description": "Chaudfontaine Stil (plat water)",
    "lot_id": "104",
    "lot_nr": "2777933–104",
    "lot_description": "",
    "lot_stocklocationid": 134,
    "stock_location": "Magazijn",
    "stock_locationid": 1,
    "barcode": "",
    "lotprice_unit": 0.9925,
    "lotprice_total": 150.860000000000014,
    "quantity": 152,
    "quantity_reserved": 100,
    "quantity_available": 52,
    "unit": "Fles",
    "purchase_price": 0.9925,
    "purchase_unit": "pak",
    "product_id": 2777933
  },
  {
    "id": 129,
    "list": "TEGELS",
    "group": "",
    "nr1": "TE.001",
    "nr2": "TE.001–2",
    "brand": "",
    "description": "Tegels Antraciet 41x41cm",
    "lot_id": "102",
    "lot_nr": "5653–102",
    "lot_description": "",
    "lot_stocklocationid": 129,
    "stock_location": "Magazijn",
    "stock_locationid": 1,
    "barcode": "",
    "lotprice_unit": 1.4912,
    "lotprice_total": 82.760000000000005,
    "quantity": 55.5,
    "quantity_reserved": 55.5,
    "quantity_available": 0,
    "unit": "st.",
    "purchase_price": 1.4912,
    "purchase_unit": "doos",
    "product_id": 5653
  }
,
…
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: nr1 eq ‘H.018’
ParameterName: limit, ParameterValue: 1
ParameterName: sort, ParameterValue: id

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/3”, “Records”: [
  {
    "id": 90,
    "list": "HOUT",
    "group": "",
    "nr1": "H.018",
    "nr2": "",
    "brand": "",
    "description": "Panlat gedrenkt 24x38 Lengte 4,20Lm",
    "lot_id": "69",
    "lot_nr": "2789553–69",
    "lot_description": "",
    "lot_stocklocationid": 90,
    "stock_location": "Magazijn",
    "stock_locationid": 1,
    "barcode": "",
    "lotprice_unit": 0.32,
    "lotprice_total": 1344.0,
    "quantity": 4200,
    "quantity_reserved": 0,
    "quantity_available": 4200,
    "unit": "lm",
    "purchase_price": 0.32,
    "purchase_unit": "pallet",
    "product_id": 2789553
  }
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: nr1 eq ‘H.018’
ParameterName: offset, ParameterValue:
ParameterName: sort, ParameterValue: stock_locationid

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–2/3”, “Records”: [
  {
    "id": 90,
    "list": "HOUT",
    "group": "",
    "nr1": "H.018",
    "nr2": "",
    "brand": "",
    "description": "Panlat gedrenkt 24x38 Lengte 4,20Lm",
    "lot_id": "69",
    "lot_nr": "2789553–69",
    "lot_description": "",
    "lot_stocklocationid": 90,
    "stock_location": "Magazijn",
    "stock_locationid": 1,
    "barcode": "",
    "lotprice_unit": 0.32,
    "lotprice_total": 1343.3599999999999,
    "quantity": 4198,
    "quantity_reserved": 0,
    "quantity_available": 4198,
    "unit": "lm",
    "purchase_price": 0.32,
    "purchase_unit": "pallet",
    "product_id": 2789553
  },
  {
    "id": 91,
    "list": "HOUT",
    "group": "",
    "nr1": "H.018",
    "nr2": "",
    "brand": "",
    "description": "Panlat gedrenkt 24x38 Lengte 4,20Lm",
    "lot_id": "69",
    "lot_nr": "2789553–69",
    "lot_description": "",
    "lot_stocklocationid": 91,
    "stock_location": "Depot 1",
    "stock_locationid": 4,
    "barcode": "",
    "lotprice_unit": 0.32,
    "lotprice_total": 26.879999999999999,
    "quantity": 84,
    "quantity_reserved": 0,
    "quantity_available": 84,
    "unit": "lm",
    "purchase_price": 0.32,
    "purchase_unit": "pallet",
    "product_id": 2789553
  }
,
…
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: nr1 eq ‘H.018’
ParameterName: limit, ParameterValue: 1
ParameterName: offset, ParameterValue:
ParameterName: sort, ParameterValue: -id

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/3”, “Records”: [
  {
    "id": 92,
    "list": "HOUT",
    "group": "",
    "nr1": "H.018",
    "nr2": "",
    "brand": "",
    "description": "Panlat gedrenkt 24x38 Lengte 4,20Lm",
    "lot_id": "69",
    "lot_nr": "2789553–69",
    "lot_description": "",
    "lot_stocklocationid": 92,
    "stock_location": "Depot 2",
    "stock_locationid": 5,
    "barcode": "",
    "lotprice_unit": 0.32,
    "lotprice_total": 134.400000000000006,
    "quantity": 420,
    "quantity_reserved": 0,
    "quantity_available": 420,
    "unit": "lm",
    "purchase_price": 0.32,
    "purchase_unit": "pallet",
    "product_id": 2789553
  }
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: nr1 eq ‘H.018’
ParameterName: sort, ParameterValue: stock_locationid

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–2/3”, “Records”: [
  {
    "id": 90,
    "list": "HOUT",
    "group": "",
    "nr1": "H.018",
    "nr2": "",
    "brand": "",
    "description": "Panlat gedrenkt 24x38 Lengte 4,20Lm",
    "lot_id": "69",
    "lot_nr": "2789553–69",
    "lot_description": "",
    "lot_stocklocationid": 90,
    "stock_location": "Magazijn",
    "stock_locationid": 1,
    "barcode": "",
    "lotprice_unit": 0.32,
    "lotprice_total": 1343.3599999999999,
    "quantity": 4198,
    "quantity_reserved": 0,
    "quantity_available": 4198,
    "unit": "lm",
    "purchase_price": 0.32,
    "purchase_unit": "pallet",
    "product_id": 2789553
  },
  {
    "id": 91,
    "list": "HOUT",
    "group": "",
    "nr1": "H.018",
    "nr2": "",
    "brand": "",
    "description": "Panlat gedrenkt 24x38 Lengte 4,20Lm",
    "lot_id": "69",
    "lot_nr": "2789553–69",
    "lot_description": "",
    "lot_stocklocationid": 91,
    "stock_location": "Depot 1",
    "stock_locationid": 4,
    "barcode": "",
    "lotprice_unit": 0.32,
    "lotprice_total": 26.879999999999999,
    "quantity": 84,
    "quantity_reserved": 0,
    "quantity_available": 84,
    "unit": "lm",
    "purchase_price": 0.32,
    "purchase_unit": "pallet",
    "product_id": 2789553
  }
,
…
]
}

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

with the following parameters :

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

Query Parameters :
ParameterName: filter, ParameterValue: nr1 eq ‘H.018’
ParameterName: sort, ParameterValue: stock_locationid

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–2/3”, “Records”: [
  {
    "id": 90,
    "list": "HOUT",
    "group": "",
    "nr1": "H.018",
    "nr2": "",
    "brand": "",
    "description": "Panlat gedrenkt 24x38 Lengte 4,20Lm",
    "lot_id": "69",
    "lot_nr": "2789553–69",
    "lot_description": "",
    "lot_stocklocationid": 90,
    "stock_location": "Magazijn",
    "stock_locationid": 1,
    "barcode": "",
    "lotprice_unit": 0.32,
    "lotprice_total": 1344.0,
    "quantity": 4200,
    "quantity_reserved": 0,
    "quantity_available": 4200,
    "unit": "lm",
    "purchase_price": 0.32,
    "purchase_unit": "pallet",
    "product_id": 2789553
  },
  {
    "id": 91,
    "list": "HOUT",
    "group": "",
    "nr1": "H.018",
    "nr2": "",
    "brand": "",
    "description": "Panlat gedrenkt 24x38 Lengte 4,20Lm",
    "lot_id": "69",
    "lot_nr": "2789553–69",
    "lot_description": "",
    "lot_stocklocationid": 91,
    "stock_location": "Depot 1",
    "stock_locationid": 4,
    "barcode": "",
    "lotprice_unit": 0.32,
    "lotprice_total": 26.879999999999999,
    "quantity": 84,
    "quantity_reserved": 0,
    "quantity_available": 84,
    "unit": "lm",
    "purchase_price": 0.32,
    "purchase_unit": "pallet",
    "product_id": 2789553
  }
,
…
]
}

/Productstock/{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/Productstock/94

with the following parameters :

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

Success gives statuscode 200 And the following result

{ “Content-Range”:“0–0/1”, “Records”: [
  {
    "id": 94,
    "list": "TESTDIRK",
    "group": "",
    "nr1": "01.0001",
    "nr2": "",
    "brand": "",
    "description": "MANITOU MAN’GO 12 Categorie: kniktelescopische-hoogwerkers MANITOU MAN’GO 12, Diesel - Dagprijs: € 165, vanaf 2tot4 dagen: € 130, weekprijs: € 490, maandprijs: € 400 /week Accessoires : Operator - CAT 1, Werftank (mazout) 1100 l Vlarem II met tankpistool, Nummerplaat,",
    "lot_id": "71",
    "lot_nr": "2237653–71",
    "lot_description": "",
    "lot_stocklocationid": 94,
    "stock_location": "Magazijn",
    "stock_locationid": 1,
    "barcode": "",
    "lotprice_unit": 15.0,
    "lotprice_total": 150.0,
    "quantity": 10,
    "quantity_reserved": 0,
    "quantity_available": 10,
    "unit": "st.",
    "purchase_price": 15.0,
    "purchase_unit": "st.",
    "product_id": 2237653
  }
]
}