Skip to main content
POST
Create item

Authorizations

Authorization
string
header
required

Enter your API key. Example: Bearer poelis_api_...

Body

application/json

Request to create a new item.

product_id
string
required

Product ID to create the item in

name
string
required

Item name

Minimum string length: 1
readable_id
string
required

Human-readable item ID (must be unique within parent scope). Only lowercase letters, numbers and underscores are allowed.

Minimum string length: 1
Pattern: ^[a-z0-9_]+$
description
string | null

Item description

part_number
string | null

Optional part number to assign on create. Must be unique within the organization.

parent_item_id
string | null

Parent item ID for hierarchical structure. Must refer to an item that already exists in the same product.

Response

Created item

Public representation of an item.

id
string
required
readable_id
string
required

Human-readable item ID

product_id
string
required

Product this item belongs to

name
string
required

Item name

deleted
boolean
required

Whether the item is deleted

parent_item_id
string | null

Parent item ID for hierarchical structure

description
string | null

Item description

part_number
string | null

Active item part number, when assigned. Uniqueness is enforced organization-wide; format is validated when the product has rule configuration in the app.

draft_item_id
string | null

Draft item ID if this is a versioned item

createdBy
PublicUser · object | null

User who created the item

Example:
createdAt
string | null

ISO 8601 creation timestamp

updatedAt
string | null

ISO 8601 last-update timestamp

updatedBy
PublicUser · object | null

User who last updated the item

Example: