Zoho Inventory API

https://www.zoho.com/inventory/api/v1
Admin
The Zoho Inventory API provides a RESTful interface to programmatically perform all operations...
Tokens:1,400,728
Snippets:8,807
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### Start stock count - Response example

Source: https://www.zoho.com/inventory/api/v1/inventorycounting/

Example JSON response for a successful start stock count request. Shows the stock count details including line items and status.

```json
{ "code": 0, "message": "Stock count has been saved.", "inventorycount": { "inventorycount_id": "4815000000044100", "inventorycount_number": "IC-00001", "count_date": "2025-06-15", "description": "Monthly stock take for warehouse A.", "status": "yet_to_start", "count_type": "count", "location_id": "4815000000038080", "location_name": "Main Warehouse", "assignee_id": "4815000000012345", "assignee_name": "John Smith", "line_items": [ { "line_item_id": "4815000000044897", "item_id": "4815000000033001", "item_name": "Laptop 15-inch", "item_order": 1, "sku": "LAP-15-WHT", "unit": "pcs", "system_quantity": 50, "counted_quantity": 48, "stock_variance": -2, "track_serial_number": false, "track_batch_number": true, "is_matched": false, "has_tracking_details_mismatch": false, "status": "draft", "reason_id": "4815000000000388" } ] } }
```

--------------------------------

### Python Request Example

Source: https://www.zoho.com/inventory/api/v1/vendor-credits/

Python example using http.client to send a GET request and print the response body.

```python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/vendorcredits/3000000002075/refunds/3000000003151?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### Response Example for Get Putaway Settings

Source: https://www.zoho.com/inventory/api/v1/putaways/

Example JSON response with HTTP 200 OK, containing putaway_settings with auto_generate, prefix_string, and next_number.

```json
{ "code": 0, "message": "string", "putaway_settings": { "auto_generate": true, "prefix_string": "string", "next_number": "string" } }
```

--------------------------------

### Get all options for a reporting tag - Response Example

Source: https://www.zoho.com/inventory/api/v1/reporting-tags/

Example JSON response for a successful request (200 OK). Shows option_id, option_name, and depth fields, including an 'untagged' option when show_untagged is true.

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

--------------------------------

### List tasks request example in Java

Source: https://www.zoho.com/inventory/api/v1/tasks/

Java code using OkHttpClient to send a GET request to the tasks endpoint.

```java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/tasks?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

--------------------------------

### Retrieve batch with Java (OkHttp)

Source: https://www.zoho.com/inventory/api/v1/batches/

Java example using OkHttpClient to send a GET request to the batch endpoint.

```java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/items/batches/6780203000000176162?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

--------------------------------

### Retrieve batch with Python (http.client)

Source: https://www.zoho.com/inventory/api/v1/batches/

Python example using http.client to send a GET request and print the response.

```python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/items/batches/6780203000000176162?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### List currencies with Python (http.client)

Source: https://www.zoho.com/inventory/api/v1/currency/

Python example using http.client to send a GET request. Prints the response body.

```python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/settings/currencies?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### Create Picklist - Python

Source: https://www.zoho.com/inventory/api/v1/picklists/

Python example using http.client to POST a picklist request.

```python
import http.client
conn = http.client.HTTPSConnection("www.zohoapis.com")
payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}"
headers = {
  'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f",
  'content-type': "application/json"
}
conn.request("POST", "/inventory/v1/picklists?organization_id=10234695", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
```

--------------------------------

### Response Example 200 OK

Source: https://www.zoho.com/inventory/api/v1/storagelocations/

Sample successful response with storage location mappings.

```json
{ "code": 0, "message": "success", "storage_locations_product_mapping": [ { "product_id": "130426000000056001", "storage_id": "130426000000801001", "location_id": "130426000000054001" }, {...}, {...} ] }
```

--------------------------------

### Response example for downloading move order document

Source: https://www.zoho.com/inventory/api/v1/moveorders/

Shows the binary body returned on success (200 OK).

```text
"<< binary body >>"
```

--------------------------------

### Get a Zone - Python Request

Source: https://www.zoho.com/inventory/api/v1/storagelocations/

Python example using http.client to send a GET request. Prints the decoded response.

```Python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/storagezones/130426000000798001?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### List tasks request example in Python

Source: https://www.zoho.com/inventory/api/v1/tasks/

Python http.client example to list tasks.

```python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/tasks?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### Get invoice attachment - JavaScript (fetch)

Source: https://www.zoho.com/inventory/api/v1/invoices/

JavaScript example using fetch to GET the invoice attachment and log the response.

```javascript
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/invoices/982000000567114/attachment?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

--------------------------------

### List tasks request example in JavaScript

Source: https://www.zoho.com/inventory/api/v1/tasks/

JavaScript fetch example to list tasks with authorization header.

```javascript
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/tasks?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

--------------------------------

### Get Invoice Email Content - Python

Source: https://www.zoho.com/inventory/api/v1/invoices/

Python example using http.client to send a GET request and print the response.

```python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/invoices/982000000567114/email?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### Response Example: Get Organizations

Source: https://www.zoho.com/inventory/api/v1/introduction/

JSON response from the GET /organizations API, showing the organization details including organization_id.

```json
{ "code": 0, "message": "success", "organizations": [ { "organization_id": "10234695", "name": "Zillum", "contact_name": "John Smith", "email": "johnsmith@zillum.com", "is_default_org": false, "language_code": "en", "fiscal_year_start_month": 0, "account_created_date": "2016-02-18", "time_zone": "PST", "is_org_active": true, "currency_id": "460000000000097", "currency_code": "USD", "currency_symbol": "$", "currency_format": "###,##0.00", "price_precision": 2 }, {...}, {...} ] }
```

--------------------------------

### Response Example: 200 OK

Source: https://www.zoho.com/inventory/api/v1/replenishment/

Sample successful response with replenishment configuration details for associated locations.

```json
{ "code": 0, "message": "Replenishment details fetched successfully.", "replenishment_configurations": { "item_id": 4815000000044208, "name": "HDMI Cable", "sku": "HDMI-001", "vendor_id": 4815000000009901, "vendor_name": "Zylker Supplies", "locations": [ { "location_id": 4815000000033001, "location_name": "New York", "replenishment_configuration": { "replenishment_configuration_id": 4815000000045001, "item_id": 4815000000044208, "item_name": "HDMI Cable", "unit": "pcs", "item_status": "active", "location_id": 4815000000033001, "location_name": "New York", "location_status": "active", "status": "active", "pause_till_date": "2026-05-01", "type": "auto", "order_type": "purchase_order", "trigger": "daily", "trigger_frequency": "1", "trigger_frequency_period": "day", "reorder_level": 10, "max_stock_level": 50, "order_multiple": 5, "max_order_quantity": 200, "min_order_quantity": 1, "preferred_vendor_id": 4815000000009901, "preferred_vendor_name": "Zylker Supplies", "preferred_vendor_status": "active", "preferred_location_id": 4815000000034001, "preferred_location_name": "Los Angeles", "preferred_location_status": "active" } } ] } }
```

--------------------------------

### Node.js Request Example

Source: https://www.zoho.com/inventory/api/v1/vendor-credits/

Node.js example using the https module to make a GET request to the vendor credit refund endpoint.

```javascript
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/vendorcredits/3000000002075/refunds/3000000003151?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
```

--------------------------------

### Enable bin locations - Success response

Source: https://www.zoho.com/inventory/api/v1/storagelocations/

Example 200 OK response indicating bin locations have been enabled.

```json
{ "code": 0, "message": "The bin locations have been enabled." }
```

--------------------------------

### Response Example (200 OK)

Source: https://www.zoho.com/inventory/api/v1/customer-payments/

Sample JSON response for a successful request, showing customer payment details.

```json
{ "code": 0, "message": "success", "customerpayments": [ { "payment_id": "9030000079467", "payment_number": "2", "invoice_number": "INV-384", "date": "2016-06-05", "payment_mode": "cash", "amount": 450, "bcy_amount": 450, "unused_amount": 0, "account_id": "450000000000353", "account_name": "Petty Cash", "description": "Payment has been added to INV-384", "reference_number": "INV-384", "customer_id": "903000000000099", "customer_name": "Bowman Furniture", "location_id": "460000000038080", "location_name": "string" }, {...}, {...} ] }
```

--------------------------------

### Get a Zone - Node.js Request

Source: https://www.zoho.com/inventory/api/v1/storagelocations/

Node.js example using the https module to make a GET request. Prints the response body.

```Node.js
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/storagezones/130426000000798001?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
```

--------------------------------

### Response example for listing storage details (200 OK)

Source: https://www.zoho.com/inventory/api/v1/inventorycounting/

Sample JSON response for a successful request. Contains storage details including system_quantity, counted_quantity, stock_variance, and tracking details. The page_context shows pagination information.

```json
{ "code": 0, "message": "success", "storages": [ { "line_item_id": "4815000000044897", "storage_id": "4815000000050010", "storage_name": "Rack A - Shelf 2", "system_quantity": 50, "counted_quantity": 48, "stock_variance": -2, "is_matched": false, "has_tracking_details_mismatch": false, "total_counted_serials": 48, "total_counted_batches": 3 }, {...}, {...} ], "page_context": { "page": 1, "per_page": 200, "has_more_page": false, "sort_column": "created_time", "sort_order": "D", "applied_filter": "Status.All" } }
```

--------------------------------

### Get all options for a reporting tag - Python

Source: https://www.zoho.com/inventory/api/v1/reporting-tags/

Python http.client example to GET reporting tag options. Prints the response body.

```python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/reportingtags/(/d+)/options/all?organization_id=10234695&tag_id=460000000038080", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### Java (OkHttp) Request to List Purchase Returns

Source: https://www.zoho.com/inventory/api/v1/purchase-returns/

Java example using OkHttpClient to send a GET request. Requires the OkHttp library and OAuth token.

```java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/purchasereturns?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

--------------------------------

### Get invoice attachment - Node.js (https)

Source: https://www.zoho.com/inventory/api/v1/invoices/

Node.js example using the https module to make a GET request for the invoice attachment.

```javascript
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/invoices/982000000567114/attachment?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
```

--------------------------------

### Get a credit note - Python request

Source: https://www.zoho.com/inventory/api/v1/credit-notes/

Python example using http.client to send a GET request. Prints the response body.

```python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/creditnotes/90300000072369?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### Response Example (200 - OK)

Source: https://www.zoho.com/inventory/api/v1/picklists/

Sample response for a successful update, showing code 0 and a message.

```json
{
  "code": 0,
  "message": "The picklist has been deleted."
}
```

--------------------------------

### Response Example (200 OK)

Source: https://www.zoho.com/inventory/api/v1/inventorycounting/

Successful response example showing the updated preferences and a success message.

```json
{
  "code": 0,
  "message": "Stock counts preferences updated successfully.",
  "preferences": {
    "default_reason_id": "4815000000000388",
    "default_adjustment_account": "4815000000000400"
  }
}
```

--------------------------------

### Response Example for List Users (200 OK)

Source: https://www.zoho.com/inventory/api/v1/users/

Sample JSON response for a successful List Users request. Contains user details such as user_id, name, email, role, and status.

```json
{ "code": 0, "message": "success", "users": [ { "user_id": "982000000554041", "role_id": "982000000006005", "name": "David John", "email": "johndavid@zilliuminc.com", "user_role": "admin", "user_type": "zoho", "status": "active", "is_current_user": true, "photo_url": "https://contacts.zoho.com/file?ID=d27344a22bad8bb83a03722b4aa5bc6967c3135f24307fe40db8572782432fd6aae0110f8bb9c4c79e8e0f0cca5904aecfacbf079f13b48c295bacc89ae91fca&fs=thumb" }, {...}, {...} ] }
```

--------------------------------

### Get retainer invoice email content - Node.js

Source: https://www.zoho.com/inventory/api/v1/retainer-invoices/

Node.js example using the https module to GET the retainer invoice email content.

```javascript
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/retainerinvoices/982000000567114/email?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
```

--------------------------------

### Create Package - Java Request Example

Source: https://www.zoho.com/inventory/api/v1/packages/

Java code using OkHttpClient to create a package. Requires organization_id and salesorder_id query parameters. Uses OAuth token in Authorization header.

```java
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}");
Request request = new Request.Builder()
  .url("https://www.zohoapis.com/inventory/v1/packages?organization_id=10234695&salesorder_id=504366000000062000")
  .post(body)
  .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f")
  .addHeader("content-type", "application/json")
  .build();
Response response = client.newCall(request).execute();
```

--------------------------------

### Get invoice attachment - Python (http.client)

Source: https://www.zoho.com/inventory/api/v1/invoices/

Python example using http.client to send a GET request for the invoice attachment and print the response.

```python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/invoices/982000000567114/attachment?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### Get a credit note - Node.js request

Source: https://www.zoho.com/inventory/api/v1/credit-notes/

Node.js example using the https module to send a GET request. Prints the response body.

```javascript
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/creditnotes/90300000072369?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
```

--------------------------------

### Response example for search storage locations

Source: https://www.zoho.com/inventory/api/v1/inventorycounting/

Sample 200 OK response showing storage location details including system quantity, counted quantity, stock variance, and page context.

```json
{ "code": 0, "message": "success", "storage_locations": [ { "storage_location_id": "4815000000050010", "storage_location_name": "Rack A - Shelf 2", "system_quantity": 50, "counted_quantity": 48, "stock_variance": -2, "no_of_items": 5, "no_of_items_counted": 3 }, {...}, {...} ], "page_context": { "page": 1, "per_page": 200, "has_more_page": false, "sort_column": "created_time", "sort_order": "D", "applied_filter": "Status.All" } }
```

--------------------------------

### Get retainer invoice email content - Python

Source: https://www.zoho.com/inventory/api/v1/retainer-invoices/

Python example using http.client to GET the retainer invoice email content and print the response.

```python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/retainerinvoices/982000000567114/email?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### List packages - Java (OkHttp) request example

Source: https://www.zoho.com/inventory/api/v1/packages/

Java code using OkHttpClient to send a GET request to the packages endpoint with an OAuth token.

```Java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/packages?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

--------------------------------

### List currencies with Java (OkHttp)

Source: https://www.zoho.com/inventory/api/v1/currency/

Java example using OkHttpClient to send a GET request to the list currencies endpoint. Requires OkHttp library and OAuth token.

```java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/settings/currencies?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

--------------------------------

### Get all options for a reporting tag - JavaScript

Source: https://www.zoho.com/inventory/api/v1/reporting-tags/

JavaScript fetch example to GET reporting tag options. Uses Promise and logs the JSON response.

```javascript
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/reportingtags/(/d+)/options/all?organization_id=10234695&tag_id=460000000038080', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

--------------------------------

### Get invoice attachment - Java (OkHttp)

Source: https://www.zoho.com/inventory/api/v1/invoices/

Java example using OkHttpClient to send a GET request for the invoice attachment. Requires OkHttp library.

```java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/invoices/982000000567114/attachment?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

--------------------------------

### Get Invoice Email Content - Node.js (https)

Source: https://www.zoho.com/inventory/api/v1/invoices/

Node.js example using the https module to make a GET request and print the response body.

```javascript
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/invoices/982000000567114/email?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
```

--------------------------------

### Response Example for Mark Assembly as Built

Source: https://www.zoho.com/inventory/api/v1/compositeitems/

Example 200 OK response after successfully marking an assembly as built. Contains the bundle details, line items, and custom fields.

```json
{ "code": 0, "message": "The assembly has been marked as built.", "bundle": { "bundle_id": 504366000000053250, "reference_number": "REF-B-00005", "transaction_number": "WO-00001", "date": "2017-01-05", "description": "Just a sample description", "composite_item_id": 504366000000053250, "composite_item_name": "Combo of Apple IPhone and Smartwatch", "composite_item_sku": "SKUIS", "quantity_to_bundle": 1, "status": "built", "total": 85000, "warehouse_id": "460000000038080", "warehouse_name": "Main Warehouse", "location_id": "460000000038080", "location_name": "Head Office", "line_items": [ { "item_id": 4815000000044208, "line_item_id": 504366000000053250, "item_order": 1, "name": "Combo of Apple IPhone and Smartwatch", "description": "Just a sample description", "quantity_consumed": 1, "unit": "units", "account_id": 504366000000000400, "account_name": "sales", "location_id": "460000000038080", "location_name": "Head Office", "rate": 85000 } ], "is_completed": true, "custom_fields": [ { "customfield_id": 504366000000053400, "value": "GBGD078", "label": "VAT ID" } ], "created_time": "2013-08-05", "last_modified_time": "string" } }
```

--------------------------------

### Create Move Order - Response Example (200 OK)

Source: https://www.zoho.com/inventory/api/v1/moveorders/

Example response for a successful move order creation (200 OK). Contains moveorder details including line items, comments, and documents.

```json
{ "code": 0, "message": "string", "moveorder": { "moveorder_id": 0, "moveorder_number": "string", "date": "string", "notes": "string", "status": "string", "completed_date": "string", "assignee_id": 0, "assignee_name": "string", "created_by_id": 0, "created_by_name": "string", "warehouse_id": 0, "warehouse_name": "string", "location_id": 0, "location_name": "string", "html_string": "string", "comments": [ { "comment_id": 0, "moveorder_id": 0, "description": "string", "commented_by_id": 0, "commented_by": "string", "comment_type": "string", "date": "string", "date_description": "string", "time": "string", "operation_type": "string" } ], "line_items": [ { "line_item_id": 0, "item_id": 0, "name": "string", "sku": "string", "unit": "string", "unit_id": 0, "image_document_id": 0, "description": "string", "quantity_transferred": 0, "track_serial_number": true, "track_batch_number": true, "serial_numbers": [ { "serialnumber_id": 0, "serial_number": "string", "status": "string" } ], "batches": [ { "batch_id": 0, "batch_in_id": 0, "batch_number": "string", "manufacturer_batch_number": "string", "manufactured_date": "string", "expiry_date": "string", "in_quantity": 0, "sales_rate": 0, "label_rate": 0, "balance_quantity": 0, "status": "string" } ], "is_combo_product": true, "from_storages": [ { "storage_id": 0, "quantity": 0 } ], "to_storages": [ { "storage_id": 0, "quantity": 0 } ], "is_storage_location_enabled": true } ], "documents": [ { "document_id": 0, "file_name": "string", "file_type": "string", "file_size": 0, "file_size_formatted": "string" } ] } }
```

--------------------------------

### Get retainer invoice email content - JavaScript (fetch)

Source: https://www.zoho.com/inventory/api/v1/retainer-invoices/

JavaScript example using fetch to GET the retainer invoice email content and log the response.

```javascript
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/retainerinvoices/982000000567114/email?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

--------------------------------

### Get retainer invoice email content - Java (OkHttp)

Source: https://www.zoho.com/inventory/api/v1/retainer-invoices/

Java example using OkHttpClient to send a GET request for retainer invoice email content.

```java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/retainerinvoices/982000000567114/email?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

--------------------------------

### Sample Response: Assembly Created

Source: https://www.zoho.com/inventory/api/v1/compositeitems/

Example JSON response returned when an assembly is created. Contains fields such as bundle_id, reference_number, transaction_number, status, total, and line_items.

```json
{ "code": 0, "message": "Assembly has been created.", "bundle_id": 504366000000053250, "reference_number": "REF-B-00005", "transaction_number": "WO-00001", "date": "2017-01-05", "description": "Just a sample description", "composite_item_id": 504366000000053250, "composite_item_name": "Combo of Apple IPhone and Smartwatch", "composite_item_sku": "SKUIS", "quantity_to_bundle": 1, "status": "pending", "total": 85000, "warehouse_id": "460000000038080", "warehouse_name": "Main Warehouse", "is_completed": true, "line_items": [ { "item_id": 4815000000044208, "line_item_id": 504366000000053250, "item_order": 1, "name": "Combo of Apple IPhone and Smartwatch", "description": "Just a sample description", "quantity_consumed": 1, "unit": "units", "account_id": 504366000000000400, "account_name": "sales", "location_id": "460000000038080", "location_name": "Head Office", "rate": 85000 } ], "custom_fields": [ { "customfield_id": 504366000000053400, "value": "GBGD078", "label": "VAT ID" } ], "created_time": "2013-08-05", "last_modified_time": "string" }
```

--------------------------------

### Get Retainer Invoice - Python (http.client)

Source: https://www.zoho.com/inventory/api/v1/retainer-invoices/

Python example using http.client to GET a retainer invoice and print the response. Requires OAuth scope ZohoInventory.invoices.READ.

```python
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/retainerinvoices/982000000567114?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
```

--------------------------------

### Get Retainer Invoice - JavaScript (fetch)

Source: https://www.zoho.com/inventory/api/v1/retainer-invoices/

JavaScript example using fetch to GET a retainer invoice and log the response. Requires OAuth scope ZohoInventory.invoices.READ.

```javascript
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/retainerinvoices/982000000567114?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

--------------------------------

### Java Request Example

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

Java code using OkHttpClient to fetch variant opening stock. Requires OAuth token and organization ID.

```java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/variants/4815000000044208/openingstock?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

--------------------------------

### Create Bin Response - 201 Created

Source: https://www.zoho.com/inventory/api/v1/storagelocations/

Sample response for a successful bin creation. Contains code, message, and storage_location object with details.

```json
{ "code": 0, "message": "Bin location has been Created.", "storage_location": { "storage_id": "130426000000801001", "name": "A-R1-B01", "description": "Row 1, Bin 01 in Zone A", "status": "active", "zone_id": "130426000000798001", "zone_name": "Zone A", "storage_zone_id": "130426000000798001", "location_id": "130426000000054001", "balance_quantity": 120.5, "batches": [ { "batch_id": "130426000000812001", "batch_number": "BATCH-001" } ] } }
```

--------------------------------

### Get Retainer Invoice - Java (OkHttp)

Source: https://www.zoho.com/inventory/api/v1/retainer-invoices/

Java example using OkHttpClient to send a GET request for a retainer invoice. Requires OAuth scope ZohoInventory.invoices.READ.

```java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/retainerinvoices/982000000567114?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

--------------------------------

### Get Invoice Email Content - Java (OkHttp)

Source: https://www.zoho.com/inventory/api/v1/invoices/

Java example using OkHttpClient to send a GET request. Requires the OkHttp library and an OAuth token.

```java
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/invoices/982000000567114/email?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
```

--------------------------------

### Create Picklist - JavaScript

Source: https://www.zoho.com/inventory/api/v1/picklists/

JavaScript fetch API example to POST a picklist request.

```javascript
const options = { method: 'POST', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://www.zohoapis.com/inventory/v1/picklists?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```

--------------------------------

### Get all options for a reporting tag - Node.js

Source: https://www.zoho.com/inventory/api/v1/reporting-tags/

Node.js HTTPS request example to GET reporting tag options. Uses the https module and prints the response body.

```javascript
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/reportingtags/(/d+)/options/all?organization_id=10234695&tag_id=460000000038080", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
```

--------------------------------

### Create Customer Payment - Response Example (201 Created)

Source: https://www.zoho.com/inventory/api/v1/customer-payments/

Example response for a successful payment creation. Shows the payment object with details like payment_id, status, and applied invoices.

```json
{
  "code": 0,
  "message": "The payment has been created.",
  "payment": {
    "payment_id": "9030000079467",
    "payment_mode": "cash",
    "amount": 450,
    "amount_refunded": 50,
    "bank_charges": 10,
    "date": "2016-06-05",
    "status": "success",
    "reference_number": "INV-384",
    "description": "Payment has been added to INV-384",
    "customer_id": "903000000000099",
    "customer_name": "Bowman Furniture",
    "email": "benjamin.george@bowmanfurniture.com",
    "tax_amount_withheld": 0,
    "invoices": [
      {
        "invoice_id": "90300000079426",
        "invoice_number": "INV-384",
        "date": "2016-06-05",
        "invoice_amount": 450,
        "amount_applied": 450,
        "balance_amount": 0
      }
    ],
    "exchange_rate": 1,
    "currency_id": "3000000002321",
    "currency_code": "USD",
    "currency_symbol": "$",
    "account_id": "450000000000353",
    "account_name": "Petty Cash",
    "tax_account_id": "",
    "tax_account_name": "",
    "unused_amount": 0,
    "last_four_digits": 1111,
    "location_id": "460000000038080",
    "location_name": "string",
    "custom_fields": [
      {
        "index": 1,
        "value": 129890,
        "label": "label",
        "data_type": "text"
      }
    ]
  }
}
```

--------------------------------

### Get Retainer Invoice - Node.js (https)

Source: https://www.zoho.com/inventory/api/v1/retainer-invoices/

Node.js example using the https module to GET a retainer invoice and print the response body. Requires OAuth scope ZohoInventory.invoices.READ.

```javascript
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/retainerinvoices/982000000567114?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
```

--------------------------------

### JavaScript Request Example

Source: https://www.zoho.com/inventory/api/v1/vendor-credits/

JavaScript fetch example to retrieve a vendor credit refund. Logs the JSON response to the console.

```javascript
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/vendorcredits/3000000002075/refunds/3000000003151?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
```
Tokens:
Raw