API Documentation
Contact Us

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 make writing applications easy. This API follows HTTP rules, so a wide range of HTTP clients 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 -G 'https://inventory.zoho.com/api/v1/organizations' \
   -d authtoken= 6e80ed905055deb9fd2d12d71f518a80
   -d organization_id= 11352208

All Zoho Inventory APIs requires a minimum of two mandatory headers.

  1. Authorization - Authentication request url parameter.
  2. organization_id - the url parameter that contains the organization ID of the organization you need to access.

Authentication

All Zoho Inventory API need to be authenticated using an authtoken.

You can obtain an authtoken by the following ways:

  1. Through a URL in your browser.
  2. Programmatically using the Zoho Accounts API.

Sample Success Response

#
#Fri Apr 11 06:14:13 PST 2014
AUTHTOKEN=6e80ed905055deb9fd2d12d71f518a80
RESULT=TRUE

Sample Error Response

#
#Fri Apr 11 06:32:13 PST 2014
CAUSE=INVALID_API_AUTHTOKEN_SCOPE
RESULT=FALSE

In your browser

Obtaining an authtoken in your browser is very simple. Login to your Zoho Account and go to the URL below.

https://accounts.zoho.com/apiauthtoken/create?SCOPE=ZohoInventory/inventoryapi

Programmatically using the API

If you chosen to obtain your authtoken via an API, please follow the instructions below:

Submit an HTTP POST request to the below URL.

https://accounts.zoho.com/apiauthtoken/nb/create.

The POST body should include a string in the below format.

?SCOPE=ZohoInventory/inventoryapi&EMAIL_ID=[ZohoID/EmailID]&PASSWORD=[Password]

Below are the mandatory case sensitive fields to be passed in the URL.

Parameter Description
SCOPE ZohoInventory/inventoryapi
EMAIL_ID Your Zoho ID or Email ID.
PASSWORD Your Zoho password or your TFA*

* To know more about TFA and creating application password click here.

Points To Note

Organization ID

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/organizations' \
   -d authtoken= 6e80ed905055deb9fd2d12d71f518a80

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": "2014-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, customers, reports, etc.

The Url 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.

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 customers

$ curl -G  'https://inventory.zoho.com/api/v1/contacts' \
   -d authtoken= 6e80ed905055deb9fd2d12d71f518a80
   -d organization_id= 11352208
To get the details of a customer referred to by a specified customer_id

$ curl -G  'https://inventory.zoho.com/api/v1/contacts/903000000000099' \
    -d authtoken= 6e80ed905055deb9fd2d12d71f518a80
    -d organization_id= 11352208

Zoho Inventory API uses appropriate HTTP verbs for every action.

Method Description
GET Used for retrieving resources.
POST Used for creating resources and performing resource actions.
PUT Used for updating resources.
DELETE Used for deleting resources.

Response

Response Structure

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

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

Request Example

$ curl -G  'https://inventory.zoho.com/api/v1/invoices/7000000079426' \
    -d authtoken= 6e80ed905055deb9fd2d12d71f518a80
    -d organization_id= 11352208
    -d Accept=pdf
                    OR
$ curl -G  'https://inventory.zoho.com/api/v1/invoices/7000000079426?accept=pdf' \
    -d authtoken= 6e80ed905055deb9fd2d12d71f518a80
    -d organization_id= 11352208

Responses will be in the JSON format.

Node Name Description
code Zoho Inventory error code. This will be zero for a success response and non-zero in case of an error.
message Message for the invoked API.
resource name Comprises the invoked API’s Data.

Response Header Example


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


Other Formats

Certain APIs support csv and pdf formats as well for which the required response format need 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: 2014-06-11T17:38:06-0700

Errors

Request Example

$ curl -G  'https://inventory.zoho.com/api/v1/invoices/700000007942' \
    -d authtoken= 6e80ed905055deb9fd2d12d71f518a80
    -d organization_id= 11352208

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 mean success, 4xx range mean 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

Status Code Description
200 OK
201 Created
400 Bad request
401 Unauthorized (Invalid AuthToken)
404 URL Not Found
405 Method Not Allowed (Method you have called is not supported for the invoked API)
429 Rate Limit Exceeded (API usage limit exceeded)
500 Internal Error

Pagination

Example

$ curl -G 'https://inventory.zoho.com/api/v1/contacts?page=2&per_page=25' \
   -d authtoken= 6e80ed905055deb9fd2d12d71f518a80
   -d organization_id= 11352208

{
    "code": 0,
    "message": "success",
    "customers": [
            {...},
            {...}
    ],
    "page_context": {
        "page": 2,
        "per_page": 25,
        "has_more_page": false
    }
}

Zoho Inventory provides APIs to retrieve lists of customers 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.

Contacts

A contact in Zoho Inventory is a person or an organization who can either be a vendor, a customer. With Zoho Inventory, you can record, monitor, communicate and generate reports specific to your vendors and customers, helping you strengthen your relations with them and plan your moves.

Example


{
  "contact_id": "4815000000044080",
  "contact_name": "Molly",
  "company_name": "Molly",
  "website": "www.zylker.com",
  "contact_salutation": "Miss",
  "has_transaction": true,
  "contact_type": "customer",
  "source": "user",
  "primary_contact_id": "4815000000044082",
  "payment_terms": 15,
  "payment_terms_label": "Net",
  "currency_id": "4815000000000097",
  "currency_code": "USD",
  "currency_symbol": "$",
  "price_precision": 2,
  "outstanding_receivable_amount": 0,
  "outstanding_receivable_amount_bcy": 0,
  "outstanding_payable_amount": 1842,
  "outstanding_payable_amount_bcy": 1842,
  "unused_credits_receivable_amount": 0,
  "unused_credits_receivable_amount_bcy": 0,
  "unused_credits_payable_amount": 0,
  "unused_credits_payable_amount_bcy": 0,
  "status": "active",
  "payment_reminder_enabled": true,
  "billing_address": {
    "address": "#234,90 Church Street",
    "city": "New York City",
    "state": "New York",
    "zip": "10048",
    "country": "U.S.A",
    "fax": "342-421234"
  },
  "shipping_address": {
    "address": "#432,Bayside,Queens",
    "city": "New York City",
    "state": "New York",
    "zip": "11364",
    "country": "U.S.A",
    "fax": "424-524242"
  },
  "contact_persons": [
    {
      "contact_person_id": "4815000000044082",
      "salutation": "Miss",
      "first_name": "Molly ",
      "last_name": "Hopper",
      "email": "Molly@zylker.com",
      "phone": "342424235",
      "mobile": "2542352325",
      "is_from_crm": false,
      "is_added_in_portal": false,
      "can_invite": true,
      "is_primary_contact": true
    }
  ],
  "pricebook_id": "4815000000044054",
  "pricebook_name": "sample_pricelist",
  "default_templates": {
    "invoice_email_template_id": "4815000000051003",
    "invoice_email_template_name": "Invoice_Email_Template",
    "purchaseorder_email_template_id": "4815000000051005",
    "purchaseorder_email_template_name": "PO_Email_Template",
    "salesorder_email_template_id": "4815000000051001",
    "salesorder_email_template_name": "SO_Email_Template"
  },
  "notes": "note",
  "created_time": "2015-05-28T22:29:48-1100",
  "last_modified_time": "2015-05-29T00:32:20-1100"
}

Attributes

contact_id
long
Unique ID generated by the server. This is used as identifier.
contact_name
string
Name of the contact
company_name
string
Registered name of the company the customer represents.
website
string
Website of the contact
contact_salutation
string
salutation of the contact
has_transaction
boolean
Is contact has transaction or not?
contact_type
string
type of the contact, can be customer or vendor
source
string
source to create contact
is_crm_customer
boolean
Is contact CRM customer?
is_linked_with_zohocrm
boolean
Is contact linked with Zoho CRM
primary_contact_id
long
Unique ID generated by the server. This is used as identifier.
payment_terms
integer
payment terms for contact
payment_terms_label
string
payment term label
currency_id
long
unique ID for currency
currency_code
string
base currency of contact
currency_symbol
string
symbol of currency
price_precision
integer
price precision
outstanding_receivable_amount
double
Outstanding receivable amount from contact
outstanding_receivable_amount_bcy
double
Outstanding receivable amount in base currency
outstanding_payable_amount
double
Outstanding payable amount to contact
outstanding_payable_amount_bcy
double
Outstanding payable amount in base currency
unused_credits_receivable_amount
double
Unused credits receivable amount of contact
unused_credits_receivable_amount_bcy
double
Unused credits receivable amount in base currency
unused_credits_payable_amount
double
Unused credits payable amount of contact
unused_credits_payable_amount_bcy
double
Unused credits payable amount in base currency
status
string
Status of the customer. It can either be active or inactive.
payment_reminder_enabled
boolean
Is payable reminder is on for customer?
billing_address
Show Attributes
list
Customer’s billing address object. It contains address, city, state,zip,country and fax.
shipping_address
Show Attributes
list
Customer’s shipping address object. It contains address, city, state,fax,country and zip.
contact_persons
Show Attributes
list
Contact persons of a contact.Each contact person contains contact_person_id, salutation, first_name, last_name, email, phone, mobile, is_from_crm, is_added_in_portal, can_invite, is_primary_contact.
pricebook_id
long
Price book ID.
pricebook_name
string
name of price list
default_templates
Show Attributes
list
Default templates for the customer.It contains It contains invoice_email_template_id,invoice_email_template_name,purchaseorder_email_template_id,purchaseorder_email_template_name,salesorder_email_template_id,salesorder_email_template_name.
notes
string
A short note about the customer.
created_time
string
Time at which the customer details were last created.
last_modified_time
string
Time at which the customer details were last updated.

Create a contact

POST /contacts

A new customer can be created.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/contacts' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "contact_name": "Molly",
    "company_name": "Molly",
    "website": "www.zylker.com",
    "contact_salutation": "Miss",
    "contact_type": "customer",
    "payment_terms": 15,
    "payment_terms_label": "Net",
    "currency_id": "4815000000000097",
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "pricebook_id": "4815000000044054",
    "default_templates": {
        "invoice_email_template_id": "4815000000051003",
        "invoice_email_template_name": "Invoice_Email_Template",
        "purchaseorder_email_template_id": "4815000000051005",
        "purchaseorder_email_template_name": "PO_Email_Template",
        "salesorder_email_template_id": "4815000000051001",
        "salesorder_email_template_name": "SO_Email_Template"
    },
    "notes": "note",
    "contact_persons": [
        {
            "salutation": "Miss",
            "first_name": "Molly ",
            "last_name": "Hopper",
            "email": "Molly@zylker.com",
            "phone": "342424235",
            "mobile": "2542352325"
        }
    ]
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The customer has been added",
    "contact":    {
    "contact_id": "4815000000044080",
    "contact_name": "Molly",
    "company_name": "Molly",
    "website": "www.zylker.com",
    "contact_salutation": "Miss",
    "has_transaction": true,
    "contact_type": "customer",
    "source": "user",
    "primary_contact_id": "4815000000044082",
    "payment_terms": 15,
    "payment_terms_label": "Net",
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "price_precision": 2,
    "outstanding_receivable_amount": 0,
    "outstanding_receivable_amount_bcy": 0,
    "outstanding_payable_amount": 1842,
    "outstanding_payable_amount_bcy": 1842,
    "unused_credits_receivable_amount": 0,
    "unused_credits_receivable_amount_bcy": 0,
    "unused_credits_payable_amount": 0,
    "unused_credits_payable_amount_bcy": 0,
    "status": "active",
    "payment_reminder_enabled": true,
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "contact_persons": [
        {
            "contact_person_id": "4815000000044082",
            "salutation": "Miss",
            "first_name": "Molly ",
            "last_name": "Hopper",
            "email": "Molly@zylker.com",
            "phone": "342424235",
            "mobile": "2542352325",
            "is_from_crm": false,
            "is_added_in_portal": false,
            "can_invite": true,
            "is_primary_contact": true
        }
    ],
    "pricebook_id": "4815000000044054",
    "pricebook_name": "sample_pricelist",
    "default_templates": {
        "invoice_email_template_id": "4815000000051003",
        "invoice_email_template_name": "Invoice_Email_Template",
        "purchaseorder_email_template_id": "4815000000051005",
        "purchaseorder_email_template_name": "PO_Email_Template",
        "salesorder_email_template_id": "4815000000051001",
        "salesorder_email_template_name": "SO_Email_Template"
    },
    "notes": "note",
    "created_time": "2015-05-28T22:29:48-1100",
    "last_modified_time": "2015-05-29T00:32:20-1100"
}
}

Arguments

contact_name
required
Name of the contact
company_name
optional
Registered name of the company the customer represents.
website
optional
Website of the contact
contact_salutation
optional
salutation of the contact
contact_type
required
type of the contact, can be customer or vendor
payment_terms
optional
payment terms for contact
payment_terms_label
optional
payment term label
currency_id
optional
unique ID for currency
billing_address
Show Attributes
optional
Customer’s billing address object. It contains address, city, state,zip,country and fax.
shipping_address
Show Attributes
optional
Customer’s shipping address object. It contains address, city, state,fax,country and zip.
pricebook_id
optional
Price book ID.
default_templates
Show Attributes
optional
Default templates for the customer.It contains It contains invoice_email_template_id,invoice_email_template_name,purchaseorder_email_template_id,purchaseorder_email_template_name,salesorder_email_template_id,salesorder_email_template_name.
notes
optional
A short note about the customer.
contact_persons
Show Attributes
optional
Contact persons of a contact.Each contact person contains salutation, first_name, last_name, email, phone, mobile.

Retrieve a contact

GET /contacts/{contact_id}

Details for an existing contact.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/contacts/{contact_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "contact":    {
    "contact_id": "4815000000044080",
    "contact_name": "Molly",
    "company_name": "Molly",
    "website": "www.zylker.com",
    "contact_salutation": "Miss",
    "has_transaction": true,
    "contact_type": "customer",
    "source": "user",
    "primary_contact_id": "4815000000044082",
    "payment_terms": 15,
    "payment_terms_label": "Net",
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "price_precision": 2,
    "outstanding_receivable_amount": 0,
    "outstanding_receivable_amount_bcy": 0,
    "outstanding_payable_amount": 1842,
    "outstanding_payable_amount_bcy": 1842,
    "unused_credits_receivable_amount": 0,
    "unused_credits_receivable_amount_bcy": 0,
    "unused_credits_payable_amount": 0,
    "unused_credits_payable_amount_bcy": 0,
    "status": "active",
    "payment_reminder_enabled": true,
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "contact_persons": [
        {
            "contact_person_id": "4815000000044082",
            "salutation": "Miss",
            "first_name": "Molly ",
            "last_name": "Hopper",
            "email": "Molly@zylker.com",
            "phone": "342424235",
            "mobile": "2542352325",
            "is_from_crm": false,
            "is_added_in_portal": false,
            "can_invite": true,
            "is_primary_contact": true
        }
    ],
    "pricebook_id": "4815000000044054",
    "pricebook_name": "sample_pricelist",
    "default_templates": {
        "invoice_email_template_id": "4815000000051003",
        "invoice_email_template_name": "Invoice_Email_Template",
        "purchaseorder_email_template_id": "4815000000051005",
        "purchaseorder_email_template_name": "PO_Email_Template",
        "salesorder_email_template_id": "4815000000051001",
        "salesorder_email_template_name": "SO_Email_Template"
    },
    "notes": "note",
    "created_time": "2015-05-28T22:29:48-1100",
    "last_modified_time": "2015-05-29T00:32:20-1100"
}
}

Update an contact

PUT /contacts/{contact_id}

Update details of existing contact.

Request Example

$ curl -X PUT 'https://inventory.zoho.com/api/v1/contacts/{contact_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "contact_name": "Molly",
    "company_name": "Molly",
    "website": "www.zylker.com",
    "contact_salutation": "Miss",
    "contact_type": "customer",
    "payment_terms": 15,
    "payment_terms_label": "Net",
    "currency_id": "4815000000000097",
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "pricebook_id": "4815000000044054",
    "default_templates": {
        "invoice_email_template_id": "4815000000051003",
        "invoice_email_template_name": "Invoice_Email_Template",
        "purchaseorder_email_template_id": "4815000000051005",
        "purchaseorder_email_template_name": "PO_Email_Template",
        "salesorder_email_template_id": "4815000000051001",
        "salesorder_email_template_name": "SO_Email_Template"
    },
    "notes": "note",
    "contact_persons": [
        {
            "salutation": "Miss",
            "first_name": "Molly ",
            "last_name": "Hopper",
            "email": "Molly@zylker.com",
            "phone": "342424235",
            "mobile": "2542352325"
        }
    ]
}

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The contact details have been updated.",
    "contact":    {
    "contact_id": "4815000000044080",
    "contact_name": "Molly",
    "company_name": "Molly",
    "website": "www.zylker.com",
    "contact_salutation": "Miss",
    "has_transaction": true,
    "contact_type": "customer",
    "source": "user",
    "primary_contact_id": "4815000000044082",
    "payment_terms": 15,
    "payment_terms_label": "Net",
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "price_precision": 2,
    "outstanding_receivable_amount": 0,
    "outstanding_receivable_amount_bcy": 0,
    "outstanding_payable_amount": 1842,
    "outstanding_payable_amount_bcy": 1842,
    "unused_credits_receivable_amount": 0,
    "unused_credits_receivable_amount_bcy": 0,
    "unused_credits_payable_amount": 0,
    "unused_credits_payable_amount_bcy": 0,
    "status": "active",
    "payment_reminder_enabled": true,
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "contact_persons": [
        {
            "contact_person_id": "4815000000044082",
            "salutation": "Miss",
            "first_name": "Molly ",
            "last_name": "Hopper",
            "email": "Molly@zylker.com",
            "phone": "342424235",
            "mobile": "2542352325",
            "is_from_crm": false,
            "is_added_in_portal": false,
            "can_invite": true,
            "is_primary_contact": true
        }
    ],
    "pricebook_id": "4815000000044054",
    "pricebook_name": "sample_pricelist",
    "default_templates": {
        "invoice_email_template_id": "4815000000051003",
        "invoice_email_template_name": "Invoice_Email_Template",
        "purchaseorder_email_template_id": "4815000000051005",
        "purchaseorder_email_template_name": "PO_Email_Template",
        "salesorder_email_template_id": "4815000000051001",
        "salesorder_email_template_name": "SO_Email_Template"
    },
    "notes": "note",
    "created_time": "2015-05-28T22:29:48-1100",
    "last_modified_time": "2015-05-29T00:32:20-1100"
}
}

Arguments

contact_name
required
Name of the contact
company_name
optional
Registered name of the company the customer represents.
website
optional
Website of the contact
contact_salutation
optional
salutation of the contact
contact_type
required
type of the contact, can be customer or vendor
payment_terms
optional
payment terms for contact
payment_terms_label
optional
payment term label
currency_id
optional
unique ID for currency
billing_address
Show Attributes
optional
Customer’s billing address object. It contains address, city, state,zip,country and fax.
shipping_address
Show Attributes
optional
Customer’s shipping address object. It contains address, city, state,fax,country and zip.
pricebook_id
optional
Price book ID.
default_templates
Show Attributes
optional
Default templates for the customer.It contains It contains invoice_email_template_id,invoice_email_template_name,purchaseorder_email_template_id,purchaseorder_email_template_name,salesorder_email_template_id,salesorder_email_template_name.
notes
optional
A short note about the customer.
contact_persons
Show Attributes
optional
Contact persons of a contact.Each contact person contains salutation, first_name, last_name, email, phone, mobile.

Delete an contact

DELETE /contacts/{contact_id}

Delete an existing contact.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/contacts/{contact_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

List all contact

GET /contacts

List of all contact.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/contacts ' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "contacts":
    [
    {
    "contact_id": "4815000000044080",
    "contact_name": "Molly",
    "company_name": "Molly",
    "website": "www.zylker.com",
    "contact_salutation": "Miss",
    "has_transaction": true,
    "contact_type": "customer",
    "source": "user",
    "primary_contact_id": "4815000000044082",
    "payment_terms": 15,
    "payment_terms_label": "Net",
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "price_precision": 2,
    "outstanding_receivable_amount": 0,
    "outstanding_receivable_amount_bcy": 0,
    "outstanding_payable_amount": 1842,
    "outstanding_payable_amount_bcy": 1842,
    "unused_credits_receivable_amount": 0,
    "unused_credits_receivable_amount_bcy": 0,
    "unused_credits_payable_amount": 0,
    "unused_credits_payable_amount_bcy": 0,
    "status": "active",
    "payment_reminder_enabled": true,
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "contact_persons": [
        {
            "contact_person_id": "4815000000044082",
            "salutation": "Miss",
            "first_name": "Molly ",
            "last_name": "Hopper",
            "email": "Molly@zylker.com",
            "phone": "342424235",
            "mobile": "2542352325",
            "is_from_crm": false,
            "is_added_in_portal": false,
            "can_invite": true,
            "is_primary_contact": true
        }
    ],
    "pricebook_id": "4815000000044054",
    "pricebook_name": "sample_pricelist",
    "default_templates": {
        "invoice_email_template_id": "4815000000051003",
        "invoice_email_template_name": "Invoice_Email_Template",
        "purchaseorder_email_template_id": "4815000000051005",
        "purchaseorder_email_template_name": "PO_Email_Template",
        "salesorder_email_template_id": "4815000000051001",
        "salesorder_email_template_name": "SO_Email_Template"
    },
    "notes": "note",
    "created_time": "2015-05-28T22:29:48-1100",
    "last_modified_time": "2015-05-29T00:32:20-1100"
}
{..},
{..}
]
}

Mark as active

POST /contacts/{contact_id}/active

Change status of the contact to active.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/contacts/{contact_id}/active' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

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

POST /contacts/{contact_id}/inactive

Change status of the contact to inactive.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/contacts/{contact_id}/inactive' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

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": "tax",
  "attribute_id1": "4815000000044112",
  "attribute_name1": "size",
  "status": "active",
  "source": "user",
  "image_id": "4815000000043210",
  "image_name": "bag.jpg",
  "image_type": "jpg",
  "items": [
    {
      "item_id": "4815000000044208",
      "name": "Bags-small",
      "status": "active",
      "rate": "6",
      "purchase_rate": "6",
      "reorder_level": "5",
      "initial_stock": "2",
      "initial_stock_rate": "4",
      "vendor_id": "4815000000044080",
      "vendor_name": "Molly",
      "stock_on_hand": "6.00",
      "sku": "s",
      "upc": "111111111111",
      "ean": "111111111112",
      "isbn": "111111111114",
      "part_number": "111111111113",
      "attribute_option_id1": "4815000000044214",
      "attribute_option_name1": "small",
      "image_id": "2077500000000002019",
      "image_name": "bag_s.jpg",
      "image_type": "jpg"
    }
  ],
  "attributes": [
    {
      "id": "4815000000044112",
      "name": "small",
      "options": [
        {
          "id": "4815000000044214",
          "name": "small"
        }
      ]
    }
  ]
}

Attributes

group_id
long
Unique ID generated by the server. This is used as identifier.
group_name
string
Name of product group
brand
string
Brand name of product group
manufacturer
string
Manufacturer of product group
unit
string
unit of product group
description
string
Description of Product group
is_taxable
boolean
To check, if item is taxable or not. Possible values are true or false
tax_id
long
Unique ID generated by the server. This is used as identifier.
tax_name
string
Name of tax applied on Product group
tax_percentage
double
Tax pecentage
tax_type
string
Type of tax, can be simple tax or group tax
attribute_id1
long
Unique ID generated by the server. This is used as identifier.
attribute_name1
string
attribute name of product group having further option like
status
string
status of product group
source
string
source
image_id
long
Unique ID generated by the server. This is used as identifier.
image_name
string
Name of image
image_type
string
Type of image i.e. jpg, jpeg etc.
list
Number of items for particular product group contains item_id,name, status, rate,purchase_rate, reorder_level,initial_stock,initial_stock_rate,vendor_id,vendor_name,stock_on_hand,sku, upc,ean,isbn,part_number,attribute_option_id1, attribute_option_name1, image_id,image_name, image_type .
attributes
Show Attributes
list
All attributes of product group. Each attribute having options.
id
long
Unique ID generated by the server. This is used as identifier.
name
string
Name of option of attribute.

Create a Item Group

POST /itemgroups

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 .

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/itemgroups' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "group_name": "Bags",
    "brand": "brand",
    "manufacturer": "bagstore",
    "unit": "qty",
    "description": "description",
    "tax_id": "4815000000044043",
    "attribute_name1": "size",
    "items": [
        {
            "name": "Bags-small",
            "rate": "6",
            "purchase_rate": "6",
            "reorder_level": "5",
            "initial_stock": "2",
            "initial_stock_rate": "4",
            "vendor_id": "4815000000044080",
            "sku": "s",
            "upc": "111111111111",
            "ean": "111111111112",
            "isbn": "111111111114",
            "part_number": "111111111113",
            "attribute_option_name1": "small"
        }
    ]
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The Item Group has been created",
    "item_group":    {
    "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": "tax",
    "attribute_id1": "4815000000044112",
    "attribute_name1": "size",
    "status": "active",
    "source": "user",
    "image_id": "4815000000043210",
    "image_name": "bag.jpg",
    "image_type": "jpg",
    "items": [
        {
            "item_id": "4815000000044208",
            "name": "Bags-small",
            "status": "active",
            "rate": "6",
            "purchase_rate": "6",
            "reorder_level": "5",
            "initial_stock": "2",
            "initial_stock_rate": "4",
            "vendor_id": "4815000000044080",
            "vendor_name": "Molly",
            "stock_on_hand": "6.00",
            "sku": "s",
            "upc": "111111111111",
            "ean": "111111111112",
            "isbn": "111111111114",
            "part_number": "111111111113",
            "attribute_option_id1": "4815000000044214",
            "attribute_option_name1": "small",
            "image_id": "2077500000000002019",
            "image_name": "bag_s.jpg",
            "image_type": "jpg"
        }
    ],
    "attributes": [
        {
            "id": "4815000000044112",
            "name": "small",
            "options": [
                {
                    "id": "4815000000044214",
                    "name": "small"
                }
            ]
        }
    ]
}
}

Arguments

group_name
required
Name of product group
brand
optional
Brand name of product group
manufacturer
optional
Manufacturer of product group
unit
required
unit of product group
description
optional
Description of Product group
tax_id
optional
Unique ID generated by the server. This is used as identifier.
attribute_name1
optional
attribute name of product group having further option like
optional
Number of items for particular product group contains name, rate,purchase_rate, reorder_level,initial_stock,initial_stock_rate,vendor_id,sku, upc,ean,isbn,part_number, attribute_option_name1.

Retrieve a Item Group

GET /itemgroups/{itemgroup_id}

Details for an existing item group.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "item_group":    {
    "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": "tax",
    "attribute_id1": "4815000000044112",
    "attribute_name1": "size",
    "status": "active",
    "source": "user",
    "image_id": "4815000000043210",
    "image_name": "bag.jpg",
    "image_type": "jpg",
    "items": [
        {
            "item_id": "4815000000044208",
            "name": "Bags-small",
            "status": "active",
            "rate": "6",
            "purchase_rate": "6",
            "reorder_level": "5",
            "initial_stock": "2",
            "initial_stock_rate": "4",
            "vendor_id": "4815000000044080",
            "vendor_name": "Molly",
            "stock_on_hand": "6.00",
            "sku": "s",
            "upc": "111111111111",
            "ean": "111111111112",
            "isbn": "111111111114",
            "part_number": "111111111113",
            "attribute_option_id1": "4815000000044214",
            "attribute_option_name1": "small",
            "image_id": "2077500000000002019",
            "image_name": "bag_s.jpg",
            "image_type": "jpg"
        }
    ],
    "attributes": [
        {
            "id": "4815000000044112",
            "name": "small",
            "options": [
                {
                    "id": "4815000000044214",
                    "name": "small"
                }
            ]
        }
    ]
}
}

Update an Item Group

PUT /itemgroups/{itemgroup_id}

Update details of an existing item group.

Request Example

$ curl -X PUT 'https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "group_name": "Bags",
    "brand": "brand",
    "manufacturer": "bagstore",
    "unit": "qty",
    "description": "description",
    "tax_id": "4815000000044043",
    "attribute_name1": "size",
    "items": [
        {
            "name": "Bags-small",
            "rate": "6",
            "purchase_rate": "6",
            "reorder_level": "5",
            "initial_stock": "2",
            "initial_stock_rate": "4",
            "vendor_id": "4815000000044080",
            "sku": "s",
            "upc": "111111111111",
            "ean": "111111111112",
            "isbn": "111111111114",
            "part_number": "111111111113",
            "attribute_option_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.",
    "item_group":    {
    "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": "tax",
    "attribute_id1": "4815000000044112",
    "attribute_name1": "size",
    "status": "active",
    "source": "user",
    "image_id": "4815000000043210",
    "image_name": "bag.jpg",
    "image_type": "jpg",
    "items": [
        {
            "item_id": "4815000000044208",
            "name": "Bags-small",
            "status": "active",
            "rate": "6",
            "purchase_rate": "6",
            "reorder_level": "5",
            "initial_stock": "2",
            "initial_stock_rate": "4",
            "vendor_id": "4815000000044080",
            "vendor_name": "Molly",
            "stock_on_hand": "6.00",
            "sku": "s",
            "upc": "111111111111",
            "ean": "111111111112",
            "isbn": "111111111114",
            "part_number": "111111111113",
            "attribute_option_id1": "4815000000044214",
            "attribute_option_name1": "small",
            "image_id": "2077500000000002019",
            "image_name": "bag_s.jpg",
            "image_type": "jpg"
        }
    ],
    "attributes": [
        {
            "id": "4815000000044112",
            "name": "small",
            "options": [
                {
                    "id": "4815000000044214",
                    "name": "small"
                }
            ]
        }
    ]
}
}

Arguments

group_name
required
Name of product group
brand
optional
Brand name of product group
manufacturer
optional
Manufacturer of product group
unit
required
unit of product group
description
optional
Description of Product group
tax_id
optional
Unique ID generated by the server. This is used as identifier.
attribute_name1
optional
attribute name of product group having further option like
optional
Number of items for particular product group contains name, rate,purchase_rate, reorder_level,initial_stock,initial_stock_rate,vendor_id,sku, upc,ean,isbn,part_number, attribute_option_name1.

Delete an Item Group

DELETE /itemgroups/{itemgroup_id}

Delete an existing item group.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

List all Item Group

GET /itemgroups

List of all item group.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/itemgroups ' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "item_groups":
    [
    {
    "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": "tax",
    "attribute_id1": "4815000000044112",
    "attribute_name1": "size",
    "status": "active",
    "source": "user",
    "image_id": "4815000000043210",
    "image_name": "bag.jpg",
    "image_type": "jpg",
    "items": [
        {
            "item_id": "4815000000044208",
            "name": "Bags-small",
            "status": "active",
            "rate": "6",
            "purchase_rate": "6",
            "reorder_level": "5",
            "initial_stock": "2",
            "initial_stock_rate": "4",
            "vendor_id": "4815000000044080",
            "vendor_name": "Molly",
            "stock_on_hand": "6.00",
            "sku": "s",
            "upc": "111111111111",
            "ean": "111111111112",
            "isbn": "111111111114",
            "part_number": "111111111113",
            "attribute_option_id1": "4815000000044214",
            "attribute_option_name1": "small",
            "image_id": "2077500000000002019",
            "image_name": "bag_s.jpg",
            "image_type": "jpg"
        }
    ],
    "attributes": [
        {
            "id": "4815000000044112",
            "name": "small",
            "options": [
                {
                    "id": "4815000000044214",
                    "name": "small"
                }
            ]
        }
    ]
}
{..},
{..}
]
}

Mark as active

POST /itemgroups/{itemgroup_id}/active

Change status of the Item Group to active.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}/active' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Mark as inactive

POST /itemgroups/{itemgroup_id}/inactive

Change status of the Item Group to inactive.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/itemgroups/{itemgroup_id}/inactive' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Items

A form or version of an item that differs in some respect from other forms of the same or from a standard. You can catogorize your items based on attributes. You can have upto 3 attributes.

Example


{
  "group_id": "4815000000044220",
  "group_name": "Bags",
  "unit": "qty",
  "item_type": "inventory",
  "is_taxable": true,
  "tax_id": "4815000000044043",
  "description": "bags",
  "tax_name": "Sales",
  "tax_percentage": 12,
  "tax_type": "tax",
  "purchase_account_id": "4815000000035003",
  "purchase_account_name": "Cost and Goods Sold",
  "account_id": "4815000000000388",
  "account_name": "Sales",
  "inventory_account_id": "4815000000035001",
  "attribute_id1": "4815000000044112",
  "attribute_name1": "size",
  "status": "active",
  "source": "user",
  "item_id": "4815000000044208",
  "name": "Bags-small",
  "rate": 6,
  "pricebook_rate": 6,
  "purchase_rate": 6,
  "reorder_level": 5,
  "initial_stock": 2,
  "initial_stock_rate": 4,
  "vendor_id": "4815000000044080",
  "vendor_name": "Molly",
  "stock_on_hand": 6,
  "sku": "s",
  "upc": "111111111111",
  "ean": "111111111112",
  "isbn": "111111111114",
  "part_number": "111111111113",
  "attribute_option_id1": "4815000000044214",
  "attribute_option_name1": "small",
  "image_id": "2077500000000002019",
  "image_name": "bag_s.jpg",
  "purchase_description": "description",
  "image_type": "jpg"
}

Attributes

group_id
long
Product Group ID, if any
group_name
string
Name of product group
unit
string
Unit of item
item_type
string
Item type,can be inventory,sales,purchases or sales_and_purchases. If item is associated with group, then type should be inventory
is_taxable
boolean
To check, if item is taxable or not. Possible values are true or false
tax_id
long
Tax ID
description
string
description of item
tax_name
string
Name of take applied on item, while item comes in transactions.
tax_percentage
double
Tax percentage
tax_type
string
Type of tax. It can either Tax or Group Tax
purchase_account_id
long
ID of Purchase Account
purchase_account_name
string
Name of Purchase Account
account_id
long
Unique ID generated by the server. This is used as identifier.
account_name
string
Name of Sales Account.
inventory_account_id
long
Inventory account ID of item
attribute_id1
long
Unique ID generated by the server. This is used as identifier.
attribute_name1
string
Attribute name of item
status
string
Status of item
source
string
Source
item_id
long
Unique ID generated by the server. This is used as identifier.
name
string
Name of item
rate
double
Sales rate of item
pricebook_rate
double
pricelist Rate applied on item
purchase_rate
double
Purchase rate of item
reorder_level
double
Reorder point of item.
initial_stock
double
Initial stock of item
initial_stock_rate
double
Initial stock rate of item
vendor_id
long
prefered vendor ID
vendor_name
string
prefered vendor name to purchase the item
stock_on_hand
double
Stock available for particular item
sku
string
SKU value of item,should be unique throughout the product
upc
long
UPC code,12 digit unique code of item
ean
long
Unique EAN value
isbn
string
Unique ISBN value
part_number
string
Part Number of item
attribute_option_id1
long
Unique ID generated by the server. This is used as identifier.
attribute_option_name1
string
Available option names for an attribute
image_id
long
Image ID gererated by server for the item
image_name
string
Image name of item
purchase_description
string
Description about purchase
image_type
string
Type of image

Create a item

POST /items

A new item can a be created separately as well as at the time of creation of a new item.After creating item, user can attach image for item by calling Different API
'https://inventory.zoho.com/api/v1/items/{item_id}/image', passing form-data parameter image i.e. -F image=bag_s.jpg .

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/items' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "group_id": "4815000000044220",
    "group_name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "description": "bags",
    "purchase_account_id": "4815000000035003",
    "inventory_account_id": "4815000000035001",
    "attribute_name1": "size",
    "name": "Bags-small",
    "rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "sku": "s",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "attribute_option_name1": "small",
    "purchase_description": "description"
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item has been created",
    "item":    {
    "group_id": "4815000000044220",
    "group_name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "description": "bags",
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "tax",
    "purchase_account_id": "4815000000035003",
    "purchase_account_name": "Cost and Goods Sold",
    "account_id": "4815000000000388",
    "account_name": "Sales",
    "inventory_account_id": "4815000000035001",
    "attribute_id1": "4815000000044112",
    "attribute_name1": "size",
    "status": "active",
    "source": "user",
    "item_id": "4815000000044208",
    "name": "Bags-small",
    "rate": 6,
    "pricebook_rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "stock_on_hand": 6,
    "sku": "s",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "attribute_option_id1": "4815000000044214",
    "attribute_option_name1": "small",
    "image_id": "2077500000000002019",
    "image_name": "bag_s.jpg",
    "purchase_description": "description",
    "image_type": "jpg"
}
}

Arguments

group_id
optional
Product Group ID, if any
group_name
optional
Name of product group
unit
optional
Unit of item
item_type
required
Item type,can be inventory,sales,purchases or sales_and_purchases. If item is associated with group, then type should be inventory
is_taxable
optional
To check, if item is taxable or not. Possible values are true or false
tax_id
optional
Tax ID
description
optional
description of item
purchase_account_id
optional
ID of Purchase Account
inventory_account_id
optional
Inventory account ID of item
attribute_name1
optional
Attribute name of item
name
required
Name of item
rate
required
Sales rate of item
purchase_rate
optional
Purchase rate of item
reorder_level
optional
Reorder point of item.
initial_stock
optional
Initial stock of item
initial_stock_rate
optional
Initial stock rate of item
vendor_id
optional
prefered vendor ID
vendor_name
optional
prefered vendor name to purchase the item
sku
required
SKU value of item,should be unique throughout the product
upc
optional
UPC code,12 digit unique code of item
ean
optional
Unique EAN value
isbn
optional
Unique ISBN value
part_number
optional
Part Number of item
attribute_option_name1
optional
Available option names for an attribute
purchase_description
optional
Description about purchase

Retrieve a item

GET /items/{item_id}

Details for an existing item.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/items/{item_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

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",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "description": "bags",
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "tax",
    "purchase_account_id": "4815000000035003",
    "purchase_account_name": "Cost and Goods Sold",
    "account_id": "4815000000000388",
    "account_name": "Sales",
    "inventory_account_id": "4815000000035001",
    "attribute_id1": "4815000000044112",
    "attribute_name1": "size",
    "status": "active",
    "source": "user",
    "item_id": "4815000000044208",
    "name": "Bags-small",
    "rate": 6,
    "pricebook_rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "stock_on_hand": 6,
    "sku": "s",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "attribute_option_id1": "4815000000044214",
    "attribute_option_name1": "small",
    "image_id": "2077500000000002019",
    "image_name": "bag_s.jpg",
    "purchase_description": "description",
    "image_type": "jpg"
}
}

Update an item

PUT /items/{item_id}

Update details of an existing item.

Request Example

$ curl -X PUT 'https://inventory.zoho.com/api/v1/items/{item_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "group_id": "4815000000044220",
    "group_name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "description": "bags",
    "purchase_account_id": "4815000000035003",
    "inventory_account_id": "4815000000035001",
    "attribute_name1": "size",
    "item_id": "4815000000044208",
    "name": "Bags-small",
    "rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "sku": "s",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "attribute_option_name1": "small",
    "purchase_description": "description"
}

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The item details have been updated.",
    "item":    {
    "group_id": "4815000000044220",
    "group_name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "description": "bags",
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "tax",
    "purchase_account_id": "4815000000035003",
    "purchase_account_name": "Cost and Goods Sold",
    "account_id": "4815000000000388",
    "account_name": "Sales",
    "inventory_account_id": "4815000000035001",
    "attribute_id1": "4815000000044112",
    "attribute_name1": "size",
    "status": "active",
    "source": "user",
    "item_id": "4815000000044208",
    "name": "Bags-small",
    "rate": 6,
    "pricebook_rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "stock_on_hand": 6,
    "sku": "s",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "attribute_option_id1": "4815000000044214",
    "attribute_option_name1": "small",
    "image_id": "2077500000000002019",
    "image_name": "bag_s.jpg",
    "purchase_description": "description",
    "image_type": "jpg"
}
}

Arguments

group_id
optional
Product Group ID, if any
group_name
optional
Name of product group
unit
optional
Unit of item
item_type
required
Item type,can be inventory,sales,purchases or sales_and_purchases. If item is associated with group, then type should be inventory
is_taxable
optional
To check, if item is taxable or not. Possible values are true or false
tax_id
optional
Tax ID
description
optional
description of item
purchase_account_id
optional
ID of Purchase Account
inventory_account_id
optional
Inventory account ID of item
attribute_name1
optional
Attribute name of item
item_id
required
Unique ID generated by the server. This is used as identifier.
name
required
Name of item
rate
required
Sales rate of item
purchase_rate
optional
Purchase rate of item
reorder_level
optional
Reorder point of item.
initial_stock
optional
Initial stock of item
initial_stock_rate
optional
Initial stock rate of item
vendor_id
optional
prefered vendor ID
vendor_name
optional
prefered vendor name to purchase the item
sku
required
SKU value of item,should be unique throughout the product
upc
optional
UPC code,12 digit unique code of item
ean
optional
Unique EAN value
isbn
optional
Unique ISBN value
part_number
optional
Part Number of item
attribute_option_name1
optional
Available option names for an attribute
purchase_description
optional
Description about purchase

Delete an item

DELETE /items/{item_id}

Delete an existing item.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/items/{item_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Delete item image

DELETE /items/{item_id}/image

Delete an existing item image.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/items/{item_id}/image' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

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 item

GET /items

List of all item.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/items ' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

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",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "description": "bags",
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "tax",
    "purchase_account_id": "4815000000035003",
    "purchase_account_name": "Cost and Goods Sold",
    "account_id": "4815000000000388",
    "account_name": "Sales",
    "inventory_account_id": "4815000000035001",
    "attribute_id1": "4815000000044112",
    "attribute_name1": "size",
    "status": "active",
    "source": "user",
    "item_id": "4815000000044208",
    "name": "Bags-small",
    "rate": 6,
    "pricebook_rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "stock_on_hand": 6,
    "sku": "s",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "attribute_option_id1": "4815000000044214",
    "attribute_option_name1": "small",
    "image_id": "2077500000000002019",
    "image_name": "bag_s.jpg",
    "purchase_description": "description",
    "image_type": "jpg"
}
{..},
{..}
]
}

Mark as active

POST /items/{item_id}/active

Change status of the item to active.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/items/{item_id}/active' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

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

POST /items/{item_id}/inactive

Change status of the item to inactive.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/items/{item_id}/inactive' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

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


{
  "composite_item_id": "4815000000044208",
  "name": "Bags",
  "unit": "qty",
  "item_type": "inventory",
  "is_taxable": true,
  "tax_id": "4815000000044043",
  "description": "bags",
  "tax_name": "Sales",
  "tax_percentage": 12,
  "tax_type": "tax",
  "purchase_account_id": "4815000000035003",
  "purchase_account_name": "Cost and Goods Sold",
  "account_id": "4815000000000388",
  "account_name": "Sales",
  "inventory_account_id": "4815000000035001",
  "inventory_account_name": "Inventory Asset",
  "status": "active",
  "source": "user",
  "rate": 6,
  "pricebook_rate": 6,
  "purchase_rate": 6,
  "reorder_level": 5,
  "initial_stock": 2,
  "initial_stock_rate": 4,
  "vendor_id": "4815000000044080",
  "vendor_name": "Molly",
  "stock_on_hand": 6,
  "sku": "sku",
  "upc": "111111111111",
  "ean": "111111111112",
  "isbn": "111111111114",
  "part_number": "111111111113",
  "image_id": "2077500000000002019",
  "image_name": "bag_s.jpg",
  "purchase_description": "description",
  "image_type": "jpg",
  "mapped_items": [
    {
      "line_item_id": "2000000002459",
      "item_id": "2000000002043",
      "name": "Bags-small",
      "quantity": 5,
      "rate": "6",
      "purchase_rate": "6",
      "reorder_level": "5",
      "initial_stock": "2",
      "initial_stock_rate": "4",
      "vendor_id": "4815000000044080",
      "vendor_name": "Molly",
      "stock_on_hand": "6.00",
      "sku": "s",
      "upc": "111111111111",
      "ean": "111111111112",
      "isbn": "111111111114",
      "part_number": "111111111113",
      "image_id": "2077500000000002019",
      "image_name": "bag_s.jpg",
      "image_type": "jpg",
      "purchase_description": "description",
      "description": "small-bags"
    }
  ]
}

Attributes

composite_item_id
long
Unique ID generated by the server. This is used as identifier.
name
string
Name of item
unit
string
Unit of item
item_type
string
Item type, always inventory
is_taxable
boolean
To check, if item is taxable or not. Possible values are true or false
tax_id
long
Tax ID
description
string
description of item
tax_name
string
Name of take applied on item, while item comes in transactions.
tax_percentage
double
Tax percentage
tax_type
string
Type of tax. It can either Tax or Group Tax
purchase_account_id
long
ID of Purchase Account
purchase_account_name
string
Name of Purchase Account
account_id
long
ID for Sales account
account_name
string
Name of Sales Account.
inventory_account_id
long
Inventory account ID of item
inventory_account_name
string
Inventory account Name of item
status
string
Status of item
source
string
Source
rate
double
Sales rate of item
pricebook_rate
double
pricelist Rate applied on item
purchase_rate
double
Purchase rate of item
reorder_level
double
Reorder point of item.
initial_stock
double
Initial stock of item
initial_stock_rate
double
Initial stock rate of item
vendor_id
long
prefered vendor ID
vendor_name
string
prefered vendor name to purchase the item
stock_on_hand
double
Stock available for particular item
sku
string
SKU value of item,should be unique throughout the product
upc
long
UPC code,12 digit unique code of item
ean
long
Unique EAN value
isbn
string
Unique ISBN value
part_number
string
Part Number of item
image_id
long
Image ID gererated by server for the item
image_name
string
Image name of item
purchase_description
string
Description about purchase
image_type
string
Type of image
mapped_items
Show Attributes
list
Number of items for associated with composite product contains line_item_id,name,item_id, quantity,rate,purchase_rate, reorder_level,initial_stock,initial_stock_rate,stock_on_hand,vendor_id,sku, upc,ean,isbn,part_number,image_id,image_name,purchase_description,description, image_type.

Create a composite item

POST /compositeitems

A new composite item can a 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 .

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/compositeitems' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "purchase_account_id": "4815000000035003",
    "inventory_account_id": "4815000000035001",
    "rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "sku": "sku",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "mapped_items": [
        {
            "item_id": "2000000002043",
            "name": "Bags-small",
            "quantity": 5
        }
    ]
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The composite item has been created",
    "composite_item":    {
    "composite_item_id": "4815000000044208",
    "name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "description": "bags",
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "tax",
    "purchase_account_id": "4815000000035003",
    "purchase_account_name": "Cost and Goods Sold",
    "account_id": "4815000000000388",
    "account_name": "Sales",
    "inventory_account_id": "4815000000035001",
    "inventory_account_name": "Inventory Asset",
    "status": "active",
    "source": "user",
    "rate": 6,
    "pricebook_rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "stock_on_hand": 6,
    "sku": "sku",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "image_id": "2077500000000002019",
    "image_name": "bag_s.jpg",
    "purchase_description": "description",
    "image_type": "jpg",
    "mapped_items": [
        {
            "line_item_id": "2000000002459",
            "item_id": "2000000002043",
            "name": "Bags-small",
            "quantity": 5,
            "rate": "6",
            "purchase_rate": "6",
            "reorder_level": "5",
            "initial_stock": "2",
            "initial_stock_rate": "4",
            "vendor_id": "4815000000044080",
            "vendor_name": "Molly",
            "stock_on_hand": "6.00",
            "sku": "s",
            "upc": "111111111111",
            "ean": "111111111112",
            "isbn": "111111111114",
            "part_number": "111111111113",
            "image_id": "2077500000000002019",
            "image_name": "bag_s.jpg",
            "image_type": "jpg",
            "purchase_description": "description",
            "description": "small-bags"
        }
    ]
}
}

Arguments

name
required
Name of item
unit
optional
Unit of item
item_type
required
Item type, always inventory
is_taxable
optional
To check, if item is taxable or not. Possible values are true or false
tax_id
optional
Tax ID
purchase_account_id
optional
ID of Purchase Account
inventory_account_id
optional
Inventory account ID of item
rate
required
Sales rate of item
purchase_rate
optional
Purchase rate of item
reorder_level
optional
Reorder point of item.
initial_stock
optional
Initial stock of item
initial_stock_rate
optional
Initial stock rate of item
vendor_id
optional
prefered vendor ID
sku
required
SKU value of item,should be unique throughout the product
upc
optional
UPC code,12 digit unique code of item
ean
optional
Unique EAN value
isbn
optional
Unique ISBN value
part_number
optional
Part Number of item
mapped_items
Show Attributes
required
Number of items for associated with composite product contains name,item_id, quantity.

Retrieve a composite item

GET /compositeitems/{composite_item_id}

Details for an existing composite item.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/compositeitems/{composite_item_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "composite_item":    {
    "composite_item_id": "4815000000044208",
    "name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "description": "bags",
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "tax",
    "purchase_account_id": "4815000000035003",
    "purchase_account_name": "Cost and Goods Sold",
    "account_id": "4815000000000388",
    "account_name": "Sales",
    "inventory_account_id": "4815000000035001",
    "inventory_account_name": "Inventory Asset",
    "status": "active",
    "source": "user",
    "rate": 6,
    "pricebook_rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "stock_on_hand": 6,
    "sku": "sku",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "image_id": "2077500000000002019",
    "image_name": "bag_s.jpg",
    "purchase_description": "description",
    "image_type": "jpg",
    "mapped_items": [
        {
            "line_item_id": "2000000002459",
            "item_id": "2000000002043",
            "name": "Bags-small",
            "quantity": 5,
            "rate": "6",
            "purchase_rate": "6",
            "reorder_level": "5",
            "initial_stock": "2",
            "initial_stock_rate": "4",
            "vendor_id": "4815000000044080",
            "vendor_name": "Molly",
            "stock_on_hand": "6.00",
            "sku": "s",
            "upc": "111111111111",
            "ean": "111111111112",
            "isbn": "111111111114",
            "part_number": "111111111113",
            "image_id": "2077500000000002019",
            "image_name": "bag_s.jpg",
            "image_type": "jpg",
            "purchase_description": "description",
            "description": "small-bags"
        }
    ]
}
}

Update an composite item

PUT /compositeitems/{composite_item_id}

Update details of an existing composite item.

Request Example

$ curl -X PUT 'https://inventory.zoho.com/api/v1/compositeitems/{composite_item_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "purchase_account_id": "4815000000035003",
    "inventory_account_id": "4815000000035001",
    "rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "sku": "sku",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "mapped_items": [
        {
            "line_item_id": "2000000002459",
            "item_id": "2000000002043",
            "name": "Bags-small",
            "quantity": 5
        }
    ]
}

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The composite item details have been updated.",
    "composite_item":    {
    "composite_item_id": "4815000000044208",
    "name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "description": "bags",
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "tax",
    "purchase_account_id": "4815000000035003",
    "purchase_account_name": "Cost and Goods Sold",
    "account_id": "4815000000000388",
    "account_name": "Sales",
    "inventory_account_id": "4815000000035001",
    "inventory_account_name": "Inventory Asset",
    "status": "active",
    "source": "user",
    "rate": 6,
    "pricebook_rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "stock_on_hand": 6,
    "sku": "sku",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "image_id": "2077500000000002019",
    "image_name": "bag_s.jpg",
    "purchase_description": "description",
    "image_type": "jpg",
    "mapped_items": [
        {
            "line_item_id": "2000000002459",
            "item_id": "2000000002043",
            "name": "Bags-small",
            "quantity": 5,
            "rate": "6",
            "purchase_rate": "6",
            "reorder_level": "5",
            "initial_stock": "2",
            "initial_stock_rate": "4",
            "vendor_id": "4815000000044080",
            "vendor_name": "Molly",
            "stock_on_hand": "6.00",
            "sku": "s",
            "upc": "111111111111",
            "ean": "111111111112",
            "isbn": "111111111114",
            "part_number": "111111111113",
            "image_id": "2077500000000002019",
            "image_name": "bag_s.jpg",
            "image_type": "jpg",
            "purchase_description": "description",
            "description": "small-bags"
        }
    ]
}
}

Arguments

name
required
Name of item
unit
optional
Unit of item
item_type
required
Item type, always inventory
is_taxable
optional
To check, if item is taxable or not. Possible values are true or false
tax_id
optional
Tax ID
purchase_account_id
optional
ID of Purchase Account
inventory_account_id
optional
Inventory account ID of item
rate
required
Sales rate of item
purchase_rate
optional
Purchase rate of item
reorder_level
optional
Reorder point of item.
initial_stock
optional
Initial stock of item
initial_stock_rate
optional
Initial stock rate of item
vendor_id
optional
prefered vendor ID
sku
required
SKU value of item,should be unique throughout the product
upc
optional
UPC code,12 digit unique code of item
ean
optional
Unique EAN value
isbn
optional
Unique ISBN value
part_number
optional
Part Number of item
mapped_items
Show Attributes
required
Number of items for associated with composite product contains line_item_id,name, item_id, quantity.

Delete an composite item

DELETE /compositeitems/{composite_item_id}

Delete an existing composite item.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/compositeitems/{composite_item_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Delete composite item image

DELETE /compositeitems/{composite_item_id}/image

Delete an existing composite item image.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/compositeitems/{composite_item_id}/image' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

List all composite item

GET /compositeitems

List of all composite item.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/compositeitems ' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "composite_items":
    [
    {
    "composite_item_id": "4815000000044208",
    "name": "Bags",
    "unit": "qty",
    "item_type": "inventory",
    "is_taxable": true,
    "tax_id": "4815000000044043",
    "description": "bags",
    "tax_name": "Sales",
    "tax_percentage": 12,
    "tax_type": "tax",
    "purchase_account_id": "4815000000035003",
    "purchase_account_name": "Cost and Goods Sold",
    "account_id": "4815000000000388",
    "account_name": "Sales",
    "inventory_account_id": "4815000000035001",
    "inventory_account_name": "Inventory Asset",
    "status": "active",
    "source": "user",
    "rate": 6,
    "pricebook_rate": 6,
    "purchase_rate": 6,
    "reorder_level": 5,
    "initial_stock": 2,
    "initial_stock_rate": 4,
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "stock_on_hand": 6,
    "sku": "sku",
    "upc": "111111111111",
    "ean": "111111111112",
    "isbn": "111111111114",
    "part_number": "111111111113",
    "image_id": "2077500000000002019",
    "image_name": "bag_s.jpg",
    "purchase_description": "description",
    "image_type": "jpg",
    "mapped_items": [
        {
            "line_item_id": "2000000002459",
            "item_id": "2000000002043",
            "name": "Bags-small",
            "quantity": 5,
            "rate": "6",
            "purchase_rate": "6",
            "reorder_level": "5",
            "initial_stock": "2",
            "initial_stock_rate": "4",
            "vendor_id": "4815000000044080",
            "vendor_name": "Molly",
            "stock_on_hand": "6.00",
            "sku": "s",
            "upc": "111111111111",
            "ean": "111111111112",
            "isbn": "111111111114",
            "part_number": "111111111113",
            "image_id": "2077500000000002019",
            "image_name": "bag_s.jpg",
            "image_type": "jpg",
            "purchase_description": "description",
            "description": "small-bags"
        }
    ]
}
{..},
{..}
]
}

Mark as active

POST /compositeitems/{composite_item_id}/active

Change status of the item to active.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/compositeitems/{composite_item_id}/active' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Mark as inactive

POST /compositeitems/{composite_item_id}/inactive

Change status of the item to inactive.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/compositeitems/{composite_item_id}/inactive' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Purchase Orders

A purchase order is an official document that you issue to your vendors, indicating relevant information about what you want to buy, the quantity, the price agreed for that particular product or service.

Example


{
  "purchaseorder_id": "4815000000044972",
  "purchaseorder_number": "PO-00002",
  "date": "2015-05-28",
  "expected_delivery_date": "2015-06-01",
  "reference_number": "REF-P-00002",
  "status": "partially_received",
  "vendor_id": "4815000000044080",
  "vendor_name": "Molly",
  "contact_persons": [
    "4815000000044080"
  ],
  "currency_id": "4815000000000097",
  "currency_code": "USD",
  "currency_symbol": "$",
  "exchange_rate": 1,
  "delivery_date": "2015-06-01",
  "salesorder_id": "4815000000044936",
  "is_drop_shipment": true,
  "line_items": [
    {
      "item_id": "4815000000044102",
      "line_item_id": "4815000000044974",
      "salesorder_item_id": "4815000000044897",
      "account_id": "4815000000035003",
      "name": "Laptop-black/13 inch/apple",
      "description": "Laptop-black/13 inch/apple",
      "item_order": 0,
      "bcy_rate": 110,
      "rate": 110,
      "quantity": 4,
      "quantity_received": 2,
      "unit": "qty",
      "item_total": 440,
      "tax_id": "4815000000044043",
      "tax_name": "Sales Tax",
      "tax_type": "tax",
      "tax_percentage": 12,
      "image_id": "2077500000000002011",
      "image_name": "apple.jpeg",
      "image_type": "jpeg"
    }
  ],
  "sub_total": 440,
  "tax_total": 52,
  "total": 492,
  "taxes": [
    {
      "tax_name": "Sales Tax (12%)",
      "tax_amount": 52.8
    }
  ],
  "price_precision": "2",
  "pricebook_id": "4815000000044054",
  "billing_address": {
    "address": "#234,90 Church Street",
    "city": "New York City",
    "state": "New York",
    "zip": "10048",
    "country": "U.S.A",
    "fax": "342-421234"
  },
  "notes": "notes",
  "terms": "T&C",
  "ship_via": "FedEx",
  "ship_via_id": "4815000000044822",
  "attention": "vishal",
  "delivery_org_address_id": "4815000000044077",
  "delivery_customer_id": "4815000000044066",
  "delivery_customer_name": "Watson",
  "delivery_address": {
    "address": "#221,,Baker Street",
    "city": "New Jursey",
    "state": "New York",
    "zip": "007007",
    "country": "U.S.A",
    "phone": "99996666",
    "Fax": "424-524242"
  },
  "attachment_name": "sample.pdf",
  "can_send_in_mail": true,
  "template_id": "4815000000015007",
  "template_name": "Standard",
  "template_type": "standard",
  "created_time": "2015-05-28T23:42:09-1100",
  "last_modified_time": "2015-05-28T23:52:03-1100",
  "purchasereceives": [
    {
      "receive_id": "4815000000045035",
      "receive_number": "PR-00002",
      "date": "2015-05-28",
      "note": "note"
    }
  ],
  "bills": [
    {
      "bill_id": "4815000000045067",
      "bill_number": "BL-00002",
      "status": "overdue",
      "date": "2015-05-28",
      "due_date": "2015-05-29",
      "total": 492.8,
      "balance": 492.8
    }
  ]
}

Attributes

purchaseorder_id
long
Unique ID generated by the server. This is used as identifier.
purchaseorder_number
string
Purchase Number
date
string
Date of Purchase Order
expected_delivery_date
string
Expected date of delivery of items ordered
reference_number
string
Reference number of purchase order
status
string
Status of purchase order
vendor_id
long
Vendor ID.
vendor_name
string
Name of vendor
contact_persons
Show Attributes
object
Array of contact person IDs
currency_id
long
Currency ID.
currency_code
string
Currency code of vendor
currency_symbol
string
Symbol of currency
exchange_rate
double
Exchange rate of currency respect to base currency
delivery_date
string
Date of delivery
is_emailed
boolean
To check, purchase order is emailed or not?
salesorder_id
long
sales order ID for DropShipment,mandatory in case of Dropship purchase orders.
is_drop_shipment
boolean
Default is FALSE, in case of drop shipment value must be TRUE
line_items
Show Attributes
list
Purchase order contains multiple line items. Each item contains- item_id,line_item_id,salesorder_item_id, account_id,name, description , item_order,bcy_rate,rate,quantity,quantity_received,unit ,item_total,tax_id,tax_name, tax_type,tax_percentage, image_id,image_name,image_type
sub_total
double
Sub total of purchase order
tax_total
double
Total Tax applied on purchase order
total
double
Total amount of purchase order
list
Number of taxes applied on purchase order. Each tax contains: tax_name and tax_amount
price_precision
string
price precision
pricebook_id
string
pricebook ID for purchase order
billing_address
Show Attributes
object
Customer’s billing address object. It contains address, city, state,zip,country and fax.
notes
string
Notes for purchase order
terms
string
Terms for purchase order
ship_via
string
Shiping method for purchase order
ship_via_id
long
Unique ID generated by the server. This is used as identifier.
attention
string
Name of person, who need to have attention
delivery_org_address_id
long
Unique ID generated by the server. This is used as identifier.
delivery_customer_id
long
Customer ID for delivery address
delivery_customer_name
String
Customer name
delivery_address
Show Attributes
list
Customer’s delivery address object. It contains address, city, state,zip,country,phone and Fax.
attachment_name
string
Attachment name , attached file with purchase order
can_send_in_mail
boolean
To check, is possible to send in mail
template_id
long
template ID.
template_name
string
Name of template used to create purchase order
template_type
string
Type of template used to create purchase order
created_time
string
Time at which the purchase order details were last created.
last_modified_time
string
Time at which the purchase order details were last modified.
can_mark_as_bill
boolean
To check, is purchase order mark as bill
can_mark_as_unbill
boolean
To check, is purchase order mark as unbill
purchasereceives
Show Attributes
list
Purchase receives for purchase order. Each Recieve contains- receive_id,receive_number,date and note
list
Bills raised for purchase order. each bill contains these field: bill_id,bill_number,status,date, due_date,total,balance

Create a purchase order

POST /purchaseorders?ignore_auto_number_generation={boolean}

A new purchase order can a be created.

Discription about extra parameter :
attachment :Allowed Extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc and docx
Allowed type:file
ignore_auto_number_generation :Ignore auto purchase order number generation for this purchase order. This mandates the purchase order number.
Allowed Values: true and false

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/purchaseorders?ignore_auto_number_generation={boolean}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "purchaseorder_number": "PO-00002",
    "date": "2015-05-28",
    "expected_delivery_date": "2015-06-01",
    "reference_number": "REF-P-00002",
    "ship_via": "FedEx",
    "vendor_id": "4815000000044080",
    "salesorder_id": "4815000000044936",
    "is_drop_shipment": true,
    "contact_persons": [
        "4815000000044080"
    ],
    "attention": "vishal",
    "delivery_org_address_id": "4815000000044077",
    "delivery_customer_id": "4815000000044066",
    "notes": "notes",
    "terms": "T&C",
    "exchange_rate": 1,
    "line_items": [
        {
            "item_id": "4815000000044102",
            "salesorder_item_id": "4815000000044897",
            "name": "Laptop-black/13 inch/apple",
            "description": "Laptop-black/13 inch/apple",
            "item_order": 0,
            "rate": 110,
            "quantity": 4,
            "quantity_received": 2,
            "unit": "qty",
            "tax_id": "4815000000044043"
        }
    ]
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The purchase order has been created",
    "purchase_order":    {
    "purchaseorder_id": "4815000000044972",
    "purchaseorder_number": "PO-00002",
    "date": "2015-05-28",
    "expected_delivery_date": "2015-06-01",
    "reference_number": "REF-P-00002",
    "status": "partially_received",
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "delivery_date": "2015-06-01",
    "salesorder_id": "4815000000044936",
    "is_drop_shipment": true,
    "line_items": [
        {
            "item_id": "4815000000044102",
            "line_item_id": "4815000000044974",
            "salesorder_item_id": "4815000000044897",
            "account_id": "4815000000035003",
            "name": "Laptop-black/13 inch/apple",
            "description": "Laptop-black/13 inch/apple",
            "item_order": 0,
            "bcy_rate": 110,
            "rate": 110,
            "quantity": 4,
            "quantity_received": 2,
            "unit": "qty",
            "item_total": 440,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "image_id": "2077500000000002011",
            "image_name": "apple.jpeg",
            "image_type": "jpeg"
        }
    ],
    "sub_total": 440,
    "tax_total": 52,
    "total": 492,
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 52.8
        }
    ],
    "price_precision": "2",
    "pricebook_id": "4815000000044054",
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "notes": "notes",
    "terms": "T&C",
    "ship_via": "FedEx",
    "ship_via_id": "4815000000044822",
    "attention": "vishal",
    "delivery_org_address_id": "4815000000044077",
    "delivery_customer_id": "4815000000044066",
    "delivery_customer_name": "Watson",
    "delivery_address": {
        "address": "#221,,Baker Street",
        "city": "New Jursey",
        "state": "New York",
        "zip": "007007",
        "country": "U.S.A",
        "phone": "99996666",
        "Fax": "424-524242"
    },
    "attachment_name": "sample.pdf",
    "can_send_in_mail": true,
    "template_id": "4815000000015007",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:42:09-1100",
    "last_modified_time": "2015-05-28T23:52:03-1100",
    "purchasereceives": [
        {
            "receive_id": "4815000000045035",
            "receive_number": "PR-00002",
            "date": "2015-05-28",
            "note": "note"
        }
    ],
    "bills": [
        {
            "bill_id": "4815000000045067",
            "bill_number": "BL-00002",
            "status": "overdue",
            "date": "2015-05-28",
            "due_date": "2015-05-29",
            "total": 492.8,
            "balance": 492.8
        }
    ]
}
}

Arguments

purchaseorder_number
required
Purchase Number
date
optional
Date of Purchase Order
expected_delivery_date
optional
Expected date of delivery of items ordered
reference_number
optional
Reference number of purchase order
ship_via
optional
Shiping method for purchase order
vendor_id
required
Vendor ID.
salesorder_id
optional
sales order ID for DropShipment,mandatory in case of Dropship purchase orders.
is_drop_shipment
optional
Default is FALSE, in case of drop shipment value must be TRUE
contact_persons
Show Attributes
optional
Array of contact person IDs
attention
optional
Name of person, who need to have attention
delivery_org_address_id
optional
Unique ID generated by the server. This is used as identifier.
delivery_customer_id
optional
Customer ID for delivery address
notes
optional
Notes for purchase order
terms
optional
Terms for purchase order
exchange_rate
optional
Exchange rate of currency respect to base currency
line_items
Show Attributes
required
Purchase order contains multiple line items. Each item contains- item_id,name,salesorder_item_id, description , item_order,rate,quantity,unit ,item_total,tax_id

Retrieve a purchase order

GET /purchaseorders/{purchaseorder_id}

Details for an existing purchase order.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/purchaseorders/{purchaseorder_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "purchase_order":    {
    "purchaseorder_id": "4815000000044972",
    "purchaseorder_number": "PO-00002",
    "date": "2015-05-28",
    "expected_delivery_date": "2015-06-01",
    "reference_number": "REF-P-00002",
    "status": "partially_received",
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "delivery_date": "2015-06-01",
    "salesorder_id": "4815000000044936",
    "is_drop_shipment": true,
    "line_items": [
        {
            "item_id": "4815000000044102",
            "line_item_id": "4815000000044974",
            "salesorder_item_id": "4815000000044897",
            "account_id": "4815000000035003",
            "name": "Laptop-black/13 inch/apple",
            "description": "Laptop-black/13 inch/apple",
            "item_order": 0,
            "bcy_rate": 110,
            "rate": 110,
            "quantity": 4,
            "quantity_received": 2,
            "unit": "qty",
            "item_total": 440,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "image_id": "2077500000000002011",
            "image_name": "apple.jpeg",
            "image_type": "jpeg"
        }
    ],
    "sub_total": 440,
    "tax_total": 52,
    "total": 492,
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 52.8
        }
    ],
    "price_precision": "2",
    "pricebook_id": "4815000000044054",
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "notes": "notes",
    "terms": "T&C",
    "ship_via": "FedEx",
    "ship_via_id": "4815000000044822",
    "attention": "vishal",
    "delivery_org_address_id": "4815000000044077",
    "delivery_customer_id": "4815000000044066",
    "delivery_customer_name": "Watson",
    "delivery_address": {
        "address": "#221,,Baker Street",
        "city": "New Jursey",
        "state": "New York",
        "zip": "007007",
        "country": "U.S.A",
        "phone": "99996666",
        "Fax": "424-524242"
    },
    "attachment_name": "sample.pdf",
    "can_send_in_mail": true,
    "template_id": "4815000000015007",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:42:09-1100",
    "last_modified_time": "2015-05-28T23:52:03-1100",
    "purchasereceives": [
        {
            "receive_id": "4815000000045035",
            "receive_number": "PR-00002",
            "date": "2015-05-28",
            "note": "note"
        }
    ],
    "bills": [
        {
            "bill_id": "4815000000045067",
            "bill_number": "BL-00002",
            "status": "overdue",
            "date": "2015-05-28",
            "due_date": "2015-05-29",
            "total": 492.8,
            "balance": 492.8
        }
    ]
}
}

Update an purchase order

PUT /purchaseorders/{purchaseorder_id}?ignore_auto_number_generation={boolean}

Update details of an existing purchase order.

Discription about extra parameter :
attachment :Allowed Extensions: gif, png, jpeg, jpg, bmp, pdf, xls, xlsx, doc and docx
Allowed type:file
ignore_auto_number_generation :Ignore auto purchase order number generation for this purchase order. This mandates the purchase order number.
Allowed Values: true and false

Request Example

$ curl -X PUT 'https://inventory.zoho.com/api/v1/purchaseorders/{purchaseorder_id}?ignore_auto_number_generation={boolean}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "purchaseorder_number": "PO-00002",
    "date": "2015-05-28",
    "expected_delivery_date": "2015-06-01",
    "reference_number": "REF-P-00002",
    "ship_via": "FedEx",
    "vendor_id": "4815000000044080",
    "salesorder_id": "4815000000044936",
    "is_drop_shipment": true,
    "contact_persons": [
        "4815000000044080"
    ],
    "attention": "vishal",
    "delivery_org_address_id": "4815000000044077",
    "delivery_customer_id": "4815000000044066",
    "notes": "notes",
    "terms": "T&C",
    "exchange_rate": 1,
    "line_items": [
        {
            "item_id": "4815000000044102",
            "line_item_id": "4815000000044974",
            "salesorder_item_id": "4815000000044897",
            "name": "Laptop-black/13 inch/apple",
            "description": "Laptop-black/13 inch/apple",
            "item_order": 0,
            "rate": 110,
            "quantity": 4,
            "unit": "qty",
            "tax_id": "4815000000044043"
        }
    ]
}

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The purchase order details have been updated.",
    "purchase_order":    {
    "purchaseorder_id": "4815000000044972",
    "purchaseorder_number": "PO-00002",
    "date": "2015-05-28",
    "expected_delivery_date": "2015-06-01",
    "reference_number": "REF-P-00002",
    "status": "partially_received",
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "delivery_date": "2015-06-01",
    "salesorder_id": "4815000000044936",
    "is_drop_shipment": true,
    "line_items": [
        {
            "item_id": "4815000000044102",
            "line_item_id": "4815000000044974",
            "salesorder_item_id": "4815000000044897",
            "account_id": "4815000000035003",
            "name": "Laptop-black/13 inch/apple",
            "description": "Laptop-black/13 inch/apple",
            "item_order": 0,
            "bcy_rate": 110,
            "rate": 110,
            "quantity": 4,
            "quantity_received": 2,
            "unit": "qty",
            "item_total": 440,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "image_id": "2077500000000002011",
            "image_name": "apple.jpeg",
            "image_type": "jpeg"
        }
    ],
    "sub_total": 440,
    "tax_total": 52,
    "total": 492,
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 52.8
        }
    ],
    "price_precision": "2",
    "pricebook_id": "4815000000044054",
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "notes": "notes",
    "terms": "T&C",
    "ship_via": "FedEx",
    "ship_via_id": "4815000000044822",
    "attention": "vishal",
    "delivery_org_address_id": "4815000000044077",
    "delivery_customer_id": "4815000000044066",
    "delivery_customer_name": "Watson",
    "delivery_address": {
        "address": "#221,,Baker Street",
        "city": "New Jursey",
        "state": "New York",
        "zip": "007007",
        "country": "U.S.A",
        "phone": "99996666",
        "Fax": "424-524242"
    },
    "attachment_name": "sample.pdf",
    "can_send_in_mail": true,
    "template_id": "4815000000015007",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:42:09-1100",
    "last_modified_time": "2015-05-28T23:52:03-1100",
    "purchasereceives": [
        {
            "receive_id": "4815000000045035",
            "receive_number": "PR-00002",
            "date": "2015-05-28",
            "note": "note"
        }
    ],
    "bills": [
        {
            "bill_id": "4815000000045067",
            "bill_number": "BL-00002",
            "status": "overdue",
            "date": "2015-05-28",
            "due_date": "2015-05-29",
            "total": 492.8,
            "balance": 492.8
        }
    ]
}
}

Arguments

purchaseorder_number
required
Purchase Number
date
optional
Date of Purchase Order
expected_delivery_date
optional
Expected date of delivery of items ordered
reference_number
optional
Reference number of purchase order
ship_via
optional
Shiping method for purchase order
vendor_id
required
Vendor ID.
salesorder_id
optional
sales order ID for DropShipment,mandatory in case of Dropship purchase orders.
is_drop_shipment
optional
Default is FALSE, in case of drop shipment value must be TRUE
contact_persons
Show Attributes
optional
Array of contact person IDs
attention
optional
Name of person, who need to have attention
delivery_org_address_id
optional
Unique ID generated by the server. This is used as identifier.
delivery_customer_id
optional
Customer ID for delivery address
notes
optional
Notes for purchase order
terms
optional
Terms for purchase order
exchange_rate
optional
Exchange rate of currency respect to base currency
line_items
Show Attributes
required
Purchase order contains multiple line items. Each item contains- item_id,line_item_id,salesorder_item_id,name, description , item_order,rate,quantity,unit ,tax_id

Delete an purchase order

DELETE /purchaseorders/{purchaseorder_id}

Delete an existing purchase order.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/purchaseorders/{purchaseorder_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

List all purchase order

GET /purchaseorders

List of all purchase order.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/purchaseorders ' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "purchase_orders":
    [
    {
    "purchaseorder_id": "4815000000044972",
    "purchaseorder_number": "PO-00002",
    "date": "2015-05-28",
    "expected_delivery_date": "2015-06-01",
    "reference_number": "REF-P-00002",
    "status": "partially_received",
    "vendor_id": "4815000000044080",
    "vendor_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "delivery_date": "2015-06-01",
    "salesorder_id": "4815000000044936",
    "is_drop_shipment": true,
    "line_items": [
        {
            "item_id": "4815000000044102",
            "line_item_id": "4815000000044974",
            "salesorder_item_id": "4815000000044897",
            "account_id": "4815000000035003",
            "name": "Laptop-black/13 inch/apple",
            "description": "Laptop-black/13 inch/apple",
            "item_order": 0,
            "bcy_rate": 110,
            "rate": 110,
            "quantity": 4,
            "quantity_received": 2,
            "unit": "qty",
            "item_total": 440,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "image_id": "2077500000000002011",
            "image_name": "apple.jpeg",
            "image_type": "jpeg"
        }
    ],
    "sub_total": 440,
    "tax_total": 52,
    "total": 492,
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 52.8
        }
    ],
    "price_precision": "2",
    "pricebook_id": "4815000000044054",
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "notes": "notes",
    "terms": "T&C",
    "ship_via": "FedEx",
    "ship_via_id": "4815000000044822",
    "attention": "vishal",
    "delivery_org_address_id": "4815000000044077",
    "delivery_customer_id": "4815000000044066",
    "delivery_customer_name": "Watson",
    "delivery_address": {
        "address": "#221,,Baker Street",
        "city": "New Jursey",
        "state": "New York",
        "zip": "007007",
        "country": "U.S.A",
        "phone": "99996666",
        "Fax": "424-524242"
    },
    "attachment_name": "sample.pdf",
    "can_send_in_mail": true,
    "template_id": "4815000000015007",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:42:09-1100",
    "last_modified_time": "2015-05-28T23:52:03-1100",
    "purchasereceives": [
        {
            "receive_id": "4815000000045035",
            "receive_number": "PR-00002",
            "date": "2015-05-28",
            "note": "note"
        }
    ],
    "bills": [
        {
            "bill_id": "4815000000045067",
            "bill_number": "BL-00002",
            "status": "overdue",
            "date": "2015-05-28",
            "due_date": "2015-05-29",
            "total": 492.8,
            "balance": 492.8
        }
    ]
}
{..},
{..}
]
}

Mark as issued

POST /purchaseorders/{purchaseorder_id}/status/issued

Change status of the purchase order to ** issued**.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/purchaseorders/{purchaseorder_id}/status/issued' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Mark as cancelled

POST /purchaseorders/{purchaseorder_id}/status/cancelled

Change status of the purchase order to ** cancelled**.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/purchaseorders/{purchaseorder_id}/status/cancelled' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Purchase Receives

It’s a receipt or a document issued by your organization to your vendor showing from indicating the quantity and the items received by you with respect to a purchase order.

Example


{
  "purchaseorder_id": "4815000000044972",
  "purchaseorder_number": "PO-00002",
  "receive_id": "4815000000045035",
  "receive_number": "PR-00002",
  "date": "2015-05-28",
  "customer_id": "4815000000044080",
  "customer_name": "Molly",
  "contact_persons": [
    "4815000000044080"
  ],
  "notes": "notes",
  "line_items": [
    {
      "line_item_id": "4815000000045037",
      "item_id": "4815000000044102",
      "name": "Laptop-black/13 inch/apple",
      "description": "Laptop-black/13 inch/apple",
      "item_order": 0,
      "quantity": 2,
      "unit": "qty"
    }
  ],
  "billing_address": {
    "address": "#234,90 Church Street",
    "city": "New York City",
    "state": "New York",
    "zip": "10048",
    "country": "U.S.A",
    "fax": "342-421234"
  },
  "shipping_address": {
    "address": "#432,Bayside,Queens",
    "city": "New York City",
    "state": "New York",
    "zip": "11364",
    "country": "U.S.A",
    "fax": "424-524242"
  },
  "created_time": "2015-05-28T23:50:47-1100",
  "last_modified_time": "2015-05-28T23:50:47-1100"
}

Attributes

purchaseorder_id
long
Purchase order ID.
purchaseorder_number
string
Purchase order Number
receive_id
long
Unique ID generated by the server. This is used as identifier.
receive_number
string
Purchase receive
date
string
Date
customer_id
long
Customer ID.
customer_name
string
Name of vendor
contact_persons
Show Attributes
object
Array of contact person IDs
notes
string
Notes about receive
line_items
Show Attributes
list
Number of line items of purchase receive, Each line item contains- line_item_id,item_id,name, description,item_order,quantity and unit
billing_address
Show Attributes
list
Customer’s billing address object. It contains address, city, state,zip,country and fax.
shipping_address
Show Attributes
list
Customer’s shipping address object. It contains address, city, state,zip,country and fax.
created_time
string
Time at which the purchase receive details were last created.
last_modified_time
string
Time at which the purchase receive were last modified.

Create a purchase receive

POST /purchasereceives?purchaseorder_id={purchaseorder_id}

A new purchase receive can a be created.To create Purchase receive, URL parameter purchaseorder_id is needed.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/purchasereceives?purchaseorder_id={purchaseorder_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "receive_number": "PR-00002",
    "date": "2015-05-28",
    "notes": "notes",
    "line_items": [
        {
            "line_item_id": "4815000000045037",
            "quantity": 2
        }
    ]
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The purchase receive has been created",
    "purchase_receive":    {
    "purchaseorder_id": "4815000000044972",
    "purchaseorder_number": "PO-00002",
    "receive_id": "4815000000045035",
    "receive_number": "PR-00002",
    "date": "2015-05-28",
    "customer_id": "4815000000044080",
    "customer_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "notes": "notes",
    "line_items": [
        {
            "line_item_id": "4815000000045037",
            "item_id": "4815000000044102",
            "name": "Laptop-black/13 inch/apple",
            "description": "Laptop-black/13 inch/apple",
            "item_order": 0,
            "quantity": 2,
            "unit": "qty"
        }
    ],
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "created_time": "2015-05-28T23:50:47-1100",
    "last_modified_time": "2015-05-28T23:50:47-1100"
}
}

Arguments

receive_number
required
Purchase receive
date
optional
Date
notes
optional
Notes about receive
line_items
Show Attributes
required
Number of line items of purchase receive, Each line item contains- line_item_id and quantity

Retrieve a purchase receive

GET /purchasereceives/{purchasereceive_id}

Details for an existing purchase receive.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/purchasereceives/{purchasereceive_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "purchase_receive":    {
    "purchaseorder_id": "4815000000044972",
    "purchaseorder_number": "PO-00002",
    "receive_id": "4815000000045035",
    "receive_number": "PR-00002",
    "date": "2015-05-28",
    "customer_id": "4815000000044080",
    "customer_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "notes": "notes",
    "line_items": [
        {
            "line_item_id": "4815000000045037",
            "item_id": "4815000000044102",
            "name": "Laptop-black/13 inch/apple",
            "description": "Laptop-black/13 inch/apple",
            "item_order": 0,
            "quantity": 2,
            "unit": "qty"
        }
    ],
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "created_time": "2015-05-28T23:50:47-1100",
    "last_modified_time": "2015-05-28T23:50:47-1100"
}
}

Delete an purchase receive

DELETE /purchasereceives/{purchasereceive_id}

Delete an existing purchase receive.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/purchasereceives/{purchasereceive_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Bills

When your vendor supplies goods/services to you on credit, you’re sent an invoice that details the amount of money you owe him. You can record this as a bill in Zoho Inventory and track it until it’s paid.

Example


{
  "bill_id": "4815000000045271",
  "purchaseorder_ids": [
    "4815000000045243"
  ],
  "vendor_id": "4815000000044066",
  "vendor_name": "Sky Motors",
  "unused_credits_payable_amount": 0,
  "status": "paid",
  "bill_number": "BL-00003",
  "date": "2015-05-29",
  "due_date": "2015-05-29",
  "reference_number": "PO-00003",
  "due_by_days": 69,
  "currency_id": "4815000000000097",
  "currency_code": "USD",
  "currency_symbol": "$",
  "price_precision": 2,
  "exchange_rate": 1,
  "line_items": [
    {
      "purchaseorder_item_id": "4815000000045245",
      "receive_item_id": "4815000000044131",
      "line_item_id": "4815000000045275",
      "item_id": "4815000000044208",
      "name": "Bags-small",
      "account_id": "4815000000035001",
      "account_name": "Inventory Asset",
      "description": "",
      "bcy_rate": 6.0,
      "rate": 6.0,
      "quantity": 4.0,
      "tax_id": "4815000000044043",
      "tax_name": "Sales Tax",
      "tax_type": "tax",
      "tax_percentage": 12,
      "item_total": 24.0,
      "item_order": 0,
      "unit": "pcs",
      "image_id": "2077500000000002011",
      "image_name": "Bags-small.jpeg",
      "image_type": "jpeg"
    }
  ],
  "taxes": [
    {
      "tax_name": "Sales Tax (12%)",
      "tax_amount": 2.88
    }
  ],
  "vendor_credits_applied": 0,
  "sub_total": 24,
  "tax_total": 2,
  "balance": 0,
  "billing_address": {
    "address": "#221,,Baker Street",
    "city": "New Jursey",
    "state": "New York",
    "zip": "007007",
    "country": "U.S.A",
    "Fax": "424-524242"
  },
  "payments": [
    {
      "payment_id": "4815000000046039",
      "bill_id": "4815000000045271",
      "bill_payment_id": "4815000000046041",
      "payment_mode": "Cash",
      "payment_number": "2",
      "description": "",
      "date": "2015-05-29",
      "reference_number": "REF-PAY-00001",
      "exchange_rate": 1,
      "amount": 26.88,
      "paid_through_account_id": "4815000000000361",
      "paid_through_account_name": "Petty Cash",
      "is_single_bill_payment": true
    }
  ],
  "vendor_credits": [

  ],
  "created_time": "2015-05-29T00:36:13-1100",
  "last_modified_time": "2015-05-29T00:37:54-1100",
  "reference_id": "4815000000000342",
  "notes": "Notes",
  "terms": "Term & Conditions",
  "attachment_name": "sample-attachments",
  "open_purchaseorders_count": 0
}

Attributes

bill_id
long
Unique ID generated by the server. This is used as identifier.
purchaseorder_ids
Show Attributes
object
purchase order IDs
vendor_id
long
Vendor IDs
vendor_name
string
Name of Vendor
unused_credits_payable_amount
double
Unused credit payable amount
status
string
status of Bill
bill_number
string
Bill number
date
string
Date of Bill
due_date
string
Due date of bill
reference_number
string
reference number of bill
due_by_days
integer
Due days of bill
currency_id
long
Currency ID
currency_code
string
Currency Code
currency_symbol
string
Symbol
price_precision
integer
Price Precision
exchange_rate
integer
Exchange rate
is_item_level_tax_calc
boolean
To check item level tax is calculated or not
line_items
Show Attributes
list
lines items added for bill. It contains- purchaseorder_item_id,receive_item_id, line_item_id,item_id, name , account_id,account_name,description,bcy_rate,rate,quantity ,tax_id,tax_name,tax_type, tax_type,tax_percentage,item_total ,item_order,unit,image_id,image_name,image_type
list
Number of taxes applied on purchase order. Each tax contains: tax_name and tax_amount
vendor_credits_applied
double
vendor credits applied on bill
sub_total
double
Sub Total of Bill
tax_total
double
Tax Total
balance
double
Remaining Balance
billing_address
Show Attributes
list
Customer’s billing address object. It contains address, city, state,zip,country and Fax.
list
payment made for bills, contains-payment_id, bill_id, bill_payment_id,payment_mode,payment_number,description, date, reference_number,exchange_rate,amount,paid_through_account_id, paid_through_account_id,paid_through_account_name and is_single_bill_payment.
vendor_credits
Show Attributes
object
Vendor Credits
created_time
string
Time at which the bill details were last created.
last_modified_time
string
Time at which the bill details were last Modified.
reference_id
long
Reference ID
notes
string
Notes
terms
string
Terms and conditions
attachment_name
string
Attached file name
open_purchaseorders_count
integer
Number of open status Purchase order Count for the bill

Create a Bill

POST /bills

Create a new Bill.

Discription about extra parameter :
attachment :Allowed Extensions: gif, png, jpeg, jpg, bmp and pdf
Allowed type:file

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/bills' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "purchaseorder_ids": [
        "4815000000045243"
    ],
    "vendor_id": "4815000000044066",
    "bill_number": "BL-00003",
    "date": "2015-05-29",
    "due_date": "2015-05-29",
    "reference_number": "PO-00003",
    "currency_id": "4815000000000097",
    "exchange_rate": 1,
    "notes": "Notes",
    "terms": "Term & Conditions",
    "line_items": [
        {
            "purchaseorder_item_id": "4815000000045245",
            "receive_item_id": "4815000000044131",
            "item_id": "4815000000044208",
            "account_id": "4815000000035001",
            "description": "",
            "rate": 6.0,
            "quantity": 4.0,
            "tax_id": "4815000000044043",
            "item_order": 0
        }
    ]
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The bill has been Created",
    "bill":    {
    "bill_id": "4815000000045271",
    "purchaseorder_ids": [
        "4815000000045243"
    ],
    "vendor_id": "4815000000044066",
    "vendor_name": "Sky Motors",
    "unused_credits_payable_amount": 0,
    "status": "paid",
    "bill_number": "BL-00003",
    "date": "2015-05-29",
    "due_date": "2015-05-29",
    "reference_number": "PO-00003",
    "due_by_days": 69,
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "price_precision": 2,
    "exchange_rate": 1,
    "line_items": [
        {
            "purchaseorder_item_id": "4815000000045245",
            "receive_item_id": "4815000000044131",
            "line_item_id": "4815000000045275",
            "item_id": "4815000000044208",
            "name": "Bags-small",
            "account_id": "4815000000035001",
            "account_name": "Inventory Asset",
            "description": "",
            "bcy_rate": 6.0,
            "rate": 6.0,
            "quantity": 4.0,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 24.0,
            "item_order": 0,
            "unit": "pcs",
            "image_id": "2077500000000002011",
            "image_name": "Bags-small.jpeg",
            "image_type": "jpeg"
        }
    ],
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 2.88
        }
    ],
    "vendor_credits_applied": 0,
    "sub_total": 24,
    "tax_total": 2,
    "balance": 0,
    "billing_address": {
        "address": "#221,,Baker Street",
        "city": "New Jursey",
        "state": "New York",
        "zip": "007007",
        "country": "U.S.A",
        "Fax": "424-524242"
    },
    "payments": [
        {
            "payment_id": "4815000000046039",
            "bill_id": "4815000000045271",
            "bill_payment_id": "4815000000046041",
            "payment_mode": "Cash",
            "payment_number": "2",
            "description": "",
            "date": "2015-05-29",
            "reference_number": "REF-PAY-00001",
            "exchange_rate": 1,
            "amount": 26.88,
            "paid_through_account_id": "4815000000000361",
            "paid_through_account_name": "Petty Cash",
            "is_single_bill_payment": true
        }
    ],
    "vendor_credits": [

    ],
    "created_time": "2015-05-29T00:36:13-1100",
    "last_modified_time": "2015-05-29T00:37:54-1100",
    "reference_id": "4815000000000342",
    "notes": "Notes",
    "terms": "Term & Conditions",
    "attachment_name": "sample-attachments",
    "open_purchaseorders_count": 0
}
}

Arguments

purchaseorder_ids
Show Attributes
optional
purchase order IDs
vendor_id
required
Vendor IDs
bill_number
required
Bill number
date
required
Date of Bill
due_date
required
Due date of bill
reference_number
optional
reference number of bill
currency_id
optional
Currency ID
exchange_rate
optional
Exchange rate
is_item_level_tax_calc
optional
To check item level tax is calculated or not
notes
optional
Notes
terms
optional
Terms and conditions
line_items
Show Attributes
required
lines items added for bill. It contains- purchaseorder_item_id,receive_item_id, item_id, account_id,description,rate,quantity ,tax_id,item_order

Retrieve a Bill

GET /bills/{bill_id}

Details of an existing Bill.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/bills/{bill_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "bill":    {
    "bill_id": "4815000000045271",
    "purchaseorder_ids": [
        "4815000000045243"
    ],
    "vendor_id": "4815000000044066",
    "vendor_name": "Sky Motors",
    "unused_credits_payable_amount": 0,
    "status": "paid",
    "bill_number": "BL-00003",
    "date": "2015-05-29",
    "due_date": "2015-05-29",
    "reference_number": "PO-00003",
    "due_by_days": 69,
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "price_precision": 2,
    "exchange_rate": 1,
    "line_items": [
        {
            "purchaseorder_item_id": "4815000000045245",
            "receive_item_id": "4815000000044131",
            "line_item_id": "4815000000045275",
            "item_id": "4815000000044208",
            "name": "Bags-small",
            "account_id": "4815000000035001",
            "account_name": "Inventory Asset",
            "description": "",
            "bcy_rate": 6.0,
            "rate": 6.0,
            "quantity": 4.0,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 24.0,
            "item_order": 0,
            "unit": "pcs",
            "image_id": "2077500000000002011",
            "image_name": "Bags-small.jpeg",
            "image_type": "jpeg"
        }
    ],
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 2.88
        }
    ],
    "vendor_credits_applied": 0,
    "sub_total": 24,
    "tax_total": 2,
    "balance": 0,
    "billing_address": {
        "address": "#221,,Baker Street",
        "city": "New Jursey",
        "state": "New York",
        "zip": "007007",
        "country": "U.S.A",
        "Fax": "424-524242"
    },
    "payments": [
        {
            "payment_id": "4815000000046039",
            "bill_id": "4815000000045271",
            "bill_payment_id": "4815000000046041",
            "payment_mode": "Cash",
            "payment_number": "2",
            "description": "",
            "date": "2015-05-29",
            "reference_number": "REF-PAY-00001",
            "exchange_rate": 1,
            "amount": 26.88,
            "paid_through_account_id": "4815000000000361",
            "paid_through_account_name": "Petty Cash",
            "is_single_bill_payment": true
        }
    ],
    "vendor_credits": [

    ],
    "created_time": "2015-05-29T00:36:13-1100",
    "last_modified_time": "2015-05-29T00:37:54-1100",
    "reference_id": "4815000000000342",
    "notes": "Notes",
    "terms": "Term & Conditions",
    "attachment_name": "sample-attachments",
    "open_purchaseorders_count": 0
}
}

Update a Bill

PUT /bills/{bill_id}

Update the details of an existing Bill.

Discription about extra parameter :
attachment :Allowed Extensions: gif, png, jpeg, jpg, bmp and pdf
Allowed type:file

Request Example

$ curl -X PUT 'https://inventory.zoho.com/api/v1/bills/{bill_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "purchaseorder_ids": [
        "4815000000045243"
    ],
    "vendor_id": "4815000000044066",
    "bill_number": "BL-00003",
    "date": "2015-05-29",
    "due_date": "2015-05-29",
    "reference_number": "PO-00003",
    "currency_id": "4815000000000097",
    "exchange_rate": 1,
    "notes": "Notes",
    "terms": "Term & Conditions",
    "line_items": [
        {
            "purchaseorder_item_id": "4815000000045245",
            "receive_item_id": "4815000000044131",
            "line_item_id": "4815000000045275",
            "item_id": "4815000000044208",
            "account_id": "4815000000035001",
            "description": "",
            "rate": 6.0,
            "quantity": 4.0,
            "tax_id": "4815000000044043",
            "item_order": 0
        }
    ]
}

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The bill details has been updated.",
    "bill":    {
    "bill_id": "4815000000045271",
    "purchaseorder_ids": [
        "4815000000045243"
    ],
    "vendor_id": "4815000000044066",
    "vendor_name": "Sky Motors",
    "unused_credits_payable_amount": 0,
    "status": "paid",
    "bill_number": "BL-00003",
    "date": "2015-05-29",
    "due_date": "2015-05-29",
    "reference_number": "PO-00003",
    "due_by_days": 69,
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "price_precision": 2,
    "exchange_rate": 1,
    "line_items": [
        {
            "purchaseorder_item_id": "4815000000045245",
            "receive_item_id": "4815000000044131",
            "line_item_id": "4815000000045275",
            "item_id": "4815000000044208",
            "name": "Bags-small",
            "account_id": "4815000000035001",
            "account_name": "Inventory Asset",
            "description": "",
            "bcy_rate": 6.0,
            "rate": 6.0,
            "quantity": 4.0,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 24.0,
            "item_order": 0,
            "unit": "pcs",
            "image_id": "2077500000000002011",
            "image_name": "Bags-small.jpeg",
            "image_type": "jpeg"
        }
    ],
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 2.88
        }
    ],
    "vendor_credits_applied": 0,
    "sub_total": 24,
    "tax_total": 2,
    "balance": 0,
    "billing_address": {
        "address": "#221,,Baker Street",
        "city": "New Jursey",
        "state": "New York",
        "zip": "007007",
        "country": "U.S.A",
        "Fax": "424-524242"
    },
    "payments": [
        {
            "payment_id": "4815000000046039",
            "bill_id": "4815000000045271",
            "bill_payment_id": "4815000000046041",
            "payment_mode": "Cash",
            "payment_number": "2",
            "description": "",
            "date": "2015-05-29",
            "reference_number": "REF-PAY-00001",
            "exchange_rate": 1,
            "amount": 26.88,
            "paid_through_account_id": "4815000000000361",
            "paid_through_account_name": "Petty Cash",
            "is_single_bill_payment": true
        }
    ],
    "vendor_credits": [

    ],
    "created_time": "2015-05-29T00:36:13-1100",
    "last_modified_time": "2015-05-29T00:37:54-1100",
    "reference_id": "4815000000000342",
    "notes": "Notes",
    "terms": "Term & Conditions",
    "attachment_name": "sample-attachments",
    "open_purchaseorders_count": 0
}
}

Arguments

purchaseorder_ids
Show Attributes
optional
purchase order IDs
vendor_id
required
Vendor IDs
bill_number
required
Bill number
date
required
Date of Bill
due_date
required
Due date of bill
reference_number
optional
reference number of bill
currency_id
optional
Currency ID
exchange_rate
optional
Exchange rate
is_item_level_tax_calc
optional
To check item level tax is calculated or not
notes
optional
Notes
terms
optional
Terms and conditions
line_items
Show Attributes
required
lines items added for bill. It contains- purchaseorder_item_id,receive_item_id,line_item_id, item_id, account_id,description,rate,quantity ,tax_id,item_order

Delete a Bill

DELETE /bills/{bill_id}

Delete an existing Bill.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/bills/{bill_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

List of all Bills

GET /bills

List of all Bills of a customer.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/bills' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "bills":
    [
    {
    "bill_id": "4815000000045271",
    "purchaseorder_ids": [
        "4815000000045243"
    ],
    "vendor_id": "4815000000044066",
    "vendor_name": "Sky Motors",
    "unused_credits_payable_amount": 0,
    "status": "paid",
    "bill_number": "BL-00003",
    "date": "2015-05-29",
    "due_date": "2015-05-29",
    "reference_number": "PO-00003",
    "due_by_days": 69,
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "price_precision": 2,
    "exchange_rate": 1,
    "line_items": [
        {
            "purchaseorder_item_id": "4815000000045245",
            "receive_item_id": "4815000000044131",
            "line_item_id": "4815000000045275",
            "item_id": "4815000000044208",
            "name": "Bags-small",
            "account_id": "4815000000035001",
            "account_name": "Inventory Asset",
            "description": "",
            "bcy_rate": 6.0,
            "rate": 6.0,
            "quantity": 4.0,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 24.0,
            "item_order": 0,
            "unit": "pcs",
            "image_id": "2077500000000002011",
            "image_name": "Bags-small.jpeg",
            "image_type": "jpeg"
        }
    ],
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 2.88
        }
    ],
    "vendor_credits_applied": 0,
    "sub_total": 24,
    "tax_total": 2,
    "balance": 0,
    "billing_address": {
        "address": "#221,,Baker Street",
        "city": "New Jursey",
        "state": "New York",
        "zip": "007007",
        "country": "U.S.A",
        "Fax": "424-524242"
    },
    "payments": [
        {
            "payment_id": "4815000000046039",
            "bill_id": "4815000000045271",
            "bill_payment_id": "4815000000046041",
            "payment_mode": "Cash",
            "payment_number": "2",
            "description": "",
            "date": "2015-05-29",
            "reference_number": "REF-PAY-00001",
            "exchange_rate": 1,
            "amount": 26.88,
            "paid_through_account_id": "4815000000000361",
            "paid_through_account_name": "Petty Cash",
            "is_single_bill_payment": true
        }
    ],
    "vendor_credits": [

    ],
    "created_time": "2015-05-29T00:36:13-1100",
    "last_modified_time": "2015-05-29T00:37:54-1100",
    "reference_id": "4815000000000342",
    "notes": "Notes",
    "terms": "Term & Conditions",
    "attachment_name": "sample-attachments",
    "open_purchaseorders_count": 0
}
{..},
{..}
]
}

Mark as Open

POST /bills/{bill_id}/status/open

Change status of the bills to ** open**.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/bills/{bill_id}/status/open' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Mark as Void

POST /bills/{bill_id}/status/void

Change status of the bills to ** void**.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/bills/{bill_id}/status/void' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

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",
  "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": [
    "4815000000044080"
  ],
  "currency_id": "4815000000000097",
  "currency_code": "USD",
  "currency_symbol": "$",
  "exchange_rate": 1,
  "discount_amount": 0,
  "discount": 0,
  "is_discount_before_tax": true,
  "discount_type": "entity_level",
  "estimate_id": "4815000000045091",
  "delivery_method": "FedEx",
  "delivery_method_id": "4815000000044822",
  "line_items": [
    {
      "line_item_id": "4815000000044897",
      "item_id": "4815000000044100",
      "name": "Laptop-white/15inch/dell",
      "description": "Laptop-white/15inch/dell",
      "item_order": 0,
      "bcy_rate": 122,
      "rate": 122,
      "quantity": 2,
      "quantity_invoiced": 2,
      "quantity_packed": 2,
      "quantity_shipped": 2,
      "unit": "qty",
      "discount": 0,
      "tax_id": "4815000000044043",
      "tax_name": "Sales Tax",
      "tax_type": "tax",
      "tax_percentage": 12,
      "item_total": 244,
      "is_invoiced": true,
      "image_id": "2077500000000002009",
      "image_name": "dell.jpg",
      "image_type": "jpg"
    }
  ],
  "shipping_charge": 7,
  "adjustment": 0,
  "adjustment_description": "Adjustment",
  "sub_total": 244,
  "tax_total": 29,
  "total": 280,
  "taxes": [
    {
      "tax_name": "Sales Tax (12%)",
      "tax_amount": 29.28
    }
  ],
  "price_precision": "2",
  "pricebook_id": "4815000000044054",
  "packages": [
    {
      "package_id": "4815000000044905",
      "package_number": "PK-00004",
      "date": "2015-05-28",
      "status": "delivered",
      "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-05-28",
      "delivery_days": "",
      "delivery_guarantee": false
    }
  ],
  "invoices": [
    {
      "invoice_id": "4815000000045091",
      "invoice_number": "INV-000001",
      "status": "paid",
      "date": "2015-05-29",
      "due_date": "2015-06-13",
      "total": 280.28,
      "balance": 0
    }
  ],
  "shipping_address": {
    "address": "#432,Bayside,Queens",
    "city": "New York City",
    "state": "New York",
    "zip": "11364",
    "country": "U.S.A",
    "fax": "424-524242"
  },
  "billing_address": {
    "address": "#234,90 Church Street",
    "city": "New York City",
    "state": "New York",
    "zip": "10048",
    "country": "U.S.A",
    "fax": "342-421234"
  },
  "notes": "notes",
  "terms": "T&C",
  "template_id": "4815000000017003",
  "template_name": "Standard",
  "template_type": "standard",
  "created_time": "2015-05-28T23:37:00-1100",
  "last_modified_time": "2015-05-28T23:53:31-1100",
  "attachment_name": "sample.pdf",
  "can_send_in_mail": "true",
  "salesperson_id": "4815000000044762",
  "salesperson_name": "Lara"
}

Attributes

salesorder_id
long
Unique ID generated by the server. This is used as identifier.
salesorder_number
string
Sales order number
date
string
Sales order creation date
status
string
Status of Salesorder
shipment_date
string
Shipment date of salesorder
reference_number
string
Reference number of sales order
customer_id
long
Customer ID.
customer_name
string
Name of customer
contact_persons
Show Attributes
object
Array of contact person IDs
currency_id
long
Currency ID.
currency_code
string
Currency Code
currency_symbol
string
Symbol of currency
exchange_rate
double
Exchange rate of currency respect to base currency
discount_amount
double
Discount amount
discount
double
Discount
is_discount_before_tax
boolean
To check, discount on sales order before tax or after tax
discount_type
string
Type of discount
estimate_id
long
estimate ID.
delivery_method
string
Delivery method
delivery_method_id
long
Delivery method ID.
line_items
Show Attributes
list
Sales order contains multiple line items. Each item contains- line_item_id,item_id,name, description , item_order,bcy_rate,rate,quantity,quantity_invoiced,quantity_packed,quantity_shipped,unit,discount,tax_id,tax_name, tax_type,tax_percentage,item_total,is_invoiced, image_id,image_name,image_type
shipping_charge
double
Shipping charges
adjustment
double
Adjustment on Salesorder total
adjustment_description
string
Description of adjustment
sub_total
double
Sub total of salesorder
tax_total
double
Tax total of salesorder
total
double
Total amount of sales order
list
Number of taxes applied on sales order. Each tax contains: tax_name and tax_amount
price_precision
string
price precision
pricebook_id
long
pricebook ID for sales order
is_emailed
boolean
To check, this salesorder is emailed to customer or not
list
Packages created for salesorders. Each packages contains-package_id,package_number,status,detailed_status,status_message,shipment_id,shipment_number,shipment_status,carrier,service,tracking_number,shipment_date,delivery_days and delivery_guarantee
list
Invoices for Salesorder. Each invoice contains- invoice_id,invoice_number,status, date, due_date,total and balance
shipping_address
Show Attributes
list
Customer’s shipping address object. It contains address, city, state,zip,country and fax.
billing_address
Show Attributes
list
Customer’s billing address object. It contains address, city, state,zip,country and fax.
notes
string
Notes for sales order
terms
string
Terms for sales order
template_id
long
template ID.
template_name
string
Name of template used for salesorder
template_type
string
Type of template
created_time
string
Time at which the sales order details were last created.
last_modified_time
string
Time at which the sales order details were last modified.
attachment_name
string
Name of attached file with salesorder
can_send_in_mail
string
To check, is sales order can send in email or not
salesperson_id
long
Sales person ID.
salesperson_name
string
Name of sales person

Create a sales order

POST /salesorders?ignore_auto_number_generation={boolean}

A new sales order can a be created.

Discription about extra parameter :
ignore_auto_number_generation : Ignore auto sales order number generation for this sales order. This mandates the Sales number.
Allowed Values: true and false

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/salesorders?ignore_auto_number_generation={boolean}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "salesorder_number": "SO-00003",
    "date": "2015-05-28",
    "shipment_date": "2015-06-02",
    "reference_number": "REF-S-00003",
    "customer_id": "4815000000044080",
    "contact_persons": [
        "4815000000044080"
    ],
    "discount": 0,
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "delivery_method": "FedEx",
    "shipping_charge": 7,
    "adjustment": 0,
    "adjustment_description": "Adjustment",
    "pricebook_id": "4815000000044054",
    "notes": "notes",
    "salesperson_name": "Lara",
    "terms": "T&C",
    "exchange_rate": 1,
    "line_items": [
        {
            "item_id": "4815000000044100",
            "name": "Laptop-white/15inch/dell",
            "description": "Laptop-white/15inch/dell",
            "item_order": 0,
            "rate": 122,
            "quantity": 2,
            "unit": "qty",
            "discount": 0,
            "tax_id": "4815000000044043"
        }
    ]
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The sales order has been created",
    "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": [
        "4815000000044080"
    ],
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "discount_amount": 0,
    "discount": 0,
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "estimate_id": "4815000000045091",
    "delivery_method": "FedEx",
    "delivery_method_id": "4815000000044822",
    "line_items": [
        {
            "line_item_id": "4815000000044897",
            "item_id": "4815000000044100",
            "name": "Laptop-white/15inch/dell",
            "description": "Laptop-white/15inch/dell",
            "item_order": 0,
            "bcy_rate": 122,
            "rate": 122,
            "quantity": 2,
            "quantity_invoiced": 2,
            "quantity_packed": 2,
            "quantity_shipped": 2,
            "unit": "qty",
            "discount": 0,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 244,
            "is_invoiced": true,
            "image_id": "2077500000000002009",
            "image_name": "dell.jpg",
            "image_type": "jpg"
        }
    ],
    "shipping_charge": 7,
    "adjustment": 0,
    "adjustment_description": "Adjustment",
    "sub_total": 244,
    "tax_total": 29,
    "total": 280,
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 29.28
        }
    ],
    "price_precision": "2",
    "pricebook_id": "4815000000044054",
    "packages": [
        {
            "package_id": "4815000000044905",
            "package_number": "PK-00004",
            "date": "2015-05-28",
            "status": "delivered",
            "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-05-28",
            "delivery_days": "",
            "delivery_guarantee": false
        }
    ],
    "invoices": [
        {
            "invoice_id": "4815000000045091",
            "invoice_number": "INV-000001",
            "status": "paid",
            "date": "2015-05-29",
            "due_date": "2015-06-13",
            "total": 280.28,
            "balance": 0
        }
    ],
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "notes": "notes",
    "terms": "T&C",
    "template_id": "4815000000017003",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:37:00-1100",
    "last_modified_time": "2015-05-28T23:53:31-1100",
    "attachment_name": "sample.pdf",
    "can_send_in_mail": "true",
    "salesperson_id": "4815000000044762",
    "salesperson_name": "Lara"
}
}

Arguments

salesorder_number
required
Sales order number
date
optional
Sales order creation date
shipment_date
optional
Shipment date of salesorder
reference_number
optional
Reference number of sales order
customer_id
required
Customer ID.
contact_persons
Show Attributes
optional
Array of contact person IDs
discount
optional
Discount
is_discount_before_tax
optional
To check, discount on sales order before tax or after tax
discount_type
optional
Type of discount
delivery_method
optional
Delivery method
shipping_charge
optional
Shipping charges
adjustment
optional
Adjustment on Salesorder total
adjustment_description
optional
Description of adjustment
pricebook_id
optional
pricebook ID for sales order
notes
optional
Notes for sales order
salesperson_name
optional
Name of sales person
terms
optional
Terms for sales order
exchange_rate
optional
Exchange rate of currency respect to base currency
line_items
Show Attributes
required
Sales order contains multiple line items. Each item contains- item_id,name, description , item_order,rate,quantity,unit,discount,tax_id

Retrieve a sales order

GET /salesorders/{salesorder_id}

Details for an existing sales order.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
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": [
        "4815000000044080"
    ],
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "discount_amount": 0,
    "discount": 0,
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "estimate_id": "4815000000045091",
    "delivery_method": "FedEx",
    "delivery_method_id": "4815000000044822",
    "line_items": [
        {
            "line_item_id": "4815000000044897",
            "item_id": "4815000000044100",
            "name": "Laptop-white/15inch/dell",
            "description": "Laptop-white/15inch/dell",
            "item_order": 0,
            "bcy_rate": 122,
            "rate": 122,
            "quantity": 2,
            "quantity_invoiced": 2,
            "quantity_packed": 2,
            "quantity_shipped": 2,
            "unit": "qty",
            "discount": 0,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 244,
            "is_invoiced": true,
            "image_id": "2077500000000002009",
            "image_name": "dell.jpg",
            "image_type": "jpg"
        }
    ],
    "shipping_charge": 7,
    "adjustment": 0,
    "adjustment_description": "Adjustment",
    "sub_total": 244,
    "tax_total": 29,
    "total": 280,
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 29.28
        }
    ],
    "price_precision": "2",
    "pricebook_id": "4815000000044054",
    "packages": [
        {
            "package_id": "4815000000044905",
            "package_number": "PK-00004",
            "date": "2015-05-28",
            "status": "delivered",
            "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-05-28",
            "delivery_days": "",
            "delivery_guarantee": false
        }
    ],
    "invoices": [
        {
            "invoice_id": "4815000000045091",
            "invoice_number": "INV-000001",
            "status": "paid",
            "date": "2015-05-29",
            "due_date": "2015-06-13",
            "total": 280.28,
            "balance": 0
        }
    ],
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "notes": "notes",
    "terms": "T&C",
    "template_id": "4815000000017003",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:37:00-1100",
    "last_modified_time": "2015-05-28T23:53:31-1100",
    "attachment_name": "sample.pdf",
    "can_send_in_mail": "true",
    "salesperson_id": "4815000000044762",
    "salesperson_name": "Lara"
}
}

Update an sales order

PUT /salesorders/{salesorder_id}?ignore_auto_number_generation={boolean}

Update details of an existing sales order.

Discription about extra parameter :
ignore_auto_number_generation : Ignore auto sales order number generation for this sales order. This mandates the Sales number.
Allowed Values: true and false

Request Example

$ curl -X PUT 'https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}?ignore_auto_number_generation={boolean}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "salesorder_number": "SO-00003",
    "date": "2015-05-28",
    "shipment_date": "2015-06-02",
    "reference_number": "REF-S-00003",
    "customer_id": "4815000000044080",
    "contact_persons": [
        "4815000000044080"
    ],
    "discount": 0,
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "delivery_method": "FedEx",
    "shipping_charge": 7,
    "adjustment": 0,
    "adjustment_description": "Adjustment",
    "pricebook_id": "4815000000044054",
    "notes": "notes",
    "salesperson_name": "Lara",
    "terms": "T&C",
    "exchange_rate": 1,
    "line_items": [
        {
            "line_item_id": "4815000000044897",
            "item_id": "4815000000044100",
            "name": "Laptop-white/15inch/dell",
            "description": "Laptop-white/15inch/dell",
            "item_order": 0,
            "rate": 122,
            "quantity": 2,
            "unit": "qty",
            "discount": 0,
            "tax_id": "4815000000044043"
        }
    ]
}

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The sales order details have been updated.",
    "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": [
        "4815000000044080"
    ],
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "discount_amount": 0,
    "discount": 0,
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "estimate_id": "4815000000045091",
    "delivery_method": "FedEx",
    "delivery_method_id": "4815000000044822",
    "line_items": [
        {
            "line_item_id": "4815000000044897",
            "item_id": "4815000000044100",
            "name": "Laptop-white/15inch/dell",
            "description": "Laptop-white/15inch/dell",
            "item_order": 0,
            "bcy_rate": 122,
            "rate": 122,
            "quantity": 2,
            "quantity_invoiced": 2,
            "quantity_packed": 2,
            "quantity_shipped": 2,
            "unit": "qty",
            "discount": 0,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 244,
            "is_invoiced": true,
            "image_id": "2077500000000002009",
            "image_name": "dell.jpg",
            "image_type": "jpg"
        }
    ],
    "shipping_charge": 7,
    "adjustment": 0,
    "adjustment_description": "Adjustment",
    "sub_total": 244,
    "tax_total": 29,
    "total": 280,
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 29.28
        }
    ],
    "price_precision": "2",
    "pricebook_id": "4815000000044054",
    "packages": [
        {
            "package_id": "4815000000044905",
            "package_number": "PK-00004",
            "date": "2015-05-28",
            "status": "delivered",
            "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-05-28",
            "delivery_days": "",
            "delivery_guarantee": false
        }
    ],
    "invoices": [
        {
            "invoice_id": "4815000000045091",
            "invoice_number": "INV-000001",
            "status": "paid",
            "date": "2015-05-29",
            "due_date": "2015-06-13",
            "total": 280.28,
            "balance": 0
        }
    ],
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "notes": "notes",
    "terms": "T&C",
    "template_id": "4815000000017003",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:37:00-1100",
    "last_modified_time": "2015-05-28T23:53:31-1100",
    "attachment_name": "sample.pdf",
    "can_send_in_mail": "true",
    "salesperson_id": "4815000000044762",
    "salesperson_name": "Lara"
}
}

Arguments

salesorder_number
required
Sales order number
date
optional
Sales order creation date
shipment_date
optional
Shipment date of salesorder
reference_number
optional
Reference number of sales order
customer_id
required
Customer ID.
contact_persons
Show Attributes
optional
Array of contact person IDs
discount
optional
Discount
is_discount_before_tax
optional
To check, discount on sales order before tax or after tax
discount_type
optional
Type of discount
delivery_method
optional
Delivery method
shipping_charge
optional
Shipping charges
adjustment
optional
Adjustment on Salesorder total
adjustment_description
optional
Description of adjustment
pricebook_id
optional
pricebook ID for sales order
notes
optional
Notes for sales order
salesperson_name
optional
Name of sales person
terms
optional
Terms for sales order
exchange_rate
optional
Exchange rate of currency respect to base currency
line_items
Show Attributes
required
Sales order contains multiple line items. Each item contains- item_id,name, description , item_order,rate,quantity,unit,discount,tax_id

Delete an sales order

DELETE /salesorders/{salesorder_id}

Delete an existing sales order.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

List all sales order

GET /salesorders

List of all sales order.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/salesorders ' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "sales_orders":
    [
    {
    "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": [
        "4815000000044080"
    ],
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "discount_amount": 0,
    "discount": 0,
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "estimate_id": "4815000000045091",
    "delivery_method": "FedEx",
    "delivery_method_id": "4815000000044822",
    "line_items": [
        {
            "line_item_id": "4815000000044897",
            "item_id": "4815000000044100",
            "name": "Laptop-white/15inch/dell",
            "description": "Laptop-white/15inch/dell",
            "item_order": 0,
            "bcy_rate": 122,
            "rate": 122,
            "quantity": 2,
            "quantity_invoiced": 2,
            "quantity_packed": 2,
            "quantity_shipped": 2,
            "unit": "qty",
            "discount": 0,
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 244,
            "is_invoiced": true,
            "image_id": "2077500000000002009",
            "image_name": "dell.jpg",
            "image_type": "jpg"
        }
    ],
    "shipping_charge": 7,
    "adjustment": 0,
    "adjustment_description": "Adjustment",
    "sub_total": 244,
    "tax_total": 29,
    "total": 280,
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 29.28
        }
    ],
    "price_precision": "2",
    "pricebook_id": "4815000000044054",
    "packages": [
        {
            "package_id": "4815000000044905",
            "package_number": "PK-00004",
            "date": "2015-05-28",
            "status": "delivered",
            "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-05-28",
            "delivery_days": "",
            "delivery_guarantee": false
        }
    ],
    "invoices": [
        {
            "invoice_id": "4815000000045091",
            "invoice_number": "INV-000001",
            "status": "paid",
            "date": "2015-05-29",
            "due_date": "2015-06-13",
            "total": 280.28,
            "balance": 0
        }
    ],
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "notes": "notes",
    "terms": "T&C",
    "template_id": "4815000000017003",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:37:00-1100",
    "last_modified_time": "2015-05-28T23:53:31-1100",
    "attachment_name": "sample.pdf",
    "can_send_in_mail": "true",
    "salesperson_id": "4815000000044762",
    "salesperson_name": "Lara"
}
{..},
{..}
]
}

Mark as Void

POST /salesorders/{salesorder_id}/status/void

Change status of the sales order to ** void**.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/salesorders/{salesorder_id}/status/void' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Packages

Zoho Inventory brings to you, the feature ‘Packages’ with which you can create and assign package slip numbers to the line items in your sales orders and keep track of your packages when they are shipped.

Example


{
  "salesorder_id": "4815000000044764",
  "salesorder_number": "SO-00001",
  "package_id": "4815000000044784",
  "package_number": "PK-00001",
  "shipment_id": "4815000000044824",
  "shipment_number": "SH-00001",
  "date": "2015-05-28",
  "shipping_date": "2015-05-28",
  "delivery_method": "FedEx",
  "delivery_method_id": "4815000000044822",
  "tracking_number": "TKG424242",
  "status": "shipped",
  "detailed_status": "shipped",
  "status_message": "Shipped.",
  "carrier": "FedEx",
  "service": "SMART_POST",
  "delivery_days": "1",
  "delivery_guarantee": "false",
  "total_quantity": 3,
  "customer_id": "4815000000044080",
  "customer_name": "Molly",
  "contact_persons": [
    "4815000000044080"
  ],
  "notes": "notes",
  "line_items": [
    {
      "line_item_id": "4815000000044786",
      "so_line_item_id": "4815000000044766",
      "item_id": "4815000000044104",
      "name": "Laptop-black/13 inch/dell",
      "description": "Laptop-black/13 inch/dell",
      "item_order": 0,
      "quantity": 3,
      "unit": "qty",
      "is_invoiced": false
    }
  ],
  "billing_address": {
    "address": "#234,90 Church Street",
    "city": "New York City",
    "state": "New York",
    "zip": "10048",
    "country": "U.S.A",
    "fax": "342-421234"
  },
  "shipping_address": {
    "address": "#432,Bayside,Queens",
    "city": "New York City",
    "state": "New York",
    "zip": "11364",
    "country": "U.S.A",
    "fax": "424-524242"
  },
  "template_id": "4815000000044031",
  "template_name": "Standard",
  "template_type": "standard",
  "created_time": "2015-05-28T23:15:53-1100",
  "last_modified_time": "2015-05-28T23:18:12-1100"
}

Attributes

salesorder_id
long
Unique ID generated by the server. This is used as identifier.
salesorder_number
required
Sales order number
package_id
long
Unique ID generated by the server. This is used as identifier.
package_number
required
Package number
shipment_id
long
Unique ID generated by the server. This is used as identifier.
shipment_number
string
Shipment number
date
string
Date of package
shipping_date
string
Shipment date
delivery_method
string
Delivery method of shipment
delivery_method_id
long
Unique ID generated by the server. This is used as identifier.
tracking_number
string
Tracking number of shipment
status
string
Status of package
detailed_status
string
Detailed status
status_message
string
Status message
carrier
string
Carrier used for shipment
service
string
Service of carrier used
delivery_days
string
Delivery days
delivery_guarantee
string
Delivery guarantee of package
total_quantity
double
Number of quantity packed
customer_id
long
Unique ID generated by the server. This is used as identifier.
customer_name
string
Customer name
contact_persons
Show Attributes
object
Array of contact person IDs
notes
string
Notes about package
line_items
Show Attributes
list
List of items in package. Each line item contains- line_item_id,so_line_item_id,item_id,name, description,item_order,quantity,unit and is_invoiced
is_emailed
boolean
To check, is package emailed or not
billing_address
Show Attributes
object
Customer’s billing address object. It contains address, city, state,zip,country and fax.
shipping_address
Show Attributes
list
Customer’s shipping address object. It contains address, city, state,zip,country and fax.
template_id
long
Unique ID generated by the server. This is used as identifier.
template_name
string
Template name of package
template_type
string
type of template
created_time
string
Time at which the package details were last created.
last_modified_time
string
Time at which the package details were last modified.

Create a package

POST /packages?salesorder_id={salesorder_id}

A new package can a be created.
To create package, URL parameter salesorder_id also needed.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/packages?salesorder_id={salesorder_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "package_number": "PK-00001",
    "date": "2015-05-28",
    "notes": "notes",
    "line_items": [
        {
            "so_line_item_id": "4815000000044766",
            "quantity": 3
        }
    ]
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The package has been created",
    "package":    {
    "salesorder_id": "4815000000044764",
    "salesorder_number": "SO-00001",
    "package_id": "4815000000044784",
    "package_number": "PK-00001",
    "shipment_id": "4815000000044824",
    "shipment_number": "SH-00001",
    "date": "2015-05-28",
    "shipping_date": "2015-05-28",
    "delivery_method": "FedEx",
    "delivery_method_id": "4815000000044822",
    "tracking_number": "TKG424242",
    "status": "shipped",
    "detailed_status": "shipped",
    "status_message": "Shipped.",
    "carrier": "FedEx",
    "service": "SMART_POST",
    "delivery_days": "1",
    "delivery_guarantee": "false",
    "total_quantity": 3,
    "customer_id": "4815000000044080",
    "customer_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "notes": "notes",
    "line_items": [
        {
            "line_item_id": "4815000000044786",
            "so_line_item_id": "4815000000044766",
            "item_id": "4815000000044104",
            "name": "Laptop-black/13 inch/dell",
            "description": "Laptop-black/13 inch/dell",
            "item_order": 0,
            "quantity": 3,
            "unit": "qty",
            "is_invoiced": false
        }
    ],
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "template_id": "4815000000044031",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:15:53-1100",
    "last_modified_time": "2015-05-28T23:18:12-1100"
}
}

Arguments

package_number
optional
Package number
date
optional
Date of package
notes
optional
Notes about package
line_items
Show Attributes
required
List of items in package. Each line item contains- so_line_item_id and quantity

Retrieve a package

GET /packages/{package_id}

Details for an existing package.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/packages/{package_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "package":    {
    "salesorder_id": "4815000000044764",
    "salesorder_number": "SO-00001",
    "package_id": "4815000000044784",
    "package_number": "PK-00001",
    "shipment_id": "4815000000044824",
    "shipment_number": "SH-00001",
    "date": "2015-05-28",
    "shipping_date": "2015-05-28",
    "delivery_method": "FedEx",
    "delivery_method_id": "4815000000044822",
    "tracking_number": "TKG424242",
    "status": "shipped",
    "detailed_status": "shipped",
    "status_message": "Shipped.",
    "carrier": "FedEx",
    "service": "SMART_POST",
    "delivery_days": "1",
    "delivery_guarantee": "false",
    "total_quantity": 3,
    "customer_id": "4815000000044080",
    "customer_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "notes": "notes",
    "line_items": [
        {
            "line_item_id": "4815000000044786",
            "so_line_item_id": "4815000000044766",
            "item_id": "4815000000044104",
            "name": "Laptop-black/13 inch/dell",
            "description": "Laptop-black/13 inch/dell",
            "item_order": 0,
            "quantity": 3,
            "unit": "qty",
            "is_invoiced": false
        }
    ],
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "template_id": "4815000000044031",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:15:53-1100",
    "last_modified_time": "2015-05-28T23:18:12-1100"
}
}

Update an package

PUT /packages/{package_id}

Update details of an existing package.

Request Example

$ curl -X PUT 'https://inventory.zoho.com/api/v1/packages/{package_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "package_number": "PK-00001",
    "date": "2015-05-28",
    "notes": "notes",
    "line_items": [
        {
            "so_line_item_id": "4815000000044766",
            "quantity": 3
        }
    ]
}

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The package details have been updated.",
    "package":    {
    "salesorder_id": "4815000000044764",
    "salesorder_number": "SO-00001",
    "package_id": "4815000000044784",
    "package_number": "PK-00001",
    "shipment_id": "4815000000044824",
    "shipment_number": "SH-00001",
    "date": "2015-05-28",
    "shipping_date": "2015-05-28",
    "delivery_method": "FedEx",
    "delivery_method_id": "4815000000044822",
    "tracking_number": "TKG424242",
    "status": "shipped",
    "detailed_status": "shipped",
    "status_message": "Shipped.",
    "carrier": "FedEx",
    "service": "SMART_POST",
    "delivery_days": "1",
    "delivery_guarantee": "false",
    "total_quantity": 3,
    "customer_id": "4815000000044080",
    "customer_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "notes": "notes",
    "line_items": [
        {
            "line_item_id": "4815000000044786",
            "so_line_item_id": "4815000000044766",
            "item_id": "4815000000044104",
            "name": "Laptop-black/13 inch/dell",
            "description": "Laptop-black/13 inch/dell",
            "item_order": 0,
            "quantity": 3,
            "unit": "qty",
            "is_invoiced": false
        }
    ],
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "template_id": "4815000000044031",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:15:53-1100",
    "last_modified_time": "2015-05-28T23:18:12-1100"
}
}

Arguments

package_number
optional
Package number
date
optional
Date of package
notes
optional
Notes about package
line_items
Show Attributes
required
List of items in package. Each line item contains- so_line_item_id and quantity

Delete an package

DELETE /packages/{package_id}

Delete an existing package.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/packages/{package_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

List all package

GET /packages

List of all package.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/packages ' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "packages":
    [
    {
    "salesorder_id": "4815000000044764",
    "salesorder_number": "SO-00001",
    "package_id": "4815000000044784",
    "package_number": "PK-00001",
    "shipment_id": "4815000000044824",
    "shipment_number": "SH-00001",
    "date": "2015-05-28",
    "shipping_date": "2015-05-28",
    "delivery_method": "FedEx",
    "delivery_method_id": "4815000000044822",
    "tracking_number": "TKG424242",
    "status": "shipped",
    "detailed_status": "shipped",
    "status_message": "Shipped.",
    "carrier": "FedEx",
    "service": "SMART_POST",
    "delivery_days": "1",
    "delivery_guarantee": "false",
    "total_quantity": 3,
    "customer_id": "4815000000044080",
    "customer_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "notes": "notes",
    "line_items": [
        {
            "line_item_id": "4815000000044786",
            "so_line_item_id": "4815000000044766",
            "item_id": "4815000000044104",
            "name": "Laptop-black/13 inch/dell",
            "description": "Laptop-black/13 inch/dell",
            "item_order": 0,
            "quantity": 3,
            "unit": "qty",
            "is_invoiced": false
        }
    ],
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "template_id": "4815000000044031",
    "template_name": "Standard",
    "template_type": "standard",
    "created_time": "2015-05-28T23:15:53-1100",
    "last_modified_time": "2015-05-28T23:18:12-1100"
}
{..},
{..}
]
}

Shipment Orders

A document used by an organization to specify what items or packages are to be transferred from a storage location or warehouse to what person and to what new location is called a shipment order. It is typically sent along with a shipment of goods so that the person receiving them(your customer) can verify that the document correctly reflects the items that they actually received.

Example


{
  "salesorder_id": "4815000000044764",
  "salesorder_number": "SO-00001",
  "shipment_id": "4815000000044824",
  "shipment_number": "SH-00001",
  "date": "2015-05-28",
  "status": "shipped",
  "detailed_status": "shipped",
  "status_message": "Shipped.",
  "carrier": "FedEx",
  "service": "SMART_POST",
  "delivery_days": "1",
  "delivery_guarantee": "false",
  "reference_number": "TKG424242",
  "customer_id": "4815000000044080",
  "customer_name": "Molly",
  "contact_persons": [
    "4815000000044080"
  ],
  "currency_id": "4815000000000097",
  "currency_code": "USD",
  "currency_symbol": "$",
  "exchange_rate": 1,
  "discount_amount": 0,
  "discount": 0,
  "is_discount_before_tax": true,
  "discount_type": "entity_level",
  "estimate_id": "4815000000045091",
  "delivery_method": "FedEx",
  "delivery_method_id": "4815000000044822",
  "tracking_number": "TKG424242",
  "line_items": [
    {
      "line_item_id": "4815000000044786",
      "item_id": "4815000000044104",
      "name": "Laptop-black/13 inch/dell",
      "description": "Laptop-black/13 inch/dell",
      "item_order": 0,
      "bcy_rate": 90,
      "rate": 90,
      "quantity": 3,
      "unit": "qty",
      "tax_id": "4815000000044043",
      "tax_name": "Sales Tax",
      "tax_type": "tax",
      "tax_percentage": 12,
      "item_total": 270,
      "is_invoiced": false
    }
  ],
  "shipping_charge": 10,
  "sub_total": 1060,
  "tax_total": 126,
  "total": 1200,
  "taxes": [
    {
      "tax_name": "Sales Tax (12%)",
      "tax_amount": 29.28
    }
  ],
  "price_precision": "2",
  "billing_address": {
    "address": "#234,90 Church Street",
    "city": "New York City",
    "state": "New York",
    "zip": "10048",
    "country": "U.S.A",
    "fax": "342-421234"
  },
  "shipping_address": {
    "address": "#432,Bayside,Queens",
    "city": "New York City",
    "state": "New York",
    "zip": "11364",
    "country": "U.S.A",
    "fax": "424-524242"
  },
  "template_id": "4815000000044033",
  "template_name": "Standard Template",
  "template_type": "standard",
  "notes": "notes",
  "created_time": "2015-05-28T23:18:12-1100",
  "last_modified_time": "2015-05-28T23:18:12-1100"
}

Attributes

salesorder_id
long
Unique ID generated by the server. This is used as identifier.
salesorder_number
required
Sales order number
shipment_id
long
shipment ID.
shipment_number
string
Shipment number
date
string
Date of package
status
string
Status of package
detailed_status
string
Detailed status
status_message
string
Status message
carrier
string
Carrier used for shipment
service
string
Service of carrier used
delivery_days
string
Delivery days
delivery_guarantee
string
Delivery guarantee of package
reference_number
string
Tracking number of shipment
customer_id
long
Customer ID.
customer_name
string
Customer name
contact_persons
Show Attributes
object
Array of contact person IDs
currency_id
long
Currency ID.
currency_code
string
Currency Code
currency_symbol
string
Symbol of currency
exchange_rate
double
Exchange rate of currency respect to base currency
discount_amount
double
Discount amount
discount
double
Discount
is_discount_before_tax
boolean
To check, discount on sales order before tax or after tax
discount_type
string
Type of discount
estimate_id
long
Estimate ID.
delivery_method
string
Delivery method
delivery_method_id
long
Delivery method ID.
tracking_number
string
Tracking number of shipment
line_items
Show Attributes
list
List of items in package. Each line item contains- line_item_id,item_id,name, description,code>item_order,bcy_rate,rate,<quantity,unit,tax_id,tax_name, tax_type,tax_percentage,item_total and is_invoiced
shipping_charge
double
Shipping charges
sub_total
double
Sub total of salesorder
tax_total
double
Tax total of salesorder
total
double
Total amount of sales order
list
Number of taxes applied on sales order. Each tax contains: tax_name and tax_amount
price_precision
string
price precision
is_emailed
boolean
To check, is package emailed or not
billing_address
Show Attributes
list
Customer’s billing address object. It contains address, city, state,zip,country and fax.
shipping_address
Show Attributes
list
Customer’s shipping address object. It contains address, city, state,zip,country and fax.
template_id
long
template ID used for shipments.
template_name
string
Template name of package
template_type
string
type of template
notes
string
Notes about package
created_time
string
Time at which the shipment details were last created.
last_modified_time
string
Time at which the shipment details were last modified.

Create a shipment order

POST /shipmentorders?package_ids={package_ids}&salesorder_id={salesorder_id}

A new shipment order can a be created.
To create shipment, URL parameter package_ids and salesorder_id are needed.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/shipmentorders?package_ids={package_ids}&salesorder_id={salesorder_id} ' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "shipment_number": "SH-00001",
    "date": "2015-05-28",
    "reference_number": "TKG424242",
    "contact_persons": [
        "4815000000044080"
    ],
    "delivery_method": "FedEx",
    "tracking_number": "TKG424242",
    "shipping_charge": 10,
    "template_id": "4815000000044033",
    "notes": "notes"
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The shipment order has been created",
    "shipment_order":    {
    "salesorder_id": "4815000000044764",
    "salesorder_number": "SO-00001",
    "shipment_id": "4815000000044824",
    "shipment_number": "SH-00001",
    "date": "2015-05-28",
    "status": "shipped",
    "detailed_status": "shipped",
    "status_message": "Shipped.",
    "carrier": "FedEx",
    "service": "SMART_POST",
    "delivery_days": "1",
    "delivery_guarantee": "false",
    "reference_number": "TKG424242",
    "customer_id": "4815000000044080",
    "customer_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "discount_amount": 0,
    "discount": 0,
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "estimate_id": "4815000000045091",
    "delivery_method": "FedEx",
    "delivery_method_id": "4815000000044822",
    "tracking_number": "TKG424242",
    "line_items": [
        {
            "line_item_id": "4815000000044786",
            "item_id": "4815000000044104",
            "name": "Laptop-black/13 inch/dell",
            "description": "Laptop-black/13 inch/dell",
            "item_order": 0,
            "bcy_rate": 90,
            "rate": 90,
            "quantity": 3,
            "unit": "qty",
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 270,
            "is_invoiced": false
        }
    ],
    "shipping_charge": 10,
    "sub_total": 1060,
    "tax_total": 126,
    "total": 1200,
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 29.28
        }
    ],
    "price_precision": "2",
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "template_id": "4815000000044033",
    "template_name": "Standard Template",
    "template_type": "standard",
    "notes": "notes",
    "created_time": "2015-05-28T23:18:12-1100",
    "last_modified_time": "2015-05-28T23:18:12-1100"
}
}

Arguments

shipment_number
required
Shipment number
date
required
Date of package
reference_number
optional
Tracking number of shipment
contact_persons
Show Attributes
optional
Array of contact person IDs
delivery_method
required
Delivery method
tracking_number
required
Tracking number of shipment
shipping_charge
optional
Shipping charges
template_id
optional
template ID used for shipments.
notes
optional
Notes about package

Retrieve a shipment order

GET /shipmentorders/{shipmentorder_id}

Details for an existing shipment order.

Request Example

$ curl -G 'https://inventory.zoho.com/api/v1/shipmentorders/{shipmentorder_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "success",
    "shipment_order":    {
    "salesorder_id": "4815000000044764",
    "salesorder_number": "SO-00001",
    "shipment_id": "4815000000044824",
    "shipment_number": "SH-00001",
    "date": "2015-05-28",
    "status": "shipped",
    "detailed_status": "shipped",
    "status_message": "Shipped.",
    "carrier": "FedEx",
    "service": "SMART_POST",
    "delivery_days": "1",
    "delivery_guarantee": "false",
    "reference_number": "TKG424242",
    "customer_id": "4815000000044080",
    "customer_name": "Molly",
    "contact_persons": [
        "4815000000044080"
    ],
    "currency_id": "4815000000000097",
    "currency_code": "USD",
    "currency_symbol": "$",
    "exchange_rate": 1,
    "discount_amount": 0,
    "discount": 0,
    "is_discount_before_tax": true,
    "discount_type": "entity_level",
    "estimate_id": "4815000000045091",
    "delivery_method": "FedEx",
    "delivery_method_id": "4815000000044822",
    "tracking_number": "TKG424242",
    "line_items": [
        {
            "line_item_id": "4815000000044786",
            "item_id": "4815000000044104",
            "name": "Laptop-black/13 inch/dell",
            "description": "Laptop-black/13 inch/dell",
            "item_order": 0,
            "bcy_rate": 90,
            "rate": 90,
            "quantity": 3,
            "unit": "qty",
            "tax_id": "4815000000044043",
            "tax_name": "Sales Tax",
            "tax_type": "tax",
            "tax_percentage": 12,
            "item_total": 270,
            "is_invoiced": false
        }
    ],
    "shipping_charge": 10,
    "sub_total": 1060,
    "tax_total": 126,
    "total": 1200,
    "taxes": [
        {
            "tax_name": "Sales Tax (12%)",
            "tax_amount": 29.28
        }
    ],
    "price_precision": "2",
    "billing_address": {
        "address": "#234,90 Church Street",
        "city": "New York City",
        "state": "New York",
        "zip": "10048",
        "country": "U.S.A",
        "fax": "342-421234"
    },
    "shipping_address": {
        "address": "#432,Bayside,Queens",
        "city": "New York City",
        "state": "New York",
        "zip": "11364",
        "country": "U.S.A",
        "fax": "424-524242"
    },
    "template_id": "4815000000044033",
    "template_name": "Standard Template",
    "template_type": "standard",
    "notes": "notes",
    "created_time": "2015-05-28T23:18:12-1100",
    "last_modified_time": "2015-05-28T23:18:12-1100"
}
}

Delete an shipment order

DELETE /shipmentorders/{shipmentorder_id}

Delete an existing shipment order.

Request Example

$ curl -X DELETE 'https://inventory.zoho.com/api/v1/shipmentorders/{shipmentorder_id}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Mark as Delivered

POST /shipmentorders/{shipmentorder_id}/status/delivered

Change status of the shipment order to ** delivered**.

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/shipmentorders/{shipmentorder_id}/status/delivered' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80 

Response Example

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

Invoices

Invoice is a document sent to your client that indicates the products/services sold by you with the payment information that the client has to make.

Example


{
  "invoice_id": "4815000000045091",
  "invoice_number": "INV-000001",
  "salesorder_id": "4815000000044895",
  "salesorder_number": "SO-00003",
  "date": "2015-05-29",
  "status": "paid",
  "payment_terms": 15,
  "payment_terms_label": "Net 15",
  "due_date": "2015-06-13",
  "payment_expected_date": "2015-05-29",
  "last_payment_date": "2015-05-29",
  "reference_number": "SO-00003",
  "customer_id": "4815000000044080",
  "customer_name": "Molly Corporation",
  "contact_persons": [
    "4815000000044082"
  ],
  "currency_id": "4815000000000097",
  "currency_code": "USD",
  "currency_symbol": "$",
  "exchange_rate": 1,
  "discount_amount": 0,
  "discount": 0,
  "is_discount_before_tax": true,
  "discount_type": "entity_level",
  "line_items": [
    {
      "line_item_id": "4815000000045105",
      "item_id": "4815000000044100",
      "salesorder_item_id": "4815000000044897",
      "name": "Laptop-white/15inch/dell",
      "description": "laptop description",
      "item_order": 0,
      "bcy_rate": 122.0,
      "rate": 122.0,
      "quantity": 2.0,
      "unit": "qty",
      "discount": 0.0,
      "tax_id": "4815000000044043",
      "tax_name": "Sales Tax",
      "tax_type": "tax",
      "tax_percentage": 12,
      "item_total": 244.0
    }
  ],
  "shipping_charge": 7,
  "adjustment": 0,
  "adjustment_description": "Adjustment",
  "sub_total": 244,
  "tax_total": 29,
  "total": 280,
  "taxes": [
    {
      "tax_name": "Sales Tax (12%)",
      "tax_amount": 29.28
    }
  ],
  "payment_reminder_enabled": true,
  "payment_made": 280,
  "credits_applied": 0,
  "tax_amount_withheld": 0,
  "balance": 0,
  "write_off_amount": 0,
  "price_precision": 2,
  "payment_options": {
    "payment_gateways": [
      {
        "configured": true,
        "is_bank_account_applicable": true,
        "gateway_name": "authorize_net"
      },
      {
        "configured": true,
        "is_bank_account_applicable": true,
        "gateway_name": "2checkout"
      }
    ]
  },
  "reminders_sent": 0,
  "shipping_address": {
    "address": "#432,Bayside,Queens",
    "city": "New York City",
    "state": "New York",
    "zip": "11364",
    "country": "U.S.A",
    "fax": "424-524242"
  },
  "billing_address": {
    "address": "#234,90 Church Street",
    "city": "New York City",
    "state": "New York",
    "zip": "10048",
    "country": "U.S.A",
    "fax": "342-421234"
  },
  "notes": "Thanks for your business.",
  "terms": "Terms",
  "template_id": "4815000000015001",
  "template_name": "Standard Template",
  "template_type": "standard",
  "created_time": "2015-05-28T23:53:31-1100",
  "can_send_in_mail": true,
  "salesperson_id": "4815000000044762",
  "salesperson_name": "Lara",
  "invoice_url": "https://inventory.localzoho.com/portal/docsapi/secure?CInvoiceID=2-54134ecf8e3fb7e8ea12727e3b6a2460dd00c853cbcfced256dcf147e8590f083542442ebc9036ba37c43781adbaddab636280e0f950de09"
}

Attributes

invoice_id
long
Invoice ID
invoice_number
string
Invoice number
salesorder_id
long
Sales Order ID
salesorder_number
string
Sales Order Number
date
string
Date of Invoice
status
string
Status of Invoice
payment_terms
integer
Payment Term for the Invoice
payment_terms_label
string
Payment term label
due_date
string
Due date for Invoice
payment_expected_date
string
Expected date for Invoice
stop_reminder_until_payment_expected_date
boolean
Stop reminder until payment expected date option, can be True or False
last_payment_date
string
Last payment date for Invoice
reference_number
string
Reference Number of Invoice
customer_id
long
Customer ID for Invoice
customer_name
string
Name of Customer
contact_persons
Show Attributes
object
Array of Contact Person IDs(comma seperated) for Customer
currency_id
long
Currency ID
currency_code
string
Currency Code
currency_symbol
string
Currency Symbol
exchange_rate
double
Exchange Rate
discount_amount
double
Discount Amount
discount
double
Discount applied
is_discount_before_tax
boolean
Is discount before tax option
discount_type
string
Type of discount : can be Entity level or Item level
is_viewed_by_client
boolean
Check for invoice is viewed by client or not
client_viewed_time
string
Times of view
is_inclusive_tax
boolean
Is tax inclusive option include tax item level, if true
line_items
Show Attributes
list
Invoice contains multiple line items. Each item contains- line_item_id,item_id,salesorder_item_id,name, description , item_order,bcy_rate,rate,quantity,unit,discount,tax_id,tax_name, tax_type,tax_percentage,item_total
shipping_charge
double
Shipping charges
adjustment
double
Adjustment applied on invoice
adjustment_description
string
Description for adjustment
sub_total
double
Sub total of invoice
tax_total
double
Tax total of invoice
total
double
Total of invoice
list
Number of taxes applied on sales order. Each tax contains: tax_name and tax_amount
payment_reminder_enabled
boolean
To check payment reminder enabled
payment_made
double
Payment Made
credits_applied
double
Credit applied on invoice
tax_amount_withheld
double
Tax amount withheld
balance
double
Balance of invoice Left
write_off_amount
double
Write off amount
allow_partial_payments
boolean
To check,allow partial payments or not
price_precision
integer
Price precision
payment_options
Show Attributes
object
Payment Options for Invoice,having following node - configured,is_bank_account_applicable,gateway_name
is_emailed
boolean
To check , invoice is emailed or not
reminders_sent
integer
Total number of reminders sent
last_reminder_sent_date
string
Last reminders sent date
shipping_address
Show Attributes
list
Customer’s shipping address object. It contains address, city, state,zip,country and fax.
billing_address
Show Attributes
list
Customer’s billing address object. It contains address, city, state,zip,country and fax.
notes
string
Notes
terms
string
Terms and Conditions
template_id
long
template ID
template_name
string
Name of template
template_type
string
Type of template
created_time
string
Time at which the invoice details were last created.
last_modified_time
string
Time at which the invoice details were last modified.
attachment_name
string
attachment name
can_send_in_mail
boolean
for check, attachment can send in mail or not
salesperson_id
long
Unique ID generated by the server. This is used as identifier.
salesperson_name
string
Name of Sales person
is_autobill_enabled
boolean
To check, is auto bill enabled or not
invoice_url
string
Invoice URL

Create a invoice

POST /invoices?send={boolean}&ignore_auto_number_generation={boolean}

A new invoice can a be created.

Discription about extra parameter :
send : Send the invoice to the contact person(s) associated with the invoice.
Allowed Values: true and false

ignore_auto_number_generation : Ignore auto invoice number generation for this invoice. This mandates the invoice number.
Allowed Values: true and false

Request Example

$ curl -X POST 'https://inventory.zoho.com/api/v1/invoices?send={boolean}&ignore_auto_number_generation={boolean}' \
    -d organization_id=11352208 \
    -d authtoken=6e80ed905055deb9fd2d12d71f518a80  \
    -d JSONString= {
    "invoice_number": "INV-000001",
    "salesorder_id": "4815000000044895",
    "date": "2015-05-29",
    "payment_terms": 15,
    "payment_terms_label": "Net 15",
    "due_date": "2015-06-13",
    "customer_id": "4815000000044080",
    "contact_persons": [
        "4815000000044082"
    ],
    "exchange_rate": 1,
    "discount": 0,
    "discount_type": "entity_level",
    "shipping_charge": 7,
    "adjustment": 0,
    "adjustment_description": "Adjustment",
    "notes": "Thanks for your business.",
    "terms": "Terms",
    "template_id": "4815000000015001",
    "salesperson_name": "Lara",
    "line_items": [
        {
            "item_id": "4815000000044100",
            "salesorder_item_id": "4815000000044897",
            "description": "laptop description",
            "item_order": 0,
            "rate": 122.0,
            "quantity": 2.0,
            "unit": "qty",
            "discount": 0.0,
            "tax_id": "4815000000044043"
        }
    ],
    "payment_options": {
        "payment_gateways": [
            {
                "gateway_name": "authorize_net"
            },
            {
                "gateway_name": "2checkout"
            }
        ]
    }
}

Response Example

HTTP/1.1 201 Created
Content-Type:application/json;charset=UTF-8
{
    "code": 0,
    "message": "The invoice has been created",
    "invoice"