Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zoho Inventory

Zoho Inventory reporting-tags API

Reporting Tags Module

Documentation Provider Profile APIs.io OpenAPI GitHub

Zoho Inventory reporting-tags API is one of 37 APIs that Zoho Inventory publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include reporting-tags. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 14 operations across 11 paths, and defines 34 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://www.zohoapis.com/inventory/v1.

14 operations 11 paths 34 schemas 1 DELETE3 GET6 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://www.zohoapis.com/inventory/v1
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Zoho Inventory reporting-tags API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 1 DELETE, 3 GET, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

reporting-tags 14

Reporting Tags Module

GET
/reportingtags
List of all Reporting Tags
get_tags 1 param → 200
POST
/reportingtags
Create Reporting Tag
create_tag 1 param body → 201
POST
/reportingtags/{tag_id}
Mark an option as default for a reporting tag
mark_default_option 3 params → 200
PUT
/reportingtags/{tag_id}
Update Reporting Tag
update_tag 2 params body → 200
DELETE
/reportingtags/{tag_id}
Delete a reporting tag
delete_tag 2 params → 200
PUT
/reportingtags/{tag_id}/options
Update Reporting Tag Options
update_tag_options 2 params body → 200
PUT
/reportingtags/{tag_id}/criteria
Update Reporting Tag - Visibility Conditions
update_tag_criteria 2 params body → 200
POST
/reportingtags/{tag_id}/active
Mark Reporting Tag as active
active_tag 2 params → 200
POST
/reportingtags/{tag_id}/inactive
Mark Reporting Tag as inactive
inactive_tag 2 params → 200
POST
/reportingtags/{tag_id}/option/(\d+)/active
Mark an option as active
active_tag_option 3 params → 200
POST
/reportingtags/{tag_id}/option/(\d+)/inactive
Mark an option as inactive
inactive_tag_option 3 params → 200
GET
/reportingtags/options
Get Reporting Tags Options Detail Page
get_all_tag_options 2 params → 200
GET
/reportingtags/(\d+)/options/all
Get all Options
all_tag_options 3 params → 200
PUT
/reportingtags/reorder
Reorder Reporting Tags
reorder_tags 1 param body → 200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are options_detail_page_response (10 properties), tag_response (6 properties), update-reporting-tag-request (5 properties), all_options_response (3 properties). Each schema is shown below with its type and property counts.

options_detail_page_response
object
10 properties
update-options-request
object
1 property 1 required
criteria_options
array
Options for criteria
update-reporting-tag-request
object
5 properties 3 required
update-criteria-response
object
1 property
filter_type
string
Type of filter entity. Allowed values: Tag tag and Location location .
reporting-tags-response
object
1 property
is_draft
boolean
Is tag still in draft state
tag_id
string
Tag ID
entities
array
Entities that can only be enabled or disabled which can also be called as mono-preference entities.
tag_response
object
6 properties
filter_option_name
string
Option Name for the filter. It can be an option name or flags. Allowed flags: All - Instead of selecting all options, you can send this flag to denote all opti…
depth
integer
Depth or how much indentation required of the option in the hierarchy
dependent_tags
array
The tags and location that is associated as filter for the tag
multi_preference_entities
object
2 properties
update-criteria-request
object
2 properties 2 required
option_name
string
Option Name
list-reporting-tags-response
array
tag_name
string
Tag Name
update-options-response
object
1 property
filter_tag_id
string
Filter tag ID. If the filter 'type' is location, null should be passed
filter_option_id
string
Option ID for the filter. It can be an option ID or flags. Allowed flags: all - Instead of selecting all options, you can send this flag to denote all options…
criteria_options_response_for_details_page
array
Options selected for the criteria
option_is_active
boolean
Is the option active for the tag
is_mandatory
boolean
Is Mandatory
tag_is_active
boolean
Is the tag active
tag_order
integer
The order in which the tag appears
all_options_response
object
3 properties
is_class
boolean
Is segmentation enabled for the tag
description
string
Description
criteria_tags
array
Filter tags and location
mark-default_option-response
object
2 properties
option_is_default
boolean
Is the option default for the tag
option_id
string
Option ID

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-inventory-reporting-tags-api-openapi.yml Raw ↑

Other APIs Zoho Inventory publishes across the network.

Zoho Inventory batches API
AE Profile APIs.io
Zoho Inventory bills API
AE Profile APIs.io
Zoho Inventory compositeitems API
AE Profile APIs.io
Zoho Inventory contact-persons API
AE Profile APIs.io
Zoho Inventory contacts API
AE Profile APIs.io
Zoho Inventory credit-notes API
AE Profile APIs.io
Zoho Inventory currency API
AE Profile APIs.io
Zoho Inventory customer-payments API
AE Profile APIs.io
Zoho Inventory delivery-challans API
AE Profile APIs.io
Zoho Inventory inventoryadjustments API
AE Profile APIs.io
Zoho Inventory invoices API
AE Profile APIs.io
Zoho Inventory itemgroups API
AE Profile APIs.io
#reporting-tags
← Back to Z APIs
API Details
ID
zoho-inventory:zoho-inventory-reporting-tags-api
Base URL
https://www.zohoapis.com/inventory/v1
Docs
https://www.zoho.com/inventory/api/v1/introduction/
Provider
Zoho Inventory
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network