Servers Playground How we check Submit a server

Unleashed Software MCP by usefulapi

Working · 567 ms

io.usefulapi/unleashed-softwarev1.17.0 Domain verified

Check products, stock on hand, customers, orders, invoices and quotes, and create records.

Commerce

Source Website Registry entry

Try it

Call this server's tools from your browser. Nothing to install.

https://unleashed-software.usefulapi.io/mcp

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.

unleashed_create_customer

Create a new customer. CustomerCode must be unique and cannot be changed later. Unleashed: POST /Customers.

customerCodestring, required

Unique customer code (cannot be changed after creation).

customerNamestring, required

Customer name.

emailstring

Contact email.

taxableboolean

Whether sales to this customer are taxable.

websitestring

Website.

paymentTermstring

Payment term name as configured in Unleashed.

phoneNumberstring

Phone number.

currencyCodestring

Currency code, e.g. NZD. Defaults to the base currency.

gstVatNumberstring

GST/VAT number.

mobileNumberstring

Mobile number.

contactLastNamestring

Contact last name.

contactFirstNamestring

Contact first name.

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.

I understand, run it anyway

Unleashed Software MCP by usefulapi MCP server | mcptry

Tools (20)

unleashed_create_customer

Create a new customer. CustomerCode must be unique and cannot be changed later. Unleashed: POST /Customers.

destructive

Argument	Type	Description
email	string	Contact email.
taxable	boolean	Whether sales to this customer are taxable.
website	string	Website.
paymentTerm	string	Payment term name as configured in Unleashed.
phoneNumber	string	Phone number.
currencyCode	string	Currency code, e.g. NZD. Defaults to the base currency.
customerCode*	string	Unique customer code (cannot be changed after creation).
customerName*	string	Customer name.
gstVatNumber	string	GST/VAT number.
mobileNumber	string	Mobile number.
contactLastName	string	Contact last name.
contactFirstName	string	Contact first name.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customerCode",
    "customerName"
  ],
  "properties": {
    "email": {
      "type": "string",
      "description": "Contact email."
    },
    "taxable": {
      "type": "boolean",
      "description": "Whether sales to this customer are taxable."
    },
    "website": {
      "type": "string",
      "description": "Website."
    },
    "paymentTerm": {
      "type": "string",
      "description": "Payment term name as configured in Unleashed."
    },
    "phoneNumber": {
      "type": "string",
      "description": "Phone number."
    },
    "currencyCode": {
      "type": "string",
      "maxLength": 3,
      "minLength": 3,
      "description": "Currency code, e.g. NZD. Defaults to the base currency."
    },
    "customerCode": {
      "type": "string",
      "minLength": 1,
      "description": "Unique customer code (cannot be changed after creation)."
    },
    "customerName": {
      "type": "string",
      "minLength": 1,
      "description": "Customer name."
    },
    "gstVatNumber": {
      "type": "string",
      "description": "GST/VAT number."
    },
    "mobileNumber": {
      "type": "string",
      "description": "Mobile number."
    },
    "contactLastName": {
      "type": "string",
      "description": "Contact last name."
    },
    "contactFirstName": {
      "type": "string",
      "description": "Contact first name."
    }
  }
}

unleashed_create_product

Create a new product. ProductCode must be unique. Unleashed: POST /Products.

destructive

Argument	Type	Description
weight	number	Weight.
barcode	string	Barcode.
packSize	number	Pack size.
isSellable	boolean	Can be sold.
productCode*	string	Unique product code (SKU).
isPurchasable	boolean	Can be purchased.
defaultSellPrice	number	Default sell price.
maxStockAlertLevel	number	Overstock alert level.
minStockAlertLevel	number	Low-stock alert level.
productDescription*	string

unleashed_create_sales_order

Create a DRAFT sales order with status Parked (reserves no stock, posts nothing to accounting — a person places or completes it in Unleashed). Line totals, line tax, SubTotal, TaxTotal and Total are computed for you to satisfy Unleashed's validation (SubTotal = sum of line totals, TaxTotal = sum of line taxes, Total = SubTotal + TaxTotal). Unleashed: POST /SalesOrders.

destructive

Argument	Type	Description
lines*	array	At least one order line.
taxCode	string	Tax code as configured in Unleashed, e.g. GST.
taxRate*	number	Tax rate as a fraction, e.g. 0.15 for 15%.
comments	string	Order comments.
orderDate	string	Order date (YYYY-MM-DD). Default today.
orderNumber	string	Order number; generated by Unleashed if omitted.
currencyCode*	string	Order currency code, e.g. NZD.
customerCode*	string

unleashed_get_company

Fetch the Unleashed company these credentials belong to — name, base currency and default tax rate. A cheap way to confirm the API id, key and signature are right. Unleashed: GET /Companies.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

unleashed_get_customer

Fetch a single customer by Guid — contact details, addresses, currency, payment terms, credit limit. Unleashed: GET /Customers/{customerGuid}.

read-only

Argument	Type	Description
customerGuid*	string	The customer's Guid.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customerGuid"
  ],
  "properties": {
    "customerGuid": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "description": "The customer's Guid."
    }
  }
}

unleashed_get_product

Fetch a single product by Guid — prices, units, stock alert levels, group, brand, supplier. Unleashed: GET /Products/{productGuid}.

read-only

Argument	Type	Description
productGuid*	string	The product's Guid.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "productGuid"
  ],
  "properties": {
    "productGuid": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "description": "The product's Guid."
    }
  }
}

unleashed_get_product_stock

Stock on hand for one product — totals, or broken down per warehouse with allWarehouses=true. The direct answer to 'how many do we have and where?'. Unleashed: GET /StockOnHand/{productGuid}[/AllWarehouses].

read-only

Argument	Type	Description
asAtDate	string	Stock on hand as at this date (YYYY-MM-DD).
productGuid*	string	The product's Guid.
allWarehouses	boolean	Break the stock down per warehouse.
warehouseCode	string	Only this warehouse (ignored with allWarehouses).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "productGuid"
  ],
  "properties": {
    "asAtDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Stock on hand as at this date (YYYY-MM-DD)."
    },
    "productGuid": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "description": "The product's Guid."
    },
    "allWarehouses": {
      "type": "boolean",
      "description": "Break the stock down per warehouse."
    },
    "warehouseCode": {
      "type": "string",
      "description": "Only this warehouse (ignored with allWarehouses)."
    }
  }
}

unleashed_get_purchase_order

Fetch a single purchase order by Guid, with its lines, supplier and totals. Unleashed: GET /PurchaseOrders/{orderGuid}.

read-only

Argument	Type	Description
orderGuid*	string	The purchase order's Guid.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "orderGuid"
  ],
  "properties": {
    "orderGuid": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "description": "The purchase order's Guid."
    }
  }
}

unleashed_get_sales_order

Fetch a single sales order by Guid, with its lines, totals, customer and warehouse. Unleashed: GET /SalesOrders/{orderGuid}.

read-only

Argument	Type	Description
orderGuid*	string	The sales order's Guid.
serialBatch	boolean	Include serial and batch numbers on lines.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "orderGuid"
  ],
  "properties": {
    "orderGuid": {
      "type": "string",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "description": "The sales order's Guid."
    },
    "serialBatch": {
      "type": "boolean",
      "description": "Include serial and batch numbers on lines."
    }
  }
}

unleashed_list_customers

List customers, optionally filtered by code or name prefix, currency or modification date. Unleashed: GET /Customers/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
orderBy	string	Sort column.
currency	string	Only customers with exactly this currency code, e.g. NZD.
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.
customerCode	string	Only customers whose code starts with this.
customerName	string	Only customers whose name starts with this.
modifiedSince	string	Only records created or modified since this UTC date (YYYY-MM-DD).
includeObsolete	boolean	Include obsolete customers.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based). Default 1."
    },
    "orderBy": {
      "enum": [
        "LastModifiedOn",
        "CreatedOn",
        "CustomerCode"
      ],
      "type": "string",
      "description": "Sort column."
    },
    "currency": {
      "type": "string",
      "description": "Only customers with exactly this currency code, e.g. NZD."
    },
    "pageSize": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page, 1-1000. Unleashed default is 200."
    },
    "customerCode": {
      "type": "string",
      "description": "Only customers whose code starts with this."
    },
    "customerName": {
      "type": "string",
      "description": "Only customers whose name starts with this."
    },
    "modifiedSince": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD)."
    },
    "includeObsolete": {
      "type": "boolean",
      "description": "Include obsolete customers."
    }
  }
}

unleashed_list_invoices

List sales invoices, filtered by status, customer, invoice number, sales order number or date range. Unleashed: GET /Invoices/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
endDate	string	Invoices created before this date (YYYY-MM-DD).
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.
startDate	string	Invoices created after this date (YYYY-MM-DD).
orderNumber	string	Only invoices for this sales order number.
customerCode	string	Only invoices for this customer code.
invoiceNumber	string	Only the invoice with this number (overrides other filters).
invoiceStatus	string	Comma-separated statuses, e.g. Completed,Parked.
modifiedSince	string	Only records created or modified since this UTC date (YYYY-MM-DD).

unleashed_list_product_groups

List product groups (name, Guid, parent group) — the category tree products are filed under. Unleashed: GET /ProductGroups/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based). Default 1."
    },
    "pageSize": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page, 1-1000. Unleashed default is 200."
    }
  }
}

unleashed_list_products

List products, optionally searched by code/description or filtered by code prefix, group, brand, barcode or modification date. Unleashed: GET /Products/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
sort	string	Sort direction.
brief	boolean	Return a condensed summary per product.
orderBy	string	Sort column.
product	string	Search text matched against product code or description.
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.
productCode	string	Only products whose code starts with this.
productBrand	string	Only products of this brand.
productGroup	string	Only products in this product group (subgroups excluded).

unleashed_list_purchase_orders

List purchase orders, filtered by status, supplier, order number, warehouse or date range. Unleashed: GET /PurchaseOrders/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
endDate	string	Orders dated on/before this date (YYYY-MM-DD).
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.
startDate	string	Orders dated on/after this date (YYYY-MM-DD).
orderNumber	string	Only the purchase order with this number.
orderStatus	string	Comma-separated: Parked, Placed, Unapproved, Costed, Receipted, Complete, Deleted.
supplierCode	string	Only orders whose supplier code starts with this.
modifiedSince	string	Only records created or modified since this UTC date (YYYY-MM-DD).
warehouseCode	string

unleashed_list_sales_orders

List sales orders, filtered by status, customer, order number, warehouse or date range. Deleted orders are excluded unless asked for. Unleashed: GET /SalesOrders/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
endDate	string	Orders dated on/before this date (YYYY-MM-DD).
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.
startDate	string	Orders dated on/after this date (YYYY-MM-DD).
customerId	string	Only orders for these customer Guids (comma-separated).
orderNumber	string	Only the order with this number (overrides other filters).
orderStatus	string	Comma-separated statuses, e.g. Parked,Placed,Backordered,Completed.
serialBatch	boolean	Include serial and batch numbers on lines.
customerCode

unleashed_list_sales_quotes

List sales quotes, filtered by status, customer, quote number or date range. Unleashed: GET /SalesQuotes/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
endDate	string	Quotes created before this date (YYYY-MM-DD).
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.
startDate	string	Quotes created after this date (YYYY-MM-DD).
quoteNumber	string	Only the quote with this number (overrides other filters).
quoteStatus	string	Comma-separated statuses, e.g. Draft,Parked,Completed.
customerCode	string	Only quotes whose customer code starts with this.
modifiedSince	string	Only records created or modified since this UTC date (YYYY-MM-DD).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based). Default 1."
    },
    "endDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Quotes created before this date (YYYY-MM-DD)."
    },
    "pageSize": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page, 1-1000. Unleashed default is 200."
    },
    "startDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Quotes created after this date (YYYY-MM-DD)."
    },
    "quoteNumber": {
      "type": "string",
      "description": "Only the quote with this number (overrides other filters)."
    },
    "quoteStatus": {
      "type": "string",
      "description": "Comma-separated statuses, e.g. Draft,Parked,Completed."
    },
    "customerCode": {
      "type": "string",
      "description": "Only quotes whose customer code starts with this."
    },
    "modifiedSince": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD)."
    }
  }
}

unleashed_list_stock_adjustments

List stock adjustments (write-offs, recounts, corrections) with reason, status and lines, filtered by warehouse, product or date. Unleashed: GET /StockAdjustments/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.
productCode	string	Only adjustments touching this product code.
modifiedSince	string	Only records created or modified since this UTC date (YYYY-MM-DD).
warehouseCode	string	Only adjustments in this warehouse.
adjustmentDate	string	Adjustments since this date (YYYY-MM-DD).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based). Default 1."
    },
    "pageSize": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page, 1-1000. Unleashed default is 200."
    },
    "productCode": {
      "type": "string",
      "maxLength": 100,
      "description": "Only adjustments touching this product code."
    },
    "modifiedSince": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD)."
    },
    "warehouseCode": {
      "type": "string",
      "maxLength": 15,
      "description": "Only adjustments in this warehouse."
    },
    "adjustmentDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Adjustments since this date (YYYY-MM-DD)."
    }
  }
}

unleashed_list_stock_on_hand

List stock on hand per product — QtyOnHand, AllocatedQty, AvailableQty, OnPurchase, AvgCost — optionally for one warehouse or as at a past date. Unleashed: GET /StockOnHand/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
orderBy	string	Sort column (default productCode).
asAtDate	string	Stock on hand as at this date (YYYY-MM-DD).
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.
productId	string	Only these product Guids (comma-separated).
isAssembled	boolean	Include quantity that can be assembled via auto-assembly BOMs in AvailableQty.
modifiedSince	string	Only records created or modified since this UTC date (YYYY-MM-DD).
warehouseCode	string	Only stock in this warehouse code.
warehouseName

unleashed_list_suppliers

List suppliers, optionally filtered by code prefix, contact email prefix or modification date. Unleashed: GET /Suppliers/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.
contactEmail	string	Only suppliers whose contact email starts with this.
supplierCode	string	Only suppliers whose code starts with this.
modifiedSince	string	Only records created or modified since this UTC date (YYYY-MM-DD).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based). Default 1."
    },
    "pageSize": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page, 1-1000. Unleashed default is 200."
    },
    "contactEmail": {
      "type": "string",
      "description": "Only suppliers whose contact email starts with this."
    },
    "supplierCode": {
      "type": "string",
      "description": "Only suppliers whose code starts with this."
    },
    "modifiedSince": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD)."
    }
  }
}

unleashed_list_warehouses

List warehouses (code, name, default flag, address). Warehouse codes are what other tools filter by. Unleashed: GET /Warehouses/{page}.

read-only

Argument	Type	Description
page	integer	Page number (1-based). Default 1.
pageSize	integer	Records per page, 1-1000. Unleashed default is 200.
modifiedSince	string	Only records created or modified since this UTC date (YYYY-MM-DD).
warehouseCode	string	Only warehouses whose code starts with this.
warehouseName	string	Only warehouses whose name starts with this.
includeObsolete	boolean	Include obsolete warehouses.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based). Default 1."
    },
    "pageSize": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page, 1-1000. Unleashed default is 200."
    },
    "modifiedSince": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD)."
    },
    "warehouseCode": {
      "type": "string",
      "description": "Only warehouses whose code starts with this."
    },
    "warehouseName": {
      "type": "string",
      "description": "Only warehouses whose name starts with this."
    },
    "includeObsolete": {
      "type": "boolean",
      "description": "Include obsolete warehouses."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customerCode",
    "warehouseCode",
    "currencyCode",
    "taxRate",
    "lines"
  ],
  "properties": {
    "lines": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "productCode",
          "quantity",
          "unitPrice"
        ],
        "properties": {
          "quantity": {
            "type": "number",
            "description": "Order quantity.",
            "exclusiveMinimum": 0
          },
          "unitPrice": {
            "type": "number",
            "minimum": 0,
            "description": "Unit price, exclusive of tax."
          },
          "productCode": {
            "type": "string",
            "minLength": 1,
            "description": "The product's code."
          }
        }
      },
      "minItems": 1,
      "description": "At least one order line."
    },
    "taxCode": {
      "type": "string",
      "description": "Tax code as configured in Unleashed, e.g. GST."
    },
    "taxRate": {
      "type": "number",
      "maximum": 1,
      "minimum": 0,
      "description": "Tax rate as a fraction, e.g. 0.15 for 15%."
    },
    "comments": {
      "type": "string",
      "maxLength": 2048,
      "description": "Order comments."
    },
    "orderDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Order date (YYYY-MM-DD). Default today."
    },
    "orderNumber": {
      "type": "string",
      "description": "Order number; generated by Unleashed if omitted."
    },
    "currencyCode": {
      "type": "string",
      "maxLength": 3,
      "minLength": 3,
      "description": "Order currency code, e.g. NZD."
    },
    "customerCode": {
      "type": "string",
      "minLength": 1,
      "description": "The customer's code."
    },
    "exchangeRate": {
      "type": "number",
      "description": "Exchange rate to the base currency. Default 1.",
      "exclusiveMinimum": 0
    },
    "requiredDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Required date (YYYY-MM-DD)."
    },
    "warehouseCode": {
      "type": "string",
      "minLength": 1,
      "description": "The warehouse code to sell from."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based). Default 1."
    },
    "sort": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction."
    },
    "brief": {
      "type": "boolean",
      "description": "Return a condensed summary per product."
    },
    "orderBy": {
      "enum": [
        "LastModifiedOn",
        "CreatedOn",
        "ProductCode"
      ],
      "type": "string",
      "description": "Sort column."
    },
    "product": {
      "type": "string",
      "description": "Search text matched against product code or description."
    },
    "pageSize": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page, 1-1000. Unleashed default is 200."
    },
    "productCode": {
      "type": "string",
      "description": "Only products whose code starts with this."
    },
    "productBrand": {
      "type": "string",
      "description": "Only products of this brand."
    },
    "productGroup": {
      "type": "string",
      "description": "Only products in this product group (subgroups excluded)."
    },
    "modifiedSince": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD)."
    },
    "ProductBarcode": {
      "type": "string",
      "description": "Only the product with this barcode."
    },
    "includeObsolete": {
      "type": "boolean",
      "description": "Include obsolete (discontinued) products."
    },
    "excludeAssembled": {
      "type": "boolean",
      "description": "Omit assembled products."
    },
    "excludeComponents": {
      "type": "boolean",
      "description": "Omit component products."
    },
    "includeAttributes": {
      "type": "boolean",
      "description": "Include each product's attribute set."
    },
    "productDescription": {
      "type": "string",
      "description": "Only products whose description starts with this."
    }
  }
}

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based). Default 1."
    },
    "endDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Orders dated on/before this date (YYYY-MM-DD)."
    },
    "pageSize": {
      "type": "integer",
      "maximum": 1000,
      "minimum": 1,
      "description": "Records per page, 1-1000. Unleashed default is 200."
    },
    "startDate": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Orders dated on/after this date (YYYY-MM-DD)."
    },
    "customerId": {
      "type": "string",
      "description": "Only orders for these customer Guids (comma-separated)."
    },
    "orderNumber": {
      "type": "string",
      "description": "Only the order with this number (overrides other filters)."
    },
    "orderStatus": {
      "type": "string",
      "description": "Comma-separated statuses, e.g. Parked,Placed,Backordered,Completed."
    },
    "serialBatch": {
      "type": "boolean",
      "description": "Include serial and batch numbers on lines."
    },
    "customerCode": {
      "type": "string",
      "description": "Only orders whose customer code starts with this."
    },
    "modifiedSince": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Only records created or modified since this UTC date (YYYY-MM-DD)."
    },
    "warehouseCode": {
      "type": "string",
      "description": "Only orders from this warehouse."
    },
    "completedAfter": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Orders completed after this date (YYYY-MM-DD)."
    },
    "completedBefore": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T[\\d:.]+Z?)?$",
      "description": "Orders completed before this date (YYYY-MM-DD)."
    },
    "customOrderStatus": {
      "type": "string",
      "description": "A custom order status (overrides orderStatus)."
    }
  }
}