WinShopAPI docs
ReferenceProduct

Get a product's building-material data

Returns the building-material attributes of the product, or nothing when it carries none. Requires `Permissions.Product.View`.

GET
/api/products/{productId}/building-material

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

productId*integer
Formatint32

Response Body

application/json
  1. response

Building-material attributes of a product, such as its material, finish and thermal properties.

basisWeight?|
Formatdecimal
colorId?|
Formatint32
consumption?|
Lengthlength <= 50
density?|
Formatdecimal
edge?|
Lengthlength <= 50
handle?|
Lengthlength <= 50
id?|
Formatint32
materialId?|
Formatint32
onlyInStockOrOrder?|
Lengthlength <= 50
paletteDimensionsId?|
Formatint32
paletteTypeId?|
Formatint32
productId?|
Formatint32
sizeId?|
Formatint32
strength?|
Formatdecimal
sumOfThermalConductivity?|
Formatdecimal
surfaceFinishId?|
Formatint32
thickness?|
Formatdecimal
type?|
Lengthlength <= 50
typeId?|
Formatint32
curl -X GET 'https://<your-instance>/api/products/0/building-material' \  -H 'Authorization: Bearer <access-token>'
{  "basisWeight": 0,  "colorId": 0,  "consumption": "string",  "density": 0,  "edge": "string",  "handle": "string",  "id": 0,  "materialId": 0,  "onlyInStockOrOrder": "string",  "paletteDimensionsId": 0,  "paletteTypeId": 0,  "productId": 0,  "sizeId": 0,  "strength": 0,  "sumOfThermalConductivity": 0,  "surfaceFinishId": 0,  "thickness": 0,  "type": "string",  "typeId": 0}