Items
A product is the item offered for sale. It can be a commodity. Based on the type of your business, you can offer one or more goods.
Possible error codes:
Error Code | Message |
---|---|
1000 | The item name already exist |
2006 | Item does not exist |
2049 | Items which are a part of other transactions cannot be deleted. Instead, mark them as inactive |
2076 | Product type cannot be changed for Items having transactions |
Attribute
Maximum length of the name [100]
active
or inactive
. It tells whether the Item is available for transactions.Maximum characters to be used for describing the item [2000]
goods
or service
Create an Item
Create a new item.
OAuth Scope : ZohoSubscriptions.items.CREATE
Arguments
Maximum length of the name [100]
Maximum characters to be used for describing the item [2000]
goods
or service
is_taxable
is false.List items
Get the list of all active items with pagination.
OAuth Scope : ZohoSubscriptions.items.READ
Query Parameters
Maximum length [100]
. Variants: name_startswith
and name_contains
Maximum length [100]
. Variants: description_startswith
and description_contains
rate_less_than
, rate_less_equals
, rate_greater_than
and rate_greater_equals
Status.All
, Status.Active
and Status.Inactive
Maximum length [100]
name
, rate
and tax_name
Update an item
Update the details of an existing item.
OAuth Scope : ZohoSubscriptions.items.UPDATE
Arguments
Maximum length of the name [100]
Maximum characters to be used for describing the item [2000]
goods
or service
is_taxable
is false.Retrieve an item
Fetch details of an existing item.
OAuth Scope : ZohoSubscriptions.items.READ
Delete an item
Delete an existing item. Items that are part of a transaction cannot be deleted.
OAuth Scope : ZohoSubscriptions.items.DELETE
Mark as active
Mark an inactive item as active.
OAuth Scope : ZohoSubscriptions.items.CREATE
Mark as inactive
Mark an active item as inactive.
OAuth Scope : ZohoSubscriptions.items.CREATE