Create product
Create a new product in a workspace.
The product will be created with the provided name and readable_id.
Optional part_number assigns a part number on create.
Part numbers
- 409: duplicate or retired
part_numberwithin the organization. - 422: value does not match the product’s configured format (when set in the app).
Authorizations
Enter your API key. Example: Bearer poelis_api_...
Body
Request to create a new product.
Workspace ID to create the product in
Product name
1Human-readable product ID (must be unique within workspace). Only lowercase letters, numbers and underscores are allowed.
1^[a-z0-9_]+$Product description
Optional part number to assign on create. Must be unique within the organization.
Response
Created product
Public representation of a product.
Human-readable product ID
Workspace this product belongs to
Product name
Product description
Active product part number, when assigned. Uniqueness is enforced organization-wide; format is validated when the product has rule configuration in the app.
User-selected baseline product version number.
Whether the product is archived or not.
Current workflow status for this product. Null when no status is set.
Workspace-level status IDs that are hidden for this product.
Product owner. Null when not set.
User who created the product.
ISO 8601 creation timestamp
ISO 8601 last-update timestamp
User who last updated the product