Items
Items are the products or services that you sell to your customers.
Attribute
active
or inactive
goods
or service
or digital_service
. For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
active
or inactive
Create an Item
Create a new item.
OAuth Scope : ZohoBooks.settings.CREATE
Arguments
goods
or service
or digital_service
. For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
is_taxable
is false.is_taxable
is false.sales
,purchases
,sales_and_purchases
and inventory
. Default value will be sales
.Update an item using a custom field's unique value
A custom field will have unique values if it's configured to not accept duplicate values. Now, you can use that custom field's value to update an item by providing its API name in the X-Unique-Identifier-Key header and its value in the X-Unique-Identifier-Value header. Based on this value, the corresponding item will be retrieved and updated. Additionally, there is an optional X-Upsert header. If the X-Upsert header is true and the custom field's unique value is not found in any of the existing items, a new item will be created if the necessary payload details are available
OAuth Scope : ZohoBooks.settings.UPDATE
Arguments
goods
or service
or digital_service
. For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
is_taxable
is false.is_taxable
is false.sales
,purchases
,sales_and_purchases
and inventory
. Default value will be sales
.List items
Get the list of all active items with pagination.
OAuth Scope : ZohoBooks.settings.READ
Query Parameters
name_startswith
and name_contains
description_startswith
and description_contains
rate_less_than
, rate_less_equals
, rate_greater_than
and rate_greater_equals
is_taxable
is false.Status.All
, Status.Active
and Status.Inactive
name
, rate
and tax_name
Update an item
Update the details of an item.
OAuth Scope : ZohoBooks.settings.UPDATE
Arguments
goods
or service
or digital_service
. For SouthAfrica Edition:
service
, goods
, capital_service
and capital_goods
is_taxable
is false.is_taxable
is false.sales
,purchases
,sales_and_purchases
and inventory
. Default value will be sales
.Get an item
Details of an existing item.
OAuth Scope : ZohoBooks.settings.READ
Delete an item
Delete the item created.items that are part of transaction cannot be deleted.
OAuth Scope : ZohoBooks.settings.DELETE
Update custom field in existing items
Update the value of the custom field in existing items.
OAuth Scope : ZohoBooks.settings.UPDATE
Arguments
Query Parameters
Mark as active
Mark an inactive item as active.
OAuth Scope : ZohoBooks.settings.CREATE
Mark as inactive
Mark an active item as inactive.
OAuth Scope : ZohoBooks.settings.CREATE