Zoho Inventory · Schema
Replenishment
Replenishment helps you configure and manage stock replenishment for items.
Inventory ManagementWarehousingSales OrdersPurchase OrdersStock AdjustmentShipmentsItemsE-commerce
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Replenishment",
"description": "Replenishment helps you configure and manage stock replenishment for items.",
"definitions": {
"gendoc-attributes-schema": {
"$ref": "#/components/schemas/replenishment-configuration-response"
},
"replenishment-configuration-response": {
"type": "object",
"properties": {
"replenishment_configuration_id": {
"type": "string",
"description": "Unique ID generated by the server for the replenishment configuration. This is used as an identifier.",
"example": 4815000000045001
},
"item_id": {
"type": "string",
"description": "Unique ID generated by the server for the item.",
"example": 4815000000044208
},
"item_name": {
"type": "string",
"description": "Name of the item.",
"example": "HDMI Cable"
},
"unit": {
"type": "string",
"description": "Unit of measurement for the item.",
"example": "pcs"
},
"item_status": {
"type": "string",
"description": "Status of the item.",
"example": "active"
},
"location_id": {
"type": "string",
"description": "Unique ID generated by the server for the location.",
"example": 4815000000033001
},
"location_name": {
"type": "string",
"description": "Name of the location.",
"example": "New York"
},
"location_status": {
"type": "string",
"description": "Status of the location.",
"example": "active"
},
"status": {
"type": "string",
"description": "Status of the replenishment configuration. Allowed values: <code>active</code> and <code>paused</code>.",
"example": "active"
},
"pause_till_date": {
"type": "string",
"format": "date",
"description": "Date until which the replenishment configuration is paused.",
"example": "2026-05-01"
},
"type": {
"type": "string",
"description": "Mode in which replenishment tasks are generated. Allowed values: <code>auto</code> and <code>manual</code>.",
"example": "auto"
},
"order_type": {
"type": "string",
"description": "Type of order generated for the replenishment configuration. Allowed values: <code>purchase_order</code> and <code>transfer_order</code>.",
"example": "purchase_order"
},
"trigger": {
"type": "string",
"description": "Trigger that determines when an automatic replenishment task is generated.",
"example": "daily"
},
"trigger_frequency": {
"type": "string",
"description": "Frequency at which the replenishment task is triggered, expressed in the units specified by <code>trigger_frequency_period</code>.",
"example": "1"
},
"trigger_frequency_period": {
"type": "string",
"description": "Period for the trigger frequency. Allowed values: <code>day</code>, <code>week</code>, and <code>month</code>.",
"example": "day"
},
"reorder_level": {
"type": "number",
"format": "double",
"description": "Stock level at which a replenishment task is generated for the item.",
"example": 10
},
"max_stock_level": {
"type": "number",
"format": "double",
"description": "Maximum stock level to be maintained for the item at the location.",
"example": 50
},
"order_multiple": {
"type": "number",
"format": "double",
"description": "Quantity multiple to which the replenishment quantity is rounded off.",
"example": 5
},
"max_order_quantity": {
"type": "number",
"format": "double",
"description": "Maximum quantity that can be ordered in a single replenishment task.",
"example": 200
},
"min_order_quantity": {
"type": "number",
"format": "double",
"description": "Minimum quantity that must be ordered in a single replenishment task.",
"example": 1
},
"preferred_vendor_id": {
"type": "string",
"description": "Unique ID generated by the server for the preferred vendor.",
"example": 4815000000009901
},
"preferred_vendor_name": {
"type": "string",
"description": "Name of the preferred vendor.",
"example": "Zylker Supplies"
},
"preferred_vendor_status": {
"type": "string",
"description": "Status of the preferred vendor.",
"example": "active"
},
"preferred_location_id": {
"type": "string",
"description": "Unique ID generated by the server for the preferred source location from which stock is replenished.",
"example": 4815000000034001
},
"preferred_location_name": {
"type": "string",
"description": "Name of the preferred source location from which stock is replenished.",
"example": "Los Angeles"
},
"preferred_location_status": {
"type": "string",
"description": "Status of the preferred source location.",
"example": "active"
}
}
},
"replenishment-configuration-location-response": {
"type": "object",
"properties": {
"location_id": {
"type": "string",
"description": "Unique ID generated by the server for the location.",
"example": 4815000000033001
},
"location_name": {
"type": "string",
"description": "Name of the location.",
"example": "New York"
},
"replenishment_configuration": {
"description": "Replenishment configuration associated with the location.",
"$ref": "#/components/schemas/replenishment-configuration-response"
}
}
},
"replenishment-configurations-associated-response": {
"type": "object",
"properties": {
"item_id": {
"type": "string",
"description": "Unique ID generated by the server for the item.",
"example": 4815000000044208
},
"name": {
"type": "string",
"description": "Name of the item.",
"example": "HDMI Cable"
},
"sku": {
"type": "string",
"description": "Stock Keeping Unit (SKU) of the item.",
"example": "HDMI-001"
},
"vendor_id": {
"type": "string",
"description": "Unique ID generated by the server for the preferred vendor of the item.",
"example": 4815000000009901
},
"vendor_name": {
"type": "string",
"description": "Name of the preferred vendor of the item.",
"example": "Zylker Supplies"
},
"locations": {
"type": "array",
"description": "List of associated locations and their replenishment configurations for the item.",
"items": {
"$ref": "#/components/schemas/replenishment-configuration-location-response"
}
}
}
},
"replenishment-order-detail-response": {
"type": "object",
"properties": {
"order_id": {
"type": "string",
"description": "Unique ID generated by the server for the order created from the replenishment configuration.",
"example": 4815000000101001
},
"order_number": {
"type": "string",
"description": "Number of the order created from the replenishment configuration.",
"example": "PO-00001"
},
"order_date": {
"type": "string",
"format": "date",
"description": "Date of the order.",
"example": "2026-04-20"
},
"order_status": {
"type": "string",
"description": "Status of the order.",
"example": "draft"
},
"order_type": {
"type": "string",
"description": "Type of the order. Allowed values: <code>purchase_order</code> and <code>transfer_order</code>.",
"example": "purchase_order"
}
}
},
"replenishment-task-response": {
"type": "object",
"properties": {
"replenishment_task_id": {
"type": "string",
"description": "Unique ID generated by the server for the replenishment task. This is used as an identifier.",
"example": 4815000000099001
},
"entry_number": {
"type": "string",
"description": "Entry number of the replenishment task.",
"example": "RT-00001"
},
"item_id": {
"type": "string",
"description": "Unique ID generated by the server for the item.",
"example": 4815000000044208
},
"item_name": {
"type": "string",
"description": "Name of the item.",
"example": "HDMI Cable"
},
"item_status": {
"type": "string",
"description": "Status of the item.",
"example": "active"
},
"unit": {
"type": "string",
"description": "Unit of measurement for the item.",
"example": "pcs"
},
"location_id": {
"type": "string",
"description": "Unique ID generated by the server for the location.",
"example": 4815000000033001
},
"location_name": {
"type": "string",
"description": "Name of the location.",
"example": "New York"
},
"location_status": {
"type": "string",
"description": "Status of the location.",
"example": "active"
},
"reorder_level": {
"type": "number",
"format": "double",
"description": "Stock level at which the replenishment task was generated for the item.",
"example": 10
},
"max_stock_level": {
"type": "number",
"format": "double",
"description": "Maximum stock level configured for the item at the location.",
"example": 50
},
"stock_available_for_sale": {
"type": "number",
"format": "double",
"description": "Stock available for sale at the location when the replenishment task was generated.",
"example": 12
},
"stock_yet_to_be_received": {
"type": "number",
"format": "double",
"description": "Stock that has been ordered but is yet to be received at the location when the replenishment task was generated.",
"example": 0
},
"stock_in_transit": {
"type": "number",
"format": "double",
"description": "Stock that is in transit to the location when the replenishment task was generated.",
"example": 0
},
"total_available_stock": {
"type": "number",
"format": "double",
"description": "Total available stock for the item at the location when the replenishment task was generated.",
"example": 12
},
"quantity_to_replenish": {
"type": "number",
"format": "double",
"description": "Quantity that needs to be replenished for the item at the location.",
"example": 38
},
"task_status": {
"type": "string",
"description": "Status of the replenishment task. Allowed values: <code>pending</code>, <code>replenished</code>, <code>completed</code>, and <code>dismissed</code>.",
"example": "pending"
},
"sku": {
"type": "string",
"description": "Stock Keeping Unit (SKU) of the item.",
"example": "HDMI-001"
},
"order_multiple": {
"type": "number",
"format": "double",
"description": "Quantity multiple to which the replenishment quantity is rounded off.",
"example": 5
},
"max_order_quantity": {
"type": "number",
"format": "double",
"description": "Maximum quantity that can be ordered in a single replenishment task.",
"example": 200
},
"min_order_quantity": {
"type": "number",
"format": "double",
"description": "Minimum quantity that must be ordered in a single replenishment task.",
"example": 1
},
"order_type": {
"type": "string",
"description": "Type of order generated for the replenishment task. Allowed values: <code>purchase_order</code> and <code>transfer_order</code>.",
"example": "purchase_order"
},
"preferred_vendor_id": {
"type": "string",
"description": "Unique ID generated by the server for the preferred vendor.",
"example": 4815000000009901
},
"preferred_vendor_name": {
"type": "string",
"description": "Name of the preferred vendor.",
"example": "Zylker Supplies"
},
"preferred_vendor_status": {
"type": "string",
"description": "Status of the preferred vendor.",
"example": "active"
},
"source_location_id": {
"type": "string",
"description": "Unique ID generated by the server for the source location from which stock is replenished.",
"example": 4815000000034001
},
"source_location_name": {
"type": "string",
"description": "Name of the source location from which stock is replenished.",
"example": "Los Angeles"
},
"source_location_status": {
"type": "string",
"description": "Status of the source location.",
"example": "active"
},
"source_warehouse_id": {
"type": "string",
"description": "Unique ID generated by the server for the source warehouse from which stock is replenished. Applicable only when multi-warehouse is enabled for the organization.",
"example": 4815000000038001
},
"source_warehouse_name": {
"type": "string",
"description": "Name of the source warehouse from which stock is replenished. Applicable only when multi-warehouse is enabled for the organization.",
"example": "Los Angeles Warehouse"
},
"source_warehouse_status": {
"type": "string",
"description": "Status of the source warehouse. Applicable only when multi-warehouse is enabled for the organization.",
"example": "active"
},
"current_stock_available_for_sale": {
"type": "number",
"format": "double",
"description": "Current stock available for sale at the location.",
"example": 12
},
"current_stock_yet_to_be_received": {
"type": "number",
"format": "double",
"description": "Current stock that has been ordered but is yet to be received at the location.",
"example": 0
},
"current_stock_in_transit": {
"type": "number",
"format": "double",
"description": "Current stock that is in transit to the location.",
"example": 0
},
"stock_from_draft_replenishment_purchase_orders": {
"type": "number",
"format": "double",
"description": "Stock from draft replenishment purchase orders for the item at the location.",
"example": 0
},
"stock_from_draft_replenishment_transfer_orders": {
"type": "number",
"format": "double",
"description": "Stock from draft replenishment transfer orders for the item at the location.",
"example": 0
},
"is_stock_updated": {
"type": "boolean",
"description": "Indicates whether the stock figures shown for the task reflect the latest available values.",
"example": true
}
}
},
"comment-response": {
"type": "object",
"properties": {
"comment_id": {
"type": "string",
"description": "Unique ID generated by the server for the comment.",
"example": 4815000000001001
},
"description": {
"type": "string",
"description": "Description of the comment.",
"example": "Replenishment task created."
},
"commented_by_id": {
"type": "string",
"description": "Unique ID generated by the server for the user who added the comment.",
"example": 4815000000002001
},
"commented_by": {
"type": "string",
"description": "Name of the user who added the comment.",
"example": "Patricia Boyle"
},
"comment_type": {
"type": "string",
"description": "Type of the comment. Allowed values: <code>system</code> and <code>user</code>.",
"example": "system"
},
"date": {
"type": "string",
"description": "Date on which the comment was added.",
"example": "2026-04-20"
},
"date_with_time": {
"type": "string",
"description": "Date and time at which the comment was added.",
"example": "2026-04-20T10:30:00Z"
},
"date_description": {
"type": "string",
"description": "Human-readable description of when the comment was added.",
"example": "10:30 AM"
},
"time": {
"type": "string",
"description": "Time at which the comment was added.",
"example": "10:30 AM"
},
"operation_type": {
"type": "string",
"description": "Operation that triggered the comment.",
"example": "create"
}
}
},
"purchase-order-summary-response": {
"type": "object",
"properties": {
"purchase_order_id": {
"type": "string",
"description": "Unique ID generated by the server for the purchase order associated with the replenishment task.",
"example": 4815000000101001
},
"purchase_order_number": {
"type": "string",
"description": "Number of the purchase order.",
"example": "PO-00001"
},
"date": {
"type": "string",
"format": "date",
"description": "Date of the purchase order.",
"example": "2026-04-20"
},
"vendor_name": {
"type": "string",
"description": "Name of the vendor on the purchase order.",
"example": "Zylker Supplies"
},
"order_status": {
"type": "string",
"description": "Status of the purchase order.",
"example": "draft"
}
}
},
"transfer-order-summary-response": {
"type": "object",
"properties": {
"transfer_order_id": {
"type": "string",
"description": "Unique ID generated by the server for the transfer order associated with the replenishment task.",
"example": 4815000000102001
},
"transfer_order_number": {
"type": "string",
"description": "Number of the transfer order.",
"example": "TO-00001"
},
"date": {
"type": "string",
"format": "date",
"description": "Date of the transfer order.",
"example": "2026-04-20"
},
"to_location_name": {
"type": "string",
"description": "Name of the destination location to which stock is transferred.",
"example": "New York"
},
"from_location_name": {
"type": "string",
"description": "Name of the source location from which stock is transferred.",
"example": "Los Angeles"
},
"status": {
"type": "string",
"description": "Status of the transfer order.",
"example": "draft"
}
}
},
"replenishment-task-detail-response": {
"type": "object",
"properties": {
"replenishment_task_id": {
"type": "string",
"description": "Unique ID generated by the server for the replenishment task. This is used as an identifier.",
"example": 4815000000099001
},
"entry_number": {
"type": "string",
"description": "Entry number of the replenishment task.",
"example": "RT-00001"
},
"item_id": {
"type": "string",
"description": "Unique ID generated by the server for the item.",
"example": 4815000000044208
},
"item_name": {
"type": "string",
"description": "Name of the item.",
"example": "HDMI Cable"
},
"sku": {
"type": "string",
"description": "Stock Keeping Unit (SKU) of the item.",
"example": "HDMI-001"
},
"item_status": {
"type": "string",
"description": "Status of the item.",
"example": "active"
},
"unit": {
"type": "string",
"description": "Unit of measurement for the item.",
"example": "pcs"
},
"location_id": {
"type": "string",
"description": "Unique ID generated by the server for the location.",
"example": 4815000000033001
},
"location_name": {
"type": "string",
"description": "Name of the location.",
"example": "New York"
},
"location_status": {
"type": "string",
"description": "Status of the location.",
"example": "active"
},
"status": {
"type": "string",
"description": "Status of the replenishment task. Allowed values: <code>pending</code>, <code>replenished</code>, <code>completed</code>, and <code>dismissed</code>.",
"example": "pending"
},
"order_type": {
"type": "string",
"description": "Type of order generated for the replenishment task. Allowed values: <code>purchase_order</code> and <code>transfer_order</code>.",
"example": "purchase_order"
},
"reorder_level": {
"type": "number",
"format": "double",
"description": "Stock level at which the replenishment task was generated for the item.",
"example": 10
},
"max_stock_level": {
"type": "number",
"format": "double",
"description": "Maximum stock level configured for the item at the location.",
"example": 50
},
"order_multiple": {
"type": "number",
"format": "double",
"description": "Quantity multiple to which the replenishment quantity is rounded off.",
"example": 5
},
"max_order_quantity": {
"type": "number",
"format": "double",
"description": "Maximum quantity that can be ordered in a single replenishment task.",
"example": 200
},
"min_order_quantity": {
"type": "number",
"format": "double",
"description": "Minimum quantity that must be ordered in a single replenishment task.",
"example": 1
},
"preferred_vendor_id": {
"type": "string",
"description": "Unique ID generated by the server for the preferred vendor.",
"example": 4815000000009901
},
"preferred_vendor_name": {
"type": "string",
"description": "Name of the preferred vendor.",
"example": "Zylker Supplies"
},
"preferred_vendor_status": {
"type": "string",
"description": "Status of the preferred vendor.",
"example": "active"
},
"preferred_location_id": {
"type": "string",
"description": "Unique ID generated by the server for the preferred source location from which stock is replenished.",
"example": 4815000000034001
},
"preferred_location_name": {
"type": "string",
"description": "Name of the preferred source location from which stock is replenished.",
"example": "Los Angeles"
},
"preferred_location_status": {
"type": "string",
"description": "Status of the preferred source location.",
"example": "active"
},
"stock_available_for_sale": {
"type": "number",
"format": "double",
"description": "Stock available for sale at the location when the replenishment task was generated.",
"example": 12
},
"quantity_to_replenish": {
"type": "number",
"format": "double",
"description": "Quantity that needs to be replenished for the item at the location.",
"example": 38
},
"date": {
"type": "string",
"format": "date",
"description": "Date on which the replenishment task was created.",
"example": "2026-04-20"
},
"date_with_time": {
"type": "string",
"description": "Date and time at which the replenishment task was created.",
"example": "2026-04-20T10:30:00Z"
},
"comments": {
"type": "array",
"description": "List of comments associated with the replenishment task.",
"items": {
"$ref": "#/components/schemas/comment-response"
}
},
"purchase_orders": {
"type": "array",
"description": "List of purchase orders associated with the replenishment task.",
"items": {
"$ref": "#/components/schemas/purchase-order-summary-response"
}
},
"transfer_orders": {
"type": "array",
"description": "List of transfer orders associated with the replenishment task.",
"items": {
"$ref": "#/components/schemas/transfer-order-summary-response"
}
}
}
},
"replenishment-task-report-detail-response": {
"type": "object",
"properties": {
"entry_number": {
"type": "string",
"description": "Entry number of the replenishment task.",
"example": "RT-00001"
},
"item_id": {
"type": "string",
"description": "Unique ID generated by the server for the item.",
"example": 4815000000044208
},
"item_name": {
"type": "string",
"description": "Name of the item.",
"example": "HDMI Cable"
},
"sku": {
"type": "string",
"description": "Stock Keeping Unit (SKU) of the item.",
"example": "HDMI-001"
},
"warehouse_id": {
"type": "string",
"description": "Unique ID generated by the server for the warehouse at which the replenishment task is recorded. Applicable only when multi-warehouse is enabled for the organization.",
"example": 4815000000037001
},
"warehouse": {
"type": "string",
"description": "Name of the warehouse at which the replenishment task is recorded. Applicable only when multi-warehouse is enabled for the organization.",
"example": "New York Warehouse"
},
"location_id": {
"type": "string",
"description": "Unique ID generated by the server for the location at which the replenishment task is recorded.",
"example": 4815000000033001
},
"location": {
"type": "string",
"description": "Name of the location at which the replenishment task is recorded.",
"example": "New York"
},
"status": {
"type": "string",
"description": "Status of the replenishment task. Allowed values: <code>pending</code>, <code>replenished</code>, <code>completed</code>, and <code>dismissed</code>.",
"example": "pending"
},
"order_type": {
"type": "string",
"description": "Type of order generated for the replenishment task. Allowed values: <code>purchase_order</code> and <code>transfer_order</code>.",
"example": "purchase_order"
},
"reorder_level": {
"type": "number",
"format": "double",
"description": "Stock level at which the replenishment task was generated for the item.",
"example": 10
},
"max_stock_level": {
"type": "number",
"format": "double",
"description": "Maximum stock level configured for the item at the location.",
"example": 50
},
"order_multiple": {
"type": "number",
"format": "double",
"description": "Quantity multiple to which the replenishment quantity is rounded off.",
"example": 5
},
"max_order_quantity": {
"type": "number",
"format": "double",
"description": "Maximum quantity that can be ordered in a single replenishment task.",
"example": 200
},
"min_order_quantity": {
"type": "number",
"format": "double",
"description": "Minimum quantity that must be ordered in a single replenishment task.",
"example": 1
},
"preferred_vendor_id": {
"type": "string",
"description": "Unique ID generated by the server for the preferred vendor.",
"example": 4815000000009901
},
"preferred_vendor_name": {
"type": "string",
"description": "Name of the preferred vendor.",
"example": "Zylker Supplies"
},
"source_warehouse_id": {
"type": "string",
"description": "Unique ID generated by the server for the source warehouse from which stock is replenished. Applicable only when multi-warehouse is enabled for the organization.",
"example": 4815000000038001
},
"source_warehouse_name": {
"type": "string",
"description": "Name of the source warehouse from which stock is replenished. Applicable only when multi-warehouse is enabled for the organization.",
"example": "Los Angeles Warehouse"
},
"source_location_id": {
"type": "string",
"description": "Unique ID generated by the server for the source location from which stock is replenished.",
"example": 4815000000034001
},
"source_location_name": {
"type": "string",
"description": "Name of the source location from which stock is replenished.",
"example": "Los Angeles"
},
"stock_available_for_sale": {
"type": "number",
"format": "double",
"description": "Stock available for sale at the location when the replenishment task was generated.",
"example": 12
},
"quantity_to_replenish": {
"type": "number",
"format": "double",
"description": "Quantity that needs to be replenished for the item at the location.",
"example": 38
},
"created_time": {
"type": "string",
"format": "date",
"description": "Date on which the replenishment task was created.",
"example": "2026-04-20"
},
"last_modified_time": {
"type": "string",
"format": "date",
"description": "Date on which the replenishment task was last modified.",
"example": "2026-04-20"
}
}
},
"create-a-replenishment-configuration-request": {
"type": "object",
"properties": {
"replenishment_configuration_id": {
"type": "string",
"description": "Unique ID of the replenishment configuration. Provide this to update an existing replenishment configuration for the item and location combination.",
"example": 4815000000045001
},
"item_id": {
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-inventory/refs/heads/main/json-schema/replenishment.json