Zoho Inventory organizations 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 organizations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.
This API exposes
4 operations
across 2 paths,
and defines 60 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.
4 operations2 paths60 schemas2 GET1 POST1 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 organizations API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (Zoho_Auth) using the implicit flow, exposing 4 scopes.
Paths & Operations 4
Across 2 paths, the API surfaces 4 operations — 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
organizations 4
Organizations Module
POST
/organizations
Create an organization
create_organizationbody→ 201
GET
/organizations
List organizations
list_organizations→ 200
PUT
/organizations/{organization_id}
Update an organization
update_organization1 parambody→ 200
GET
/organizations/{organization_id}
Get an organization
get_organization1 param→ 200
Schemas 60
The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are update-an-organization-request (21 properties), organization-response (16 properties), create-an-organization-request (13 properties), address (6 properties). Each schema is shown below with its type and property counts.
country
string
Country of the Organisation
is_default_org
boolean
currency_code
string
Code of the organisation's base currency
remit_to_address
string
Shipping address of the organisation
taxid_label
string
Label "tax ID"
get-an-organization-response
object
3 properties
website
string
Organisation's website
industry_size
string
The size of the industry. The possibe values could be "small scale", "medium scale", "large scale"
companyid_value
string
value in field "company ID"
organization_id
string
ID of the organisation generated by the server
address
object
Billing address of the organisation
6 properties
account_created_date_formatted
string
phone
string
Contact number of the organisation
contact_name
string
Name of the contact person of the organisation
label
string
Label of each column
plan_name
string
Name of the subscribed plan
org_address
string
Billing address of the organisation
street_address2
string
Continyed billing address of the organisation
plan_type
number
Type of the plan subscribed
zip
string
ZIP/Postal code of the organisation's location
date_format
string
update-an-organization-response
object
3 properties
company_id_value
string
Value in the label "company ID"
companyid_label
string
Label " Company ID "
tax_group_enabled
boolean
is_logo_uploaded
string
Boolean to check if logo of the organisation if available
name
string
Name of the Organisation
fiscal_year_start_month
number
Starting month of teh financial year
company_id_label
string
Label denoting company ID
city
string
City of the organisation
update-an-organization-request
object
21 properties
email
string
email ID of the contact person of the organisation
price_precision
number
Precision of the number of places of decimal in price
is_org_active
boolean
plan_period
string
Duration/Cycle of the plan cycle
organization-response
object
List of Organisation - details
16 properties
time_zone
string
Time Zone of the Organisation's country
list-organizations-response
object
3 properties
index
number
Index used to list
custom_fields
array
Additional fields to describe an organisation
portal_name
string
Poratal name for the organisation. Length of the portal name should be greater than 4 and less than 31. Allowed chars [a-z][A-Z][0-9]
value
string
Value of the list
currency_symbol
string
Symbol used to denote currency of a country
fax
string
FAX number of the organisation
tax_id_value
string
Value in the tax ID field
tax_id_label
string
Label in "Tax ID" field
currency_id
string
ID of the organisation curreency
create-an-organization-request
object
13 properties4 required
language_code
string
Language for use
zi_migration_status
number
field_separator
string
Separator used to classify fields
state
string
State where the organisation is located
industry_type
string
Business type
account_created_date
string
Date of creation of the account
currency_format
string
Format of the organisation's currency
create-an-organization-response
object
3 properties
user_role
string
Role of the user(s). A user can be an admin or a non-admin user, accountant, staff member, special user ( this includes custom users)
user_status
string
Status of the user
taxid_value
string
Value in "tax ID"
street_address1
string
Street name of the Billing address of the Organisation
Specification
The full machine-readable OpenAPI contract behind this narrative.
