Skip to main content
POST
Create inventory item (alias)

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.

Body

application/json
name
string
required

Item name.

selling_price
number

Default selling price.

cost_price
number

Unit cost for COGS and stock valuation.

stock
number

Opening stock quantity.

unit
string

Unit of measure (e.g. pcs, kg).

is_inventory
boolean

Set true to track stock movements. Omit for non-stocked services.

type
enum<string>

Item type.

Available options:
product,
service
currency
string

Item currency; defaults to business currency.

description
string

Item description.

category
string

Revenue account name/uuid/code for sales lines.

category_cost
string

Expense or COGS account name/uuid/code for cost lines.

Response

Item created

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.