{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Items", "description": "An item is the product that is offered for sale. Nature of the product could be physical or digital. Based on the type of your business, you can offer one or more goods/services. Your product can be either fixed priced or a subscription service. Each of this may fall under a separate pricing category or have add ons associated to them.", "definitions": { "gendoc-attributes-schema": { "$ref": "#/components/schemas/item-response" }, "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" } } }, "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 }, "group_name": { "description": "Name of product group", "type": "string", "example": "Bags" }, "unit": { "description": "Unit of measurement for the item.", "type": "string", "example": "qty" }, "unit_id": { "description": "Unique ID of the unit associated with the item.", "type": "string", "example": "4815000000044300" }, "unit_group_id": { "description": "Unique ID of the unit group associated with the item. Applicable when unit conversion is enabled.", "type": "string", "example": "4815000000044350" }, "unit_group_name": { "description": "Name of the unit group associated with the item. Applicable when unit conversion is enabled.", "type": "string", "example": "Weight" }, "default_sales_unit_conversion_id": { "description": "Unique ID of the default sales unit conversion. Applicable when unit conversion is enabled.", "type": "string", "example": "4815000000044400" }, "default_purchase_unit_conversion_id": { "description": "Unique ID of the default purchase unit conversion. Applicable when unit conversion is enabled.", "type": "string", "example": "4815000000044410" }, "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" }, "is_taxable": { "description": "Boolean to track the taxability of the item.", "type": "boolean", "example": true }, "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 }, "track_inventory": { "description": "Boolean to indicate whether inventory tracking is enabled for the item.", "type": "boolean", "example": true }, "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 }, "description": { "description": "Description of the Item.", "type": "string", "example": "description" }, "tax_name": { "description": "Name of the tax applied on the Item Group.", "type": "string", "example": "Sales" }, "tax_percentage": { "description": "Percentage of the Tax", "type": "number", "format": "double", "example": 12 }, "tax_type": { "description": "Type of the Tax.", "type": "string", "example": "Service Tax" }, "purchase_account_id": { "description": "Unique ID generated by the server for the Purchase account.", "type": "string", "example": 4815000000035003 }, "purchase_account_name": { "description": "Name of the Purchase Account", "type": "string", "example": "Cost of Goods Sold" }, "account_id": { "description": "Unique ID generated by the server for the Sales account.", "type": "string", "example": 4815000000000388 }, "account_name": { "description": "Name of the Sales Account.", "type": "string", "example": "Sales" }, "inventory_account_id": { "description": "Uniquq ID generated by the server for the Inventory account.", "type": "string", "example": 4815000000035001 }, "attribute_id1": { "description": "Unique ID used by the server. This is used as an identifier.", "type": "string", "example": 4815000000044112 }, "attribute_name1": { "description": "Name of the attribute present in the Item Group.", "type": "string", "example": "Small" }, "status": { "description": "Status of the Item Group.", "type": "string", "example": "active" }, "source": { "description": "The source of the Item Group.", "type": "string" }, "item_id": { "description": "Unique ID generated by the server for the Item. This is used as an identifier.", "type": "string", "example": 4815000000044208 }, "name": { "description": "Name of the Item.", "type": "string", "example": "Bags-small" }, "rate": { "description": "Sales price of the Item.", "type": "number", "format": "double", "example": 6 }, "pricebook_rate": { "description": "Pricelist rate applied on the item.", "type": "number", "format": "double", "example": 6 }, "purchase_rate": { "description": "Purchase price of the Item.", "type": "number", "format": "double", "example": 6 }, "reorder_level": { "description": "Reorder level of the item.", "type": "number", "format": "double", "example": 5 }, "initial_stock": { "description": "The opening stock of the item.", "type": "number", "format": "double", "example": 50 }, "initial_stock_rate": { "description": "The opening stock value of the item.", "type": "number", "format": "double", "example": 500 }, "vendor_id": { "description": "Unique ID generated by the server for the Vendor. This is used as an identifier.", "type": "string", "example": 4815000000044080 }, "vendor_name": { "description": "Name of the preferred Vendor for purchasing this item.", "type": "string", "example": "Molly" }, "stock_on_hand": { "description": "Stock available for a particular item.", "type": "number", "format": "double", "example": 50 }, "sku": { "description": "The Stock Keeeping Unit (SKU) of an item. This is unique for every item in the Inventory.", "type": "string", "example": "SK123" }, "upc": { "description": "The 12 digit Unique Product Code (UPC) of the item.", "type": "integer", "format": "int64", "example": 111111111111 }, "ean": { "description": "Unique EAN value for the Item.", "type": "integer", "format": "int64", "example": 111111111112 }, "isbn": { "description": "Unique ISBN value for the Item.", "type": "string", "example": 111111111113 }, "part_number": { "description": "Part Number of the Item.", "type": "string", "example": 111111111114 }, "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 }, "attribute_option_name1": { "description": "Name of the attribute's option.", "type": "string", "example": "Small" }, "image_id": { "description": "Unique ID generated by the server for the item image. This is used as an identifier.", "type": "string", "example": 2077500000000002000 }, "image_name": { "description": "Image name of the Item.", "type": "string", "example": "bag_s.jpg" }, "image_type": { "description": "Type of the image i.e., its file format.", "type": "string", "example": "jpg" }, "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" }, "is_combo_product": { "type": "boolean", "example": false }, "product_type": { "description": "Type of the product. It can be goods or service", "type": "string", "example": "goods" }, "is_linked_with_zohocrm": { "description": "Denotes if the item is linked to Zoho CRM", "type": "boolean", "example": false }, "actual_available_stock": { "description": "Stock based on Shipments and Receives minus ordered stock", "type": "number", "format": "decimal", "example": 2 }, "available_stock": { "description": "Stock based on Shipments and Receives", "type": "number", "format": "decimal", "example": 2 }, "location_id": { "description": "Location ID", "type": "string", "example": "460000000038080" }, "location_name": { "description": "Name of the location", "type": "string", "example": "" }, "is_primary": { "description": "Mention whether the item is primary or not", "type": "boolean", "example": false }, "location_stock_on_hand": { "description": "Current available stock in your location.", "type": "string", "example": "" }, "location_available_stock": { "description": "Available stock in your location.", "type": "string", "example": "" }, "location_actual_available_stock": { "description": "Actual available stock in your location.", "type": "string", "example": "" }, "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" } } } }, "created_time": { "description": "Created Time of the Transaction", "type": "string", "example": "2013-01-24" }, "last_modified_time": { "description": "Last Modified time of the Transaction", "type": "string", "example": "2013-01-24" }, "documents": { "description": "List of all the documents associated with the item", "type": "array", "items": { "type": "string" } }, "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": [] }, "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": [] }, "hsn_or_sac": { "description": "HSN Code of the item", "type": "string", "example": 85423100, "x-node_available_in": [ "in" ], "x-node_unavailable_in": [] }, "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": [] }, "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": [] }, "customfield_id": { "type": "string", "description": "Unique ID of the custom field." }, "label": { "description": "Label of the Custom Field", "type": "string" }, "value": { "description": "Value of the Custom Field", "type": "string", "example": "Normal" }, "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" } } } }, "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 } } }, "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" } } }, "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" } } }, "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" } } } } } }, "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" } } } } }, "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" } } }, "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-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The item has been deleted.", "readOnly": true } } }, "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 } } }, "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 } } }, "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 } } }, "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 \u2014 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." } } } } } } } } } } } }, "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" } } } } } } } }, "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 } } }, "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 } } }, "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 } } }, "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 } } } } } }, "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 } } }, "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 } } }, "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 } } }, "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 } } }, "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 } } }, "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 } } }, "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 } } }, "ungroup-items-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The items have been ungrouped.", "readOnly": 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 } } }, "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 } } }, "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 } } }, "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." } } }, "move-item-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The item has been moved.", "readOnly": true } } }, "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." } } } } } }, "group-items-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "The items have been grouped.", "readOnly": true } } }, "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 } } }, "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 } } }, "validate-serial-numbers-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "success", "readOnly": true } } }, "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" } } } }, "validate-and-map-serial-numbers-response": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "readOnly": true }, "message": { "type": "string", "example": "success", "readOnly": true } } }, "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" } } } } } }, "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" } } } } } }, "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" } } } } } }, "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" } } } } } }, "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" } } } } } }, "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" } } } } } }, "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" } } } } } } } }