Introduction

API Root Endpoint

https://inventory.zoho.com/api/v1
  

The Zoho Inventory API allows you to perform all the operations that you do with our web client.

Zoho Inventory API is built using REST principles which ensures predictable URLs that makes writing applications easy. This API follows HTTP rules, enabling a wide range of HTTP clients which can be used to interact with the API.

Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.

Getting Started

Example

 
 $ curl https://inventory.zoho.com/api/v1/organizations?organization_id=10234695
      -H  'Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f'
 

 

To use our API you must satisfy these prerequistes

1. A valid Zoho username and password.
2. An Authentication Token - authtoken in short!

Multiple Data Centers

Zoho Inventory is hosted at multiple data centers, and therefore available on different domains.

There are 4 different domains for Zoho Inventory's APIs, and you will have to use the one that is applicable to you.

The APIs on this page are for organizations in Zoho Inventory that are hosted on the .com domain. If your organization is on a different domain, then you must replace .com with the appropriate domain for API endpoints on this page before using them.

Note: To find out which domain you're accessing Zoho Inventory from, visit the Zoho Inventory web app and check its URL. If the URL contains inventory.zoho.com, then you're accessing it from the .com domain. If the URL contains inventory.zoho.in, you're accessing it from the .in domain. Similarly, you could be accessing Zoho Inventory from the .eu or .com.au domain.

For example, here's how you would modify the domain in an API endpoint for the .eu domain:

API endpoint for the .com domain, as available on this page:

https://inventory.zoho.com/api/v1/items

API endpoint after replacing the .com domain with .eu:

https://inventory.zoho.eu/api/v1/items

OAuth

Zoho REST APIs uses the OAuth 2.0 protocol to authorize and authenticate calls (The above approach of authentication via Authtoken will be deprecated soon). It provides secure access to protect resources thereby reducing the hassle of asking for a username and password everytime a user logs in. Follow the steps listed here, to access Zoho’s APIs using OAuth 2.0

Note:The API URLs in this section should be modified, based on your domain.

You can read more about this here.

Step 1: Registering New Client

You will have to first register your application with Zoho's Developer console in order get your Client ID and Client Secret.

To register your application, go to https://accounts.zoho.com/developerconsole and click on Add Client ID. Provide the required details to register your application.

On successful registration, you will be provided with a set of OAuth 2.0 credentials such as a Client ID and Client Secret that are known to both Zoho and your application. Do not share this credentials anywhere.

Step 2: Generating Grant Token

Redirect to the following authorization URL with the given params

https://accounts.zoho.com/oauth/v2/auth?

Request Example

https://accounts.zoho.com/oauth/v2/auth?scope=ZohoInventory.invoices.CREATE,ZohoInventory.invoices.READ,ZohoInventory.invoices.UPDATE,ZohoInventory.invoices.DELETE&client_id=1000.0SRSZSY37WMZ69405H3TMYI2239V&state=testing&response_type=code&redirect_uri=http://www.zoho.com/inventory&access_type=offline

Note: Fields with * are mandatory

On this request, you will be shown with a "user consent page".

Upon clicking “Accept”, Zoho will redirect to the given redirect_uri with code and state param. This code value is mandatory to get the access token in the next step and this code is valid for 60 seconds.

On clicking “Deny”, the server returns an error

Step 3: Generate Access and Refresh Token

After getting code from the above step, make a POST request for the following URL with given params, to generate the access_token.

https://accounts.zoho.com/oauth/v2/token?

Request Example

https://accounts.zoho.com/oauth/v2/token?code=1000.dd7e47321d48b8a7e312e3d6eb1a9bb8.b6c07ac766ec11da98bf6a261e24dca4&client_id=1000.0SRSZSY37WMZ69405H3TMYI2239V&client_secret=fb0196010f2b70df8db2a173ca2cf59388798abf&redirect_uri=http://www.zoho.com/inventory&grant_type=authorization_code

Note: Fields with * are mandatory

In the response, you will get both access_token and refresh_token.

1. The access_token will expire after a particular period (as given in expires_in param in the response).

2. The refresh_token is permanent and will be used to regenerate new access_token, if the current access token is expired.

Note: Each time a re-consent page is accepted, a new refresh token is generated. The maximum limit is 20 refresh tokens per user. If this limit is crossed, the first refresh token is automatically deleted to accommodate the latest one. This is done irrespective of whether the first refresh token is in use or not.

Step 4: Generate Access Token From Refresh Token

Access Tokens have limited validity. In most general cases the access tokens expire in one hour. Until then, the access token has unlimited usage. Once it expires, your app will have to use the refresh token to request for a new access token. Redirect to the following POST URL with the given params to get a new access token

https://accounts.zoho.com/oauth/v2/token?

Request Example

https://accounts.zoho.com/oauth/v2/token?refresh_token=1000.8ecd474019e31d52d2f94aad6c5cb7.4638677ebc14f2f2ee0b6dfb6cebdc&client_id=1000.0SRSZSY37WMZ69405H3TMYI2239V&client_secret=fb0196010f2b70df8db2a173ca2cf59388798abf&redirect_uri=http://www.zoho.com/inventory&grant_type=authorization_code

Step 5: Revoking a Refresh Token

To revoke a refresh token, call the following POST URL with the given params

https://accounts.zoho.com/oauth/v2/token/revoke?

Request Example

https://accounts.zoho.com/oauth/v2/token/revoke?refresh_token=1000.8ecd474019e31d522f94aad6c5cb7.4638677ebc14f2f2ee0b6dfb6cebdc

Step 6: Calling An API

Access Token can be passed only in header and cannot be passed in the request param.

• Header name should be Authorization
• Header value should be Zoho-oauthtoken {access_token}

List of scopes available in Zoho Inventory :

Convert Authtokens to OAuth

• Convert Authtokens to OAuth for Self-client Applications
• Convert Authtokens to OAuth for Redirection-based Applications
• Convert Authtokens to OAuth in Existing Deluge Scripts

Convert Authtokens to OAuth for Self-client Applications

Learn how to convert Authtokens in your existing workflows to OAuth 2.0's access and refresh tokens.

Note: This guide is intended for standalone, server-side applications that perform back-end jobs without a domain or redirect URL. If you want to convert Authtokens to OAuth for redirection-based applications, refer to the guide for Redirection-based Applications instead.

Prerequisites

Register your application as a client in Zoho's API Console to receive a Client ID and Client Secret for your application. Visit OAuth’s documentation to learn how.

How it Works

1. Your client makes a POST call to the "Migration for Self-client Applications" API with your Client ID, Client Secret, Authtoken, and the required OAuth scope(s).
2. Zoho Accounts checks whether the service names in the Authtoken and OAuth scopes match.
3. Next, Zoho Accounts checks whether your Client ID and Authtoken have the same owner.
4. If this validation is successful, Zoho Accounts generates OAuth access and refresh tokens for your client. If not, the system throws an "access_denied" error.
5. 24 hours after the OAuth tokens have been generated, Zoho Accounts deletes your Authtoken automatically.

You will receive an email from Zoho Accounts as soon as this process has been completed.

Sample Response

    

        
          {
          "access_token": "1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxfa",
          "refresh_token": "1000.95xxxxxxxxxxxxxxxb0de.10bxxxxxxxxxxxxxxx31b",
          "expires_in": 3600,
          "token_type": "Bearer"
          }
        
    
 

Request Method

POST

Request URL

https://accounts.zoho.com/oauth/v2/token/self/authtooauth

Request Parameters

All of these parameters must be present in your API request.

Troubleshooting

Note: You can make a maximum of 25 such conversion requests per minute and 60 per hour.

Convert Authtokens to OAuth for Redirection-based Applications

Learn how to convert Authtokens in your existing workflows to OAuth 2.0's access and refresh tokens.

This guide is intended for applications that have multiple users, where usernames and passwords are used to generate Authtokens, or applications where the users input their Authtokens. If you want to convert Authtokens to OAuth for self-client applications, refer to the guide for Self-client Applications instead.

Prerequisites

• Register your application as a client in Zoho's API Console to receive a Client ID and Client Secret for your application. Visit Oauth's documentation to learn how.
• Send an email to support@zohoinventory.com with your Client ID, Authtoken scope(s) and the required OAuth scope(s). The Zoho Inventory team will validate these details and register them in Zoho Accounts. We'll notify you via email when this process has been completed.

How it Works

1. Your client makes a POST call to the "Migration for Redirection-based Applications" API with your Client ID, Client Secret, and Authtoken.
2. Zoho Accounts checks whether the parameters passed in this request have been verified. If successful, Zoho Accounts generates OAuth access and refresh tokens for your client. If not, the system throws an "access_denied" error.
3. 24 hours after the OAuth tokens have been generated, Zoho Accounts deletes your Authtoken automatically.

You will receive an email from Zoho Accounts as soon as this process has been completed.

Sample Response

    

        
          {
          "access_token": "1000.03xxxxxxxxxxxxxxxxxa5317.dxxxxxxxxxxxxxfa",
          "refresh_token": "1000.95xxxxxxxxxxxxxxxb0de.10bxxxxxxxxxxxxxxx31b",
          "expires_in": 3600,
          "token_type": "Bearer"
          }
        
    
 

Request Method

POST

Request URL

https://accounts.zoho.com/oauth/v2/token/external/authtooauth

Request Parameters

All of these parameters must be present in your API request.

Troubleshooting

Note: You can make a maximum of 60 such conversion requests per minute and 100 per hour.

Convert Authtokens to OAuth in Existing Deluge Scripts

If your Deluge script uses Authtokens to invoke any Zoho APIs, you will need to change this script from Authtoken to OAuth-based authentication. This can be done with ease using Deluge's Connections. Learn how to set up and create new Connections.

Once you've created a Connection, simply remove the Authtoken details from your existing script and replace it with Connections instead. Here's how:

Existing Deluge script:

Example 1: An InvokeURL task with Authtoken-based authentication

  invoiceID = invoice.get("invoice_id");
  invoicedate = invoice.get("date").toDate();
  organizationID = organization.get("organization_id");
  authtoken = "XXXXXXXXXXXXXXX";
  invDetails = invokeurl
  [
  	url :"https://inventory.zoho.com/api/v1/invoices/" + invoiceID + "?organization_id=" + organizationID + "&authtoken="+ authtoken
  	type :GET
  ];

Example 2: A GetURL/PostURL task with Authtoken-based authentication

  invoiceID = invoice.get("invoice_id");
  invoicedate = invoice.get("date").toDate();
  organizationID = organization.get("organization_id");
  authtoken = "XXXXXXXXXXXXX";
  result = getUrl("https://inventory.zoho.com/api/v1/invoices/" + invoiceID + "?organization_id=" + organizationID + "&authtoken=" + authtoken);

Revised Deluge script with OAuth-based authentication:

  invoiceID = invoice.get("invoice_id");
  invoicedate = invoice.get("date").toDate();
  organizationID = organization.get("organization_id");
  invDetails = invokeurl
  [
    url :"https://inventory.zoho.com/api/v1/invoices/" + invoiceID + "?organization_id=" + organizationID
    type :GET
  connection : inventoryconnection
  ];

Here, inventoryconnection is the name of the Connection in Deluge, and you will have to replace it with your own Connection's name.

Once these changes have been made, your Deluge script will start using OAuth 2.0 for authentication with Zoho APIs.

Adding Connection Details to Integration Tasks

To ensure that the integration tasks in your Deluge scripts use OAuth 2.0, you must add Connection details to them.

Note: You need not make these changes to integration tasks which were created before November 2020, as Deluge will take care of this automatically.

  invoiceID = invoice.get("invoice_id");
  organizationID = organization.get("organization_id");
  invDetails = zoho.inventory.getRecordsByID("invoices", organizationID, invoiceID,"inventoryconnection");
  info invDetails;

The example on the right is of an existing integration task, to which we've added Connection details.

Here, inventoryconnection is the name of the Connection.

Organization ID

Request Example

$ curl https://inventory.zoho.com/api/v1/organizations?authtoken=ba4604e8e433g9c892e360d53463oec5
 

Response Example

HTTP/1.1 200 OK
 Content-Type:application/json;charset=UTF-8
 {
   "code": 0,
   "message": "success",
   "organizations": [
     {
       "organization_id": "10234695",
       "name": "Zillum",
       "contact_name": "John Smith",
       "email": "johnsmith@zillum.com",
       "is_default_org": false,
       "language_code": "en",
       "fiscal_year_start_month": 0,
       "account_created_date": "2016-02-18",
       "time_zone": "PST",
       "is_org_active": true,
       "currency_id": "460000000000097",
       "currency_code": "USD",
       "currency_symbol": "$",
       "currency_format": "###,##0.00",
       "price_precision": 2
     },
     {...},
     {...}
   ]
 

In Zoho Inventory, your business is termed as an organization. If you have multiple businesses, you simply set each of those up as an individual organization. Each organization is an independent Zoho Inventory Organization with it’s own organization ID, base currency, time zone, language, contacts, reports, etc.

The parameter organization_id along with the organization ID should be sent in with every API request to identify the organization.

The organization_id can be obtained from the GET /organizations API’s JSON response. Alternatively, it can be obtained from the Manage Organizations page in the admin console:

Login to the Zoho Inventory admin console. Click the drop down with organization’s name as the label and click Manage Organizations.

Now you’ll be able to find Organization IDs for each of your organizations.

HTTP Methods

Using GET method, you can get the list of resources or details of a particular instance of a resource.
 To get a list of contacts
 

$ curl https://inventory.zoho.com/api/v1/contacts?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695
 

 To get the details of a contact referred to by a specified contact_id
 

 $ curl https://inventory.zoho.com/api/v1/contacts/903000000000099?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695
 

Zoho Inventory API uses appropriate HTTP verbs for every action.

Response

Response Structure

 The response structure for the invoice API follows the below format.
 

{
     "code" : 0,
     "message" : "success",
     "invoice" : {
         "invoice_id" : "..."
     }
 }
 

Request Example

 $ curl https://inventory.zoho.com/api/v1/invoices/7000000079426?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695
     -H 'Accept: application/pdf'
 

                    OR
 

 $ curl https://inventory.zoho.com/api/v1/invoices/7000000079426?accept=pdf \
     '&authtoken=ba4604e8e433g9c892e360d53463oec5' \
     '&organization_id=10234695'
 

Responses will be in the JSON format.

Response Header Example

 HTTP/1.1 200 OK
 Content-Disposition: attachment; filename="INV-384.pdf"
 Content-Type: application/pdf;charset=UTF-8
 

Other Formats

Certain APIs support csv and pdf formats as well for which the required response format needs to be specified in the respective request’s Accept header or accept query parameter.

Date

All timestamps are returned in the ISO 8601 format - YYYY-MM-DDThh:mm:ssTZD.

Example: 2016-06-11T17:38:06-0700

Errors

Request Example

 $ curl https://inventory.zoho.com/api/v1/invoices/700000007942?authtoken=ba4604e8e433g9c892e360d53463oec5&organization_id=10234695
 

Response Example

 HTTP/1.1 404 Not Found
 Content-Type: application/json;charset=UTF-8
 {
     "code": 1002,
     "message": "Invoice does not exist."
 }
 

Zoho Inventory uses HTTP status codes to indicate success or failure of an API call. In general, status codes in the 2xx range means success, 4xx range means there was an error in the provided information, and those in the 5xx range indicate server side errors. Commonly used HTTP status codes are listed below.

HTTP Status Codes

Pagination

Example

 $ curl https://inventory.zoho.com/api/v1/contacts?page=2&per_page=25
 {
     "code": 0,
     "message": "success",
     "contacts": [
             {...},
             {...}
     ],
     "page_context": {
         "page": 2,
         "per_page": 25,
         "has_more_page": false
     }
 }
 

Zoho Inventory provides APIs to retrieve lists of contacts, plans and other resources - paginated to 200 items by default. The pagination information will be included in the list API response under the node name page_context.

• By default first page will be listed. For navigating through pages, use the page parameter.
• The per_page parameter can be used to set the number of records that you want to receive in response.

API Call Limit

API calls are limited to provide better quality of service and availability to all the users. You can send a maximum of 1000 API requests per day per organization during the free plan. However, if the organization is on a paid plan you can send up to 5000 API requests per day per organization.

Organizations

An Organisation represents a company or an institution running a business.

Example

{}

Attribute

Create an organization

Create an organization.
oauthscope : ZohoInventory.settings.CREATE

POST /organizations

Request Example

  

$ curl https://inventory.zoho.com/api/v1/organizations?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "name": "Zillium Inc",
    "fiscal_year_start_month": "january",
    "currency_code": "USD",
    "time_zone": "PST",
    "date_format": "dd MMM yyyy",
    "field_separator": " ",
    "language_code": "en",
    "industry_type": "Services",
    "industry_size": " ",
    "portal_name": "zilluminc",
    "org_address": " ",
    "remit_to_address": " ",
    "address": [
        {
            "street_address1": " ",
            "street_address2": " ",
            "city": " ",
            "state": " ",
            "country": "U.S.A",
            "zip": "U.S.A"
        }
    ]
}"'

Response Example

  

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "organization": {
        "organization_id": "10229182",
        "name": "Zillium Inc",
        "is_logo_uploaded": " ",
        "is_default_org": false,
        "user_role": " ",
        "account_created_date": "2012-02-15",
        "time_zone": "PST",
        "language_code": "en",
        "date_format": "dd MMM yyyy",
        "field_separator": " ",
        "fiscal_year_start_month": 0,
        "tax_group_enabled": true,
        "user_status": " ",
        "contact_name": "John Smith",
        "industry_type": "Services",
        "address": [
            {
                "street_address1": " ",
                "street_address2": " ",
                "city": " ",
                "state": " ",
                "country": "U.S.A",
                "zip": "U.S.A"
            }
        ]
    }
}

ARGUMENTS

Update an organization

Update the details of an organization.
oauthscope : ZohoInventory.settings.UPDATE

PUT /organizations/:organization_id

Request Example

  

$ curl https://inventory.zoho.com/api/v1/organizations/:organization_id?organization_id=10234695
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "name": "Zillium Inc",
    "fiscal_year_start_month": "january",
    "is_logo_uploaded": true,
    "time_zone": "PST",
    "date_format": "dd MMM yyyy",
    "field_separator": " ",
    "language_code": "en",
    "org_address": " ",
    "remit_to_address": " ",
    "address": [
        {
            "street_address1": " ",
            "street_address2": " ",
            "city": " ",
            "state": " ",
            "country": "U.S.A",
            "zip": "U.S.A"
        }
    ],
    "contact_name": "John Smith",
    "phone": " ",
    "fax": " ",
    "website": " ",
    "email": "johndavid@zilliuminc.com",
    "currency_id": "982000000000190",
    "companyid_label": " ",
    "companyid_value": " ",
    "taxid_label": " ",
    "taxid_value": " ",
    "custom_fields": [
        {
            "index": 1,
            "value": " ",
            "label": " "
        }
    ]
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "organization": {
        "organization_id": "10229182",
        "name": "Zillium Inc",
        "is_default_org": false,
        "account_created_date": "2012-02-15",
        "time_zone": "PST",
        "language_code": "en",
        "date_format": "dd MMM yyyy",
        "field_separator": " ",
        "fiscal_year_start_month": 0,
        "contact_name": "John Smith",
        "industry_type": "Services",
        "industry_size": " ",
        "company_id_label": "Company ID",
        "company_id_value": " ",
        "tax_id_label": "Tax ID",
        "tax_id_value": " ",
        "currency_id": "982000000000190",
        "currency_code": "USD",
        "currency_symbol": "$",
        "currency_format": "###,##0.00",
        "price_precision": 2,
        "org_address": " ",
        "remit_to_address": " ",
        "phone": " ",
        "fax": " ",
        "website": " ",
        "email": "johndavid@zilliuminc.com",
        "is_org_active": true,
        "address": [
            {
                "street_address1": " ",
                "street_address2": " ",
                "city": " ",
                "state": " ",
                "country": "U.S.A",
                "zip": "U.S.A"
            }
        ],
        "custom_fields": [
            {
                "index": 1,
                "value": " ",
                "label": " "
            }
        ]
    }
}

ARGUMENTS

List organizations

Get the list of organizations.
oauthscope : ZohoInventory.settings.READ

GET /organizations

Request Example

  

$ curl https://inventory.zoho.com/api/v1/organizations?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "organizations": [
        {
            "organization_id": "10229182",
            "name": "Zillium Inc",
            "contact_name": "John Smith",
            "email": "johndavid@zilliuminc.com",
            "is_default_org": false,
            "plan_type": 130,
            "tax_group_enabled": true,
            "zi_migration_status": 0,
            "plan_name": "PROFESSIONAL",
            "plan_period": "Monthly",
            "language_code": "en",
            "fiscal_year_start_month": 0,
            "account_created_date": "2012-02-15",
            "account_created_date_formatted": "15 Feb 2012",
            "time_zone": "PST",
            "is_org_active": true,
            "currency_id": "982000000000190",
            "currency_code": "USD",
            "currency_symbol": "$",
            "currency_format": "###,##0.00",
            "price_precision": 2
        },
        {...},
        {...}
    ]
}

Get an organization

Get the details of an organization.
oauthscope : ZohoInventory.settings.READ

GET /organizations/:organization_id

Request Example

  

$ curl https://inventory.zoho.com/api/v1/organizations/:organization_id?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "organization": {
        "organization_id": "10229182",
        "name": "Zillium Inc",
        "is_default_org": false,
        "account_created_date": "2012-02-15",
        "time_zone": "PST",
        "language_code": "en",
        "date_format": "dd MMM yyyy",
        "field_separator": " ",
        "fiscal_year_start_month": 0,
        "contact_name": "John Smith",
        "industry_type": "Services",
        "industry_size": " ",
        "company_id_label": "Company ID",
        "company_id_value": " ",
        "tax_id_label": "Tax ID",
        "tax_id_value": " ",
        "currency_id": "982000000000190",
        "currency_code": "USD",
        "currency_symbol": "$",
        "currency_format": "###,##0.00",
        "price_precision": 2,
        "org_address": " ",
        "remit_to_address": " ",
        "phone": " ",
        "fax": " ",
        "website": " ",
        "email": "johndavid@zilliuminc.com",
        "is_org_active": true,
        "address": [
            {
                "street_address1": " ",
                "street_address2": " ",
                "city": " ",
                "state": " ",
                "country": "U.S.A",
                "zip": "U.S.A"
            }
        ],
        "custom_fields": [
            {
                "index": 1,
                "value": " ",
                "label": " "
            }
        ]
    }
}

Contacts

A contact is either a customer or vendor. A contact can be an individual or a business in general.

Example

{
    "contact_name": "Bowman and Co",
    "company_name": "Bowman and Co",
    "first_name": "Will",
    "last_name": "Smith",
    "email": "willsmith@bowmanfurniture.com",
    "phone": "+1-925-921-9201",
    "facebook": "zoho",
    "twitter": "zoho",
    "language_code": "en",
    "billing_address": {
        "attention": "Mr.John",
        "address": "4900 Hopyard Rd",
        "street2": "Suit 310",
        "city": "Pleasanton",
        "state": "CA",
        "zip": 94588,
        "country": "U.S.A"
    },
    "shipping_address": {
        "attention": "Mr.John",
        "address": "4900 Hopyard Rd",
        "street2": "Suit 310",
        "city": "Pleasanton",
        "state": "CA",
        "zip": 94588,
        "country": "U.S.A"
    },
    "contact_persons": [
        {
            "salutation": "Mr",
            "first_name": "Will",
            "last_name": "Smith",
            "email": "willsmith@bowmanfurniture.com",
            "phone": "+1-925-921-9201",
            "mobile": "+1-4054439562",
            "is_primary_contact": true
        }
    ],
    "place_of_contact": "TN",
    "gst_no": "22AAAAA0000A1Z5",
    "gst_treatment": "business_gst"
}

Attribute

Create a Contact

Create a contact with given information.
oauthscope : ZohoInventory.contacts.CREATE

POST /contacts

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "contact_name": "Bowman and Co",
    "company_name": "Bowman and Co",
    "payment_terms": 15,
    "currency_id": 460000000000097,
    "website": "www.bowmanfurniture.com",
    "contact_type": "customer",
    "custom_fields": [
        {
            "value": "GBGD078",
            "index": 1
        }
    ],
    "billing_address": {
        "attention": "Mr.John",
        "address": "4900 Hopyard Rd",
        "street2": "Suit 310",
        "city": "Pleasanton",
        "state": "CA",
        "zip": 94588,
        "country": "U.S.A"
    },
    "shipping_address": {
        "attention": "Mr.John",
        "address": "4900 Hopyard Rd",
        "street2": "Suit 310",
        "city": "Pleasanton",
        "state": "CA",
        "zip": 94588,
        "country": "U.S.A"
    },
    "contact_persons": [
        {
            "salutation": "Mr",
            "first_name": "Will",
            "last_name": "Smith",
            "email": "willsmith@bowmanfurniture.com",
            "phone": "+1-925-921-9201",
            "mobile": "+1-4054439562",
            "is_primary_contact": true
        }
    ],
    "default_templates": {
        "invoice_template_id": 460000000052069,
        "invoice_template_name": "Custom Classic",
        "estimate_template_id": 460000000000179,
        "estimate_template_name": "Service - Professional",
        "creditnote_template_id": 460000000000211,
        "creditnote_template_name": "Fixed Cost - Professional",
        "invoice_email_template_id": 460000000052071,
        "invoice_email_template_name": "Custom Invoice Notification",
        "estimate_email_template_id": 460000000052073,
        "estimate_email_template_name": "Custom Estimate Notification",
        "creditnote_email_template_id": 460000000052075,
        "creditnote_email_template_name": "Custom Credit Note Notification"
    },
    "language_code": "en",
    "notes": "Payment option : Through check",
    "tax_exemption_id": 11149000000061054,
    "tax_authority_id": 11149000000061052,
    "tax_id": 11149000000061058,
    "is_taxable": true,
    "facebook": "zoho",
    "twitter": "zoho",
    "place_of_contact": "TN",
    "gst_no": "22AAAAA0000A1Z5",
    "gst_treatment": "business_gst"
}"'

Response Example

  

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The contact has been created",
    "contact": {
        "contact_id": 460000000026049,
        "contact_name": "Bowman and Co",
        "company_name": "Bowman and Co",
        "has_transaction": true,
        "contact_type": "customer",
        "is_linked_with_zohocrm": false,
        "website": "www.bowmanfurniture.com",
        "primary_contact_id": 460000000026051,
        "payment_terms": 15,
        "payment_terms_label": "Net 15",
        "currency_id": 460000000000097,
        "currency_code": "USD",
        "currency_symbol": "$",
        "language_code": "en",
        "outstanding_receivable_amount": 250,
        "outstanding_receivable_amount_bcy": 250,
        "unused_credits_receivable_amount": 1369.66,
        "unused_credits_receivable_amount_bcy": 1369.66,
        "status": "active",
        "payment_reminder_enabled": true,
        "custom_fields": [
            {
                "value": "GBGD078",
                "index": 1,
                "label": "VAT ID"
            }
        ],
        "billing_address": {
            "attention": "Mr.John",
            "address": "4900 Hopyard Rd",
            "street2": "Suit 310",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A"
        },
        "shipping_address": {
            "attention": "Mr.John",
            "address": "4900 Hopyard Rd",
            "street2": "Suit 310",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A"
        },
        "facebook": "zoho",
        "twitter": "zoho",
        "contact_persons": [
            {
                "salutation": "Mr",
                "first_name": "Will",
                "last_name": "Smith",
                "email": "willsmith@bowmanfurniture.com",
                "phone": "+1-925-921-9201",
                "mobile": "+1-4054439562",
                "is_primary_contact": true
            }
        ],
        "default_templates": {
            "invoice_template_id": 460000000052069,
            "invoice_template_name": "Custom Classic",
            "estimate_template_id": 460000000000179,
            "estimate_template_name": "Service - Professional",
            "creditnote_template_id": 460000000000211,
            "creditnote_template_name": "Fixed Cost - Professional",
            "invoice_email_template_id": 460000000052071,
            "invoice_email_template_name": "Custom Invoice Notification",
            "estimate_email_template_id": 460000000052073,
            "estimate_email_template_name": "Custom Estimate Notification",
            "creditnote_email_template_id": 460000000052075,
            "creditnote_email_template_name": "Custom Credit Note Notification"
        },
        "notes": "Payment option : Through check",
        "created_time": "2013-08-05",
        "last_modified_time": "2013-10-07",
        "is_taxable": true,
        "tax_id": 11149000000061058,
        "tax_name": "CGST",
        "tax_percentage": 12,
        "tax_authority_id": 11149000000061052,
        "tax_exemption_id": 11149000000061054,
        "place_of_contact": "TN",
        "gst_no": "22AAAAA0000A1Z5",
        "gst_treatment": "business_gst"
    }
}

ARGUMENTS

Update a contact

Update an existing contact. To delete a contact person remove it from the contact_persons list.
oauthscope : ZohoInventory.contacts.UPDATE

PUT /contacts/{contact_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/{contact_id}?organization_id=10234695
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "contact_name": "Bowman and Co",
    "company_name": "Bowman and Co",
    "payment_terms": 15,
    "currency_id": 460000000000097,
    "contact_type": "customer",
    "website": "www.bowmanfurniture.com",
    "custom_fields": [
        {
            "value": "GBGD078",
            "index": 1,
            "label": "VAT ID"
        }
    ],
    "billing_address": {
        "attention": "Mr.John",
        "address": "4900 Hopyard Rd",
        "street2": "Suit 310",
        "city": "Pleasanton",
        "state": "CA",
        "zip": 94588,
        "country": "U.S.A"
    },
    "shipping_address": {
        "attention": "Mr.John",
        "address": "4900 Hopyard Rd",
        "street2": "Suit 310",
        "city": "Pleasanton",
        "state": "CA",
        "zip": 94588,
        "country": "U.S.A"
    },
    "contact_persons": [
        {
            "salutation": "Mr",
            "first_name": "Will",
            "last_name": "Smith",
            "email": "willsmith@bowmanfurniture.com",
            "phone": "+1-925-921-9201",
            "mobile": "+1-4054439562",
            "is_primary_contact": true
        }
    ],
    "default_templates": {
        "invoice_template_id": 460000000052069,
        "invoice_template_name": "Custom Classic",
        "estimate_template_id": 460000000000179,
        "estimate_template_name": "Service - Professional",
        "creditnote_template_id": 460000000000211,
        "creditnote_template_name": "Fixed Cost - Professional",
        "invoice_email_template_id": 460000000052071,
        "invoice_email_template_name": "Custom Invoice Notification",
        "estimate_email_template_id": 460000000052073,
        "estimate_email_template_name": "Custom Estimate Notification",
        "creditnote_email_template_id": 460000000052075,
        "creditnote_email_template_name": "Custom Credit Note Notification"
    },
    "language_code": "en",
    "notes": "Payment option : Through check",
    "tax_exemption_id": 11149000000061054,
    "tax_authority_id": 11149000000061052,
    "tax_id": 11149000000061058,
    "is_taxable": true,
    "facebook": "zoho",
    "twitter": "zoho",
    "place_of_contact": "TN",
    "gst_no": "22AAAAA0000A1Z5",
    "gst_treatment": "business_gst"
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Contact has been updated successfully",
    "contact": {
        "contact_id": 460000000026049,
        "contact_name": "Bowman and Co",
        "company_name": "Bowman and Co",
        "has_transaction": true,
        "contact_type": "customer",
        "is_linked_with_zohocrm": false,
        "website": "www.bowmanfurniture.com",
        "primary_contact_id": 460000000026051,
        "payment_terms": 15,
        "payment_terms_label": "Net 15",
        "currency_id": 460000000000097,
        "currency_code": "USD",
        "currency_symbol": "$",
        "language_code": "en",
        "outstanding_receivable_amount": 250,
        "outstanding_receivable_amount_bcy": 250,
        "unused_credits_receivable_amount": 1369.66,
        "unused_credits_receivable_amount_bcy": 1369.66,
        "status": "active",
        "payment_reminder_enabled": true,
        "custom_fields": [
            {
                "value": "GBGD078",
                "index": 1,
                "label": "VAT ID"
            }
        ],
        "billing_address": {
            "attention": "Mr.John",
            "address": "4900 Hopyard Rd",
            "street2": "Suit 310",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A"
        },
        "shipping_address": {
            "attention": "Mr.John",
            "address": "4900 Hopyard Rd",
            "street2": "Suit 310",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A"
        },
        "facebook": "zoho",
        "twitter": "zoho",
        "contact_persons": [
            {
                "salutation": "Mr",
                "first_name": "Will",
                "last_name": "Smith",
                "email": "willsmith@bowmanfurniture.com",
                "phone": "+1-925-921-9201",
                "mobile": "+1-4054439562",
                "is_primary_contact": true
            }
        ],
        "default_templates": {
            "invoice_template_id": 460000000052069,
            "invoice_template_name": "Custom Classic",
            "estimate_template_id": 460000000000179,
            "estimate_template_name": "Service - Professional",
            "creditnote_template_id": 460000000000211,
            "creditnote_template_name": "Fixed Cost - Professional",
            "invoice_email_template_id": 460000000052071,
            "invoice_email_template_name": "Custom Invoice Notification",
            "estimate_email_template_id": 460000000052073,
            "estimate_email_template_name": "Custom Estimate Notification",
            "creditnote_email_template_id": 460000000052075,
            "creditnote_email_template_name": "Custom Credit Note Notification"
        },
        "notes": "Payment option : Through check",
        "created_time": "2013-08-05",
        "last_modified_time": "2013-10-07",
        "is_taxable": true,
        "tax_id": 11149000000061058,
        "tax_name": "CGST",
        "tax_percentage": 12,
        "tax_authority_id": 11149000000061052,
        "tax_exemption_id": 11149000000061054,
        "place_of_contact": "TN",
        "gst_no": "22AAAAA0000A1Z5",
        "gst_treatment": "business_gst"
    }
}

ARGUMENTS

List contacts

List all contacts with pagination.
oauthscope : ZohoInventory.contacts.READ

GET /contacts

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "contacts": [
        {
            "contact_id": 460000000026049,
            "contact_name": "Bowman and Co",
            "company_name": "Bowman and Co",
            "contact_type": "customer",
            "status": "active",
            "payment_terms": 15,
            "payment_terms_label": "Net 15",
            "currency_id": 460000000000097,
            "currency_code": "USD",
            "outstanding_receivable_amount": 250,
            "unused_credits_receivable_amount": 1369.66,
            "first_name": "Will",
            "last_name": "Smith",
            "email": "willsmith@bowmanfurniture.com",
            "phone": "+1-925-921-9201",
            "mobile": "+1-4054439562",
            "created_time": "2013-08-05",
            "last_modified_time": "2013-10-07"
        },
        {...},
        {...}
    ]
}

Query Params

Get contact

Get details of a contact.
oauthscope : ZohoInventory.contacts.READ

GET /contacts/{:contacts_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/{:contacts_id}?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "contact": {
        "contact_id": 460000000026049,
        "contact_name": "Bowman and Co",
        "company_name": "Bowman and Co",
        "has_transaction": true,
        "contact_type": "customer",
        "is_linked_with_zohocrm": false,
        "website": "www.bowmanfurniture.com",
        "primary_contact_id": 460000000026051,
        "payment_terms": 15,
        "payment_terms_label": "Net 15",
        "currency_id": 460000000000097,
        "currency_code": "USD",
        "currency_symbol": "$",
        "outstanding_receivable_amount": 250,
        "outstanding_receivable_amount_bcy": 250,
        "unused_credits_receivable_amount": 1369.66,
        "unused_credits_receivable_amount_bcy": 1369.66,
        "status": "active",
        "facebook": "zoho",
        "twitter": "zoho",
        "payment_reminder_enabled": true,
        "custom_fields": [
            {
                "value": "GBGD078",
                "index": 1,
                "label": "VAT ID"
            }
        ],
        "billing_address": {
            "attention": "Mr.John",
            "address": "4900 Hopyard Rd",
            "street2": "Suit 310",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A"
        },
        "shipping_address": {
            "attention": "Mr.John",
            "address": "4900 Hopyard Rd",
            "street2": "Suit 310",
            "city": "Pleasanton",
            "state": "CA",
            "zip": 94588,
            "country": "U.S.A"
        },
        "contact_persons": [
            {
                "salutation": "Mr",
                "first_name": "Will",
                "last_name": "Smith",
                "email": "willsmith@bowmanfurniture.com",
                "phone": "+1-925-921-9201",
                "mobile": "+1-4054439562",
                "is_primary_contact": true
            }
        ],
        "default_templates": {
            "invoice_template_id": 460000000052069,
            "invoice_template_name": "Custom Classic",
            "estimate_template_id": 460000000000179,
            "estimate_template_name": "Service - Professional",
            "creditnote_template_id": 460000000000211,
            "creditnote_template_name": "Fixed Cost - Professional",
            "invoice_email_template_id": 460000000052071,
            "invoice_email_template_name": "Custom Invoice Notification",
            "estimate_email_template_id": 460000000052073,
            "estimate_email_template_name": "Custom Estimate Notification",
            "creditnote_email_template_id": 460000000052075,
            "creditnote_email_template_name": "Custom Credit Note Notification"
        },
        "notes": "Payment option : Through check",
        "created_time": "2013-08-05",
        "last_modified_time": "2013-10-07",
        "is_taxable": true,
        "tax_id": 11149000000061058,
        "tax_name": "CGST",
        "tax_percentage": 12,
        "tax_authority_id": 11149000000061052,
        "tax_exemption_id": 11149000000061054,
        "place_of_contact": "TN",
        "gst_no": "22AAAAA0000A1Z5",
        "gst_treatment": "business_gst"
    }
}

Delete a contact

Delete an existing contact.
oauthscope : ZohoInventory.contacts.DELETE

DELETE /contacts/{:contact_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}?organization_id=10234695
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The contact has been deleted."
}

Mark as active

Mark a contact as active.
oauthscope : ZohoInventory.contacts.CREATE

POST /contact/{:contact_id}/active

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contact/{:contact_id}/active?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The contact has been marked as active."
}

Mark as Inactive

Mark a contact as inactive.
oauthscope : ZohoInventory.contacts.CREATE

POST /contacts/{:contact_id}/inactive

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/inactive?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The contact has been marked as inactive."
}

Email statement

Email statement to the contact. If JSONString is not inputted, mail will be sent with the default mail content.
oauthscope : ZohoInventory.contacts.CREATE

POST /contacts/{:contact_id}/statements/email

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/statements/email?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "send_from_org_email_id": true,
    "to_mail_ids": [
        "willsmith@bowmanfurniture.com"
    ],
    "cc_mail_ids": [
        "peterparker@bowmanfurniture.com"
    ],
    "subject": "Statement of transactions with Zillium Inc",
    "body": "Dear Customer,     <br/>We have attached with this email a list of all your transactions with us for the period 01 Sep 2013 to 30 Sep 2013. You can write to us or call us if you need any assistance or clarifications.     <br/>Thanks for your business.<br/>Regards<br/>Zillium Inc"
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Statement has been sent to the customer."
}

ARGUMENTS

Query Params

Get Statement mail content

Get the mail content of a contacts billing statement.
oauthscope : ZohoInventory.contacts.READ

GET /contacts/{:contact_id}/statements/email

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/statements/email?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "body": "Dear Customer,     <br/>We have attached with this email a list of all your transactions with us for the period 01 Sep 2013 to 30 Sep 2013. You can write to us or call us if you need any assistance or clarifications.     <br/>Thanks for your business.<br/>Regards<br/>Zillium Inc",
    "subject": "Statement of transactions with Zillium Inc",
    "to_contacts": [
        {
            "first_name": "Will",
            "selected": true,
            "phone": "+1-925-921-9201",
            "email": "willsmith@bowmanfurniture.com",
            "contact_person_id": 460000000026051,
            "last_name": "Smith",
            "salutation": "Mr",
            "mobile": "+1-4054439562"
        }
    ],
    "file_name": "statement_BowmanandCo.pdf",
    "from_emails": [
        {
            "user_name": "John Smith",
            "selected": true,
            "email": "willsmith@bowmanfurniture.com"
        }
    ],
    "contact_id": 460000000026049
}

Query Params

Email contact

Send email to contact.
oauthscope : ZohoInventory.contacts.CREATE

POST /contacts/{:contact_id}/email

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/email?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "to_mail_ids": [
        "willsmith@bowmanfurniture.com"
    ],
    "subject": "Welcome to Zillium Inc .",
    "body": "Dear Customer,     <br/>We have attached with this email a list of all your transactions with us for the period 01 Sep 2013 to 30 Sep 2013. You can write to us or call us if you need any assistance or clarifications.     <br/>Thanks for your business.<br/>Regards<br/>Zillium Inc"
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Email has been sent."
}

ARGUMENTS

Query Params

List Comments

List recent activities of a contact.
oauthscope : ZohoInventory.contacts.READ

GET /contacts/{:contact_id}/comments

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/comments?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "contact_comments": [
        {
            "contact_comments": [
                {
                    "comment_id": 460000000053131,
                    "contact_id": 460000000026049,
                    "contact_name": "Bowman and Co",
                    "description": "",
                    "commented_by_id": 460000000024003,
                    "commented_by": "David Sujin",
                    "date": "2013-11-19",
                    "date_description": "4 days ago",
                    "time": "6:03 PM",
                    "transaction_id": 460000000053123,
                    "transaction_type": "customer_payment",
                    "is_entity_deleted": false,
                    "operation_type": "added"
                }
            ]
        },
        {...},
        {...}
    ]
}

Contact Persons

A contact person is an individual who acts as a representative of an organisation for communication purpose. For example, a Manager can be a contact person for an organisation.

Example

{
    "contact_id": 460000000026049,
    "first_name": "Will",
    "last_name": "Smith",
    "email": "willsmith@bowmanfurniture.com",
    "skype": "zoho",
    "designation": "Sales Engineer",
    "department": "Sales"
}

Attribute

Create a contact person

Create a contact person for contact.
oauthscope : ZohoInventory.contacts.CREATE

POST /contacts/contactpersons

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/contactpersons?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "contact_id": 460000000026049,
    "salutation": "Mr",
    "first_name": "Will",
    "last_name": "Smith",
    "email": "willsmith@bowmanfurniture.com",
    "phone": "+1-925-921-9201",
    "mobile": "+1-4054439562",
    "skype": "zoho",
    "designation": "Sales Engineer",
    "department": "Sales",
    "enable_portal": true
}"'

Response Example

  

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The contact person has been Created",
    "contact_person": [
        {
            "contact_id": 460000000026049,
            "contact_person_id": 460000000026051,
            "salutation": "Mr",
            "first_name": "Will",
            "last_name": "Smith",
            "email": "willsmith@bowmanfurniture.com",
            "phone": "+1-925-921-9201",
            "mobile": "+1-4054439562",
            "is_primary_contact": true,
            "skype": "zoho",
            "designation": "Sales Engineer",
            "department": "Sales",
            "is_added_in_portal": true
        }
    ]
}

ARGUMENTS

Update a contact person

Update details of an existing contact person.
oauthscope : ZohoInventory.contacts.UPDATE

PUT /contacts/contactpersons/{:contact_person_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/contactpersons/{:contact_person_id}?organization_id=10234695
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "contact_id": 460000000026049,
    "salutation": "Mr",
    "first_name": "Will",
    "last_name": "Smith",
    "email": "willsmith@bowmanfurniture.com",
    "phone": "+1-925-921-9201",
    "mobile": "+1-4054439562",
    "skype": "zoho",
    "designation": "Sales Engineer",
    "department": "Sales",
    "enable_portal": true
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The contactperson details has been updated.",
    "contact_person": [
        {
            "contact_id": 460000000026049,
            "contact_person_id": 460000000026051,
            "salutation": "Mr",
            "first_name": "Will",
            "last_name": "Smith",
            "email": "willsmith@bowmanfurniture.com",
            "phone": "+1-925-921-9201",
            "mobile": "+1-4054439562",
            "is_primary_contact": true,
            "skype": "zoho",
            "designation": "Sales Engineer",
            "department": "Sales",
            "is_added_in_portal": true
        }
    ]
}

ARGUMENTS

List contact persons

List all contacts with pagination.
oauthscope : ZohoInventory.contacts.READ

GET /contacts/{:contact_id}/contactpersons

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/contactpersons?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "contact_persons": [
        {
            "contact_id": 460000000026049,
            "contact_person_id": 460000000026051,
            "salutation": "Mr",
            "first_name": "Will",
            "last_name": "Smith",
            "email": "willsmith@bowmanfurniture.com",
            "phone": "+1-925-921-9201",
            "mobile": "+1-4054439562",
            "is_primary_contact": true,
            "skype": "zoho",
            "designation": "Sales Engineer",
            "department": "Sales",
            "is_added_in_portal": true
        },
        {...},
        {...}
    ]
}

Get a contact person

Get the details of a contact person.
oauthscope : ZohoInventory.contacts.READ

GET /contacts/{:contact_id}/contactpersons/{:contact_person_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/{:contact_id}/contactpersons/{:contact_person_id}?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "contact_person": {
        "contact_id": 460000000026049,
        "contact_person_id": 460000000026051,
        "salutation": "Mr",
        "first_name": "Will",
        "last_name": "Smith",
        "email": "willsmith@bowmanfurniture.com",
        "phone": "+1-925-921-9201",
        "mobile": "+1-4054439562",
        "is_primary_contact": true,
        "skype": "zoho",
        "designation": "Sales Engineer",
        "department": "Sales",
        "is_added_in_portal": true
    }
}

Delete a contact person

Delete an existing contact person.
oauthscope : ZohoInventory.contacts.DELETE

DELETE /contacts/contactpersons/{:contact_person_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/contactpersons/{:contact_person_id}?organization_id=10234695
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The contact person has been deleted."
}

Mark as primary contact person

Mark a contact person as primary for contact.
oauthscope : ZohoInventory.contacts.CREATE

POST /contacts/contactpersons/{:contact_person_id}/primary

Request Example

  

$ curl https://inventory.zoho.com/api/v1/contacts/contactpersons/{:contact_person_id}/primary?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "This contact person has been marked as your primary contact person."
}

Item Groups

Item Group are the products that you sell or services that you render to various clients and can be purchased from various vendors in a business. Create and manage the item groups your business deals with and also create price lists for specific item and clients.

Example

{
    "group_id": 4815000000044220,
    "group_name": "Bags",
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "unit": "qty",
    "description": "description",
    "is_taxable": true,
    "tax_id": 4815000000044043,
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "Service Tax",
    "attribute_id1": 4815000000044112,
    "attribute_name1": "Small",
    "status": "active",
    "image_id": 2077500000000002000,
    "image_name": "bag_s.jpg",
    "image_type": "jpg",
    "items": [
        {
            "item_id": 4815000000044208,
            "name": "Bags-small",
            "status": "active",
            "rate": 6,
            "purchase_rate": 6,
            "reorder_level": 5,
            "initial_stock": 50,
            "initial_stock_rate": 500,
            "vendor_id": 4815000000044080,
            "vendor_name": "Molly",
            "stock_on_hand": 50,
            "sku": "SK1234",
            "upc": 111111111111,
            "ean": 111111111112,
            "isbn": 111111111113,
            "part_number": 111111111114,
            "attribute_option_id1": 4815000000044214,
            "attribute_option_name1": "Small",
            "image_id": 2077500000000002000,
            "image_name": "bag_s.jpg",
            "image_type": "jpg"
        }
    ],
    "attributes": [
        {
            "id": 4815000000044112,
            "name": "Bags-small",
            "options": [
                {
                    "id": 4815000000044112,
                    "name": "Bags-small"
                }
            ]
        }
    ]
}

Attribute

Create an Item Group

A new Item Group can a be created. While creating items, user can attach image for product group by passing form-data parameter image i.e., -F image=bag_s.jpg.
oauthscope : ZohoInventory.items.CREATE

POST /itemgroups

Request Example

  

$ curl https://inventory.zoho.com/api/v1/itemgroups?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "group_name": "Bags",
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "unit": "qty",
    "description": "description",
    "tax_id": 4815000000044043,
    "attribute_name1": "Small",
    "items": [
        {
            "name": "Bags-small",
            "rate": 6,
            "purchase_rate": 6,
            "reorder_level": 5,
            "initial_stock": 50,
            "initial_stock_rate": 500,
            "vendor_id": 4815000000044080,
            "sku": "SK1234",
            "upc": 111111111111,
            "ean": 111111111112,
            "isbn": 111111111113,
            "part_number": 111111111114,
            "attribute_option_name1": "Small"
        }
    ],
    "attributes": [
        {
            "id": 4815000000044112,
            "name": "Bags-small",
            "options": [
                {
                    "id": 4815000000044112,
                    "name": "Bags-small"
                }
            ]
        }
    ]
}"'

Response Example

  

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The Item Group has been created.",
    "group_id": 4815000000044220,
    "group_name": "Bags",
    "documents": [
        {...}
    ],
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "unit": "qty",
    "description": "description",
    "is_taxable": true,
    "tax_id": 4815000000044043,
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "Service Tax",
    "attribute_id1": 4815000000044112,
    "attribute_name1": "Small",
    "status": "active",
    "image_id": 2077500000000002000,
    "image_name": "bag_s.jpg",
    "image_type": "jpg",
    "items": {
        "item_id": 4815000000044208,
        "name": "Bags-small",
        "status": "active",
        "rate": 6,
        "purchase_rate": 6,
        "reorder_level": 5,
        "initial_stock": 50,
        "initial_stock_rate": 500,
        "vendor_id": 4815000000044080,
        "vendor_name": "Molly",
        "stock_on_hand": 50,
        "sku": "SK1234",
        "upc": 111111111111,
        "ean": 111111111112,
        "isbn": 111111111113,
        "part_number": 111111111114,
        "attribute_option_id1": 4815000000044214,
        "attribute_option_name1": "Small",
        "image_id": 2077500000000002000,
        "image_name": "bag_s.jpg",
        "image_type": "jpg",
        "actual_available_stock": 2,
        "available_stock": 2
    },
    "attributes": {
        "id": 4815000000044112,
        "name": "Bags-small",
        "options": {
            "id": 4815000000044112,
            "name": "Bags-small"
        }
    }
}

ARGUMENTS

Retrieve an Item Group

Fetches the details for an existing Item Group.
oauthscope : ZohoInventory.items.READ

GET /itemgroups/{itemgroup_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "group_id": 4815000000044220,
    "group_name": "Bags",
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "unit": "qty",
    "description": "description",
    "is_taxable": true,
    "tax_id": 4815000000044043,
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "Service Tax",
    "attribute_id1": 4815000000044112,
    "attribute_name1": "Small",
    "status": "active",
    "image_id": 2077500000000002000,
    "image_name": "bag_s.jpg",
    "image_type": "jpg",
    "items": {
        "item_id": 4815000000044208,
        "name": "Bags-small",
        "status": "active",
        "rate": 6,
        "purchase_rate": 6,
        "reorder_level": 5,
        "initial_stock": 50,
        "initial_stock_rate": 500,
        "vendor_id": 4815000000044080,
        "vendor_name": "Molly",
        "stock_on_hand": 50,
        "sku": "SK1234",
        "upc": 111111111111,
        "ean": 111111111112,
        "isbn": 111111111113,
        "part_number": 111111111114,
        "attribute_option_id1": 4815000000044214,
        "attribute_option_name1": "Small",
        "image_id": 2077500000000002000,
        "image_name": "bag_s.jpg",
        "image_type": "jpg"
    },
    "attributes": {
        "id": 4815000000044112,
        "name": "Bags-small",
        "options": {
            "id": 4815000000044112,
            "name": "Bags-small"
        }
    },
    "options": {
        "id": 4815000000044112,
        "name": "Bags-small"
    }
}

Update an Item Group

Updates the details of an existing Item Group.
oauthscope : ZohoInventory.items.UPDATE

PUT /itemgroups/{itemgroup_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}?organization_id=10234695
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "group_name": "Bags",
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "unit": "qty",
    "description": "description",
    "tax_id": 4815000000044043,
    "attribute_name1": "Small"
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The Item Group details have been updated.",
    "group_id": 4815000000044220,
    "group_name": "Bags",
    "brand": "Brand",
    "manufacturer": "Bagstore",
    "unit": "qty",
    "description": "description",
    "is_taxable": true,
    "tax_id": 4815000000044043,
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "Service Tax",
    "attribute_id1": 4815000000044112,
    "attribute_name1": "Small",
    "status": "active",
    "image_id": 2077500000000002000,
    "image_name": "bag_s.jpg",
    "image_type": "jpg"
}

ARGUMENTS

Delete an Item Group

Deletes an existing Item Group from Zoho Inventory.
oauthscope : ZohoInventory.items.DELETE

DELETE /itemgroups/{itemgroup_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}?organization_id=10234695
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Whooooosh! The item group and all its items have been deleted."
}

List all Item Groups

Lists all the Item Groups that are present in the Zoho Inventory organization.
oauthscope : ZohoInventory.items.READ

GET /itemgroups

Request Example

  

$ curl https://inventory.zoho.com/api/v1/itemgroups?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "itemgroups": [
        {
            "group_id": 4815000000044220,
            "group_name": "Bags",
            "product_type": "goods",
            "brand": "Brand",
            "manufacturer": "Bagstore",
            "unit": "qty",
            "description": "description",
            "is_taxable": true,
            "tax_id": 4815000000044043,
            "tax_name": "Sales",
            "tax_percentage": 12,
            "tax_type": "Service Tax",
            "tax_exemption_id": null,
            "attribute_id1": 4815000000044112,
            "attribute_name1": "Small",
            "status": "active",
            "image_id": 2077500000000002000,
            "image_name": "bag_s.jpg",
            "image_type": "jpg",
            "items": {
                "item_id": 4815000000044208,
                "name": "Bags-small",
                "status": "active",
                "rate": 6,
                "purchase_rate": 6,
                "reorder_level": 5,
                "initial_stock": 50,
                "initial_stock_rate": 500,
                "vendor_id": 4815000000044080,
                "vendor_name": "Molly",
                "stock_on_hand": 50,
                "sku": "SK1234",
                "upc": 111111111111,
                "ean": 111111111112,
                "isbn": 111111111113,
                "part_number": 111111111114,
                "attribute_option_id1": 4815000000044214,
                "attribute_option_name1": "Small",
                "image_id": 2077500000000002000,
                "image_name": "bag_s.jpg",
                "image_type": "jpg",
                "available_stock": 2,
                "actual_available_stock": 2
            },
            "created_time": "2013-01-24",
            "last_modified_time": "2013-01-24"
        },
        {...},
        {...}
    ]
}

Mark as Active

Marks an Item group as Active.
oauthscope : ZohoInventory.items.CREATE

POST /itemgroups/{itemgroup_id}/active

Request Example

  

$ curl https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}/active?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Back to business! The item group and all its items have been marked as active."
}

Mark as Inactive.

Marks as Item Group as Inactive.
oauthscope : ZohoInventory.items.CREATE

POST /itemgroups/{itemgroup_id}/inactive

Request Example

  

$ curl https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}/inactive?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item group and all its items have been marked as inactive."
}

Items

An item is the product that is offered for sale. Nature of the product could be physical or digital. Based on the type of your business, you can offer one or more goods/services. Your product can be either fixed priced or a subscription service. Each of this may fall under a separate pricing category or have add ons associated to them.

Example

{
    "group_id": 4815000000044220,
    "group_name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "product_type": "goods",
    "is_taxable": true,
    "tax_id": 4815000000044043,
    "description": "description",
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "Service Tax",
    "purchase_account_id": 4815000000035003,
    "purchase_account_name": "Cost of Goods Sold",
    "account_id": 4815000000000388,
    "account_name": "Sales",
    "inventory_account_id": 4815000000035001,
    "attribute_id1": 4815000000044112,
    "attribute_name1": "Small",
    "status": "active",
    "item_id": 4815000000044208,
    "name": "Bags-small",
    "rate": 6,
    "pricebook_rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 50,
    "initial_stock_rate": 500,
    "vendor_id": 4815000000044080,
    "vendor_name": "Molly",
    "stock_on_hand": 50,
    "sku": "SK123",
    "upc": 111111111111,
    "ean": 111111111112,
    "isbn": 111111111113,
    "part_number": 111111111114,
    "attribute_option_id1": 4815000000044214,
    "attribute_option_name1": "Small",
    "image_id": 2077500000000002000,
    "image_name": "bag_s.jpg",
    "purchase_description": "Purchase description",
    "image_type": "jpg",
    "item_tax_preferences": [
        {
            "tax_id": 4815000000044043,
            "tax_specification": "intra"
        }
    ],
    "hsn_or_sac": 85423100
}

Attribute

Create an item

Creates a new item in Zoho Inventory.
oauthscope : ZohoInventory.items.CREATE

POST /items

Request Example

  

$ curl https://inventory.zoho.com/api/v1/items?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "group_id": 4815000000044220,
    "group_name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "product_type": "goods",
    "is_taxable": true,
    "tax_id": 4815000000044043,
    "description": "description",
    "purchase_account_id": 4815000000035003,
    "inventory_account_id": 4815000000035001,
    "attribute_name1": "Small",
    "name": "Bags-small",
    "rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 50,
    "initial_stock_rate": 500,
    "vendor_id": 4815000000044080,
    "vendor_name": "Molly",
    "sku": "SK123",
    "upc": 111111111111,
    "ean": 111111111112,
    "isbn": 111111111113,
    "part_number": 111111111114,
    "attribute_option_name1": "Small",
    "purchase_description": "Purchase description",
    "item_tax_preferences": [
        {
            "tax_id": 4815000000044043,
            "tax_specification": "intra"
        }
    ],
    "hsn_or_sac": 85423100
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item has been added.",
    "item": {
        "group_id": 4815000000044220,
        "group_name": "Bags",
        "item_id": 4815000000044208,
        "name": "Bags-small",
        "unit": "qty",
        "item_type": "inventory",
        "product_type": "goods",
        "is_taxable": true,
        "tax_id": 4815000000044043,
        "description": "description",
        "tax_name": "Sales",
        "tax_percentage": 12,
        "tax_type": "Service Tax",
        "purchase_account_id": 4815000000035003,
        "purchase_account_name": "Cost of Goods Sold",
        "account_name": "Sales",
        "inventory_account_id": 4815000000035001,
        "attribute_id1": 4815000000044112,
        "attribute_name1": "Small",
        "status": "active",
        "rate": 6,
        "pricebook_rate": 6,
        "purchase_rate": 6,
        "reorder_level": 5,
        "initial_stock": 50,
        "initial_stock_rate": 500,
        "vendor_id": 4815000000044080,
        "vendor_name": "Molly",
        "stock_on_hand": 50,
        "available_stock": 2,
        "actual_available_stock": 2,
        "sku": "SK123",
        "upc": 111111111111,
        "ean": 111111111112,
        "isbn": 111111111113,
        "part_number": 111111111114,
        "attribute_option_id1": 4815000000044214,
        "attribute_option_name1": "Small",
        "image_id": 2077500000000002000,
        "image_name": "bag_s.jpg",
        "purchase_description": "Purchase description",
        "image_type": "jpg",
        "item_tax_preferences": [
            {
                "tax_id": 4815000000044043,
                "tax_specification": "intra"
            }
        ],
        "hsn_or_sac": 85423100
    }
}

ARGUMENTS

Retrieve an item

Fetches the details for an existing item.
oauthscope : ZohoInventory.items.READ

GET /items/{item_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/items/{item_id}?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "item": {
        "group_id": 4815000000044220,
        "group_name": "Bags",
        "item_id": 4815000000044208,
        "name": "Bags-small",
        "unit": "qty",
        "item_type": "inventory",
        "product_type": "goods",
        "is_taxable": true,
        "tax_id": 4815000000044043,
        "description": "description",
        "tax_name": "Sales",
        "tax_percentage": 12,
        "tax_type": "Service Tax",
        "purchase_account_id": 4815000000035003,
        "purchase_account_name": "Cost of Goods Sold",
        "account_name": "Sales",
        "inventory_account_id": 4815000000035001,
        "attribute_id1": 4815000000044112,
        "attribute_name1": "Small",
        "status": "active",
        "rate": 6,
        "pricebook_rate": 6,
        "purchase_rate": 6,
        "reorder_level": 5,
        "initial_stock": 50,
        "initial_stock_rate": 500,
        "vendor_id": 4815000000044080,
        "vendor_name": "Molly",
        "stock_on_hand": 50,
        "available_stock": 2,
        "actual_available_stock": 2,
        "sku": "SK123",
        "upc": 111111111111,
        "ean": 111111111112,
        "isbn": 111111111113,
        "part_number": 111111111114,
        "attribute_option_id1": 4815000000044214,
        "attribute_option_name1": "Small",
        "image_id": 2077500000000002000,
        "image_name": "bag_s.jpg",
        "purchase_description": "Purchase description",
        "image_type": "jpg",
        "item_tax_preferences": [
            {
                "tax_id": 4815000000044043,
                "tax_specification": "intra"
            }
        ],
        "hsn_or_sac": 85423100
    }
}

Update an item

Update the details of an item.
oauthscope : ZohoInventory.items.UPDATE

PUT /items/{item_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/items/{item_id}?organization_id=10234695
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "group_id": 4815000000044220,
    "group_name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "product_type": "goods",
    "is_taxable": true,
    "tax_id": 4815000000044043,
    "description": "description",
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "Service Tax",
    "purchase_account_id": 4815000000035003,
    "purchase_account_name": "Cost of Goods Sold",
    "account_name": "Sales",
    "inventory_account_id": 4815000000035001,
    "attribute_id1": 4815000000044112,
    "attribute_name1": "Small",
    "status": "active",
    "name": "Bags-small",
    "rate": 6,
    "pricebook_rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 50,
    "initial_stock_rate": 500,
    "vendor_id": 4815000000044080,
    "vendor_name": "Molly",
    "stock_on_hand": 50,
    "sku": "SK123",
    "upc": 111111111111,
    "ean": 111111111112,
    "isbn": 111111111113,
    "part_number": 111111111114,
    "attribute_option_id1": 4815000000044214,
    "attribute_option_name1": "Small",
    "image_id": 2077500000000002000,
    "image_name": "bag_s.jpg",
    "purchase_description": "Purchase description",
    "image_type": "jpg",
    "item_tax_preferences": [
        {
            "tax_id": 4815000000044043,
            "tax_specification": "intra"
        }
    ],
    "hsn_or_sac": 85423100
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Item details have been updated",
    "item": {
        "group_id": 4815000000044220,
        "group_name": "Bags",
        "item_id": 4815000000044208,
        "name": "Bags-small",
        "unit": "qty",
        "item_type": "inventory",
        "product_type": "goods",
        "is_taxable": true,
        "tax_id": 4815000000044043,
        "description": "description",
        "tax_name": "Sales",
        "tax_percentage": 12,
        "tax_type": "Service Tax",
        "purchase_account_id": 4815000000035003,
        "purchase_account_name": "Cost of Goods Sold",
        "account_name": "Sales",
        "inventory_account_id": 4815000000035001,
        "attribute_id1": 4815000000044112,
        "attribute_name1": "Small",
        "status": "active",
        "rate": 6,
        "pricebook_rate": 6,
        "purchase_rate": 6,
        "reorder_level": 5,
        "initial_stock": 50,
        "initial_stock_rate": 500,
        "vendor_id": 4815000000044080,
        "vendor_name": "Molly",
        "stock_on_hand": 50,
        "available_stock": 2,
        "actual_available_stock": 2,
        "sku": "SK123",
        "upc": 111111111111,
        "ean": 111111111112,
        "isbn": 111111111113,
        "part_number": 111111111114,
        "attribute_option_id1": 4815000000044214,
        "attribute_option_name1": "Small",
        "image_id": 2077500000000002000,
        "image_name": "bag_s.jpg",
        "purchase_description": "Purchase description",
        "image_type": "jpg",
        "item_tax_preferences": [
            {
                "tax_id": 4815000000044043,
                "tax_specification": "intra"
            }
        ],
        "hsn_or_sac": 85423100
    }
}

ARGUMENTS

Delete an item

Deletes an existing item from Zoho Inventory.
oauthscope : ZohoInventory.items.DELETE

DELETE /items/{item_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/items/{item_id}?organization_id=10234695
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item has been deleted."
}

Delete an item image

Deletes the image associated for an item in Zoho Inventory.
oauthscope : ZohoInventory.items.DELETE

DELETE /items/{item_id}/image

Request Example

  

$ curl https://inventory.zoho.com/api/v1/items/{item_id}/image?organization_id=10234695
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item image has been deleted."
}

List all the items

Lists all the items present in Zoho Inventory.
oauthscope : ZohoInventory.items.READ

GET /items

Request Example

  

$ curl https://inventory.zoho.com/api/v1/items?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "items": [
        {
            "group_id": 4815000000044220,
            "group_name": "Bags",
            "item_id": 4815000000044208,
            "name": "Bags-small",
            "status": "active",
            "is_linked_with_zohocrm": false,
            "item_type": "inventory",
            "description": "description",
            "rate": 6,
            "is_taxable": true,
            "tax_id": 4815000000044043,
            "tax_name": "Sales",
            "tax_percentage": 12,
            "purchase_description": "Purchase description",
            "purchase_rate": 6,
            "is_combo_product": false,
            "product_type": "goods",
            "attribute_id1": 4815000000044112,
            "attribute_name1": "Small",
            "reorder_level": 5,
            "stock_on_hand": 50,
            "available_stock": 2,
            "actual_available_stock": 2,
            "sku": "SK123",
            "upc": 111111111111,
            "ean": 111111111112,
            "isbn": 111111111113,
            "part_number": 111111111114,
            "attribute_option_id1": 4815000000044214,
            "attribute_option_name1": "Small",
            "image_name": "bag_s.jpg",
            "image_type": "jpg",
            "created_time": "2013-01-24",
            "last_modified_time": "2013-01-24",
            "hsn_or_sac": 85423100
        },
        {...},
        {...}
    ]
}

Mark as active

Changes the status of an item to active.
oauthscope : ZohoInventory.items.CREATE

POST /items/{item_id}/active

Request Example

  

$ curl https://inventory.zoho.com/api/v1/items/{item_id}/active?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item has been marked as Active."
}

Mark as inactive

Mark an item as inactive.
oauthscope : ZohoInventory.items.CREATE

POST /items/{item_id}/inactive

Request Example

  

$ curl https://inventory.zoho.com/api/v1/items/{item_id}/inactive?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item has been marked as Inactive."
}

Composite Items

A form or version of an composite item that differs in some respect from other forms of the same or from a standard. You can create your composite items by associating multiple items and their respective quantities.

Example

{
    "name": "Combo of Apple IPhone and Smartwatch",
    "sku": "SKUIS",
    "unit": "units",
    "description": "Just a sample description",
    "purchase_description": "Composite item purchase description",
    "composite_item_id": 504366000000053250,
    "rate": 85000,
    "pricebook_rate": 85000,
    "initial_stock": 2,
    "initial_stock_rate": 30000,
    "upc": 746325287436,
    "ean": 5789414385764,
    "isbn": 368302334,
    "part_number": "JHFKE7GK7",
    "status": "active",
    "is_combo_product": true,
    "item_type": "inventory",
    "is_taxable": true,
    "reorder_level": 1,
    "vendor_id": 504366000000053250,
    "line_item_id": 504366000000053250,
    "quantity": 1,
    "item_id": 4815000000044208,
    "tax_id": 504366000000053100,
    "tax_name": "VAT",
    "tax_percentage": 13,
    "tax_type": "tax",
    "custom_fields": [
        {
            "custom_field_id": 504366000000053400,
            "value": "GBGD078",
            "index": 1,
            "label": "VAT ID"
        }
    ],
    "available_stock": 2,
    "actual_available_stock": 2,
    "stock_on_hand": 2,
    "mapped_items": [
        {
            "line_item_id": 504366000000053250,
            "item_id": 4815000000044208,
            "name": "Combo of Apple IPhone and Smartwatch",
            "rate": 85000,
            "purchase_rate": 30000,
            "sku": "SKUIS",
            "image_id": 8408722000000019000,
            "image_name": "img1.jpg",
            "purchase_description": "Composite item purchase description",
            "image_type": "jpg",
            "unit": "units",
            "is_combo_product": true,
            "description": "Just a sample description",
            "quantity": 1,
            "stock_on_hand": 2,
            "available_stock": 2,
            "actual_available_stock": 2
        }
    ],
    "item_tax_preferences": [
        {
            "tax_id": 504366000000053100,
            "tax_specification": "intra"
        }
    ],
    "hsn_or_sac": 85423100,
    "is_completed": true
}

Attribute

Creating a Composite Item

A new composite item can be created after creating items that we want to associcate with composite item. User can attach image for composite item by calling Different API 'https://inventory.zoho.com/api/v1/compositeitems/{composite_item_id}/image', passing form-data parameter image i.e. -F image=bag_s.jpg
oauthscope : ZohoInventory.compositeitems.CREATE

POST /compositeitems

Request Example

  

$ curl https://inventory.zoho.com/api/v1/compositeitems?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "name": "Combo of Apple IPhone and Smartwatch",
    "mapped_items": [
        {
            "quantity": 1,
            "item_id": 4815000000044208,
            "line_item_id": 504366000000053250
        }
    ],
    "description": "Just a sample description",
    "is_combo_product": true,
    "vendor_id": 504366000000053250,
    "purchase_rate": 30000,
    "purchase_description": "Composite item purchase description",
    "initial_stock": 2,
    "initial_stock_rate": 30000,
    "tax_id": 504366000000053100,
    "sku": "SKUIS",
    "isbn": 368302334,
    "ean": 5789414385764,
    "part_number": "JHFKE7GK7",
    "reorder_level": 1,
    "unit": "units",
    "upc": 746325287436,
    "item_type": "inventory",
    "rate": 85000,
    "custom_fields": [
        {
            "custom_field_id": 504366000000053400,
            "value": "GBGD078"
        }
    ],
    "account_id": 504366000000000400,
    "purchase_account_id": 504366000000034000,
    "inventory_account_id": 504366000000034000,
    "item_tax_preferences": [
        {
            "tax_id": 504366000000053100,
            "tax_specification": "intra"
        }
    ],
    "hsn_or_sac": 85423100
}"'

Response Example

  

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item has been added.",
    "composite_item": {
        "composite_item_id": 504366000000053250,
        "name": "Combo of Apple IPhone and Smartwatch",
        "unit": "units",
        "tax_id": 504366000000053100,
        "description": "Just a sample description",
        "tax_name": "VAT",
        "tax_percentage": 13,
        "tax_type": "tax",
        "purchase_account_id": 504366000000034000,
        "purchase_account_name": "Cost of Goods Sold",
        "account_id": 504366000000000400,
        "account_name": "sales",
        "inventory_account_id": 504366000000034000,
        "inventory_account_name": "Inventory Asset",
        "status": "active",
        "source": "user",
        "is_combo_product": true,
        "item_type": "inventory",
        "rate": 85000,
        "pricebook_rate": 85000,
        "purchase_rate": 30000,
        "reorder_level": 1,
        "initial_stock": 2,
        "initial_stock_rate": 30000,
        "vendor_id": 504366000000053250,
        "vendor_name": "Mr. vendor combo",
        "stock_on_hand": 2,
        "available_stock": 2,
        "actual_available_stock": 2,
        "sku": "SKUIS",
        "upc": 746325287436,
        "ean": 5789414385764,
        "isbn": 368302334,
        "part_number": "JHFKE7GK7",
        "image_id": 8408722000000019000,
        "image_name": "img1.jpg",
        "purchase_description": "Composite item purchase description",
        "custom_fields": [
            {
                "custom_field_id": 504366000000053400,
                "value": "GBGD078",
                "index": 1,
                "label": "VAT ID"
            }
        ],
        "mapped_items": [
            {
                "line_item_id": 504366000000053250,
                "item_id": 4815000000044208,
                "name": "Combo of Apple IPhone and Smartwatch",
                "rate": 85000,
                "purchase_rate": 30000,
                "sku": "SKUIS",
                "image_id": 8408722000000019000,
                "image_name": "img1.jpg",
                "purchase_description": "Composite item purchase description",
                "image_type": "jpg",
                "unit": "units",
                "is_combo_product": true,
                "description": "Just a sample description",
                "quantity": 1,
                "stock_on_hand": 2,
                "available_stock": 2,
                "actual_available_stock": 2
            }
        ],
        "item_tax_preferences": [
            {
                "tax_id": 504366000000053100,
                "tax_specification": "intra"
            }
        ],
        "hsn_or_sac": 85423100
    }
}

ARGUMENTS

Retrieving a Composite Item

Retrieving details of an existing compostie item.
oauthscope : ZohoInventory.compositeitems.READ

GET /compositeitems/{:composite_item_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/compositeitems/{:composite_item_id}?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "composite_item_id": 504366000000053250,
    "name": "Combo of Apple IPhone and Smartwatch",
    "status": "active",
    "source": "user",
    "unit": "units",
    "tax_id": 504366000000053100,
    "description": "Just a sample description",
    "tax_name": "VAT",
    "tax_percentage": 13,
    "tax_type": "tax",
    "purchase_account_id": 504366000000034000,
    "purchase_account_name": "Cost of Goods Sold",
    "account_id": 504366000000000400,
    "account_name": "sales",
    "inventory_account_id": 504366000000034000,
    "inventory_account_name": "Inventory Asset",
    "is_combo_product": true,
    "item_type": "inventory",
    "rate": 85000,
    "pricebook_rate": 85000,
    "purchase_rate": 30000,
    "reorder_level": 1,
    "initial_stock": 2,
    "initial_stock_rate": 30000,
    "vendor_id": 504366000000053250,
    "vendor_name": "Mr. vendor combo",
    "stock_on_hand": 2,
    "available_stock": 2,
    "actual_available_stock": 2,
    "sku": "SKUIS",
    "upc": 746325287436,
    "ean": 5789414385764,
    "isbn": 368302334,
    "part_number": "JHFKE7GK7",
    "image_id": 8408722000000019000,
    "image_name": "img1.jpg",
    "purchase_description": "Composite item purchase description",
    "custom_fields": [
        {
            "custom_field_id": 504366000000053400,
            "value": "GBGD078",
            "index": 1,
            "label": "VAT ID"
        }
    ],
    "mapped_items": [
        {
            "line_item_id": 504366000000053250,
            "item_id": 4815000000044208,
            "name": "Combo of Apple IPhone and Smartwatch",
            "rate": 85000,
            "purchase_rate": 30000,
            "sku": "SKUIS",
            "image_id": 8408722000000019000,
            "image_name": "img1.jpg",
            "purchase_description": "Composite item purchase description",
            "image_type": "jpg",
            "unit": "units",
            "is_combo_product": true,
            "description": "Just a sample description",
            "quantity": 1,
            "stock_on_hand": 2,
            "available_stock": 2,
            "actual_available_stock": 2
        }
    ],
    "item_tax_preferences": [
        {
            "tax_id": 504366000000053100,
            "tax_specification": "intra"
        }
    ],
    "hsn_or_sac": 85423100
}

Updating a composite item

Updating details of an existing composite item.
oauthscope : ZohoInventory.compositeitems.UPDATE

PUT /compositeitems/{:composite_item_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/compositeitems/{:composite_item_id}?organization_id=10234695
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "composite_item_id": 504366000000053250,
    "name": "Combo of Apple IPhone and Smartwatch",
    "unit": "units",
    "tax_id": 504366000000053100,
    "description": "Just a sample description",
    "tax_name": "VAT",
    "tax_percentage": 13,
    "tax_type": "tax",
    "purchase_account_id": 504366000000034000,
    "purchase_account_name": "Cost of Goods Sold",
    "account_id": 504366000000000400,
    "account_name": "sales",
    "inventory_account_id": 504366000000034000,
    "inventory_account_name": "Inventory Asset",
    "status": "active",
    "source": "user",
    "is_combo_product": true,
    "item_type": "inventory",
    "rate": 85000,
    "pricebook_rate": 85000,
    "purchase_rate": 30000,
    "reorder_level": 1,
    "initial_stock": 2,
    "initial_stock_rate": 30000,
    "vendor_id": 504366000000053250,
    "vendor_name": "Mr. vendor combo",
    "stock_on_hand": 2,
    "available_stock": 2,
    "actual_available_stock": 2,
    "sku": "SKUIS",
    "upc": 746325287436,
    "ean": 5789414385764,
    "isbn": 368302334,
    "part_number": "JHFKE7GK7",
    "image_id": 8408722000000019000,
    "image_name": "img1.jpg",
    "purchase_description": "Composite item purchase description",
    "custom_fields": [
        {
            "custom_field_id": 504366000000053400,
            "value": "GBGD078",
            "index": 1,
            "label": "VAT ID"
        }
    ],
    "mapped_items": [
        {
            "line_item_id": 504366000000053250,
            "item_id": 4815000000044208,
            "name": "Combo of Apple IPhone and Smartwatch",
            "rate": 85000,
            "purchase_rate": 30000,
            "sku": "SKUIS",
            "image_id": 8408722000000019000,
            "image_name": "img1.jpg",
            "purchase_description": "Composite item purchase description",
            "image_type": "jpg",
            "unit": "units",
            "is_combo_product": true,
            "description": "Just a sample description",
            "quantity": 1,
            "stock_on_hand": 2,
            "available_stock": 2,
            "actual_available_stock": 2
        }
    ],
    "item_tax_preferences": [
        {
            "tax_id": 504366000000053100,
            "tax_specification": "intra"
        }
    ],
    "hsn_or_sac": 85423100
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Item details have been saved.",
    "composite_item": {
        "composite_item_id": 504366000000053250,
        "name": "Combo of Apple IPhone and Smartwatch",
        "unit": "units",
        "tax_id": 504366000000053100,
        "description": "Just a sample description",
        "tax_name": "VAT",
        "tax_percentage": 13,
        "tax_type": "tax",
        "purchase_account_id": 504366000000034000,
        "purchase_account_name": "Cost of Goods Sold",
        "account_id": 504366000000000400,
        "account_name": "sales",
        "inventory_account_id": 504366000000034000,
        "inventory_account_name": "Inventory Asset",
        "status": "active",
        "source": "user",
        "is_combo_product": true,
        "item_type": "inventory",
        "rate": 85000,
        "pricebook_rate": 85000,
        "purchase_rate": 30000,
        "reorder_level": 1,
        "initial_stock": 2,
        "initial_stock_rate": 30000,
        "vendor_id": 504366000000053250,
        "vendor_name": "Mr. vendor combo",
        "stock_on_hand": 2,
        "available_stock": 2,
        "actual_available_stock": 2,
        "sku": "SKUIS",
        "upc": 746325287436,
        "ean": 5789414385764,
        "isbn": 368302334,
        "part_number": "JHFKE7GK7",
        "image_id": 8408722000000019000,
        "image_name": "img1.jpg",
        "purchase_description": "Composite item purchase description",
        "custom_fields": [
            {
                "custom_field_id": 504366000000053400,
                "value": "GBGD078",
                "index": 1,
                "label": "VAT ID"
            }
        ],
        "mapped_items": [
            {
                "line_item_id": 504366000000053250,
                "item_id": 4815000000044208,
                "name": "Combo of Apple IPhone and Smartwatch",
                "rate": 85000,
                "purchase_rate": 30000,
                "sku": "SKUIS",
                "image_id": 8408722000000019000,
                "image_name": "img1.jpg",
                "purchase_description": "Composite item purchase description",
                "image_type": "jpg",
                "unit": "units",
                "is_combo_product": true,
                "description": "Just a sample description",
                "quantity": 1,
                "stock_on_hand": 2,
                "available_stock": 2,
                "actual_available_stock": 2
            }
        ],
        "item_tax_preferences": [
            {
                "tax_id": 504366000000053100,
                "tax_specification": "intra"
            }
        ],
        "hsn_or_sac": 85423100
    }
}

ARGUMENTS

Deleting a Composite Item

Deleting an existing Composite Item.
oauthscope : ZohoInventory.compositeitems.DELETE

DELETE /compositeitems/{:composite_item_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/compositeitems/{:composite_item_id}?organization_id=10234695
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item has been deleted."
}

Mark as Active

Changing status of an existing composite item to active.
oauthscope : ZohoInventory.compositeitems.CREATE

POST /compositeitems/{composite_item_id}/active

Request Example

  

$ curl https://inventory.zoho.com/api/v1/compositeitems/{composite_item_id}/active?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Re-activation complete! The item is back in business!"
}

Mark as Inactive

Changing status of an existing composite item to inactive.
oauthscope : ZohoInventory.compositeitems.CREATE

POST /compositeitems/{:composite_item_id}/inactive

Request Example

  

$ curl https://inventory.zoho.com/api/v1/compositeitems/{:composite_item_id}/inactive?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item has been marked as inactive."
}

List All Composite Items

List of all composite items.
oauthscope : ZohoInventory.compositeitems.READ

GET /compositeitems

Request Example

  

$ curl https://inventory.zoho.com/api/v1/compositeitems?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "composite_items": [
        {
            "composite_item_id": 504366000000053250,
            "name": "Combo of Apple IPhone and Smartwatch",
            "status": "active",
            "source": "user",
            "description": "Just a sample description",
            "rate": 85000,
            "tax_id": 504366000000053100,
            "tax_name": "VAT",
            "tax_percentage": 13,
            "purchase_description": "Composite item purchase description",
            "purchase_rate": 30000,
            "is_combo_product": true,
            "item_type": "inventory",
            "product_type": "goods",
            "is_taxable": true,
            "stock_on_hand": 2,
            "available_stock": 2,
            "actual_available_stock": 2,
            "sku": "SKUIS",
            "upc": 746325287436,
            "ean": 5789414385764,
            "isbn": 368302334,
            "part_number": "JHFKE7GK7",
            "reorder_level": 1,
            "image_id": 8408722000000019000,
            "image_name": "img1.jpg",
            "created_time": "2013-08-05"
        },
        {...},
        {...}
    ]
}

Query Params

Create Bundle

Bundling is the technique of putting together different components in desired quantities to produce a single commodity. These components could be goods, services and other non-inventory items of your choice.

POST /bundles

Request Example

  

$ curl https://inventory.zoho.com/api/v1/bundles?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "reference_number": "REF-B-00005",
    "date": "2017-01-05",
    "description": "Just a sample description",
    "composite_item_id": 504366000000053250,
    "composite_item_name": "Combo of Apple IPhone and Smartwatch",
    "composite_item_sku": "SKUIS",
    "quantity_to_bundle": 1,
    "line_items": [
        {
            "item_id": 4815000000044208,
            "name": "Combo of Apple IPhone and Smartwatch",
            "quantity_consumed": 1,
            "unit": "units",
            "account_id": 504366000000000400,
            "account_name": "sales",
            "warehouse_id": 4815000000000390,
            "warehouse_name": "MyWarehouse",
            "rate": 85000
        }
    ],
    "is_completed": true
}"'

Response Example

  

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Bundle has been created.",
    "bundle_id": 504366000000053250,
    "reference_number": "REF-B-00005",
    "date": "2017-01-05",
    "description": "Just a sample description",
    "composite_item_id": 504366000000053250,
    "composite_item_name": "Combo of Apple IPhone and Smartwatch",
    "composite_item_sku": "SKUIS",
    "quantity_to_bundle": 1,
    "line_items": [
        {
            "item_id": 4815000000044208,
            "line_item_id": 504366000000053250,
            "name": "Combo of Apple IPhone and Smartwatch",
            "description": "Just a sample description",
            "quantity_consumed": 1,
            "unit": "units",
            "account_id": 504366000000000400,
            "account_name": "sales",
            "warehouse_id": 4815000000000390,
            "warehouse_name": "MyWarehouse",
            "rate": 85000
        }
    ]
}

ARGUMENTS

Bundling History

List of all bundles of a given composite item.

GET /bundles

Request Example

  

$ curl https://inventory.zoho.com/api/v1/bundles?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "bundles": [
        {
            "bundle_id": 504366000000053250,
            "reference_number": "REF-B-00005",
            "date": "2017-01-05",
            "description": "Just a sample description",
            "composite_item_id": 504366000000053250,
            "composite_item_name": "Combo of Apple IPhone and Smartwatch",
            "composite_item_sku": "SKUIS",
            "quantity_to_bundle": 1,
            "line_items": [
                {
                    "item_id": 4815000000044208,
                    "line_item_id": 504366000000053250,
                    "name": "Combo of Apple IPhone and Smartwatch",
                    "description": "Just a sample description",
                    "quantity_consumed": 1,
                    "unit": "units",
                    "account_id": 504366000000000400,
                    "account_name": "sales",
                    "warehouse_id": 4815000000000390,
                    "warehouse_name": "MyWarehouse",
                    "rate": 85000
                }
            ]
        },
        {...},
        {...}
    ]
}

Query Params

Retrieve Bundle

Fetches the details for an existing bundle.

GET /bundles/{bundle_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/bundles/{bundle_id}?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "bundle": {
        "bundle_id": 504366000000053250,
        "reference_number": "REF-B-00005",
        "date": "2017-01-05",
        "description": "Just a sample description",
        "composite_item_id": 504366000000053250,
        "composite_item_name": "Combo of Apple IPhone and Smartwatch",
        "composite_item_sku": "SKUIS",
        "quantity_to_bundle": 1,
        "line_items": [
            {
                "item_id": 4815000000044208,
                "line_item_id": 504366000000053250,
                "name": "Combo of Apple IPhone and Smartwatch",
                "description": "Just a sample description",
                "quantity_consumed": 1,
                "unit": "units",
                "account_id": 504366000000000400,
                "account_name": "sales",
                "warehouse_id": 4815000000000390,
                "warehouse_name": "MyWarehouse",
                "rate": 85000
            }
        ],
        "is_completed": true
    }
}

Delete Bundle

Deletes an existing bundle from Zoho Inventory.

DELETE /bundles/{bundle_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/bundles/{bundle_id}?organization_id=10234695
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The bundle has been deleted."
}

Item Adjustments

Item Adjustments are used to synchronize the inventory/stock to account for things that occur outside the normal business like theft, damaged goods, data entry error etc.

Example

{
    "inventory_adjustment_id": 4815000000044100,
    "date": "2015-05-28",
    "reason": "Damaged goods",
    "reason_id": 4815000000044110,
    "description": "Just a sample description.",
    "reference_number": "REF-IA-00001",
    "adjustment_type": "quantity",
    "line_items": [
        {
            "item_id": 4815000000044100,
            "line_item_id": 4815000000044897,
            "name": "Laptop-white/15inch/dell",
            "description": "Just a sample description.",
            "quantity_adjusted": 10,
            "item_total": 244,
            "unit": "qty",
            "is_combo_product": false,
            "adjustment_account_id": 4815000000000388,
            "adjustment_account_name": "Cost of Goods Sold",
            "warehouse_id": 4815000000000390,
            "warehouse_name": "MyWarehouse"
        }
    ],
    "total": 350
}

Attribute

Create an item adjustment

Creates a new item adjustment in Zoho Inventory.
oauthscope : ZohoInventory.inventoryadjustments.CREATE

POST /inventoryadjustments

Request Example

  

$ curl https://inventory.zoho.com/api/v1/inventoryadjustments?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "date": "2015-05-28",
    "reason": "Damaged goods",
    "description": "Just a sample description.",
    "reference_number": "REF-IA-00001",
    "adjustment_type": "quantity",
    "line_items": [
        {
            "item_id": 4815000000044100,
            "name": "Laptop-white/15inch/dell",
            "quantity_adjusted": 10,
            "item_total": 244,
            "unit": "qty",
            "is_combo_product": false,
            "adjustment_account_id": 4815000000000388,
            "adjustment_account_name": "Cost of Goods Sold",
            "warehouse_id": 4815000000000390,
            "warehouse_name": "MyWarehouse"
        }
    ]
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Inventory Adjustment has been added",
    "inventory_adjustment": {
        "inventory_adjustment_id": 4815000000044100,
        "date": "2015-05-28",
        "reason": "Damaged goods",
        "reason_id": 4815000000044110,
        "description": "Just a sample description.",
        "reference_number": "REF-IA-00001",
        "adjustment_type": "quantity",
        "line_items": [
            {
                "item_id": 4815000000044100,
                "line_item_id": 4815000000044897,
                "name": "Laptop-white/15inch/dell",
                "description": "Just a sample description.",
                "quantity_adjusted": 10,
                "item_total": 244,
                "unit": "qty",
                "is_combo_product": false,
                "adjustment_account_id": 4815000000000388,
                "adjustment_account_name": "Cost of Goods Sold",
                "warehouse_id": 4815000000000390,
                "warehouse_name": "MyWarehouse"
            }
        ],
        "total": 350
    }
}

ARGUMENTS

Retrieve an item adjustment

Fetches the details for an existing item adjustment.
oauthscope : ZohoInventory.inventoryadjustments.READ

GET /inventoryadjustments/{inventory_adjustment_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/inventoryadjustments/{inventory_adjustment_id}?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "inventory_adjustment": {
        "inventory_adjustment_id": 4815000000044100,
        "date": "2015-05-28",
        "reason": "Damaged goods",
        "reason_id": 4815000000044110,
        "description": "Just a sample description.",
        "reference_number": "REF-IA-00001",
        "adjustment_type": "quantity",
        "line_items": [
            {
                "item_id": 4815000000044100,
                "line_item_id": 4815000000044897,
                "name": "Laptop-white/15inch/dell",
                "description": "Just a sample description.",
                "quantity_adjusted": 10,
                "item_total": 244,
                "unit": "qty",
                "is_combo_product": false,
                "adjustment_account_id": 4815000000000388,
                "adjustment_account_name": "Cost of Goods Sold",
                "warehouse_id": 4815000000000390,
                "warehouse_name": "MyWarehouse"
            }
        ],
        "total": 350
    }
}

Delete an item adjustment

Deletes an existing item adjustment from Zoho Inventory.
oauthscope : ZohoInventory.inventoryadjustments.DELETE

DELETE /inventoryadjustments/{inventory_adjustment_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/inventoryadjustments/{inventory_adjustment_id}?organization_id=10234695
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Inventory Adjustment(s) has been deleted"
}

List all the item adjustments

Lists all the item adjustments present in Zoho Inventory.
oauthscope : ZohoInventory.inventoryadjustments.READ

GET /inventoryadjustments

Request Example

  

$ curl https://inventory.zoho.com/api/v1/inventoryadjustments?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "inventory_adjustments": [
        {
            "inventory_adjustment_id": 4815000000044100,
            "date": "2015-05-28",
            "reason": "Damaged goods",
            "reason_id": 4815000000044110,
            "description": "Just a sample description.",
            "reference_number": "REF-IA-00001",
            "adjustment_type": "quantity",
            "total": 350
        },
        {...},
        {...}
    ]
}

Transfer Orders

Transfer Orders allow you transfer stock from one warehouse to another, thereby greatly reducing the hassle of manually updating the stock levels.

Example

{
    "transfer_order_id": 4815000000044895,
    "transfer_order_number": "TO-00001",
    "date": "2018-03-23",
    "from_warehouse_id": 4815000000035003,
    "to_warehouse_id": 4815000000035003,
    "line_items": [
        {
            "item_id": 4815000000044100,
            "line_item_id": 4815000000044897,
            "name": "Laptop-white/15inch/dell",
            "description": "Just a sample description.",
            "quantity_transfer": 2,
            "unit": "qty"
        }
    ],
    "is_intransit_order": false,
    "ignore_auto_number_generation": false
}

Attribute

Create a transfer order

Creates a new transfer order in Zoho Inventory.
oauthscope : ZohoInventory.transferorders.CREATE

POST /transferorders

Request Example

  

$ curl https://inventory.zoho.com/api/v1/transferorders?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "transfer_order_number": "TO-00001",
    "date": "2018-03-23",
    "from_warehouse_id": 4815000000035003,
    "to_warehouse_id": 4815000000035003,
    "line_items": [
        {
            "item_id": 4815000000044100,
            "name": "Laptop-white/15inch/dell",
            "quantity_transfer": 2,
            "unit": "qty"
        }
    ],
    "is_intransit_order": false
}"'

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Transfer Order added successfully.",
    "transfer_order": {
        "transfer_order_id": 4815000000044895,
        "transfer_order_number": "TO-00001",
        "date": "2018-03-23",
        "from_warehouse_id": 4815000000035003,
        "to_warehouse_id": 4815000000035003,
        "line_items": [
            {
                "item_id": 4815000000044100,
                "line_item_id": 4815000000044897,
                "name": "Laptop-white/15inch/dell",
                "description": "Just a sample description.",
                "quantity_transfer": 2,
                "unit": "qty"
            }
        ],
        "is_intransit_order": false
    }
}

ARGUMENTS

Query Params

Retrieve a transfer order

Fetches the details for an existing transfer order.
oauthscope : ZohoInventory.transferorders.READ

GET /transferorders/{transfer_order_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/transferorders/{transfer_order_id}?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "transfer_order": {
        "transfer_order_id": 4815000000044895,
        "transfer_order_number": "TO-00001",
        "date": "2018-03-23",
        "from_warehouse_id": 4815000000035003,
        "to_warehouse_id": 4815000000035003,
        "line_items": [
            {
                "item_id": 4815000000044100,
                "line_item_id": 4815000000044897,
                "name": "Laptop-white/15inch/dell",
                "description": "Just a sample description.",
                "quantity_transfer": 2,
                "unit": "qty"
            }
        ],
        "is_intransit_order": false
    },
    "warehouses": {...}
}

Delete a transfer order

Deletes an existing transfer order from Zoho Inventory.
oauthscope : ZohoInventory.transferorders.DELETE

DELETE /transferorders/{transfer_order_id}

Request Example

  

$ curl https://inventory.zoho.com/api/v1/transferorders/{transfer_order_id}?organization_id=10234695
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "Transfer Order(s) has been deleted."
}

List all the transfer orders

Lists all the transfer orders present in Zoho Inventory.
oauthscope : ZohoInventory.transferorders.READ

GET /transferorders

Request Example

  

$ curl https://inventory.zoho.com/api/v1/transferorders?organization_id=10234695
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "transfer_orders": [
        {
            "transfer_order_id": 4815000000044895,
            "transfer_order_number": "TO-00001",
            "date": "2018-03-23",
            "from_warehouse_id": 4815000000035003,
            "to_warehouse_id": 4815000000035003,
            "is_intransit_order": false
        },
        {...},
        {...}
    ]
}

Mark as Received

Changes the status of a transfer order to Transferred.
oauthscope : ZohoInventory.transferorders.CREATE

POST /transferorders/{transfer_order_id}/markastransferred

Request Example

  

$ curl https://inventory.zoho.com/api/v1/transferorders/{transfer_order_id}/markastransferred?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"

Response Example

  

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The status of the Transfer Order has been updated."
}

Sales Orders

A sales order is a financial document that confirms an impending sale. It details the exact quantity, price and delivery details of the products or services being sold. Perform the simple operations mentioned below to create and manage your Sales Orders.

Example

{
    "salesorder_id": 4815000000044895,
    "ignore_auto_number_generation": false,
    "salesorder_number": "SO-00003",
    "date": "2015-05-28",
    "status": "fulfilled",
    "shipment_date": "2015-06-02",
    "reference_number": "REF-S-00003",
    "customer_id": 4815000000044080,
    "customer_name": "Molly",
    "contact_persons": [
        {
            "contact_person_id": 4815000000044080
        }
    ],
    "currency_id": 4815000000000097,
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "discount_amount": 0,
    "discount": "20.00%",
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "estimate_id": 4815000000045091,
    "delivery_method": "FedEx",
    "delivery_method_id": 4815000000044822,
    "line_items": [
        {
            "item_id": 4815000000044100,
            "line_item_id": 4815000000044897,
            "name": "Laptop-white/15inch/dell",
            "description": "Just a sample description.",
            "item_order": 0,
            "bcy_rate": 122,
            "rate": 122,
            "quantity": 2,
            "quantity_invoiced": 2,
            "quantity_packed": 2,
            "quantity_shipped": 2,
            "unit": "qty",
            "tax_id": 4815000000044043,
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 244,
            "is_invoiced": true,
            "image_id": 2077500000000002000,
            "image_name": "dell.jpg",
            "image_type": "jpg",
            "warehouse_id": 130426000000664020,
            "hsn_or_sac": 80540
        }
    ],
    "shipping_charge": 7,
    "adjustment": 0,
    "adjustment_description": "Just an example description.",
    "sub_total": 244,
    "tax_total": 29,
    "total": 350,
    "taxes": [
        {
            "tax_name": "Sales Tax",
            "tax_amount": 29.28
        }
    ],
    "price_precision": 2,
    "pricebook_id": 4815000000044054,
    "is_emailed": true,
    "packages": [
        {
            "package_id": 4815000000044905,
            "package_number": "PK-00004",
            "status": "fulfilled",
            "detailed_status": "Delivered",
            "status_message": "Delivered",
            "shipment_id": 4815000000044917,
            "shipment_number": "SH-00004",
            "shipment_status": 3,
            "carrier": "FedEx",
            "service": "SMART_POST",
            "tracking_number": "TRK214124124",
            "shipment_date": "2015-06-02",
            "delivery_days": 12,
            "delivery_guarantee": true
        }
    ],
    "invoices": [
        {
            "invoice_id": 4815000000045091,
            "invoice_number": "INV-001",
            "status": "fulfilled",
            "date": "2015-05-28",
            "due_date": "2015-06-13",
            "total": 350,
            "balance": 0
        }
    ],
    "shipping_address": [
        {
            "address": "No:432,Bayside,Queens",
            "city": "New York City",
            "state": "New York",
            "zip": 11364,
            "country": "U.S.A",
            "fax": "424-524242"
        }
    ],
    "billing_address": [
        {
            "address": "No:432,Bayside,Queens",
            "city": "New York City",
            "state": "New York",
            "zip": 11364,
            "country": "U.S.A",
            "fax": "424-524242"
        }
    ],
    "notes": "Sample Note",
    "terms": "Terms and Conditions",
    "template_id": 4815000000017003,
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T00:00:00.000Z",
    "last_modified_time": "2015-05-28T00:00:00.000Z",
    "attachment_name": "sample.pdf",
    "can_send_in_mail": true,
    "salesperson_id": 4815000000044762,
    "salesperson_name": "Lara",
    "documents": [
        {
            "can_send_in_mail": true,
            "file_name": "sample.pdf",
            "file_type": "pdf",
            "file_size_formatted": "116.8 KB",
            "attachment_order": 1,
            "document_id": 16115000000096068,
            "file_size": 11957
        }
    ],
    "is_pre_gst": false,
    "gst_no": "22AAAAA0000A1Z5",
    "gst_treatment": "business_gst",
    "place_of_supply": "TN"
}

Attribute

Create a Sales Order

Creates a new Sales Order in Zoho Inventory. Description about extra parameter ignore_auto_number_generation - Ignore auto sales order number generation for this sales order. This mandates the Sales Order number to be entered. Allowed Values true and false.
oauthscope : ZohoInventory.salesorders.CREATE

POST /salesorders

Request Example

  

$ curl https://inventory.zoho.com/api/v1/salesorders?organization_id=10234695
-X POST
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-F 'JSONString="{
    "customer_id": 4815000000044080,
    "salesorder_number": "SO-00003",
    "date": "2015-05-28",
    "shipment_date": "2015-06-02",
    "custom_fields": [
        {}
    ],
    "reference_number": "REF-S-00003",
    "line_items": [
        {
            "item_id": 4815000000044100,
            "name": "Laptop-white/15inch/dell",
            "description": "Just a sample description.",
            "rate": 122,
            "quantity": 2,
            "unit": "qty",
            "tax_id": 4815000000044043,
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 244,
            "warehouse_id": 130426000000664020,
            "hsn_or_sac": 80540
        }
    ],
    "notes": "Sample Note",
    "terms": "Terms and Conditions",
    "discount": "20.00%",
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "shipping_charge": 7,
    "delivery_method": "FedEx",
    "adjustment": 0,
    "pricebook_id": 4815000000044054,
    "salesperson_id": 4815000000044762,
    "adjustment_description": "Just an example description.",
    "is_inclusive_tax": false,
    "exchange_rate": 1,
    "template_id": 4815000000017003,
    "documents": [
        {
            "can_send_in_mail": true,
            "file_name": "sample.pdf",
            "file_type": "pdf",
            "file_size_formatted": "116.8 KB",
            "attachment_order": 1,
            "document_id": 16115000000096068,
            "file_size": 11957
        }
    ],
    "billing_address_id": 4815000000017005,
    "shipping_address_id": 4815000000017005,
    "place_of_supply": "TN",
    "gst_treatment": "business_gst",
    "gst_no": "22AAAAA0000A1Z5"
}"'

Response Example

  

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "sales_order": {
        "salesorder_id": 4815000000044895,
        "salesorder_number": "SO-00003",
        "date": "2015-05-28",
        "status": "fulfilled",
        "shipment_date": "2015-06-02",
        "reference_number": "REF-S-00003",
        "customer_id": 4815000000044080,
        "customer_name": "Molly",
        "contact_persons": [
            {
                "contact_person_id": 4815000000044080
            }
        ],
        "currency_id": 4815000000000097,
        "currency_code": "USD",
        "currency_symbol": "$",
        "exchange_rate": 1,
        "discount_amount": 0,
        "discount": "20.00%",
        "is_discount_before_tax": true,
        "discount_type": "entity_level",
        "estimate_id": 4815000000045091,
        "delivery_method": "FedEx",
        "delivery_method_id": 4815000000044822,
        "line_items": [
            {
                "item_id": 4815000000044100,
                "line_item_id": 4815000000044897,
                "name": "Laptop-white/15inch/dell",
                "description": "Just a sample description.",
                "item_order": 0,
                "bcy_rate": 122,
                "rate": 122,
                "quantity": 2,
                "quantity_invoiced": 2,
                "quantity_packed": 2,
                "quantity_shipped": 2,
                "unit": "qty",
                "tax_id": 4815000000044043,
                "tax_name": "Sales Tax",
                "tax_type": "tax",
                "tax_percentage": 12,
                "item_total": 244,
                "is_invoiced": true,
                "image_id": 2077500000000002000,
                "image_name": "dell.jpg",
                "image_type": "jpg",
                "warehouse_id": 130426000000664020,
                "hsn_or_sac": 80540
            }
        ],
        "shipping_charge": 7,
        "adjustment": 0,
        "adjustment_description": "Just an example description.",
        "sub_total": 244,
        "tax_total": 29,
        "total": 350,
        "taxes": [
            {
                "tax_name": "Sales Tax",
                "tax_amount": 29.28
            }
        ],
        "price_precision": 2,
        "pricebook_id": 4815000000044054,
        "shipping_address": [
            {
                "address": "No:432,Bayside,Queens",
                "city": "New York City",
                "state": "New York",
                "zip": 11364,
                "country": "U.S.A",
                "fax": "424-524242"
            }
        ],
        "billing_address": [
            {
                "address": "No:432,Bayside,Queens",
                "city": "New York City",
                "state": "New York",
                "zip": 11364,
                "country": "U.S.A",
                "fax": "424-524242"
            }
        ],
        "notes": "Sample Note",
        "terms": "Terms and Conditions",
        "template_id": 4815000000017003,
        "template_name": "Standard",
        "template_type": "standard",
        "created_time": "2015-05-28T00:00:00.000Z",
        "last_modified_time": "2015-05-28T00:00:00.000Z",
        "salesperson_id": 4815000000044762,
        "salesperson_name": "Lara",
        "documents": [
            {
                "can_send_in_mail": true,
                "file_name": "sample.pdf",
                "file_type": "pdf",
                "file_size_formatted": "116.8 KB",
                "attachment_order": 1,
                "document_id": 16115000000096068,
                "file_size": 11957
            }
        ],
        "is_pre_gst": false,
        "gst_no": "22AAAAA0000A1Z5",
        "gst_treatment": "business_gst",
        "place_of_supply": "TN"
    }
}

ARGUMENTS