Skip to main content
PUT
Update a product

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Path Parameters

id
integer
required

The product identifier

Body

application/json
name
string

Product name.

Maximum string length: 255
barcode
string | null

Product barcode (unique per tenant).

Maximum string length: 255
description
string | null

Product description.

product_category_id
integer | null

Product category.

product_brand_id
integer | null

Product brand.

product_type_id
integer

Product type.

base_unit_code_id
integer

Base unit code.

stock_tracking_mode
enum<string>

Stock tracking mode.

Available options:
base_unit,
inner_unit,
direct_unit
inner_unit_count
integer

Inner unit count (units per box or direct units).

Required range: x >= 0
base_unit_per_inner
number | null

Base units per inner unit.

Required range: x >= 0
critical_stock_level
number | null

Critical stock level.

Required range: x >= 0
invoice_name
string | null

Invoice name override.

Maximum string length: 255
price
number

Product price.

Required range: x >= 0
tax_rate
enum<integer>

Tax rate (KDV).

Available options:
0,
1,
10,
20
is_active
boolean | null

Active status.

Response

success
string
required
data
ProductResource · object
required