API Docs
/
No Results Found
Item Adjustments

Item Adjustments

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

Attribute

inventory_adjustment_id
long
Unique ID generated by the server for the item adjustment. This is used as an identifier.
date
string
The date for the Item Adjustment.
reason
string
The reason for the Item Adjustment.
reason_id
long
Unique ID generated by the server for the reason. This is used as an identifier.
description
string
Sample Description.
reference_number
string
Reference number of the Item Adjustment.
adjustment_type
string
The adjustment type should be either quantity or value.Allowed values are quantity and value only.
line_items
array
An item adjustment can contain multiple line items. Each line item contains item_id,name,description,quantity_adjusted,unit,adjustment_account_id,warehouse_id.
Show Sub-Attributes arrow
item_id
long
Unique ID generated by the server for the item. This is used as an identifier.
line_item_id
long
Unique ID generated by the server for each line item. This is used as an identifier.
name
string
Name of the line item.
description
string
Sample Description.
quantity_adjusted
double
The adjusted quantity of the line item.It depends on adjustment_type and should be given only when adjustment_type is given as quantity.
item_total
double
Total of line item.
unit
string
Unit of line item.
is_combo_product
boolean
adjustment_account_id
long
Unique ID generated by the server for the Adjustment account.
adjustment_account_name
string
Name of the Adjustment Account.
warehouse_id
long
Unique ID generated by the server for the Warehouse.
warehouse_name
string
Name of the Warehouse.
total
double
Total value of the Item Adjustment.

Example

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

Create an item adjustment

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

Arguments

date
string
(Required)
The date for the Item Adjustment.
reason
string
(Required)
The reason for the Item Adjustment.
description
string
Sample Description.
reference_number
string
Reference number of the Item Adjustment.
adjustment_type
string
(Required)
The adjustment type should be either quantity or value.Allowed values are quantity and value only.
line_items
array
(Required)
An item adjustment can contain multiple line items. Each line item contains item_id,name,description,quantity_adjusted,unit,adjustment_account_id,warehouse_id.
Show Sub-Attributes arrow
item_id
long
(Required)
Unique ID generated by the server for the item. This is used as an identifier.
name
string
Name of the line item.
description
string
Sample Description.
quantity_adjusted
double
(Required)
The adjusted quantity of the line item.It depends on adjustment_type and should be given only when adjustment_type is given as quantity.
item_total
double
Total of line item.
unit
string
Unit of line item.
is_combo_product
boolean
adjustment_account_id
long
Unique ID generated by the server for the Adjustment account.
adjustment_account_name
string
Name of the Adjustment Account.
warehouse_id
long
Unique ID generated by the server for the Warehouse.
warehouse_name
string
Name of the Warehouse.

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/inventoryadjustments?organization_id=10234695" type: POST headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}"); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/inventoryadjustments?organization_id=10234695") .post(body) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
const options = { method: 'POST', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://www.zohoapis.com/inventory/v1/inventoryadjustments?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("POST", "/inventory/v1/inventoryadjustments?organization_id=10234695", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "POST", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/inventoryadjustments?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", "content-type": "application/json" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({field1: 'value1', field2: 'value2'})); req.end();
curl --request POST \ --url 'https://www.zohoapis.com/inventory/v1/inventoryadjustments?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

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

Response Example

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

List all the item adjustments

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

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/inventoryadjustments?organization_id=10234695" type: GET headers: headers_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/inventoryadjustments?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/inventoryadjustments?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/inventoryadjustments?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/inventoryadjustments?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url 'https://www.zohoapis.com/inventory/v1/inventoryadjustments?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "success", "inventory_adjustments": [ { "inventory_adjustment_id": 4815000000044100, "date": "2015-05-28", "reason": "Damaged goods", "reason_id": 4815000000044110, "description": "Just a sample description.", "reference_number": "REF-IA-00001", "adjustment_type": "quantity", "total": 350 }, {...}, {...} ] }

Update an item adjustment

Update the details of an existing item adjustment by quantity.
OAuth Scope : ZohoInventory.inventoryadjustments.UPDATE

Arguments

date
string
(Required)
The date for the Item Adjustment.
reason
string
(Required)
The reason for the Item Adjustment.
description
string
Sample Description.
reference_number
string
Reference number of the Item Adjustment.
adjustment_type
string
(Required)
The adjustment type should be either quantity or value.Allowed values are quantity and value only.
line_items
array
(Required)
An item adjustment can contain multiple line items. Each line item contains item_id,line_item_id,name,description,quantity_adjusted,unit,adjustment_account_id,warehouse_id.
Show Sub-Attributes arrow
line_item_id
long
Unique ID generated by the server for each line item. This is used as an identifier.
item_id
long
(Required)
Unique ID generated by the server for the item. This is used as an identifier.
name
string
Name of the line item.
description
string
Sample Description.
quantity_adjusted
double
(Required)
The adjusted quantity of the line item.It depends on adjustment_type and should be given only when adjustment_type is given as quantity.
item_total
double
Total of line item.
unit
string
Unit of line item.
is_combo_product
boolean
adjustment_account_id
long
Unique ID generated by the server for the Adjustment account.
adjustment_account_name
string
Name of the Adjustment Account.
warehouse_id
long
Unique ID generated by the server for the Warehouse.
warehouse_name
string
Name of the Warehouse.

Request Example

Click to copy
parameters_data='{"field1":"value1","field2":"value2"}'; headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695" type: PUT headers: headers_data content-type: application/json parameters: parameters_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\"field1\":\"value1\",\"field2\":\"value2\"}"); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695") .put(body) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
const options = { method: 'PUT', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f', 'content-type': 'application/json' }, body: '{"field1":"value1","field2":"value2"}' }; fetch('https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") payload = "{\"field1\":\"value1\",\"field2\":\"value2\"}" headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", 'content-type': "application/json" } conn.request("PUT", "/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "PUT", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f", "content-type": "application/json" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({field1: 'value1', field2: 'value2'})); req.end();
curl --request PUT \ --url 'https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' \ --header 'content-type: application/json' \ --data '{"field1":"value1","field2":"value2"}'

Body Parameters

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

Response Example

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

Retrieve an item adjustment

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

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695" type: GET headers: headers_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695") .get() .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'GET', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("GET", "/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "GET", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request GET \ --url 'https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

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

Delete an item adjustment

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

Request Example

Click to copy
headers_data = Map(); headers_data.put("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"); response = invokeUrl [ url: "https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695" type: DELETE headers: headers_data connection: <connection_name> ] info response;
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695") .delete(null) .addHeader("Authorization", "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f") .build(); Response response = client.newCall(request).execute();
const options = { method: 'DELETE', headers: { Authorization: 'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f' } }; fetch('https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));
import http.client conn = http.client.HTTPSConnection("www.zohoapis.com") headers = { 'Authorization': "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } conn.request("DELETE", "/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695", headers=headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
const http = require("https"); const options = { "method": "DELETE", "hostname": "www.zohoapis.com", "port": null, "path": "/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695", "headers": { "Authorization": "Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f" } }; const req = http.request(options, function (res) { const chunks = []; res.on("data", function (chunk) { chunks.push(chunk); }); res.on("end", function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.end();
curl --request DELETE \ --url 'https://www.zohoapis.com/inventory/v1/inventoryadjustments/4815000000044100?organization_id=10234695' \ --header 'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'

Response Example

{ "code": 0, "message": "Inventory Adjustment(s) has been deleted" }