Update an Item

put

https://apiprod.fattlabs.com/item/{id}

Updates or edits any existing catalog item that matches the given ID.

Updates/edits any existing catalog item that matches the given ID. Has the same input body as POST /item. None of the parameters are required, but name and code are recommended.

As with POST /item, the details field accepts up to 500 characters.

Path Params

id

string

required

ID of the item to be modified.

Body Params

item

string

required

Name of the catalog item

code

string

Code of the catalog item

category

string

Set category for catalog item

details

string

Description for catalog item

is_active

boolean

Define if the item is active

is_taxable

boolean

Define if the item is taxable

is_service

boolean

Define if the item is a service

is_discount

boolean

Defaults to false

Defaults to false. Sets the item to a discount which overrides the is_service variable.

price

float

Update the catalog item price

in_stock

int32

Sets the stock quantity

low_stock_alert

int32

Update the low stock alert amount

meta

json

files

string

IDs of files to be associated to the item.

thumbnail

string

File ID of a file to be associated to the item as the thumbnail or preview.

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json