Product

• Allowed query parameters
• Create a product
• Update a product
• Retrieve a product
• Delete a product
• List products

Allowed query parameters

Filters

Filter	Type	Description
search	String	Full-text search (name, sku)
tag	String	Filter by tag ID
unit	String	Filter by unit ID
vat_rate	String	Filter by VAT Rate ID

Sorting

name, price, sku, vat_rate

Includes

tag, unit, account, vatRate

Create a product

post

/product

Attribute (* required)	Type	Description
name *	String	Product name (max: 255 characters)
price	Float?	Product price (max: 999999)
description	String?	Product description
remark	String?	Product remark/notes
sku	String?	Product SKU (max: 255 characters)
unit_id	String?	A Unit ID
tag_id	String?	A Tag ID
vat_rate_id	String?	A VAT Rate ID
revenue_account_no	String?	Revenue account number for accounting

Example response

// HTTP 201 Created
{
    // a product object
}

Update a product

put

/product/{id}

Attribute	Type	Description
name	String	Product name (max: 255 characters)
price	Float?	Product price (max: 999999)
description	String?	Product description
remark	String?	Product remark/notes
sku	String?	Product SKU (max: 255 characters)
unit_id	String?	A Unit ID
tag_id	String?	A Tag ID
vat_rate_id	String?	A VAT Rate ID
revenue_account_no	String?	Revenue account number for accounting

Example response

// HTTP 200 OK
{
    // a product object
}

Retrieve a product

get

/product/{id}

Example response

// HTTP 200 OK
{
	"id": "6k2KpJY3By",
	"name": "Analyse der aktuellen Webseite",
	"price": 1675,
	"vat_rate": 7.7,
	"vat_rate_id": "xyz123def",
	"sku": "ART-840",
	"description": "<p>Mittels Heatmap &amp; User Flow Analysen sowie Real-Time Verhaltensanalysen (mittels Screen-Recordings) werden zusammen mit bereits vorliegenden historischen Messdaten Rückschlüsse auf das Nutzerverhalten geschlossen.</p>",
	"remark": null,
	"is_percentage": false,
	"is_excluded_from_budget": false,
	"revenue_account_no": "3200",
	"vat": {
		"id": "xyz123def",
		"name": "7.7%",
		"rate": 7.7
	},
	"rate": null,
	"tag": null,
	"unit": null,
	"account": {
		"number": "3200",
		"name": "Produkterlöse"
	}
}

Delete a product

delete

/product/{id}

Example response

// HTTP 204 No Content

List products

get

/product

The list endpoint accepts the same parameters as in Retrieve a product and returns a paginated array of the same product object in the data property.

Read more about Pagination, Filtering, Sorting and Includes on the Introduction page.