Read Megaventory products, stock, orders and partners; create clients, sales and purchase orders.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: create a NEW client, supplier or both in Megaventory (Insert only: an existing record is never updated, nothing is deleted). Creating the same name twice creates two records, so search with megaventory_list_clients_suppliers first. POST /SupplierClient/SupplierClientUpdate.
Company or person name.
Whether the record is a client, a supplier or both.
Tax / VAT id.
Optionally add one contact person.
Billing address, free text.
Shipping address, free text.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
WRITE: create a NEW client, supplier or both in Megaventory (Insert only: an existing record is never updated, nothing is deleted). Creating the same name twice creates two records, so search with megaventory_list_clients_suppliers first. POST /SupplierClient/SupplierClientUpdate.
| Argument | Type | Description |
|---|---|---|
| name* | string | Company or person name. |
| type* | string | Whether the record is a client, a supplier or both. |
| string | ||
| phone | string | |
| tax_id | string | Tax / VAT id. |
| comments | string | |
| contact_name | string | Optionally add one contact person. |
| contact_email | string | |
| contact_phone | string | |
| billing_address | string | Billing address, free text. |
| shipping_address | string | Shipping address, free text. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type",
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Company or person name."
},
"type": {
"enum": [
"Client",
"Supplier",
"Both"
],
"type": "string",
"description": "Whether the record is a client, a supplier or both."
},
"email": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"phone": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"tax_id": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Tax / VAT id."
},
"comments": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"contact_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Optionally add one contact person."
},
"contact_email": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"contact_phone": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"billing_address": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Billing address, free text."
},
"shipping_address": {
"type": "string",
"maxLength": 2000,
"minLength": 1,
"description": "Shipping address, free text."
}
}
}WRITE: create a NEW purchase order to an existing supplier in the PENDING status. A pending order is only a draft document: it is not verified or sent, nothing is received, invoiced or paid, and stock is not touched. Verifying and receiving happen in Megaventory, not through this server. POST /PurchaseOrder/PurchaseOrderUpdate.
| Argument | Type | Description |
|---|---|---|
| rows* | array | The order rows. |
| type_id | integer | Document type id of the purchase order (default 4, the standard Purchase Order type; see megaventory_list_document_types). |
| comments | string | |
| location_id | integer | Inventory location the goods are received into (megaventory_list_inventory_locations). |
| supplier_id* | integer | Supplier id (megaventory_list_clients_suppliers). |
| reference_no | string | Your own reference number. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"supplier_id",
"rows"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"sku",
"quantity"
],
"properties": {
"sku": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "SKU of an existing product (megaventory_list_products)."
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"unit_price": {
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "Unit price before tax and discount; omitted = the product's default price."
}
}
},
"maxItems": 100,
"minItems": 1,
"description": "The order rows."
},
"type_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Document type id of the purchase order (default 4, the standard Purchase Order type; see megaventory_list_document_types).",
"exclusiveMinimum": 0
},
"comments": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Inventory location the goods are received into (megaventory_list_inventory_locations).",
"exclusiveMinimum": 0
},
"supplier_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Supplier id (megaventory_list_clients_suppliers).",
"exclusiveMinimum": 0
},
"reference_no": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Your own reference number."
}
}
}WRITE: create a NEW sales order for an existing client in the PENDING status. A pending order is only a draft document: it is not verified, nothing is shipped, invoiced or paid, and stock is not touched. Verifying, shipping and invoicing happen in Megaventory, not through this server. POST /SalesOrder/SalesOrderUpdate.
| Argument | Type | Description |
|---|---|---|
| rows* | array | The order rows. |
| type_id | integer | Document type id of the sales order (default 3, the standard Sales Order type; see megaventory_list_document_types). |
| comments | string | |
| client_id* | integer | Client id (megaventory_list_clients_suppliers). |
| location_id | integer | Inventory location the order is served from (megaventory_list_inventory_locations). |
| reference_no | string | Your own reference number. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"client_id",
"rows"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"sku",
"quantity"
],
"properties": {
"sku": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "SKU of an existing product (megaventory_list_products)."
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"exclusiveMinimum": 0
},
"unit_price": {
"type": "number",
"maximum": 1000000000,
"minimum": 0,
"description": "Unit price before tax and discount; omitted = the product's default price."
}
}
},
"maxItems": 100,
"minItems": 1,
"description": "The order rows."
},
"type_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Document type id of the sales order (default 3, the standard Sales Order type; see megaventory_list_document_types).",
"exclusiveMinimum": 0
},
"comments": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"client_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Client id (megaventory_list_clients_suppliers).",
"exclusiveMinimum": 0
},
"location_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Inventory location the order is served from (megaventory_list_inventory_locations).",
"exclusiveMinimum": 0
},
"reference_no": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Your own reference number."
}
}
}The Megaventory user this API key belongs to (user name and whether they are an administrator). The key itself and the mobile PIN are never returned. POST /User/UserGet.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}The bill of materials (BOM) of a manufactured product: its raw materials (id, SKU, description, quantity per unit). POST /ProductBOM/ProductBOMGet.
| Argument | Type | Description |
|---|---|---|
| sku* | string | SKU of the finished product. |
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| category_id | integer | Restrict to products in this category. |
| include_referenced_objects | boolean | Also return the referenced product objects. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"sku"
],
"properties": {
"sku": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "SKU of the finished product."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"category_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Restrict to products in this category.",
"exclusiveMinimum": 0
},
"include_referenced_objects": {
"type": "boolean",
"description": "Also return the referenced product objects."
}
}
}Stock per product per inventory location: physical stock, on hand, on hold, not yet shipped (open sales orders), not yet received (open purchase orders / work orders) and the alert level. Filter by product ids, SKU, category, location or supplier, or show only products below their alert level. POST /InventoryLocationStock/InventoryLocationStockGet.
| Argument | Type | Description |
|---|---|---|
| sku | string | Only the product with exactly this SKU. |
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| search | string | Products whose description contains this text. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| product_ids | array | Only these product ids. |
| category_ids | array | Only products in these categories. |
| location_ids | array | Only these inventory locations (see megaventory_list_inventory_locations). |
List clients and suppliers (one record type in Megaventory): id, type, name, addresses, phone, email, tax id, currency, payment terms and contacts. Filter by type or words in the name. POST /SupplierClient/SupplierClientGet.
| Argument | Type | Description |
|---|---|---|
| type | string | Only clients, only suppliers, or records that are both. |
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| search | string | Records whose name contains this text. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| show_deleted | string | Whether to include deleted records (default: only undeleted). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"type": {
"enum": [
"Client",
"Supplier",
"Both"
],
"type": "string",
"description": "Only clients, only suppliers, or records that are both."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Records whose name contains this text."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"show_deleted": {
"enum": [
"showOnlyUndeleted",
"showOnlyDeleted",
"showAllDeletedAndUndeleted"
],
"type": "string",
"description": "Whether to include deleted records (default: only undeleted)."
}
}
}List the currencies of the account (code, description, exchange rate to the default currency, default flag). POST /Currency/CurrencyGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
}
}
}List the document types of the account (sales order, purchase order, shipment, invoice and so on) with their ids and abbreviations. POST /DocumentType/DocumentTypeGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| show_deleted | string | Whether to include deleted records (default: only undeleted). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"show_deleted": {
"enum": [
"showOnlyUndeleted",
"showOnlyDeleted",
"showAllDeletedAndUndeleted"
],
"type": "string",
"description": "Whether to include deleted records (default: only undeleted)."
}
}
}List transaction documents of any type: shipments, invoices, receipts, credit notes, returns, adjustments and so on, with totals and status. Narrow by document type ids (megaventory_list_document_types), document number or status. POST /Document/DocumentGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| status | string | Only documents in this status. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| document_no | string | Only the document with this number. |
| document_type_ids | array | Only documents of these type ids (built-in types have negative ids). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"status": {
"enum": [
"ValidStatus",
"Pending",
"ApprovalInProcess",
"Verified",
"PartiallyShipped",
"PartiallyShippedInvoiced",
"FullyShipped",
"PartiallyReceived",
"PartiallyReceivedInvoiced",
"FullyReceived",
"PartiallyInvoiced",
"FullyInvoiced",
"Closed",
"ClosedWO",
"Cancelled"
],
"type": "string",
"description": "Only documents in this status."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"document_no": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only the document with this number."
},
"document_type_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -1000000
},
"maxItems": 50,
"description": "Only documents of these type ids (built-in types have negative ids)."
}
}
}List inventory locations (warehouses, shops, transit): id, abbreviation, name, address. Use the ids for stock filters and order locations. POST /InventoryLocation/InventoryLocationGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| show_deleted | string | Whether to include deleted records (default: only undeleted). |
| include_transit | boolean | Also include transit locations. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"show_deleted": {
"enum": [
"showOnlyUndeleted",
"showOnlyDeleted",
"showAllDeletedAndUndeleted"
],
"type": "string",
"description": "Whether to include deleted records (default: only undeleted)."
},
"include_transit": {
"type": "boolean",
"description": "Also include transit locations."
}
}
}List product bundles (a bundle sells several products together). Filter by bundle id or SKU, or by a product the bundle includes. POST /Product/ProductBundleGetAll.
| Argument | Type | Description |
|---|---|---|
| bundle_ids | array | Only these bundle product ids. |
| bundle_skus | array | Only these bundle SKUs. |
| show_deleted | string | Whether to include deleted records (default: only undeleted). |
| included_product_ids | array | Bundles that include any of these product ids. |
| included_product_skus | array | Bundles that include any of these product SKUs. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"bundle_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only these bundle product ids."
},
"bundle_skus": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 100,
"description": "Only these bundle SKUs."
},
"show_deleted": {
"enum": [
"showOnlyUndeleted",
"showOnlyDeleted",
"showAllDeletedAndUndeleted"
],
"type": "string",
"description": "Whether to include deleted records (default: only undeleted)."
},
"included_product_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Bundles that include any of these product ids."
},
"included_product_skus": {
"type": "array",
"items": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"maxItems": 100,
"description": "Bundles that include any of these product SKUs."
}
}
}List product categories (id, name, description). Use the ids to filter products. POST /ProductCategory/ProductCategoryGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| search | string | Categories whose name contains this text. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| show_deleted | string | Whether to include deleted records (default: only undeleted). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Categories whose name contains this text."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"show_deleted": {
"enum": [
"showOnlyUndeleted",
"showOnlyDeleted",
"showAllDeletedAndUndeleted"
],
"type": "string",
"description": "Whether to include deleted records (default: only undeleted)."
}
}
}Which suppliers sell which products: supplier SKU, description and purchase price per product-supplier pair. POST /ProductSupplier/ProductSupplierGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| include_referenced_objects | boolean | Also return the product and supplier objects. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"include_referenced_objects": {
"type": "boolean",
"description": "Also return the product and supplier objects."
}
}
}Search the product catalog: SKU, description, category, prices (selling, purchase, unit cost), dimensions, main supplier, sellable/purchasable flags and more. Filter by id, exact SKU, category, main supplier or words in the description. Empty text fields are omitted. POST /Product/ProductGet.
| Argument | Type | Description |
|---|---|---|
| sku | string | Only the product with exactly this SKU. |
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| search | string | Products whose description contains this text. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| product_id | integer | Only the product with this id. |
| category_id | integer | Only products in this category (see megaventory_list_product_categories). |
| show_deleted | string | Whether to include deleted records (default: only undeleted). |
| main_supplier_id |
List purchase orders with supplier, dates, totals, status and the order rows (SKU, quantity, received/invoiced quantity, unit price). Filter by order number, status or supplier. POST /PurchaseOrder/PurchaseOrderGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| status | string | Only orders in this status (ValidStatus = every non-cancelled order). |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| order_no | string | Only the purchase order with this number. |
| supplier_id | integer | Only orders to this supplier. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"status": {
"enum": [
"ValidStatus",
"Pending",
"Verified",
"PartiallyReceived",
"PartiallyReceivedAndPartiallyInvoiced",
"FullyReceived",
"PartiallyInvoiced",
"FullyInvoiced",
"Closed",
"Cancelled"
],
"type": "string",
"description": "Only orders in this status (ValidStatus = every non-cancelled order)."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"order_no": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only the purchase order with this number."
},
"supplier_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only orders to this supplier.",
"exclusiveMinimum": 0
}
}
}List sales orders with client, dates, totals (subtotal, tax, discount, grand total), status and the order rows (SKU, quantity, shipped/invoiced quantity, unit price). Filter by order number or status. POST /SalesOrder/SalesOrderGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| status | string | Only orders in this status (ValidStatus = every non-cancelled order). |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| order_no | string | Only the sales order with this number. |
| client_id | integer | Only orders of this client. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"status": {
"enum": [
"ValidStatus",
"Pending",
"Verified",
"PartiallyShipped",
"PartiallyShippedAndPartiallyInvoiced",
"FullyShipped",
"PartiallyInvoiced",
"FullyInvoiced",
"Closed",
"Cancelled"
],
"type": "string",
"description": "Only orders in this status (ValidStatus = every non-cancelled order)."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"order_no": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only the sales order with this number."
},
"client_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only orders of this client.",
"exclusiveMinimum": 0
}
}
}List sales quotes with client, totals, status and rows. Filter by quote number or status. POST /SalesQuote/SalesQuoteGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| status | string | Only quotes in this status. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| quote_no | string | Only the quote with this number. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"status": {
"enum": [
"ValidStatus",
"Pending",
"Verified",
"Closed",
"Cancelled"
],
"type": "string",
"description": "Only quotes in this status."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"quote_no": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only the quote with this number."
}
}
}List the tax rates defined in the account (id, name, rate). POST /Tax/TaxGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| show_deleted | string | Whether to include deleted records (default: only undeleted). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"show_deleted": {
"enum": [
"showOnlyUndeleted",
"showOnlyDeleted",
"showAllDeletedAndUndeleted"
],
"type": "string",
"description": "Whether to include deleted records (default: only undeleted)."
}
}
}List work (production) orders: finished product, quantity, location, status, priority and the materials allocated. Filter by work order number or status. POST /WorkOrder/WorkOrderGet.
| Argument | Type | Description |
|---|---|---|
| limit | integer | How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging. |
| status | string | Only work orders in this status. |
| filters | array | Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive). |
| work_order_no | string | Only the work order with this number. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"status": {
"enum": [
"Pending",
"InProcess",
"InProcessPartiallyCompleted",
"Completed",
"Closed",
"Cancelled"
],
"type": "string",
"description": "Only work orders in this status."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"work_order_no": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only the work order with this number."
}
}
}| main_supplier_ids |
| array |
| Only products whose main supplier is one of these ids. |
| only_needing_reorder | boolean | Only products that need to be ordered (at or below their alert level). |
| only_positive_quantity | boolean | Only products with a positive quantity. |
| include_product_details | boolean | Also return the product objects. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sku": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only the product with exactly this SKU."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Products whose description contains this text."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"product_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only these product ids."
},
"category_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only products in these categories."
},
"location_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only these inventory locations (see megaventory_list_inventory_locations)."
},
"main_supplier_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 100,
"description": "Only products whose main supplier is one of these ids."
},
"only_needing_reorder": {
"type": "boolean",
"description": "Only products that need to be ordered (at or below their alert level)."
},
"only_positive_quantity": {
"type": "boolean",
"description": "Only products with a positive quantity."
},
"include_product_details": {
"type": "boolean",
"description": "Also return the product objects."
}
}
}| integer |
| Only products whose main supplier has this id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"sku": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only the product with exactly this SKU."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "How many records to return, 1-100 (default 25). Megaventory returns the newest records first (highest id) and has no page offset: narrow with filters instead of paging."
},
"search": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Products whose description contains this text."
},
"filters": {
"type": "array",
"items": {
"type": "object",
"required": [
"field",
"operator",
"value"
],
"properties": {
"field": {
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_]{0,79}$",
"description": "A field of the record, for example SalesOrderClientID or ProductSellingPrice."
},
"value": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"operator": {
"enum": [
"Equals",
"NotEquals",
"BeginsWith",
"EndsWith",
"Contains",
"GreaterThan",
"LessThan"
],
"type": "string"
}
}
},
"maxItems": 10,
"description": "Extra filters, all combined with AND. Field names are the property names shown in the results (case-insensitive)."
},
"product_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only the product with this id.",
"exclusiveMinimum": 0
},
"category_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only products in this category (see megaventory_list_product_categories).",
"exclusiveMinimum": 0
},
"show_deleted": {
"enum": [
"showOnlyUndeleted",
"showOnlyDeleted",
"showAllDeletedAndUndeleted"
],
"type": "string",
"description": "Whether to include deleted records (default: only undeleted)."
},
"main_supplier_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only products whose main supplier has this id.",
"exclusiveMinimum": 0
}
}
}