WinShopAPI docs
ReferenceProduct

Create a product unit

Adds a unit of measure to the product and returns it (201, `Location` header set). Requires `Permissions.Product.Create`.

POST
/api/products/{productId}/units

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

Request Body

application/json
  1. body

A unit of measure a product can be traded in, with its conversion to the base unit.

depth?|
Formatdecimal
depthInPackaging?|
Formatdecimal
depthInPackagingUnitId?|
Formatint32
depthUnitId?|
Formatint32
diameter?|
Formatdecimal
diameterInPackaging?|
Formatdecimal
diameterInPackagingUnitId?|
Formatint32
diameterUnitId?|
Formatint32
dimension?|
Lengthlength <= 40
dimensionUnitId?|
Formatint32
guid?|
Formatguid
height?|
Formatdecimal
heightInPackaging?|
Formatdecimal
heightInPackagingUnitId?|
Formatint32
heightUnitId?|
Formatint32
id?|
Formatint32
isInvisible?boolean|null
productId?|
Formatint32
quantityCoefficient?|
Formatdecimal
unit?|Deprecated
Formatint32
unitId?|
Formatint32
unitOrder?|
Formatint32
volume?|
Lengthlength <= 20
volumeInPackaging?|
Lengthlength <= 20
volumeInPackagingUnitId?|
Formatint32
volumeUnitId?|
Formatint32
weight?|
Formatdecimal
weightInPackaging?|
Formatdecimal
weightInPackagingUnitId?|
Formatint32
weightUnitId?|
Formatint32
width?|
Formatdecimal
widthInPackaging?|
Formatdecimal
widthInPackagingUnitId?|
Formatint32
widthUnitId?|
Formatint32

Response Body

application/json
  1. response

A unit of measure a product can be traded in, with its conversion to the base unit.

depth?|
Formatdecimal
depthInPackaging?|
Formatdecimal
depthInPackagingUnitId?|
Formatint32
depthUnitId?|
Formatint32
diameter?|
Formatdecimal
diameterInPackaging?|
Formatdecimal
diameterInPackagingUnitId?|
Formatint32
diameterUnitId?|
Formatint32
dimension?|
Lengthlength <= 40
dimensionUnitId?|
Formatint32
guid?|
Formatguid
height?|
Formatdecimal
heightInPackaging?|
Formatdecimal
heightInPackagingUnitId?|
Formatint32
heightUnitId?|
Formatint32
id?|
Formatint32
isInvisible?boolean|null
productId?|
Formatint32
quantityCoefficient?|
Formatdecimal
unit?|Deprecated
Formatint32
unitId?|
Formatint32
unitOrder?|
Formatint32
volume?|
Lengthlength <= 20
volumeInPackaging?|
Lengthlength <= 20
volumeInPackagingUnitId?|
Formatint32
volumeUnitId?|
Formatint32
weight?|
Formatdecimal
weightInPackaging?|
Formatdecimal
weightInPackagingUnitId?|
Formatint32
weightUnitId?|
Formatint32
width?|
Formatdecimal
widthInPackaging?|
Formatdecimal
widthInPackagingUnitId?|
Formatint32
widthUnitId?|
Formatint32
curl -X POST 'https://<your-instance>/api/products/0/units' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{  "depth": 3,  "depthInPackaging": 4,  "depthInPackagingUnitId": 4,  "depthUnitId": 4,  "diameter": 2.5,  "diameterInPackaging": 3,  "diameterInPackagingUnitId": 4,  "diameterUnitId": 4,  "dimension": "10x5x3",  "dimensionUnitId": 4,  "height": 10,  "heightInPackaging": 12,  "heightInPackagingUnitId": 4,  "heightUnitId": 4,  "isInvisible": false,  "productId": 123,  "quantityCoefficient": 6,  "unitId": 2,  "unitOrder": 1,  "volume": "0.15",  "volumeInPackaging": "0.29",  "volumeInPackagingUnitId": 5,  "volumeUnitId": 5,  "weight": 1.5,  "weightInPackaging": 1.8,  "weightInPackagingUnitId": 3,  "weightUnitId": 3,  "width": 5,  "widthInPackaging": 6,  "widthInPackagingUnitId": 4,  "widthUnitId": 4}'
{  "depth": 0,  "depthInPackaging": 0,  "depthInPackagingUnitId": 0,  "depthUnitId": 0,  "diameter": 0,  "diameterInPackaging": 0,  "diameterInPackagingUnitId": 0,  "diameterUnitId": 0,  "dimension": "string",  "dimensionUnitId": 0,  "guid": "string",  "height": 0,  "heightInPackaging": 0,  "heightInPackagingUnitId": 0,  "heightUnitId": 0,  "id": 0,  "isInvisible": true,  "productId": 0,  "quantityCoefficient": 0,  "unit": 0,  "unitId": 0,  "unitOrder": 0,  "volume": "string",  "volumeInPackaging": "string",  "volumeInPackagingUnitId": 0,  "volumeUnitId": 0,  "weight": 0,  "weightInPackaging": 0,  "weightInPackagingUnitId": 0,  "weightUnitId": 0,  "width": 0,  "widthInPackaging": 0,  "widthInPackagingUnitId": 0,  "widthUnitId": 0}