openapi: 3.0.0 info: title: batches items API description: Batches help you track inventory items by batch numbers, manufacturing dates, and expiration dates. contact: {} version: 1.0.0 servers: - url: https://www.zohoapis.com/inventory/v1 description: API Endpoint tags: - name: items description: Items Module paths: /items: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: create_item summary: Create an item description: Creates a new item in Zoho Inventory. requestBody: content: application/json: schema: $ref: '#/components/schemas/create-an-item-request' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/create-an-item-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE get: tags: - items operationId: list_items summary: List all the items description: Lists all the items present in Zoho Inventory. parameters: - name: page in: query description: Page number to be fetched. Default value is 1. required: false schema: type: integer default: 1 example: 1 - name: per_page in: query description: Number of records to be fetched per page. Default value is 200. required: false schema: type: integer default: 200 example: 200 - name: search_text in: query description: Search items by name, SKU, or other searchable fields. required: false schema: type: string - name: filter_by in: query description: 'Filter items by status or item type. Allowed values: Status.All, Status.Active, Status.Inactive, Status.Lowstock, Status.Unmapped, Status.Uncategorized, Status.Grouped, ItemType.All, ItemType.Sales, ItemType.Purchases, ItemType.SalesAndPurchases, ItemType.Inventory, ItemType.NonInventory, ItemType.Service.' required: false schema: type: string - name: sort_column in: query description: 'Sort by column. Allowed values: name, sku, rate, purchase_rate, created_time, last_modified_time, reorder_level, stock_on_hand.' required: false schema: type: string - name: sort_order in: query description: 'Sort order. Allowed values: A for ascending and D for descending.' required: false schema: type: string - name: status in: query description: 'Filter by item status. Allowed values: active, inactive.' required: false schema: type: string - name: name in: query description: Filter by exact item name. required: false schema: type: string - name: name_startswith in: query description: Filter by item name that starts with the given value. required: false schema: type: string - name: name_contains in: query description: Filter by item name that contains the given value. required: false schema: type: string - name: sku in: query description: Filter by exact SKU. required: false schema: type: string - name: sku_startswith in: query description: Filter by SKU that starts with the given value. required: false schema: type: string - name: sku_contains in: query description: Filter by SKU that contains the given value. required: false schema: type: string - name: rate in: query description: Filter by exact selling rate. required: false schema: type: number format: double - name: rate_less_than in: query description: Filter by selling rate less than the given value. required: false schema: type: number format: double - name: rate_less_equals in: query description: Filter by selling rate less than or equal to the given value. required: false schema: type: number format: double - name: rate_greater_than in: query description: Filter by selling rate greater than the given value. required: false schema: type: number format: double - name: rate_greater_equals in: query description: Filter by selling rate greater than or equal to the given value. required: false schema: type: number format: double - name: purchase_rate in: query description: Filter by exact purchase rate. required: false schema: type: number format: double - name: purchase_rate_less_than in: query description: Filter by purchase rate less than the given value. required: false schema: type: number format: double - name: purchase_rate_less_equals in: query description: Filter by purchase rate less than or equal to the given value. required: false schema: type: number format: double - name: purchase_rate_greater_than in: query description: Filter by purchase rate greater than the given value. required: false schema: type: number format: double - name: purchase_rate_greater_equals in: query description: Filter by purchase rate greater than or equal to the given value. required: false schema: type: number format: double - name: tax_id in: query description: Filter by tax ID. required: false schema: type: string - name: account_id in: query description: Filter by sales account ID. required: false schema: type: string - name: purchase_account_id in: query description: Filter by purchase account ID. required: false schema: type: string - name: customview_id in: query description: Custom view ID to apply. required: false schema: type: string - name: vendor_id in: query description: Filter by vendor ID. required: false schema: type: string - name: item_id in: query description: Filter by item ID. required: false schema: type: string - name: zcrm_product_id in: query description: Filter by Zoho CRM product ID. required: false schema: type: string - name: last_modified_time in: query description: Filter items modified after the given date and time. Format yyyy-MM-ddTHH:mm:ssZ. required: false schema: type: string - name: category_id in: query description: Filter by category ID. required: false schema: type: string - name: brand_ids in: query description: Comma-separated list of brand IDs to filter by. required: false schema: type: string - name: manufacturer_ids in: query description: Comma-separated list of manufacturer IDs to filter by. required: false schema: type: string - name: warehouse_id in: query description: Filter by warehouse ID. required: false schema: type: string - name: location_id in: query description: Filter by location ID. required: false schema: type: string - name: group_id in: query description: Filter by item group ID. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/list-all-the-items-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.READ delete: tags: - items operationId: bulk_delete_items summary: Delete multiple items description: Deletes multiple items from Zoho Inventory. parameters: - name: item_ids in: query description: Comma-separated list of item IDs to delete. required: false schema: type: string example: 4815000000044208,4815000000044274 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/bulk-delete-items-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.DELETE /itemdetails: x-mcp-group: - Items parameters: - name: item_ids in: query required: true description: List of item ids separated by comma schema: type: string example: 4815000000044208,4815000000044274,4815000000044340 - $ref: '#/components/parameters/organization_id' get: tags: - items operationId: list_item_details summary: Bulk fetch item details description: Fetch item details for the mentioned item IDs responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/bulk-fetch-item-details-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.READ /items/{item_id}: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' get: tags: - items operationId: get_item summary: Retrieve an item description: Fetches the details for an existing item. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/retrieve-an-item-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.READ put: tags: - items operationId: update_item summary: Update an item description: Update the details of an item. requestBody: content: application/json: schema: $ref: '#/components/schemas/update-an-item-request' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/update-an-item-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.UPDATE delete: tags: - items operationId: delete_item summary: Delete an item description: Deletes an existing item from Zoho Inventory. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/delete-an-item-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.DELETE /item/{item_id}/customfields: x-mcp-group: - Items put: tags: - items operationId: update_custom_field_in_item summary: Update custom field in existing items description: Update the value of the custom field in existing items. parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 45667789900 - $ref: '#/components/parameters/organization_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/custom_fields' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/update-an-item-customfield-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.UPDATE /items/{item_id}/image: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: upload_item_image summary: Upload an item image description: 'Uploads an image for an item in Zoho Inventory. Allowed formats: gif, png, jpeg, jpg, bmp, webp. Maximum size: 7 MB.' requestBody: content: multipart/form-data: schema: type: object properties: image: type: string format: binary description: Image file to upload. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/upload-item-image-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE get: tags: - items operationId: get_item_image summary: Retrieve an item image description: Retrieves the image associated with an item. parameters: - name: preview in: query description: Set to true to get a preview of the image. required: false schema: type: boolean responses: '200': description: Returns the item image as a binary stream. deprecated: false security: - Zoho_Auth: - ZohoInventory.items.READ delete: tags: - items operationId: delete_item_image summary: Delete an item image description: Deletes the image associated for an item in Zoho Inventory. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/delete-an-item-image-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.DELETE /items/{item_id}/active: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: mark_item_as_active summary: Mark as active description: Changes the status of an item to active. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/mark-as-active-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE /items/{item_id}/inactive: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: mark_item_as_inactive summary: Mark as inactive description: Mark an item as inactive. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/mark-as-inactive-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE /variants/{variant_id}/openingstock: x-mcp-group: - Items parameters: - name: variant_id in: path required: true description: Unique identifier of the variant. schema: type: string example: '4815000000044208' - $ref: '#/components/parameters/organization_id' get: tags: - items operationId: get_variant_opening_stock summary: Retrieve variant opening stock description: Fetches the opening stock details of a variant, including batches, serial numbers, and warehouse details. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/get-variant-opening-stock-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.READ put: tags: - items operationId: update_variant_opening_stock summary: Update variant opening stock description: Updates the opening stock details of a variant. requestBody: content: application/json: schema: $ref: '#/components/schemas/update-variant-opening-stock-request' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/update-variant-opening-stock-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.UPDATE /items/{item_id}/images: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: upload_item_images summary: Upload multiple item images description: 'Uploads multiple images for an item. Allowed formats: gif, png, jpeg, jpg, bmp, webp. Maximum size: 7 MB per image.' parameters: - name: document_ids in: query description: Comma-separated list of document IDs. required: false schema: type: string - name: remove_all in: query description: Set to true to remove all existing images before uploading. required: false schema: type: boolean - name: update_primary_image in: query description: Set to true to update the primary image. required: false schema: type: boolean requestBody: content: multipart/form-data: schema: type: object properties: image: type: string format: binary description: Image file(s) to upload. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/upload-item-images-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE delete: tags: - items operationId: delete_item_images summary: Delete multiple item images description: Deletes multiple images associated with an item. parameters: - name: document_ids in: query description: Comma-separated list of document IDs to delete. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/delete-item-images-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.DELETE /items/{item_id}/images/reorder: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: reorder_item_images summary: Reorder item images description: Reorders the images associated with an item. requestBody: content: application/json: schema: $ref: '#/components/schemas/reorder-item-images-request' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/reorder-item-images-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE /items/{item_id}/backimage: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: upload_item_back_image summary: Upload an item back image description: 'Uploads a back image for an item. Allowed formats: gif, png, jpeg, jpg, bmp, webp. Maximum size: 7 MB.' parameters: - name: document_id in: query description: Document ID of an existing image to set as back image. required: false schema: type: string requestBody: content: multipart/form-data: schema: type: object properties: back_image: type: string format: binary description: Back image file to upload. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/upload-item-back-image-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE delete: tags: - items operationId: delete_item_back_image summary: Delete an item back image description: Deletes the back image associated with an item. parameters: - name: document_id in: query description: Document ID of the back image to delete. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/delete-item-back-image-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.DELETE /items/{item_id}/images/{image_id}/backimage: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - name: image_id in: path required: true description: Unique identifier of the image. schema: type: string example: '2077500000000002000' - $ref: '#/components/parameters/organization_id' put: tags: - items operationId: mark_image_as_back_image summary: Mark an image as back image description: Marks an existing item image as the rear/back image. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/mark-image-as-back-image-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.UPDATE /items/active: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: bulk_mark_items_active summary: Bulk mark items as active description: Changes the status of multiple items to active. parameters: - name: item_ids in: query description: Comma-separated list of item IDs to mark as active. required: true schema: type: string example: 4815000000044208,4815000000044274 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/bulk-mark-items-active-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE /items/inactive: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: bulk_mark_items_inactive summary: Bulk mark items as inactive description: Changes the status of multiple items to inactive. parameters: - name: item_ids in: query description: Comma-separated list of item IDs to mark as inactive. required: true schema: type: string example: 4815000000044208,4815000000044274 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/bulk-mark-items-inactive-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE /items/ungroup: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: ungroup_items summary: Ungroup items description: Ungroups the specified items from their variant grouping. parameters: - name: item_ids in: query description: Comma-separated list of item IDs to ungroup. required: false schema: type: string - name: composite_item_ids in: query description: Comma-separated list of composite item IDs to ungroup. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ungroup-items-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE /items/enablestoragelocation: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: enable_storage_location summary: Enable storage location for items description: Enables storage location tracking for the specified items. parameters: - name: item_ids in: query description: Comma-separated list of item IDs. required: true schema: type: string example: 4815000000044208,4815000000044274 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/enable-storage-location-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE /items/disablestoragelocation: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: disable_storage_location summary: Disable storage location for items description: Disables storage location tracking for the specified items. parameters: - name: item_ids in: query description: Comma-separated list of item IDs. required: true schema: type: string example: 4815000000044208,4815000000044274 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/disable-storage-location-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE /items/move/{item_id}: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' put: tags: - items operationId: move_item summary: Move an item description: Moves an item to a different group or location. requestBody: content: application/json: schema: $ref: '#/components/schemas/move-item-request' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/move-item-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.UPDATE /items/grouping/{group_id}: x-mcp-group: - Items parameters: - name: group_id in: path required: true description: Unique identifier of the item group. schema: type: string example: '4815000000044220' - $ref: '#/components/parameters/organization_id' put: tags: - items operationId: group_items summary: Group items description: Groups items together as variants under a single item. requestBody: content: application/json: schema: $ref: '#/components/schemas/group-items-request' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/group-items-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.UPDATE /items/{item_id}/locations/permissions: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' put: tags: - items operationId: update_item_location_permissions summary: Update item location permissions description: Updates the location access permissions for an item. parameters: - name: associated_with_all_locations in: query description: Set to true to associate the item with all locations. required: true schema: type: boolean - name: allowed_location_ids in: query description: Comma-separated list of allowed location IDs. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/update-item-location-permissions-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.warehouses.UPDATE /items/locations/permissions: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' put: tags: - items operationId: bulk_update_item_location_permissions summary: Bulk update item location permissions description: Updates location access permissions for multiple items at once. parameters: - name: item_ids in: query description: Comma-separated list of item IDs. required: false schema: type: string - name: allowed_location_ids in: query description: Comma-separated list of allowed location IDs. required: false schema: type: string - name: overwrite in: query description: Set to true to overwrite existing permissions. required: false schema: type: boolean responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/bulk-update-item-location-permissions-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.warehouses.UPDATE /items/{item_id}/serialnumber/validate: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: validate_serial_numbers summary: Validate serial numbers description: Checks serial number availability for outgoing transactions. parameters: - name: entity_id in: query description: Unique identifier of the entity. required: false schema: type: string - name: warehouse_id in: query description: Unique identifier of the warehouse. required: false schema: type: string - name: entity_type in: query description: Type of the entity. required: true schema: type: string - name: serial_numbers in: query description: Comma-separated list of serial numbers to validate. required: true schema: type: string - name: location_id in: query description: Unique identifier of the location. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/validate-serial-numbers-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE /items/{item_id}/serialnumber/validateandmap: x-mcp-group: - Items parameters: - name: item_id in: path required: true description: Unique identifier of the item. schema: type: string example: 4815000000044208 - $ref: '#/components/parameters/organization_id' post: tags: - items operationId: validate_and_map_serial_numbers summary: Validate and map serial numbers description: Validates serial number availability and maps them with bin locations for outgoing transactions. requestBody: content: application/json: schema: $ref: '#/components/schemas/validate-and-map-serial-numbers-request' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/validate-and-map-serial-numbers-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.CREATE /items/transactions/salesorders: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' get: tags: - items operationId: list_item_sales_orders summary: List sales orders for an item description: Lists all sales orders associated with a particular item. parameters: - name: item_id in: query description: Unique identifier of the item. required: true schema: type: string example: '4815000000044208' - name: status in: query description: 'Filter by status. Allowed values: draft, pending_approval, approved, confirmed, overdue, shipped, partially_shipped, fulfilled, void, drop_shipped, partially_invoiced, invoiced, onhold, closed, backordered.' required: false schema: type: string - name: customer_id in: query description: Filter by customer ID. required: false schema: type: string - name: sales_channel in: query description: Filter by sales channel. required: false schema: type: string - name: sort_column in: query description: 'Sort by column. Allowed values: date, salesorder_number.' required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/list-item-sales-orders-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.salesorders.READ /items/transactions/purchaseorders: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' get: tags: - items operationId: list_item_purchase_orders summary: List purchase orders for an item description: Lists all purchase orders associated with a particular item. parameters: - name: item_id in: query description: Unique identifier of the item. required: true schema: type: string example: '4815000000044208' - name: status in: query description: 'Filter by status. Allowed values: draft, issued, closed, received, partially_received, billed, partially_billed, cancelled, drop_shipped, pending_approval, approved.' required: false schema: type: string - name: vendor_id in: query description: Filter by vendor ID. required: false schema: type: string - name: sort_column in: query description: 'Sort by column. Allowed values: vendor_name, date, purchaseorder_number.' required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/list-item-purchase-orders-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.purchaseorders.READ /items/transactions/invoices: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' get: tags: - items operationId: list_item_invoices summary: List invoices for an item description: Lists all invoices associated with a particular item. parameters: - name: item_id in: query description: Unique identifier of the item. required: true schema: type: string example: '4815000000044208' - name: status in: query description: 'Filter by status. Allowed values: sent, draft, pending_approval, approved, viewed, overdue, paid, void, unpaid, partially_paid.' required: false schema: type: string - name: customer_id in: query description: Filter by customer ID. required: false schema: type: string - name: sort_column in: query description: 'Sort by column. Allowed values: customer_name, date, invoice_number.' required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/list-item-invoices-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.invoices.READ /items/transactions/deliverychallans: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' get: tags: - items operationId: list_item_delivery_challans summary: List delivery challans for an item description: Lists all delivery challans associated with a particular item. parameters: - name: item_id in: query description: Unique identifier of the item. required: true schema: type: string example: '4815000000044208' - name: status in: query description: 'Filter by status. Allowed values: draft, open, void, fulfilled, invoiced, partially_invoiced, elapsed.' required: false schema: type: string - name: customer_id in: query description: Filter by customer ID. required: false schema: type: string - name: sort_column in: query description: 'Sort by column. Allowed values: customer_name, deliverychallan_number, total, date, created_time, last_modified_time.' required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/list-item-delivery-challans-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.invoices.READ /items/transactions/salesreceipts: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' get: tags: - items operationId: list_item_sales_receipts summary: List sales receipts for an item description: Lists all sales receipts associated with a particular item. parameters: - name: item_id in: query description: Unique identifier of the item. required: true schema: type: string example: '4815000000044208' - name: customer_id in: query description: Filter by customer ID. required: false schema: type: string - name: sort_column in: query description: 'Sort by column. Allowed values: customer_name, date, receipt_number.' required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/list-item-sales-receipts-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.invoices.READ /items/transactions/moveorders: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' get: tags: - items operationId: list_item_move_orders summary: List move orders for an item description: Lists all move orders associated with a particular item. parameters: - name: item_id in: query description: Unique identifier of the item. required: true schema: type: string example: '4815000000044208' - name: sort_column in: query description: 'Sort by column. Allowed values: moveorder_number, date.' required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/list-item-move-orders-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.READ /items/transactions/putaways: x-mcp-group: - Items parameters: - $ref: '#/components/parameters/organization_id' get: tags: - items operationId: list_item_putaways summary: List putaways for an item description: Lists all putaways associated with a particular item. parameters: - name: item_id in: query description: Unique identifier of the item. required: true schema: type: string example: '4815000000044208' - name: sort_column in: query description: 'Sort by column. Allowed values: putaway_number, date.' required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/list-item-putaways-response' deprecated: false security: - Zoho_Auth: - ZohoInventory.items.READ components: schemas: update-an-item-request: required: - name type: object properties: group_id: $ref: '#/components/schemas/group_id' group_name: $ref: '#/components/schemas/group_name' unit: $ref: '#/components/schemas/unit' unit_id: $ref: '#/components/schemas/unit_id' unit_group_id: $ref: '#/components/schemas/unit_group_id' default_sales_unit_conversion_id: $ref: '#/components/schemas/default_sales_unit_conversion_id' default_purchase_unit_conversion_id: $ref: '#/components/schemas/default_purchase_unit_conversion_id' item_type: $ref: '#/components/schemas/item_type' product_type: $ref: '#/components/schemas/product_type' can_be_sold: $ref: '#/components/schemas/can_be_sold' can_be_purchased: $ref: '#/components/schemas/can_be_purchased' track_inventory: $ref: '#/components/schemas/track_inventory' is_taxable: $ref: '#/components/schemas/is_taxable' tax_id: $ref: '#/components/schemas/tax_id' description: $ref: '#/components/schemas/description' tax_name: $ref: '#/components/schemas/tax_name' tax_percentage: $ref: '#/components/schemas/tax_percentage' tax_type: $ref: '#/components/schemas/tax_type' purchase_account_id: $ref: '#/components/schemas/purchase_account_id' purchase_account_name: $ref: '#/components/schemas/purchase_account_name' account_name: $ref: '#/components/schemas/account_name' inventory_account_id: $ref: '#/components/schemas/inventory_account_id' attribute_id1: $ref: '#/components/schemas/attribute_id1' attribute_name1: $ref: '#/components/schemas/attribute_name1' status: $ref: '#/components/schemas/status' source: $ref: '#/components/schemas/source' name: $ref: '#/components/schemas/name' rate: $ref: '#/components/schemas/rate' pricebook_rate: $ref: '#/components/schemas/pricebook_rate' purchase_rate: $ref: '#/components/schemas/purchase_rate' reorder_level: $ref: '#/components/schemas/reorder_level' locations: type: array description: List of locations. items: type: object properties: location_id: $ref: '#/components/schemas/location_id' initial_stock: $ref: '#/components/schemas/initial_stock' initial_stock_rate: $ref: '#/components/schemas/initial_stock_rate' vendor_id: $ref: '#/components/schemas/vendor_id' vendor_name: $ref: '#/components/schemas/vendor_name' sku: $ref: '#/components/schemas/sku' upc: $ref: '#/components/schemas/upc' ean: $ref: '#/components/schemas/ean' isbn: $ref: '#/components/schemas/isbn' part_number: $ref: '#/components/schemas/part_number' attribute_option_id1: $ref: '#/components/schemas/attribute_option_id1' attribute_option_name1: $ref: '#/components/schemas/attribute_option_name1' image_id: $ref: '#/components/schemas/image_id' image_name: $ref: '#/components/schemas/image_name' purchase_description: $ref: '#/components/schemas/purchase_description' image_type: $ref: '#/components/schemas/image_type' item_tax_preferences: $ref: '#/components/schemas/item_tax_preferences' hsn_or_sac: $ref: '#/components/schemas/hsn_or_sac' sat_item_key_code: $ref: '#/components/schemas/sat_item_key_code' unitkey_code: $ref: '#/components/schemas/unitkey_code' custom_fields: $ref: '#/components/schemas/custom_fields' attribute_option_name1: description: Name of the attribute's option. type: string example: Small update-an-item-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: Item details have been updated readOnly: true item: type: object properties: group_id: $ref: '#/components/schemas/group_id' group_name: $ref: '#/components/schemas/group_name' item_id: $ref: '#/components/schemas/item_id' name: $ref: '#/components/schemas/name' unit: $ref: '#/components/schemas/unit' unit_id: $ref: '#/components/schemas/unit_id' unit_group_id: $ref: '#/components/schemas/unit_group_id' unit_group_name: $ref: '#/components/schemas/unit_group_name' default_sales_unit_conversion_id: $ref: '#/components/schemas/default_sales_unit_conversion_id' default_purchase_unit_conversion_id: $ref: '#/components/schemas/default_purchase_unit_conversion_id' item_type: $ref: '#/components/schemas/item_type' product_type: $ref: '#/components/schemas/product_type' can_be_sold: $ref: '#/components/schemas/can_be_sold' can_be_purchased: $ref: '#/components/schemas/can_be_purchased' track_inventory: $ref: '#/components/schemas/track_inventory' is_taxable: $ref: '#/components/schemas/is_taxable' tax_id: $ref: '#/components/schemas/tax_id' documents: $ref: '#/components/schemas/documents' description: $ref: '#/components/schemas/description' tax_name: $ref: '#/components/schemas/tax_name' tax_percentage: $ref: '#/components/schemas/tax_percentage' tax_type: $ref: '#/components/schemas/tax_type' purchase_account_id: $ref: '#/components/schemas/purchase_account_id' purchase_account_name: $ref: '#/components/schemas/purchase_account_name' account_name: $ref: '#/components/schemas/account_name' inventory_account_id: $ref: '#/components/schemas/inventory_account_id' attribute_id1: $ref: '#/components/schemas/attribute_id1' attribute_name1: $ref: '#/components/schemas/attribute_name1' status: $ref: '#/components/schemas/status' source: $ref: '#/components/schemas/source' rate: $ref: '#/components/schemas/rate' pricebook_rate: $ref: '#/components/schemas/pricebook_rate' purchase_rate: $ref: '#/components/schemas/purchase_rate' reorder_level: $ref: '#/components/schemas/reorder_level' vendor_id: $ref: '#/components/schemas/vendor_id' vendor_name: $ref: '#/components/schemas/vendor_name' locations: $ref: '#/components/schemas/locations' sku: $ref: '#/components/schemas/sku' upc: $ref: '#/components/schemas/upc' ean: $ref: '#/components/schemas/ean' isbn: $ref: '#/components/schemas/isbn' part_number: $ref: '#/components/schemas/part_number' attribute_option_id1: $ref: '#/components/schemas/attribute_option_id1' attribute_option_name1: $ref: '#/components/schemas/attribute_option_name1' image_id: $ref: '#/components/schemas/image_id' image_name: $ref: '#/components/schemas/image_name' purchase_description: $ref: '#/components/schemas/purchase_description' image_type: $ref: '#/components/schemas/image_type' item_tax_preferences: $ref: '#/components/schemas/item_tax_preferences' hsn_or_sac: $ref: '#/components/schemas/hsn_or_sac' sat_item_key_code: $ref: '#/components/schemas/sat_item_key_code' unitkey_code: $ref: '#/components/schemas/unitkey_code' custom_fields: $ref: '#/components/schemas/custom_fields' delete-an-item-image-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The item image has been deleted. readOnly: true create-an-item-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The item has been added. readOnly: true item: $ref: '#/components/schemas/item-response' ean: description: Unique EAN value for the Item. type: integer format: int64 example: 111111111112 ungroup-items-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The items have been ungrouped. readOnly: true delete-item-images-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The item images have been deleted. readOnly: true group_name: description: Name of product group type: string example: Bags vendor_name: description: Name of the preferred Vendor for purchasing this item. type: string example: Molly mark-as-active-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The item has been marked as Active. readOnly: true upload-item-back-image-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The back image has been uploaded. readOnly: true item_id: description: Unique ID generated by the server for the Item. This is used as an identifier. type: string example: 4815000000044208 get-variant-opening-stock-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true opening_stock: type: object properties: initial_stock: type: number format: double initial_stock_rate: type: number format: double serial_numbers: type: array items: type: string batches: type: array items: type: object properties: batch_number: type: string quantity: type: number format: double rate: type: number format: double locations: type: array items: type: object properties: location_id: type: string initial_stock: type: number format: double initial_stock_rate: type: number format: double location_available_stock: description: Available stock in your location. type: string example: '' sat_item_key_code: description: Add SAT Item Key Code for your goods/services. Download the CFDI Catalogs. type: string x-node_available_in: - mx x-node_unavailable_in: [] documents: description: List of all the documents associated with the item type: array items: type: string default_purchase_unit_conversion_id: description: Unique ID of the default purchase unit conversion. Applicable when unit conversion is enabled. type: string example: '4815000000044410' purchase_account_id: description: Unique ID generated by the server for the Purchase account. type: string example: 4815000000035003 purchase_rate: description: Purchase price of the Item. type: number format: double example: 6 list-all-the-items-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true items: type: array items: type: object properties: group_id: $ref: '#/components/schemas/group_id' group_name: $ref: '#/components/schemas/group_name' item_id: $ref: '#/components/schemas/item_id' name: $ref: '#/components/schemas/name' status: $ref: '#/components/schemas/status' source: $ref: '#/components/schemas/source' is_linked_with_zohocrm: $ref: '#/components/schemas/is_linked_with_zohocrm' item_type: $ref: '#/components/schemas/item_type' description: $ref: '#/components/schemas/description' rate: $ref: '#/components/schemas/rate' is_taxable: $ref: '#/components/schemas/is_taxable' tax_id: $ref: '#/components/schemas/tax_id' tax_name: $ref: '#/components/schemas/tax_name' tax_percentage: $ref: '#/components/schemas/tax_percentage' purchase_description: $ref: '#/components/schemas/purchase_description' purchase_rate: $ref: '#/components/schemas/purchase_rate' is_combo_product: $ref: '#/components/schemas/is_combo_product' product_type: $ref: '#/components/schemas/product_type' attribute_id1: $ref: '#/components/schemas/attribute_id1' attribute_name1: $ref: '#/components/schemas/attribute_name1' reorder_level: $ref: '#/components/schemas/reorder_level' locations: $ref: '#/components/schemas/locations' sku: $ref: '#/components/schemas/sku' upc: $ref: '#/components/schemas/upc' ean: $ref: '#/components/schemas/ean' isbn: $ref: '#/components/schemas/isbn' part_number: $ref: '#/components/schemas/part_number' attribute_option_id1: $ref: '#/components/schemas/attribute_option_id1' attribute_option_name1: $ref: '#/components/schemas/attribute_option_name1' image_name: $ref: '#/components/schemas/image_name' image_type: $ref: '#/components/schemas/image_type' created_time: $ref: '#/components/schemas/created_time' last_modified_time: $ref: '#/components/schemas/last_modified_time' hsn_or_sac: $ref: '#/components/schemas/hsn_or_sac' sat_item_key_code: $ref: '#/components/schemas/sat_item_key_code' unitkey_code: $ref: '#/components/schemas/unitkey_code' custom_fields: $ref: '#/components/schemas/custom_fields' bulk-fetch-item-details-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true items: type: array items: type: object properties: item_id: $ref: '#/components/schemas/item_id' name: $ref: '#/components/schemas/name' unit: $ref: '#/components/schemas/unit' item_type: $ref: '#/components/schemas/item_type' product_type: $ref: '#/components/schemas/product_type' is_taxable: $ref: '#/components/schemas/is_taxable' tax_id: $ref: '#/components/schemas/tax_id' description: $ref: '#/components/schemas/description' tax_name: $ref: '#/components/schemas/tax_name' tax_percentage: $ref: '#/components/schemas/tax_percentage' tax_type: $ref: '#/components/schemas/tax_type' purchase_account_id: $ref: '#/components/schemas/purchase_account_id' purchase_account_name: $ref: '#/components/schemas/purchase_account_name' account_name: $ref: '#/components/schemas/account_name' inventory_account_id: $ref: '#/components/schemas/inventory_account_id' attribute_id1: $ref: '#/components/schemas/attribute_id1' attribute_name1: $ref: '#/components/schemas/attribute_name1' status: $ref: '#/components/schemas/status' rate: $ref: '#/components/schemas/rate' pricebook_rate: $ref: '#/components/schemas/pricebook_rate' purchase_rate: $ref: '#/components/schemas/purchase_rate' reorder_level: $ref: '#/components/schemas/reorder_level' vendor_id: $ref: '#/components/schemas/vendor_id' vendor_name: $ref: '#/components/schemas/vendor_name' locations: $ref: '#/components/schemas/locations' sku: $ref: '#/components/schemas/sku' upc: $ref: '#/components/schemas/upc' ean: $ref: '#/components/schemas/ean' isbn: $ref: '#/components/schemas/isbn' part_number: $ref: '#/components/schemas/part_number' attribute_option_id1: $ref: '#/components/schemas/attribute_option_id1' attribute_option_name1: $ref: '#/components/schemas/attribute_option_name1' image_id: $ref: '#/components/schemas/image_id' image_name: $ref: '#/components/schemas/image_name' purchase_description: $ref: '#/components/schemas/purchase_description' image_type: $ref: '#/components/schemas/image_type' item_tax_preferences: $ref: '#/components/schemas/item_tax_preferences' hsn_or_sac: $ref: '#/components/schemas/hsn_or_sac' custom_fields: $ref: '#/components/schemas/custom_fields' list-item-move-orders-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true moveorders: type: array items: type: object properties: moveorder_id: type: string moveorder_number: type: string date: type: string warehouse_id: type: string warehouse_name: type: string location_id: type: string location_name: type: string item_quantity: type: number format: double custom_fields: description: List of custom fields associated with the item type: array items: type: object properties: customfield_id: $ref: '#/components/schemas/customfield_id' label: $ref: '#/components/schemas/label' value: $ref: '#/components/schemas/value' group_id: description: Unique ID generated by the server for the group to which the item belongs, if any. This is used as an identifier. type: string example: 4815000000044220 item_type: description: Item type can be inventory, sales, purchases or sales_and_purchases. If item is associated with a group, then type should be inventory. type: string example: inventory item-response: type: object properties: group_id: $ref: '#/components/schemas/group_id' group_name: $ref: '#/components/schemas/group_name' item_id: $ref: '#/components/schemas/item_id' name: $ref: '#/components/schemas/name' unit: $ref: '#/components/schemas/unit' unit_id: $ref: '#/components/schemas/unit_id' unit_group_id: $ref: '#/components/schemas/unit_group_id' unit_group_name: $ref: '#/components/schemas/unit_group_name' default_sales_unit_conversion_id: $ref: '#/components/schemas/default_sales_unit_conversion_id' default_purchase_unit_conversion_id: $ref: '#/components/schemas/default_purchase_unit_conversion_id' item_type: $ref: '#/components/schemas/item_type' product_type: $ref: '#/components/schemas/product_type' can_be_sold: $ref: '#/components/schemas/can_be_sold' can_be_purchased: $ref: '#/components/schemas/can_be_purchased' track_inventory: $ref: '#/components/schemas/track_inventory' is_taxable: $ref: '#/components/schemas/is_taxable' tax_id: $ref: '#/components/schemas/tax_id' documents: $ref: '#/components/schemas/documents' description: $ref: '#/components/schemas/description' tax_name: $ref: '#/components/schemas/tax_name' tax_percentage: $ref: '#/components/schemas/tax_percentage' tax_type: $ref: '#/components/schemas/tax_type' purchase_account_id: $ref: '#/components/schemas/purchase_account_id' purchase_account_name: $ref: '#/components/schemas/purchase_account_name' account_name: $ref: '#/components/schemas/account_name' inventory_account_id: $ref: '#/components/schemas/inventory_account_id' attribute_id1: $ref: '#/components/schemas/attribute_id1' attribute_name1: $ref: '#/components/schemas/attribute_name1' status: $ref: '#/components/schemas/status' source: $ref: '#/components/schemas/source' rate: $ref: '#/components/schemas/rate' pricebook_rate: $ref: '#/components/schemas/pricebook_rate' purchase_rate: $ref: '#/components/schemas/purchase_rate' reorder_level: $ref: '#/components/schemas/reorder_level' vendor_id: $ref: '#/components/schemas/vendor_id' vendor_name: $ref: '#/components/schemas/vendor_name' locations: $ref: '#/components/schemas/locations' sku: $ref: '#/components/schemas/sku' upc: $ref: '#/components/schemas/upc' ean: $ref: '#/components/schemas/ean' isbn: $ref: '#/components/schemas/isbn' part_number: $ref: '#/components/schemas/part_number' attribute_option_id1: $ref: '#/components/schemas/attribute_option_id1' attribute_option_name1: $ref: '#/components/schemas/attribute_option_name1' image_id: $ref: '#/components/schemas/image_id' image_name: $ref: '#/components/schemas/image_name' purchase_description: $ref: '#/components/schemas/purchase_description' image_type: $ref: '#/components/schemas/image_type' item_tax_preferences: $ref: '#/components/schemas/item_tax_preferences' hsn_or_sac: $ref: '#/components/schemas/hsn_or_sac' sat_item_key_code: $ref: '#/components/schemas/sat_item_key_code' unitkey_code: $ref: '#/components/schemas/unitkey_code' custom_fields: $ref: '#/components/schemas/custom_fields' value: description: Value of the Custom Field type: string example: Normal unitkey_code: description: Add Unit Key Code for your goods/services. Download the CFDI Catalogs. type: string x-node_available_in: - mx x-node_unavailable_in: [] update-an-item-customfield-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: Custom Fields Updated Successfully readOnly: true tax_specification: description: Type of tax. It can be intra or inter type: string example: intra x-node_available_in: - in x-node_unavailable_in: [] inventory_account_id: description: Uniquq ID generated by the server for the Inventory account. type: string example: 4815000000035001 mark-as-inactive-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The item has been marked as Inactive. readOnly: true list-item-purchase-orders-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true purchaseorders: type: array items: type: object properties: purchaseorder_id: type: string vendor_name: type: string vendor_id: type: string status: type: string purchaseorder_number: type: string date: type: string item_quantity: type: number format: double unit: type: string currency_id: type: string currency_code: type: string currency_symbol: type: string item_price: type: number format: double item_total_price: type: number format: double status: description: Status of the Item Group. type: string example: active label: description: Label of the Custom Field type: string unit_group_name: description: Name of the unit group associated with the item. Applicable when unit conversion is enabled. type: string example: Weight hsn_or_sac: description: HSN Code of the item type: string example: 85423100 x-node_available_in: - in x-node_unavailable_in: [] location_actual_available_stock: description: Actual available stock in your location. type: string example: '' upload-item-images-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The item images have been uploaded. readOnly: true move-item-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The item has been moved. readOnly: true part_number: description: Part Number of the Item. type: string example: 111111111114 name: description: Name of the Item. type: string example: Bags-small tax_percentage: description: Percentage of the Tax type: number format: double example: 12 group-items-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The items have been grouped. readOnly: true enable-storage-location-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: Storage location has been enabled. readOnly: true is_primary: description: Mention whether the item is primary or not type: boolean example: false group-items-request: type: object description: Either group_name or group_id is required. Pass group_name to create a new group with up to 3 attributes and an items array, or pass group_id to associate the item with an existing group and map its attributes. properties: group_name: type: string description: Name of the new group to create. Required when creating a new group. group_id: type: string description: Unique identifier of an existing group. Required when associating the item with an existing group. unit: type: string description: Unit of measurement for the group. example: box attribute_name1: type: string description: Name of the first attribute (e.g., Size). example: at1 attribute_name2: type: string description: Name of the second attribute (e.g., Color). attribute_name3: type: string description: Name of the third attribute. items: type: array description: List of items to include in the group, each with their attribute option mappings. items: type: object properties: item_id: type: string description: Unique identifier of the item to group. example: '2975552000000327090' name: type: string description: Name of the item variant. sku: type: string description: SKU of the item. attribute_option_name1: type: string description: Option value for the first attribute for this item. attribute_option_name2: type: string description: Option value for the second attribute for this item. attribute_option_name3: type: string description: Option value for the third attribute for this item. attribute_option_data1: type: string description: Additional data for the first attribute option. attribute_option_data2: type: string description: Additional data for the second attribute option. attribute_option_data3: type: string description: Additional data for the third attribute option. locations: type: array description: List of locations. items: type: object properties: location_id: $ref: '#/components/schemas/location_id' location_name: $ref: '#/components/schemas/location_name' status: $ref: '#/components/schemas/status' is_primary: $ref: '#/components/schemas/is_primary' location_stock_on_hand: $ref: '#/components/schemas/location_stock_on_hand' location_available_stock: $ref: '#/components/schemas/location_available_stock' location_actual_available_stock: $ref: '#/components/schemas/location_actual_available_stock' location_id: description: Location ID type: string example: '460000000038080' upload-item-image-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The item image has been uploaded. readOnly: true description: description: Description of the Item. type: string example: description bulk-update-item-location-permissions-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: Location permissions have been updated. readOnly: true purchase_description: description: The description for the purchase information. This will be displayed to the vendor in your purchase order. type: string example: Purchase description reorder-item-images-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The item images have been reordered. readOnly: true last_modified_time: description: Last Modified time of the Transaction type: string example: '2013-01-24' reorder-item-images-request: required: - documents type: object properties: documents: type: array description: List of documents with their display order. items: type: object required: - document_id - order properties: document_id: type: string description: Unique identifier of the document (image). example: '2975552000000927087' order: type: integer description: Display order of the image. example: 1 sku: description: The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory. type: string example: SK123 track_inventory: description: Boolean to indicate whether inventory tracking is enabled for the item. type: boolean example: true bulk-delete-items-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The items have been deleted. readOnly: true validate-and-map-serial-numbers-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true validate-serial-numbers-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true list-item-putaways-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true putaways: type: array items: type: object properties: putaway_id: type: string putaway_number: type: string date: type: string warehouse_id: type: string warehouse_name: type: string location_id: type: string location_name: type: string item_quantity: type: number format: double update-item-location-permissions-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: Location permissions have been updated. readOnly: true disable-storage-location-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: Storage location has been disabled. readOnly: true bulk-mark-items-inactive-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The items have been marked as Inactive. readOnly: true image_id: description: Unique ID generated by the server for the item image. This is used as an identifier. type: string example: 2077500000000002000 initial_stock_rate: description: The opening stock value of the item. type: number format: double example: 500 initial_stock: description: The opening stock of the item. type: number format: double example: 50 is_taxable: description: Boolean to track the taxability of the item. type: boolean example: true default_sales_unit_conversion_id: description: Unique ID of the default sales unit conversion. Applicable when unit conversion is enabled. type: string example: '4815000000044400' unit_id: description: Unique ID of the unit associated with the item. type: string example: '4815000000044300' list-item-delivery-challans-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true deliverychallans: type: array items: type: object properties: deliverychallan_id: type: string customer_name: type: string customer_id: type: string status: type: string deliverychallan_number: type: string date: type: string item_quantity: type: number format: double unit: type: string currency_id: type: string currency_code: type: string currency_symbol: type: string item_price: type: number format: double item_total_price: type: number format: double update-variant-opening-stock-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The opening stock has been updated. readOnly: true unit: description: Unit of measurement for the item. type: string example: qty list-item-invoices-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true invoices: type: array items: type: object properties: invoice_id: type: string customer_name: type: string customer_id: type: string status: type: string invoice_number: type: string date: type: string item_quantity: type: number format: double unit: type: string currency_id: type: string currency_code: type: string currency_symbol: type: string item_price: type: number format: double item_total_price: type: number format: double image_type: description: Type of the image i.e., its file format. type: string example: jpg created_time: description: Created Time of the Transaction type: string example: '2013-01-24' update-variant-opening-stock-request: type: object description: The request body structure varies based on the item tracking configuration. When warehouse/location is not enabled, use top-level initial_stock, initial_stock_rate, serial_numbers, and batches. When warehouse/location is enabled, use the locations array with nested tracking details. These two modes are mutually exclusive — do not send top-level stock fields and locations together. properties: initial_stock: type: number format: double description: Opening stock quantity. Applicable only when warehouse/location is not enabled. Must not be sent when locations is provided. initial_stock_rate: type: number format: double description: Opening stock rate per unit. Applicable only when warehouse/location is not enabled. Must not be sent when locations is provided. serial_numbers: type: array description: List of serial numbers. Applicable only when the item is serial tracked and warehouse/location is not enabled. Must not be sent when locations is provided. items: type: string example: - SN001 - SN002 batches: type: array description: List of batches. Applicable only when the item is batch tracked and warehouse/location is not enabled. Must not be sent when locations is provided. Maximum 5000 batches per request. items: type: object properties: batch_number: type: string description: Batch number. quantity: type: number format: double description: Quantity in this batch. rate: type: number format: double description: Rate per unit for this batch. manufactured_date: type: string description: Manufactured date in yyyy-MM-dd format. expiry_date: type: string description: Expiry date in yyyy-MM-dd format. locations: type: array description: Location-level stock details. Applicable when warehouse/location is enabled. items: type: object properties: location_id: type: integer format: int64 description: Unique identifier of the location or warehouse. initial_stock: type: number format: double description: Opening stock quantity for this location. initial_stock_rate: type: number format: double description: Opening stock rate per unit for this location. serial_numbers: type: array description: List of serial numbers at the location level. Applicable when the item is serial tracked without bin/storage tracking. items: type: string storages: type: array description: Storage (bin) level details within this location. Applicable when the item has bin/storage tracking enabled. items: type: object properties: storage_location_id: type: string description: Unique identifier of the storage location (bin). quantity: type: number format: double description: Quantity in this storage. serial_numbers: type: array description: List of serial numbers within this storage. Applicable when the item is both bin and serial tracked. items: type: string batches: type: array description: Batch details at the location level. Applicable when the item is batch tracked. Maximum 5000 batches per request. items: type: object properties: batch_number: type: string description: Batch number. quantity: type: number format: double description: Quantity in this batch. rate: type: number format: double description: Rate per unit for this batch. manufactured_date: type: string description: Manufactured date in yyyy-MM-dd format. expiry_date: type: string description: Expiry date in yyyy-MM-dd format. storages: type: array description: Storage (bin) level details within this batch. Applicable when the item has both batch and bin/storage tracking enabled. items: type: object properties: storage_location_id: type: string description: Unique identifier of the storage location (bin). quantity: type: number format: double description: Quantity in this storage. create-an-item-request: required: - name type: object properties: group_id: $ref: '#/components/schemas/group_id' group_name: $ref: '#/components/schemas/group_name' unit: $ref: '#/components/schemas/unit' unit_id: $ref: '#/components/schemas/unit_id' unit_group_id: $ref: '#/components/schemas/unit_group_id' default_sales_unit_conversion_id: $ref: '#/components/schemas/default_sales_unit_conversion_id' default_purchase_unit_conversion_id: $ref: '#/components/schemas/default_purchase_unit_conversion_id' documents: $ref: '#/components/schemas/documents' item_type: $ref: '#/components/schemas/item_type' product_type: $ref: '#/components/schemas/product_type' can_be_sold: $ref: '#/components/schemas/can_be_sold' can_be_purchased: $ref: '#/components/schemas/can_be_purchased' track_inventory: $ref: '#/components/schemas/track_inventory' is_taxable: $ref: '#/components/schemas/is_taxable' tax_id: $ref: '#/components/schemas/tax_id' description: $ref: '#/components/schemas/description' purchase_account_id: $ref: '#/components/schemas/purchase_account_id' inventory_account_id: $ref: '#/components/schemas/inventory_account_id' attribute_name1: $ref: '#/components/schemas/attribute_name1' name: $ref: '#/components/schemas/name' rate: $ref: '#/components/schemas/rate' purchase_rate: $ref: '#/components/schemas/purchase_rate' reorder_level: $ref: '#/components/schemas/reorder_level' locations: type: array description: List of locations. items: type: object properties: location_id: $ref: '#/components/schemas/location_id' initial_stock: $ref: '#/components/schemas/initial_stock' initial_stock_rate: $ref: '#/components/schemas/initial_stock_rate' vendor_id: $ref: '#/components/schemas/vendor_id' vendor_name: $ref: '#/components/schemas/vendor_name' sku: $ref: '#/components/schemas/sku' upc: $ref: '#/components/schemas/upc' ean: $ref: '#/components/schemas/ean' isbn: $ref: '#/components/schemas/isbn' part_number: $ref: '#/components/schemas/part_number' attribute_option_name1: $ref: '#/components/schemas/attribute_option_name1' purchase_description: $ref: '#/components/schemas/purchase_description' item_tax_preferences: $ref: '#/components/schemas/item_tax_preferences' hsn_or_sac: $ref: '#/components/schemas/hsn_or_sac' sat_item_key_code: $ref: '#/components/schemas/sat_item_key_code' unitkey_code: $ref: '#/components/schemas/unitkey_code' custom_fields: $ref: '#/components/schemas/custom_fields' upc: description: The 12 digit Unique Product Code (UPC) of the item. type: integer format: int64 example: 111111111111 rate: description: Sales price of the Item. type: number format: double example: 6 product_type: description: Type of the product. It can be goods or service type: string example: goods reorder_level: description: Reorder level of the item. type: number format: double example: 5 tax_id: description: Unique ID generated by the server for the tax associated with the item. This is used a unique identifier. type: string example: 4815000000044043 delete-an-item-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The item has been deleted. readOnly: true is_linked_with_zohocrm: description: Denotes if the item is linked to Zoho CRM type: boolean example: false validate-and-map-serial-numbers-request: type: object properties: entity_id: type: string description: Unique identifier of the entity. warehouse_id: type: string description: Unique identifier of the warehouse. location_id: type: string description: Unique identifier of the location. entity_type: type: string description: Type of the entity. serial_numbers: type: array description: List of serial numbers to validate and map. items: type: string location_name: description: Name of the location type: string example: '' delete-item-back-image-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The back image has been deleted. readOnly: true location_stock_on_hand: description: Current available stock in your location. type: string example: '' attribute_id1: description: Unique ID used by the server. This is used as an identifier. type: string example: 4815000000044112 isbn: description: Unique ISBN value for the Item. type: string example: 111111111113 unit_group_id: description: Unique ID of the unit group associated with the item. Applicable when unit conversion is enabled. type: string example: '4815000000044350' pricebook_rate: description: Pricelist rate applied on the item. type: number format: double example: 6 retrieve-an-item-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true item: type: object properties: group_id: $ref: '#/components/schemas/group_id' group_name: $ref: '#/components/schemas/group_name' item_id: $ref: '#/components/schemas/item_id' name: $ref: '#/components/schemas/name' unit: $ref: '#/components/schemas/unit' unit_id: $ref: '#/components/schemas/unit_id' unit_group_id: $ref: '#/components/schemas/unit_group_id' unit_group_name: $ref: '#/components/schemas/unit_group_name' default_sales_unit_conversion_id: $ref: '#/components/schemas/default_sales_unit_conversion_id' default_purchase_unit_conversion_id: $ref: '#/components/schemas/default_purchase_unit_conversion_id' item_type: $ref: '#/components/schemas/item_type' product_type: $ref: '#/components/schemas/product_type' can_be_sold: $ref: '#/components/schemas/can_be_sold' can_be_purchased: $ref: '#/components/schemas/can_be_purchased' track_inventory: $ref: '#/components/schemas/track_inventory' is_taxable: $ref: '#/components/schemas/is_taxable' tax_id: $ref: '#/components/schemas/tax_id' description: $ref: '#/components/schemas/description' tax_name: $ref: '#/components/schemas/tax_name' tax_percentage: $ref: '#/components/schemas/tax_percentage' tax_type: $ref: '#/components/schemas/tax_type' purchase_account_id: $ref: '#/components/schemas/purchase_account_id' purchase_account_name: $ref: '#/components/schemas/purchase_account_name' account_name: $ref: '#/components/schemas/account_name' inventory_account_id: $ref: '#/components/schemas/inventory_account_id' attribute_id1: $ref: '#/components/schemas/attribute_id1' attribute_name1: $ref: '#/components/schemas/attribute_name1' status: $ref: '#/components/schemas/status' source: $ref: '#/components/schemas/source' rate: $ref: '#/components/schemas/rate' pricebook_rate: $ref: '#/components/schemas/pricebook_rate' purchase_rate: $ref: '#/components/schemas/purchase_rate' reorder_level: $ref: '#/components/schemas/reorder_level' vendor_id: $ref: '#/components/schemas/vendor_id' vendor_name: $ref: '#/components/schemas/vendor_name' locations: $ref: '#/components/schemas/locations' sku: $ref: '#/components/schemas/sku' upc: $ref: '#/components/schemas/upc' ean: $ref: '#/components/schemas/ean' isbn: $ref: '#/components/schemas/isbn' part_number: $ref: '#/components/schemas/part_number' attribute_option_id1: $ref: '#/components/schemas/attribute_option_id1' attribute_option_name1: $ref: '#/components/schemas/attribute_option_name1' image_id: $ref: '#/components/schemas/image_id' image_name: $ref: '#/components/schemas/image_name' purchase_description: $ref: '#/components/schemas/purchase_description' image_type: $ref: '#/components/schemas/image_type' item_tax_preferences: $ref: '#/components/schemas/item_tax_preferences' hsn_or_sac: $ref: '#/components/schemas/hsn_or_sac' sat_item_key_code: $ref: '#/components/schemas/sat_item_key_code' unitkey_code: $ref: '#/components/schemas/unitkey_code' custom_fields: $ref: '#/components/schemas/custom_fields' is_combo_product: type: boolean example: false purchase_account_name: description: Name of the Purchase Account type: string example: Cost of Goods Sold customfield_id: type: string description: Unique ID of the custom field. can_be_sold: description: Boolean to indicate whether the item can be sold. type: boolean example: true can_be_purchased: description: Boolean to indicate whether the item can be purchased. type: boolean example: true bulk-mark-items-active-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The items have been marked as Active. readOnly: true attribute_name1: description: Name of the attribute present in the Item Group. type: string example: Small image_name: description: Image name of the Item. type: string example: bag_s.jpg mark-image-as-back-image-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: The image has been marked as back image. readOnly: true attribute_option_id1: description: Unique ID generated by the server for the attribute's options. This is used as an identifier. type: string example: 4815000000044214 item_tax_preferences: type: array description: List of tax preferences of the item. items: type: object properties: tax_id: $ref: '#/components/schemas/tax_id' tax_specification: $ref: '#/components/schemas/tax_specification' x-node_available_in: - in x-node_unavailable_in: [] account_name: description: Name of the Sales Account. type: string example: Sales list-item-sales-receipts-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true sales_receipts: type: array items: type: object properties: receipt_id: type: string customer_name: type: string customer_id: type: string receipt_number: type: string date: type: string item_quantity: type: number format: double currency_id: type: string currency_code: type: string currency_symbol: type: string item_price: type: number format: double item_total_price: type: number format: double move-item-request: required: - group_id type: object properties: group_id: type: string description: Unique identifier of the destination group. example: '2975552000000525321' attribute_name1: type: string description: Name of the first attribute. Required if the destination group has attributes defined. example: Title attribute_option_name1: type: string description: Option value for the first attribute. example: asdfgh attribute_name2: type: string description: Name of the second attribute. Required if the destination group has a second attribute defined. attribute_option_name2: type: string description: Option value for the second attribute. attribute_name3: type: string description: Name of the third attribute. Required if the destination group has a third attribute defined. attribute_option_name3: type: string description: Option value for the third attribute. tax_type: description: Type of the Tax. type: string example: Service Tax source: description: The source of the Item Group. type: string list-item-sales-orders-response: type: object properties: code: type: integer example: 0 readOnly: true message: type: string example: success readOnly: true salesorders: type: array items: type: object properties: salesorder_id: type: string customer_name: type: string customer_id: type: string order_status: type: string salesorder_number: type: string date: type: string item_quantity: type: number format: double unit: type: string currency_id: type: string currency_code: type: string currency_symbol: type: string item_price: type: number format: double item_total_price: type: number format: double sales_channel: type: string tax_name: description: Name of the tax applied on the Item Group. type: string example: Sales vendor_id: description: Unique ID generated by the server for the Vendor. This is used as an identifier. type: string example: 4815000000044080 parameters: organization_id: name: organization_id description: ID of the organization in: query required: true schema: type: string example: '10234695' securitySchemes: Zoho_Auth: type: oauth2 flows: implicit: authorizationUrl: https://accounts.zoho.com/oauth/v2/auth scopes: ZohoInventory.items.CREATE: Create Items ZohoInventory.items.READ: Read Items ZohoInventory.items.UPDATE: Update Items ZohoInventory.items.DELETE: Delete Items