Product

Product

archived_at
string or null <date-time>
cost_price
string or null <decimal> [ 0 .. 4000000000 )
created_at
string <date-time>
id
string <int64>
item_code
string or null <= 100 characters
object
name
string <= 255 characters
notes
string or null
price_ex_tax
string or null <decimal>
price_including_tax
string or null <decimal>
object
product_supplier_name
string or null
serial_number
string or null <= 255 characters
object
stock_level
integer or null ( -4000000000 .. 4000000000 )
object
updated_at
string <date-time>
{}

List products

get/products
SecuritybasicAuth
Request
query Parameters
order
string
Deprecated
Enum: "asc" "desc"
page
integer
per_page
integer [ 1 .. 100 ]
q[]
Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value Format
archived_at date-time
created_at date-time
id int64
name string
tax_id int64
updated_at date-time
sort
Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
Responses
200

successful operation

Request samples 
Response samples 
application/json
{}
Create product
post/products
SecuritybasicAuth 
Request 
Request Body schema: application/json
cost_price
string or null <decimal>   [ 0 .. 4000000000 ) 
 
item_code
string or null  <= 100 characters 
 
name
string  <= 255 characters 
 
notes
string or null
 
price
number <decimal> 
 
price_includes_tax
boolean or null
 
product_supplier_name
string or null
 
serial_number
string or null  <= 255 characters 
 
stock_level
integer or null  ( -4000000000 .. 4000000000 ) 
 
tax_id
string <int64> 
tax id


 
Responses 
201
Resource was created


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "item_code": "string",
  • "name": "string",
  • "serial_number": "string",
  • "price": 0,
  • "product_supplier_name": "string",
  • "price_includes_tax": true,
  • "stock_level": -3999999999,
  • "tax_id": "1",
  • "cost_price": "string",
  • "notes": "string"
}
Response samples 
application/json
{}
Get product
get/products/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
query Parameters
q[]
Array of strings
Filter result by one or more fields.


See Filtering Results


Available filters:






Value
Format





archived_at
date-time





 
Responses 
200
Successful operation


Request samples 
Response samples 
application/json
{}
Update product
patch/products/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Request Body schema: application/json
cost_price
string or null <decimal>   [ 0 .. 4000000000 ) 
 
item_code
string or null  <= 100 characters 
 
name
string  <= 255 characters 
 
notes
string or null
 
price
number <decimal> 
 
price_includes_tax
boolean or null
 
product_supplier_name
string or null
 
serial_number
string or null  <= 255 characters 
 
stock_level
number or null  ( -4000000000 .. 4000000000 ) 
 
tax_id
string <int64> 
tax id


 
Responses 
200
Resource was updated


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "item_code": "string",
  • "name": "string",
  • "serial_number": "string",
  • "price": 0,
  • "product_supplier_name": "string",
  • "price_includes_tax": true,
  • "stock_level": -3999999999,
  • "tax_id": "1",
  • "cost_price": "string",
  • "notes": "string"
}
Response samples 
application/json
{}
Archive productDeprecated
delete/products/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived successfully


Request samples 
Archive product
post/products/{id}/archive
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived


Request samples