Reporting Tags

Reporting tags are custom financial labels you add to financial transactions to categorize them by department, cost center, business unit, or any other way based on business needs for reporting. In this document, you'll learn how to create and manage reporting tags for the specific requirements that your organization needs.

Download Reporting Tags OpenAPI Document

End Points

POST

/reportingtags/{tag_id}

PUT

/reportingtags/{tag_id}

DELETE

/reportingtags/{tag_id}

PUT

/reportingtags/{tag_id}/options

PUT

/reportingtags/{tag_id}/criteria

POST

/reportingtags/{tag_id}/active

POST

/reportingtags/{tag_id}/inactive

POST

/reportingtags/{tag_id}/option/(\d+)/active

POST

/reportingtags/{tag_id}/option/(\d+)/inactive

GET

/reportingtags/options

GET

/reportingtags/(\d+)/options/all

PUT

/reportingtags/reorder

Create a reporting tag
OAuth Scope : ZohoInventory.settings.CREATE

Arguments

tag_name

string

(Required)

Tag Name

description

string

Description

is_mandatory

boolean

Is Mandatory

entities

array

(Required)

Entities that can only be enabled or disabled which can also be called as mono-preference entities.

multi_preference_entities

object

(Required)

Show Sub-Attributes

preference

string

(Required)

Preference type. Currently, only 'transaction' and 'line_item' is supported for this node

entities

array

(Required)

Entities that can only be enabled or disabled

Show Sub-Attributes

entity_name

string

Entity Name. Possible Values:
Sales - sales,
Purchases - purchases,
Inventory Adjustment - inventory_adjustment

is_enabled

boolean

(Required)

Is Enabled

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags?organization_id=10234695"
type: POST
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags?organization_id=10234695")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("POST", "/inventory/v3/reportingtags?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "tag_name": "Business Unit",
    "description": "Description of the reporting tag",
    "is_mandatory": false,
    "entities": [
        {
            "entity_name": "customers",
            "is_enabled": true
        },
        {
            "entity_name": "vendors",
            "is_enabled": true
        },
        {
            "entity_name": "items",
            "is_enabled": true
        }
    ],
    "multi_preference_entities": {
        "preference": "line_item",
        "entities": [
            {
                "entity_name": "sales",
                "is_enabled": true
            },
            {
                "entity_name": "purchases",
                "is_enabled": true
            },
            {
                "entity_name": "inventory_adjustment",
                "is_enabled": true
            }
        ]
    }
}

{
    "tag": {
        "tag_id": "460000000038080",
        "tag_name": "Business Unit",
        "description": "Description of the reporting tag",
        "is_mandatory": false,
        "entities": [
            {
                "entity_name": "customers",
                "is_enabled": true
            },
            {
                "entity_name": "vendors",
                "is_enabled": true
            },
            {
                "entity_name": "items",
                "is_enabled": true
            }
        ],
        "multi_preference_entities": {
            "preference": "line_item",
            "entities": [
                {
                    "entity_name": "sales",
                    "is_enabled": true
                },
                {
                    "entity_name": "purchases",
                    "is_enabled": true
                },
                {
                    "entity_name": "inventory_adjustment",
                    "is_enabled": true
                }
            ]
        }
    }
}

Get a list of all reporting tags in the preferred order that you can set.
OAuth Scope : ZohoInventory.settings.READ

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags?organization_id=10234695"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags?organization_id=10234695")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v3/reportingtags?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "reporting_tags": [
        {
            "tag_id": "460000000038080",
            "tag_name": "Business Unit",
            "tag_order": 1,
            "description": "Description of the reporting tag",
            "is_active": true,
            "is_mandatory": false,
            "is_class": false,
            "is_draft": false
        },
        {
            "tag_id": "460000000038081",
            "tag_name": "Sales Region",
            "tag_order": 2,
            "description": "Description of the reporting tag",
            "is_active": true,
            "is_mandatory": false,
            "is_class": true,
            "is_draft": false
        },
        {
            "tag_id": "460000000038082",
            "tag_name": "Department",
            "tag_order": 3,
            "description": "Description of the reporting tag",
            "is_active": false,
            "is_mandatory": true,
            "is_class": false,
            "is_draft": true
        }
    ]
}

Mark an option as the default option or clear default option for a reporting tag.
OAuth Scope : ZohoInventory.settings.READ

Path Parameters

tag_id

string

(Required)

ID of the reporting tag

Query Parameters

organization_id

string

(Required)

ID of the organization

default_option_id

string

(Required)

ID of the option to be marked as default. If this parameter is not sent or sent empty, the current default option of the tag will be removed.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695&default_option_id=460000000038081"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695&default_option_id=460000000038081")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695&default_option_id=460000000038081', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v3/reportingtags/460000000038080?organization_id=10234695&default_option_id=460000000038081", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/460000000038080?organization_id=10234695&default_option_id=460000000038081",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695&default_option_id=460000000038081' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "The option has been marked as default."
}

Update a reporting tag
OAuth Scope : ZohoInventory.settings.UPDATE

Arguments

tag_name

string

(Required)

Tag Name

description

string

Description

is_mandatory

boolean

Is Mandatory

entities

array

(Required)

Entities that can only be enabled or disabled which can also be called as mono-preference entities.

multi_preference_entities

object

(Required)

Show Sub-Attributes

preference

string

(Required)

Preference type. Currently, only 'transaction' and 'line_item' is supported for this node

entities

array

(Required)

Entities that can only be enabled or disabled

Show Sub-Attributes

entity_name

string

Entity Name. Possible Values:
Sales - sales,
Purchases - purchases,
Inventory Adjustment - inventory_adjustment

is_enabled

boolean

(Required)

Is Enabled

Path Parameters

tag_id

string

(Required)

ID of the reporting tag

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v3/reportingtags/460000000038080?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/460000000038080?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "tag_name": "Business Unit",
    "description": "Description of the reporting tag",
    "is_mandatory": false,
    "entities": [
        {
            "entity_name": "customers",
            "is_enabled": true
        },
        {
            "entity_name": "vendors",
            "is_enabled": true
        },
        {
            "entity_name": "items",
            "is_enabled": true
        }
    ],
    "multi_preference_entities": {
        "preference": "line_item",
        "entities": [
            {
                "entity_name": "sales",
                "is_enabled": true
            },
            {
                "entity_name": "purchases",
                "is_enabled": true
            },
            {
                "entity_name": "inventory_adjustment",
                "is_enabled": true
            }
        ]
    }
}

{
    "tag": {
        "tag_id": "460000000038080",
        "tag_name": "Business Unit",
        "description": "Description of the reporting tag",
        "is_mandatory": false,
        "entities": [
            {
                "entity_name": "customers",
                "is_enabled": true
            },
            {
                "entity_name": "vendors",
                "is_enabled": true
            },
            {
                "entity_name": "items",
                "is_enabled": true
            }
        ],
        "multi_preference_entities": {
            "preference": "line_item",
            "entities": [
                {
                    "entity_name": "sales",
                    "is_enabled": true
                },
                {
                    "entity_name": "purchases",
                    "is_enabled": true
                },
                {
                    "entity_name": "inventory_adjustment",
                    "is_enabled": true
                }
            ]
        }
    }
}

Delete a reporting tag. If there are any usages of the reporting tag in transactions, custom views or workflows, you will not be able to delete the tag.
OAuth Scope : ZohoInventory.settings.DELETE

Path Parameters

tag_id

string

(Required)

ID of the reporting tag

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695"
type: DELETE
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695")
  .delete(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'DELETE',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("DELETE", "/inventory/v3/reportingtags/460000000038080?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "DELETE",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/460000000038080?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request DELETE \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "message": "The reporting tag has been deleted successfully."
}

Create, update or delete the options of a reporting tag. Reorder and arrange them in an hierarchical structure as per your organization requirements.
NOTE:

An option cannot be a child option beyond five hierarchical level.
The overall children of an option cannot exceed 500 options.

OAuth Scope : ZohoInventory.settings.UPDATE

Arguments

options

array

(Required)

Show Sub-Attributes

option_name

string

(Required)

Option Name

option_id

string

Option ID

is_active

boolean

Is the option active for the tag

is_default

boolean

Is the option default for the tag

children

array

Show Sub-Attributes

option_id

string

Option ID

option_name

string

(Required)

Option Name

is_active

boolean

Is the option active for the tag

is_default

boolean

Is the option default for the tag

Path Parameters

tag_id

string

(Required)

ID of the reporting tag

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/options?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/options?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/options?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v3/reportingtags/460000000038080/options?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/460000000038080/options?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/options?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "options": [
        {
            "option_id": "460000000038082",
            "option_name": "ES-2003",
            "is_active": true,
            "is_default": true,
            "children": [
                {
                    "option_id": "460000000038088",
                    "children": [],
                    "option_name": "ES-2003 Sec - B",
                    "is_active": true
                },
                {
                    "option_name": "ES-2003 Sec - C",
                    "is_active": true,
                    "children": [
                        {
                            "children": [],
                            "option_name": "EES-2003",
                            "is_active": true
                        }
                    ]
                }
            ]
        },
        {
            "option_id": "460000000038084",
            "option_name": "ES-N-2016",
            "is_active": true,
            "is_default": false,
            "children": []
        },
        {
            "option_id": "460000000038086",
            "option_name": "HS & ES-N",
            "is_active": true,
            "is_default": false,
            "children": []
        }
    ]
}

{
    "message": "Options updated successfully"
}

Update the visibility conditions (or filter in some places) of a reporting tag. You can set other tags or location as filters for a tag. Check our help document to know about the requirements of a tag to be associated as a filter to another tag.
OAuth Scope : ZohoInventory.settings.UPDATE

Arguments

criteria_tags

array

Filter tags and location

Show Sub-Attributes

tag_id

string

Filter tag ID. If the filter 'type' is location, null should be passed

type

string

Type of filter entity.
Allowed values: Tag tag and Location location.

options

array

Options for criteria

Show Sub-Attributes

option_id

string

Option ID

criteria_options

array

List containing filter tags and location

Show Sub-Attributes

tag_id

string

Filter tag ID. If the filter 'type' is location, null should be passed

type

string

Type of filter entity.
Allowed values: Tag tag and Location location.

options

array

Options selected for the criteria

Path Parameters

tag_id

string

(Required)

ID of the reporting tag

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/criteria?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/criteria?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/criteria?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v3/reportingtags/460000000038080/criteria?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/460000000038080/criteria?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/criteria?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "criteria_tags": [
        {
            "tag_id": "460000000038081",
            "type": "tag"
        }
    ],
    "options": [
        {
            "option_id": "460000000038081",
            "criteria_options": [
                {
                    "tag_id": "460000000038081",
                    "type": "tag",
                    "options": [
                        "460000000038081"
                    ]
                }
            ]
        }
    ]
}

{
    "message": "The criteria has been updated."
}

Mark a reporting tag as active so that you can use it on entities which you allowed. A newly created tag will be in draft state. Use this to mark that tag as ready.
OAuth Scope : ZohoInventory.settings.UPDATE

Path Parameters

tag_id

string

(Required)

ID of the reporting tag

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/active?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/active?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/active?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v3/reportingtags/460000000038080/active?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/460000000038080/active?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/active?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "message": "The reporting tag has been activated."
}

Mark a reporting tag as inactive.
OAuth Scope : ZohoInventory.settings.UPDATE

Path Parameters

tag_id

string

(Required)

ID of the reporting tag

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/inactive?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/inactive?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/inactive?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v3/reportingtags/460000000038080/inactive?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/460000000038080/inactive?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/inactive?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "message": "The reporting tag has been deactivated."
}

Mark a reporting tag's option as active.
OAuth Scope : ZohoInventory.settings.UPDATE

Path Parameters

tag_id

string

(Required)

ID of the reporting tag

option_id

string

(Required)

ID of a reporting tag's option

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/option/(/d+)/active?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/option/(/d+)/active?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/option/(/d+)/active?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v3/reportingtags/460000000038080/option/(/d+)/active?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/460000000038080/option/(/d+)/active?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/option/(/d+)/active?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "message": "The reporting tag option has been activated."
}

Mark a reporting tag's option as inactive.
OAuth Scope : ZohoInventory.settings.UPDATE

Path Parameters

tag_id

string

(Required)

ID of the reporting tag

option_id

string

(Required)

ID of a reporting tag's option

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/option/(/d+)/inactive?organization_id=10234695"
type: POST
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/option/(/d+)/inactive?organization_id=10234695")
  .post(null)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/option/(/d+)/inactive?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("POST", "/inventory/v3/reportingtags/460000000038080/option/(/d+)/inactive?organization_id=10234695", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "POST",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/460000000038080/option/(/d+)/inactive?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request POST \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/460000000038080/option/(/d+)/inactive?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "message": "The reporting tag option has been deactivated."
}

Get the options and its criteria details of a reporting tag. For each page, you can retrieve only 200 options.
OAuth Scope : ZohoInventory.settings.READ

Query Parameters

organization_id

string

(Required)

ID of the organization

tag_id

string

(Required)

ID of the reporting tag

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/options?organization_id=10234695&tag_id=460000000038080"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/options?organization_id=10234695&tag_id=460000000038080")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/options?organization_id=10234695&tag_id=460000000038080', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v3/reportingtags/options?organization_id=10234695&tag_id=460000000038080", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/options?organization_id=10234695&tag_id=460000000038080",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/options?organization_id=10234695&tag_id=460000000038080' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "dependent_tags": [
        {
            "dependent_id": "",
            "dependent_name": "Location",
            "dependent_type": "location",
            "dependent_order": "",
            "dependent_options": [
                {
                    "dependent_option_id": "460000000058078",
                    "dependent_option_name": "Europe",
                    "dependent_option_order": ""
                },
                {
                    "dependent_option_id": "460000000058080",
                    "dependent_option_name": "Asia",
                    "dependent_option_order": ""
                },
                {
                    "dependent_option_id": "460000000058082",
                    "dependent_option_name": "India",
                    "dependent_option_order": ""
                },
                {
                    "dependent_option_id": "460000000058084",
                    "dependent_option_name": "North America",
                    "dependent_option_order": ""
                }
            ]
        },
        {
            "dependent_id": "460000000038078",
            "dependent_name": "Business Type",
            "dependent_type": "tag",
            "dependent_order": 1,
            "dependent_options": [
                {
                    "dependent_option_id": "460000000038080",
                    "dependent_option_name": "Government",
                    "dependent_option_order": ""
                },
                {
                    "dependent_option_id": "460000000038076",
                    "dependent_option_name": "Military / Defense",
                    "dependent_option_order": ""
                }
            ]
        },
        {...},
        {...}
    ],
    "description": "Description of the reporting tag",
    "is_class": false,
    "is_draft": false,
    "tag_id": "460000000038080",
    "tag_name": "Business Unit",
    "options": [
        {
            "option_id": "460000000038081",
            "option_name": "Sales",
            "is_active": true,
            "is_default": false,
            "depth": 0,
            "option_order": 1,
            "parent_id": "",
            "parent_name": "",
            "criteria": [
                {
                    "options": [
                        "Asia",
                        "India",
                        "Europe"
                    ],
                    "criteria_id": "460000000048081",
                    "tag_id": "",
                    "type": "location"
                },
                {
                    "options": [
                        "Untagged",
                        "Government",
                        "Military / Defense"
                    ],
                    "criteria_id": "460000000048083",
                    "tag_id": "460000000038078",
                    "type": "tag"
                }
            ],
            "children": [
                {
                    "option_id": "460000000038083",
                    "option_name": "Sales - Central",
                    "children": [],
                    "is_active": true,
                    "is_default": false,
                    "depth": 0,
                    "option_order": 2,
                    "parent_id": "",
                    "parent_name": "",
                    "criteria": [
                        {
                            "options": [
                                "Asia",
                                "North America"
                            ],
                            "criteria_id": "460000000048081",
                            "tag_id": "",
                            "type": "location"
                        },
                        {
                            "options": [
                                "All"
                            ],
                            "criteria_id": "460000000048083",
                            "tag_id": "460000000038078",
                            "type": "tag"
                        }
                    ]
                }
            ]
        }
    ],
    "page_context": {
        "page": 1,
        "per_page": 200,
        "has_more_page": false
    }
}

Get all options for a reporting tag.
OAuth Scope : ZohoInventory.settings.READ

Query Parameters

organization_id

string

(Required)

ID of the organization

tag_id

string

(Required)

ID of the reporting tag

show_untagged

boolean

'untagged' will be included in the response if this parameter is set to true.

Request Example

headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/(/d+)/options/all?organization_id=10234695&tag_id=460000000038080"
type: GET
headers: headers_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/(/d+)/options/all?organization_id=10234695&tag_id=460000000038080")
  .get()
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'
  }
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/(/d+)/options/all?organization_id=10234695&tag_id=460000000038080', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" }

conn.request("GET", "/inventory/v3/reportingtags/(/d+)/options/all?organization_id=10234695&tag_id=460000000038080", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "GET",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/(/d+)/options/all?organization_id=10234695&tag_id=460000000038080",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

curl --request GET \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/(/d+)/options/all?organization_id=10234695&tag_id=460000000038080' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

{
    "code": 0,
    "message": "success",
    "results": [
        {
            "option_id": "460000000038081",
            "option_name": "Sales",
            "depth": 0
        },
        {
            "option_id": "460000000038083",
            "option_name": "Sales - Central",
            "depth": 1
        },
        {
            "option_id": "untagged",
            "option_name": "Untagged",
            "depth": 0
        },
        {...},
        {...}
    ]
}

Reorder the reporting tags in your organization. The order of tags will be followed in transactions and reports.
OAuth Scope : ZohoInventory.settings.UPDATE

Arguments

tag_ids

array

List of reporting tag IDs in the desired order

Query Parameters

organization_id

string

(Required)

ID of the organization

Request Example

parameters_data='{"field1":"value1","field2":"value2"}';
headers_data = Map();
headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f");
response = invokeUrl
[
url: "https://www.zohoapis.com/inventory/v3/reportingtags/reorder?organization_id=10234695"
type: PUT
headers: headers_data
content-type: application/json
parameters: parameters_data
connection: <connection_name>
];
info response;

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v3/reportingtags/reorder?organization_id=10234695")
  .put(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

const options = {
  method: 'PUT',
  headers: {
    Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f',
    'content-type': 'application/json'
  },
  body: '{"field1":"value1","field2":"value2"}'
};

fetch('https://www.zohoapis.com/inventory/v3/reportingtags/reorder?organization_id=10234695', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"

headers = {
    'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    'content-type': "application/json"
    }

conn.request("PUT", "/inventory/v3/reportingtags/reorder?organization_id=10234695", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

const http = require("https");

const options = {
  "method": "PUT",
  "hostname": "www.zohoapis.com",
  "port": null,
  "path": "/inventory/v3/reportingtags/reorder?organization_id=10234695",
  "headers": {
    "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
    "content-type": "application/json"
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({field1: 'value1', field2: 'value2'}));
req.end();

curl --request PUT \
  --url 'https://www.zohoapis.com/inventory/v3/reportingtags/reorder?organization_id=10234695' \
  --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \
  --header 'content-type: application/json' \
  --data '{"field1":"value1","field2":"value2"}'

{
    "tag_ids": [
        "460000000038080",
        "460000000038081",
        "460000000038082"
    ]
}

{
    "code": 0,
    "message": "The reporting tags have been reordered successfully.",
    "tags": [
        {
            "tag_id": "460000000038080",
            "tag_name": "Business Unit",
            "tag_order": 1,
            "description": "Description of the reporting tag",
            "is_active": true,
            "is_mandatory": false,
            "is_class": false,
            "is_draft": false
        },
        {
            "tag_id": "460000000038081",
            "tag_name": "Sales Region",
            "tag_order": 2,
            "description": "Description of the reporting tag",
            "is_active": true,
            "is_mandatory": false,
            "is_class": true,
            "is_draft": false
        },
        {
            "tag_id": "460000000038082",
            "tag_name": "Department",
            "tag_order": 3,
            "description": "Description of the reporting tag",
            "is_active": false,
            "is_mandatory": true,
            "is_class": false,
            "is_draft": true
        },
        {...},
        {...}
    ]
}

Create Reporting Tag

Arguments

Query Parameters

List of all Reporting Tags

Query Parameters

Mark an option as default for a reporting tag

Path Parameters

Query Parameters

Update Reporting Tag

Arguments

Path Parameters

Query Parameters

Delete a reporting tag

Path Parameters

Query Parameters

Update Reporting Tag Options

Arguments

Path Parameters

Query Parameters

Update Reporting Tag - Visibility Conditions

Arguments

Path Parameters

Query Parameters

Mark Reporting Tag as active

Path Parameters

Query Parameters

Mark Reporting Tag as inactive

Path Parameters

Query Parameters

Mark an option as active

Path Parameters

Query Parameters

Mark an option as inactive

Path Parameters

Query Parameters

Get Reporting Tags Options Detail Page

Query Parameters

Get all Options

Query Parameters

Reorder Reporting Tags

Arguments

Query Parameters