Products API
PUT/api/v1/products/{id}
Product availabilityAlgaPSA

Update product

Updates a product catalog entry by UUID.

RBAC · service

Path parameters

idstring <uuid>Required
Product UUID.

Request body

Content type: application/json

service_namestring
min length 1 · max length 255
custom_service_type_idstring <uuid>
billing_methodstring
default "usage"
Enum: usage
default_ratenumber
default 0 · ≥ 0
currency_codestring
min length 3 · max length 3
unit_of_measurestring
min length 1 · max length 128
unit_codestring
category_idanyOf
anyOf (option 1)string <uuid>
anyOf (option 2)null
anyOf (option 3)null
tax_rate_idanyOf
anyOf (option 1)string <uuid>
anyOf (option 2)null
anyOf (option 3)null
descriptionanyOf
anyOf (option 1)string
max length 2048
anyOf (option 2)null
anyOf (option 3)null
skuanyOf
anyOf (option 1)string
max length 128
anyOf (option 2)null
anyOf (option 3)null
barcodeanyOf
anyOf (option 1)string
max length 255
anyOf (option 2)null
anyOf (option 3)null
costanyOf
anyOf (option 1)number
≥ 0
anyOf (option 2)null
anyOf (option 3)null
cost_currencyanyOf
anyOf (option 1)string
min length 3 · max length 3
anyOf (option 2)null
anyOf (option 3)null
vendoranyOf
anyOf (option 1)string
max length 255
anyOf (option 2)null
anyOf (option 3)null
manufactureranyOf
anyOf (option 1)string
max length 255
anyOf (option 2)null
anyOf (option 3)null
product_categoryanyOf
anyOf (option 1)string
max length 255
anyOf (option 2)null
anyOf (option 3)null
is_licenseboolean
default false
license_termanyOf
anyOf (option 1)string
max length 64
anyOf (option 2)null
anyOf (option 3)null
license_billing_cadenceanyOf
anyOf (option 1)string
max length 64
anyOf (option 2)null
anyOf (option 3)null
is_activeboolean
default true
pricesarray of object
itemsobject
currency_codestringRequired
min length 3 · max length 3
ratenumberRequired
≥ 0

Response body

Success response 200 · schema ProductEnvelope

dataobjectRequired
Product catalog entry.
service_idstring <uuid>Required
tenantstring <uuid>Required
service_namestringRequired
custom_service_type_idstring <uuid>Required
billing_methodstringRequired
Enum: usage
default_ratenumberRequired
unit_of_measurestringRequired
unit_codestringNullable
category_idstring <uuid>Nullable
tax_rate_idstring <uuid>Nullable
descriptionstringNullable
item_kindstringRequired
Enum: product
is_activeboolean
skustringNullable
barcodestringNullable
costnumberNullable
cost_currencystringNullable
min length 3 · max length 3
vendorstringNullable
manufacturerstringNullable
product_categorystringNullable
is_licenseboolean
license_termstringNullable
license_billing_cadencestringNullable
service_type_namestring
pricesarray of ProductPrice
Current price per currency (latest effective on or before today).
itemsobject
currency_codestringRequired
min length 3 · max length 3
ratenumberRequired
effective_datestringNullable
Calendar date the price takes effect; the epoch when untagged.
scheduled_pricesarray of ProductPrice
Future-dated prices that are not yet billed.
itemsobject
currency_codestringRequired
min length 3 · max length 3
ratenumberRequired
effective_datestringNullable
Calendar date the price takes effect; the epoch when untagged.
metaobject

Response codes

200
Product updated successfully.
400
Validation error.
401
Authentication failed.
403
Authenticated user lacks the required permission.
404
Product not found.
409
A product with the submitted SKU or barcode already exists.