(Deprecated) Items

IMPORTANT NOTICE
This API is deprecated and not supported after 30th April 2022.
ClearTax Items API provides you the ability to manage your inventory or stock on your ClearTax account.
Item Object
Parameters
Type
Description
Item_code
String
Client Item/SKU code
gst_code
String
Item HSN code
gst_type
String
GOODS/SERVICE
description
String
Item description
notes
String
Item notes
unit_price
String
Item unit price in Rupees
unit_of_measurement
String
Refer Unit master​
id
String
Mandatory. Item unique ID
Get an Item
You can get all the contact details by submitting a GET request to the GST API with the following request headers
URL Query String
{{HOST}}/gst/api/v0.1/businesses/{{business_id}}/items/{{item_id}}
Request Parameter
Parameters
Parameters Type
Type
Description
business_id
Path
String
Required. This is the unique ID associated with the GSTIN in your account.
item_id
Path
String
Unique item ID of the item
Sample Request
https://api.clear.in/gst/api/v0.1/businesses/f33961ec-1c1a-461d-b888-8a5a56577a14/items/ck9uyejks00033b6cketziohz
Sample Response
200
  {
        "item_code": "",
        "gst_code": "",
        "gst_type": "GOODS",
        "description": "penc",
        "notes": "",
        "unit_price": null,
        "unit_price_including_tax": null,
        "unit_of_measurement": "",
        "id": "ck2a41dju00073b6akqkr71tp",
        "unit_cost": null,
        "unit_cost_including_tax": null,
        "discount": 0.00,
        "tax_rate": 0.00,
        "cess_rate": null,
        "cess_val": null,
        "inventory": [
            {
                "opening_quantity": null,
                "opening_price": null,
                "current_quantity": null,
                "safety_stock": null,
                "track_inventory": false,
                "taxable_entity_id": "249baf74-7392-4fa2-b3a0-685c6c7ad87e"
            }
        ],
        "is_active": true,
        "group": null
    }
​
Get all Items
You can get all the contact details by submitting a GET request to the GST API with the following request headers
X-Cleartax-Auth-Token: <USER_AUTH_TOKEN>
URL Query String
{{HOST}}/gst/api/v0.1/businesses/business_id/items?override_pagination=true
Request Parameter
Parameters
Parameters Type
Type
Description
business_id
Path
String
Required. This is the unique ID associated with the GSTIN in your account.
item_id
Path
String
Unique item ID of the item
override_pagination
Path
Boolean
Ignores the default limit of 20 in the response
item_ids
Path
String
Unique Item ID
item_codes
Path
String
Item code
Sample Request
https://api.clear.in/gst/api/v0.1/businesses/f33961ec-1c1a-461d-b888-8a5a56577a14/items?override_pagination=true
Sample Response
200
  [
  {
        "item_code": "",
        "gst_code": "",
        "gst_type": "GOODS",
        "description": "penc",
        "notes": "",
        "unit_price": null,
        "unit_price_including_tax": null,
        "unit_of_measurement": "",
        "id": "ck2a41dju00073b6akqkr71tp",
        "unit_cost": null,
        "unit_cost_including_tax": null,
        "discount": 0.00,
        "tax_rate": 0.00,
        "cess_rate": null,
        "cess_val": null,
        "inventory": [
            {
                "opening_quantity": null,
                "opening_price": null,
                "current_quantity": null,
                "safety_stock": null,
                "track_inventory": false,
                "taxable_entity_id": "249baf74-7392-4fa2-b3a0-685c6c7ad87e"
            }
        ],
        "is_active": true,
        "group": null
    }
]
Add/Update an Item
You can get all the contact details by submitting a PUT request to the GST API with the following request headers
X-Cleartax-Auth-Token: <USER_AUTH_TOKEN>
URL Query String
{{HOST}}/gst/api/v0.1/businesses/business_id/items/item_id
Request Parameter
Parameters
Parameters Type
Type
Description
business_id
Path
String
Required. This is the unique ID associated with the GSTIN in your account.
item_id
Path
String
Unique item ID of the item
Sample Request
https://api.clear.in/gst/api/v0.1/businesses/f33961ec-1c1a-461d-b888-8a5a56577a14/items/ck9uyejks00033b6cketziohz
Sample Payload
{
    "item_code": "",
    "gst_code": "",
    "gst_type": "GOODS",
    "description": "pencil",
    "unit_of_measurement": "BOX",
    "id": "ck9uzfzh100043b6ceixxirrk",
    "unit_price": "05",
    "unit_price_including_tax": "",
    "unit_cost": "10",
    "unit_cost_including_tax": "",
    "tax_rate": "5",
    "cess_val": "",
    "is_price_including_tax": "",
    "discount": "",
    "notes": "pencil boxes"
}
Sample Response
200
  {
        "item_code": "",
        "gst_code": "",
        "gst_type": "GOODS",
        "description": "penc",
        "notes": "",
        "unit_price": null,
        "unit_price_including_tax": null,
        "unit_of_measurement": "",
        "id": "ck2a41dju00073b6akqkr71tp",
        "unit_cost": null,
        "unit_cost_including_tax": null,
        "discount": 0.00,
        "tax_rate": 0.00,
        "cess_rate": null,
        "cess_val": null,
        "inventory": [
            {
                "opening_quantity": null,
                "opening_price": null,
                "current_quantity": null,
                "safety_stock": null,
                "track_inventory": false,
                "taxable_entity_id": "249baf74-7392-4fa2-b3a0-685c6c7ad87e"
            }
        ],
        "is_active": true,
        "group": null
    }

(Deprecated) Document Classification/Section Name master

(Deprecated) Contacts

Last modified 1yr ago

Parameters	Type	Description
Item_code	String	Client Item/SKU code
gst_code	String	Item HSN code
gst_type	String	GOODS/SERVICE
description	String	Item description
notes	String	Item notes
unit_price	String	Item unit price in Rupees
unit_of_measurement	String	Refer Unit master
id	String	Mandatory. Item unique ID

Parameters	Parameters Type	Type	Description
business_id	Path	String	Required. This is the unique ID associated with the GSTIN in your account.
item_id	Path	String	Unique item ID of the item