ProductTypes

Deletes an existing product type, scoped by the company/business unit of the current user

Removes the product type

Securitybearer
Request
path Parameters
productTypeId
required
string <uuid>

The product type guid.

header Parameters
BusinessUnitId
string

The business unit's guid

Responses
204

No Content

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

delete/api/v1/producttypes/{productTypeId}
Request samples 
Returns a product type by id, scoped by the company/business unit of the current user
Securitybearer 
Request 
path Parameters
productTypeId
required
string <uuid> 
The product type's guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Responses 
get/api/v1/producttypes/{productTypeId}
Request samples 
Response samples 
application/json
{
  • "id": "c153e03f-1061-4655-b5b9-564dbc270c85",
  • "code": "ASPH",
  • "description": "Asphalt"
}
Updates an existing product type, scoped by the company/business unit of the current user
Securitybearer 
Request 
path Parameters
productTypeId
required
string <uuid> 
The product type's guid


 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Request Body schema: application/json
The product type


id
required
string <uuid> 
Existing product type's identifier.


 
code
required
string  non-empty 
Unique product type code.


 
description
string or null
The product type's description.


 
Responses 
put/api/v1/producttypes/{productTypeId}
Request samples 
application/json
{
  • "id": "c4566343-ebad-48b2-a23c-02578aa4197b",
  • "code": "CONC",
  • "description": "Concrete"
}
Creates a new product type, scoped by the company/business unit of the current user
Securitybearer 
Request 
header Parameters
BusinessUnitId
string
The business unit's guid


 
Request Body schema: 
The product type


code
required
string  non-empty 
A unique product type code.


 
description
string or null
The product type's description.


 
Responses 
post/api/v1/producttypes
Request samples 
{
  • "code": "ASPH",
  • "description": "Asphalt"
}
Response samples 
application/json
"497f6eca-6276-4993-bfeb-53cbbbba6f08"