Company Products API

Your own company product catalog — SKUs you sell, assemble or consume.

Endpoints

MethodPathDescription
GET/api/v1/company/productsList all products in the company catalog
GET/api/v1/company/products/{id}Get a single company product
POST/api/v1/company/productsAdd a product to the company catalog
PATCH/api/v1/company/products/{id}Partially update a company product
DELETE/api/v1/company/products/{id}Delete a company product

GET /api/v1/company/products

Shell
curl {{BASE_URL}}/api/v1/company/products

Response 200 OK — JSON array of CompanyProductDto.


POST /api/v1/company/products

Request body (CreateCompanyProductDto)

FieldTypeRequiredDescription
namestringProduct name
codestringSKU / article code — unique within your catalog
descriptionstringDescription
unitOfMeasureenumOne of KG, G, T, L, ML, M3, M, CM, MM, M2, PCS, ROLL, BOX, PALLET
activebooleanWhether the product is currently active (default true)
Shell
curl -X POST {{BASE_URL}}/api/v1/company/products \
-H "Content-Type: application/json" \
-d '{
"name": "T-Shirt Organic Cotton",
"code": "CP-TSH-001",
"unitOfMeasure": "PCS",
"active": true
}'

Response 201 CreatedCompanyProductDto.


GET /api/v1/company/products/{id}

  • 200 OKCompanyProductDto.
  • 404 Not Found — product does not exist in your tenant.

PATCH /api/v1/company/products/{id}

Partial update. Fields allowed: name, code, description, unitOfMeasure, active.

DELETE /api/v1/company/products/{id}

  • 204 No Content — deleted.
  • 404 Not Found — product does not exist in your tenant.

Company product schema

CompanyProductDto:

JSON
{
"id": "a1b2c3…",
"name": "T-Shirt Organic Cotton",
"code": "CP-TSH-001",
"description": null,
"unitOfMeasure": "PCS",
"active": true,
"createdAt": "2026-04-21T10:00:00.000Z",
"updatedAt": "2026-04-21T10:00:00.000Z"
}