Skip to content

Update product

PATCH
/products/{id}
id
required
integer
object
sku
string | null
<= 50 characters
name
string
<= 255 characters
description
string | null
salesDescription
string | null
type
string
<= 50 characters
categoryId
integer | null
>= -2147483648 <= 2147483647
costPrice
string | null
sellPrice
string | null
unit
string | null
<= 50 characters
manufacturerId
integer | null
>= -2147483648 <= 2147483647
manufacturerCode
string | null
<= 100 characters
isKit
boolean
isActive
boolean
buyTaxPercent
string | null
sellTaxPercent
string | null

Updated

object
data
required
object
id
required
integer
sku
required
string
name
required
string
description
required
string | null
type
required
string
categoryId
required
integer | null
costPrice
required
string | null
sellPrice
required
string | null
unit
required
string | null
manufacturerId
required
integer | null
manufacturerCode
required
string | null
isKit
required
boolean
isActive
required
boolean
createdAt
required
Any of:
string format: date-time
updatedAt
required
Any of:
string format: date-time
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer

Error

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string

Error

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string

Error

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string