Servers Playground How we check Add a server Log in

Cin7 Core MCP by usefulapi

Working · 2.2 s

io.usefulapi/cin7-corev1.10.0 Domain verified

Read Cin7 Core products, stock by location, sales, purchases, customers, suppliers and transfers.

Commerce

Source Website Registry entry

Maintain this server? Claim it

Try it

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

https://cin7-core.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.

cin7core_get_company Read-only

The Cin7 Core company these credentials belong to: company name, base currency, time zone, default weight/dimension units, lock date and tax calculation method. Good first call. GET /me.

This tool takes no arguments.

Cin7 Core MCP by usefulapi MCP server | mcptry

Tools (17)

cin7core_get_company

The Cin7 Core company these credentials belong to: company name, base currency, time zone, default weight/dimension units, lock date and tax calculation method. Good first call. GET /me.

read-only

No arguments.

Input schema (JSON)

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

cin7core_get_customer

One customer by id (including deprecated ones), optionally with its customer-specific product prices. GET /customer?ID=…

read-only

Argument	Type	Description
customer_id*	string	Customer id (GUID).
include_product_prices	boolean	Include customer-specific product prices.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "customer_id"
  ],
  "properties": {
    "customer_id": {
      "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": "Customer id (GUID)."
    },
    "include_product_prices": {
      "type": "boolean",
      "description": "Include customer-specific product prices."
    }
  }
}

cin7core_get_product

One product by id (including deprecated ones) with its full detail; optionally its bill of materials, suppliers, stock movements, attachments, reorder levels and customer-specific prices. GET /product?ID=…

read-only

Argument	Type	Description
product_id*	string	Product id (GUID, from cin7core_list_products).
include_bom	boolean	Include the bill of materials.
include_movements	boolean	Include stock movements.
include_suppliers	boolean	Include suppliers and supplier prices.
include_attachments	boolean	Include attachments (file names and download links).
include_custom_prices	boolean	Include customer-specific prices.
include_reorder_levels	boolean	Include reorder levels per location.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "product_id"
  ],
  "properties": {
    "product_id": {
      "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": "Product id (GUID, from cin7core_list_products)."
    },
    "include_bom": {
      "type": "boolean",
      "description": "Include the bill of materials."
    },
    "include_movements": {
      "type": "boolean",
      "description": "Include stock movements."
    },
    "include_suppliers": {
      "type": "boolean",
      "description": "Include suppliers and supplier prices."
    },
    "include_attachments": {
      "type": "boolean",
      "description": "Include attachments (file names and download links)."
    },
    "include_custom_prices": {
      "type": "boolean",
      "description": "Include customer-specific prices."
    },
    "include_reorder_levels": {
      "type": "boolean",
      "description": "Include reorder levels per location."
    }
  }
}

cin7core_get_purchase

One purchase by id (simple, advanced or service purchase): supplier, contact, addresses, terms, location, required-by date, note, order lines, stock received, put away, invoices, credit notes, payments and attachments. GET /advanced-purchase?ID=… (the vendor endpoint that serves every purchase type).

read-only

Argument	Type	Description
purchase_id*	string	Purchase id (GUID, the ID from cin7core_list_purchases).
combine_additional_charges	boolean	Show additional charges inside the line arrays.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "purchase_id"
  ],
  "properties": {
    "purchase_id": {
      "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": "Purchase id (GUID, the ID from cin7core_list_purchases)."
    },
    "combine_additional_charges": {
      "type": "boolean",
      "description": "Show additional charges inside the line arrays."
    }
  }
}

cin7core_get_sale

One sale by id with everything on it: customer, contact, addresses, terms, location, notes, quote, order lines, fulfilments (pick/pack/ship and tracking), invoices, credit notes, payments, attachments and inventory movements. GET /sale?ID=…

read-only

Argument	Type	Description
sale_id*	string	Sale id (GUID, the SaleID from cin7core_list_sales).
include_transactions	boolean	Include the related accounting transactions.
hide_inventory_movements	boolean	Leave out inventory movements (smaller reply).
combine_additional_charges	boolean	Show additional charges inside the line arrays.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "sale_id"
  ],
  "properties": {
    "sale_id": {
      "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": "Sale id (GUID, the SaleID from cin7core_list_sales)."
    },
    "include_transactions": {
      "type": "boolean",
      "description": "Include the related accounting transactions."
    },
    "hide_inventory_movements": {
      "type": "boolean",
      "description": "Leave out inventory movements (smaller reply)."
    },
    "combine_additional_charges": {
      "type": "boolean",
      "description": "Show additional charges inside the line arrays."
    }
  }
}

cin7core_get_stock_adjustment

One stock adjustment by task id with its lines (product, location, batch, quantity, unit cost) and transactions. GET /stockadjustment?TaskID=…

read-only

Argument	Type	Description
task_id*	string	Stock adjustment task id (GUID, from cin7core_list_stock_adjustments).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "task_id"
  ],
  "properties": {
    "task_id": {
      "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": "Stock adjustment task id (GUID, from cin7core_list_stock_adjustments)."
    }
  }
}

cin7core_get_stock_availability

Stock levels per product, location, bin and batch: on hand, allocated, available, on order, in transit, stock on hand value and next delivery date. Filter by product id, name (starts with), exact SKU, location name, batch/serial number or category. GET /ref/productavailability.

read-only

Argument	Type	Description
sku	string	Only the product with exactly this SKU.
name	string	Only products whose name starts with this.
page	integer	Page number (default 1).
batch	string	Only this batch or serial number.
limit	integer	Records per page, 1-100 (default 50).
category	string	Only products in this category (name).
location	string	Only stock in this location (exact location name, see cin7core_list_locations).
product_id	string	Only this product (GUID).

Input schema (JSON)

cin7core_get_stock_transfer

One stock transfer by task id with its lines (product, quantity, from/to bin, batch) and status. GET /stockTransfer?TaskID=…

read-only

Argument	Type	Description
task_id*	string	Stock transfer task id (GUID, from cin7core_list_stock_transfers).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "task_id"
  ],
  "properties": {
    "task_id": {
      "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": "Stock transfer task id (GUID, from cin7core_list_stock_transfers)."
    }
  }
}

cin7core_get_supplier

One supplier by id (including deprecated ones). GET /supplier?ID=…

read-only

Argument	Type	Description
supplier_id*	string	Supplier id (GUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "supplier_id"
  ],
  "properties": {
    "supplier_id": {
      "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": "Supplier id (GUID)."
    }
  }
}

cin7core_list_customers

List customers (active by default): id, name, display name, currency, payment term, tax rule, price tier, sales rep, location, credit limit and hold, status, addresses and contacts. Filter by name (starts with), contact name/email, or modification date. GET /customer.

read-only

Argument	Type	Description
name	string	Only customers whose name starts with this.
page	integer	Page number (default 1).
limit	integer	Records per page, 1-100 (default 50).
contact	string	Only customers with a contact whose name starts with this or whose email equals this.
modified_since	string	Only customers changed since this time. YYYY-MM-DD (UTC) or ISO 8601 date-time with zone.
include_deprecated	boolean	true = include deprecated customers.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only customers whose name starts with this."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records per page, 1-100 (default 50)."
    },
    "contact": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only customers with a contact whose name starts with this or whose email equals this."
    },
    "modified_since": {
      "type": "string",
      "maxLength": 40,
      "description": "Only customers changed since this time. YYYY-MM-DD (UTC) or ISO 8601 date-time with zone."
    },
    "include_deprecated": {
      "type": "boolean",
      "description": "true = include deprecated customers."
    }
  }
}

cin7core_list_locations

List stock locations (warehouses) with their id, name, default flag, address, bins and pick zones. Location names are what the stock-availability and sale/purchase tools use. GET /ref/location.

read-only

Argument	Type	Description
name	string	Only locations whose name starts with this.
page	integer	Page number (default 1).
limit	integer	Records per page, 1-100 (default 100).
deprecated_only	boolean	true = only deprecated locations.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only locations whose name starts with this."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records per page, 1-100 (default 100)."
    },
    "deprecated_only": {
      "type": "boolean",
      "description": "true = only deprecated locations."
    }
  }
}

cin7core_list_products

List products (active by default): id, SKU, name, category, brand, type (Stock/Service), costing method, unit of measure, barcode, price tiers, average cost, reorder settings, status and description. Filter by name or SKU (contains) or by modification date. GET /product.

read-only

Argument	Type	Description
sku	string	Only products whose SKU contains this.
name	string	Only products whose name contains this.
page	integer	Page number (default 1).
limit	integer	Records per page, 1-100 (default 25).
modified_since	string	Only products changed since this time. YYYY-MM-DD (UTC) or ISO 8601 date-time with zone.
include_suppliers	boolean	Include each product's suppliers and supplier prices.
include_deprecated	boolean	true = include deprecated products.
include_reorder_levels	boolean	Include reorder levels per location.

cin7core_list_purchases

List purchases (purchase orders) with order number, status, supplier, order/invoice/required-by dates, invoice and paid amounts, currencies, type (simple/advanced/service) and the order/receiving/invoice/payment statuses. GET /purchaseList.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
limit	integer	Records per page, 1-100 (default 50).
search	string	Text contained in the order number, status, supplier, invoice number or credit note number.
status	string	Overall purchase status.
required_by	string	Only purchases with a Required By date on or before this.
order_status	string	Purchase order status.
updated_since	string	Only purchases changed after this time.
updated_until	string	Only purchases changed before this time.
invoice_status

cin7core_list_sales

List sales (sale orders) with order number, status, customer, order/invoice dates, invoice and paid amounts, currencies, and the quote/order/pick/pack/ship/invoice/payment statuses. Search by order number, customer, invoice number or customer reference; filter by dates and statuses. GET /saleList.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
limit	integer	Records per page, 1-100 (default 50).
search	string	Text contained in the order number, status, customer, invoice number, customer reference or credit note number.
status	string	Overall sale status.
ship_by	string	Only sales with a Ship By date on or before this, not yet shipped.
external_id	string	Only sales with this External ID.
pack_status	string	Combined pack status.
pick_status	string	Combined pick status.
order_status

cin7core_list_stock_adjustments

List stock adjustments: task id, number, effective date, status, expense account, reference and comment. GET /stockadjustmentList.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
limit	integer	Records per page, 1-100 (default 50).
status	string	Only adjustments with this status.

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 (default 1)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records per page, 1-100 (default 50)."
    },
    "status": {
      "enum": [
        "DRAFT",
        "COMPLETED",
        "VOIDED"
      ],
      "type": "string",
      "description": "Only adjustments with this status."
    }
  }
}

cin7core_list_stock_transfers

List stock transfers between locations: task id, number, from/to location, status, departure and completion dates, reference. GET /stockTransferList.

read-only

Argument	Type	Description
page	integer	Page number (default 1).
limit	integer	Records per page, 1-100 (default 50).
search	string	Text contained in the from/to location, status, reference or number.
status	string	Only transfers with this status.

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 (default 1)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records per page, 1-100 (default 50)."
    },
    "search": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Text contained in the from/to location, status, reference or number."
    },
    "status": {
      "enum": [
        "DRAFT",
        "IN TRANSIT",
        "COMPLETED",
        "VOIDED"
      ],
      "type": "string",
      "description": "Only transfers with this status."
    }
  }
}

cin7core_list_suppliers

List suppliers (active by default): id, name, currency, payment term, tax rule, discount, status, addresses and contacts. Filter by name (starts with) or modification date. GET /supplier.

read-only

Argument	Type	Description
name	string	Only suppliers whose name starts with this.
page	integer	Page number (default 1).
limit	integer	Records per page, 1-100 (default 50).
modified_since	string	Only suppliers changed since this time. YYYY-MM-DD (UTC) or ISO 8601 date-time with zone.
include_deprecated	boolean	true = include deprecated suppliers.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only suppliers whose name starts with this."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records per page, 1-100 (default 50)."
    },
    "modified_since": {
      "type": "string",
      "maxLength": 40,
      "description": "Only suppliers changed since this time. YYYY-MM-DD (UTC) or ISO 8601 date-time with zone."
    },
    "include_deprecated": {
      "type": "boolean",
      "description": "true = include deprecated suppliers."
    }
  }
}

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sku": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only the product with exactly this SKU."
    },
    "name": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only products whose name starts with this."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "batch": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only this batch or serial number."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records per page, 1-100 (default 50)."
    },
    "category": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only products in this category (name)."
    },
    "location": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only stock in this location (exact location name, see cin7core_list_locations)."
    },
    "product_id": {
      "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": "Only this product (GUID)."
    }
  }
}

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sku": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only products whose SKU contains this."
    },
    "name": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only products whose name contains this."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (default 1)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records per page, 1-100 (default 25)."
    },
    "modified_since": {
      "type": "string",
      "maxLength": 40,
      "description": "Only products changed since this time. YYYY-MM-DD (UTC) or ISO 8601 date-time with zone."
    },
    "include_suppliers": {
      "type": "boolean",
      "description": "Include each product's suppliers and supplier prices."
    },
    "include_deprecated": {
      "type": "boolean",
      "description": "true = include deprecated products."
    },
    "include_reorder_levels": {
      "type": "boolean",
      "description": "Include reorder levels per location."
    }
  }
}

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 (default 1)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records per page, 1-100 (default 50)."
    },
    "search": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Text contained in the order number, status, supplier, invoice number or credit note number."
    },
    "status": {
      "enum": [
        "DRAFT",
        "VOIDED",
        "ORDERING",
        "ORDERED",
        "RECEIVING",
        "RECEIVED",
        "INVOICED",
        "CREDITED",
        "RECEIVING / CREDITED",
        "RECEIVED / CREDITED",
        "PARTIALLY INVOICED",
        "COMPLETED"
      ],
      "type": "string",
      "description": "Overall purchase status."
    },
    "required_by": {
      "type": "string",
      "maxLength": 40,
      "description": "Only purchases with a Required By date on or before this."
    },
    "order_status": {
      "enum": [
        "NOT AVAILABLE",
        "DRAFT",
        "AUTHORISED",
        "VOIDED"
      ],
      "type": "string",
      "description": "Purchase order status."
    },
    "updated_since": {
      "type": "string",
      "maxLength": 40,
      "description": "Only purchases changed after this time."
    },
    "updated_until": {
      "type": "string",
      "maxLength": 40,
      "description": "Only purchases changed before this time."
    },
    "invoice_status": {
      "enum": [
        "NOT AVAILABLE",
        "DRAFT",
        "AUTHORISED",
        "VOIDED",
        "PAID"
      ],
      "type": "string",
      "description": "Invoice status."
    },
    "unstock_status": {
      "enum": [
        "NOT AVAILABLE",
        "DRAFT",
        "AUTHORISED",
        "VOIDED"
      ],
      "type": "string",
      "description": "Unstock status."
    },
    "drop_ship_sale_id": {
      "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": "Only drop-ship purchases created by this sale (GUID)."
    },
    "credit_note_status": {
      "enum": [
        "NOT AVAILABLE",
        "DRAFT",
        "AUTHORISED",
        "VOIDED"
      ],
      "type": "string",
      "description": "Credit note status."
    },
    "stock_received_status": {
      "enum": [
        "NOT AVAILABLE",
        "DRAFT",
        "AUTHORISED",
        "VOIDED"
      ],
      "type": "string",
      "description": "Stock received (put away) status."
    }
  }
}

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 (default 1)."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Records per page, 1-100 (default 50)."
    },
    "search": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Text contained in the order number, status, customer, invoice number, customer reference or credit note number."
    },
    "status": {
      "enum": [
        "DRAFT",
        "VOIDED",
        "ESTIMATING",
        "ESTIMATED",
        "ORDERING",
        "ORDERED",
        "BACKORDERED",
        "PICKING",
        "PICKED",
        "PACKING",
        "PACKED",
        "SHIPPING",
        "INVOICING",
        "INVOICED",
        "CREDITED",
        "COMPLETED"
      ],
      "type": "string",
      "description": "Overall sale status."
    },
    "ship_by": {
      "type": "string",
      "maxLength": 40,
      "description": "Only sales with a Ship By date on or before this, not yet shipped."
    },
    "external_id": {
      "type": "string",
      "maxLength": 256,
      "minLength": 1,
      "description": "Only sales with this External ID."
    },
    "pack_status": {
      "enum": [
        "VOIDED",
        "NOT AVAILABLE",
        "PACKED",
        "PACKING",
        "NOT PACKED",
        "PARTIALLY PACKED"
      ],
      "type": "string",
      "description": "Combined pack status."
    },
    "pick_status": {
      "enum": [
        "VOIDED",
        "NOT AVAILABLE",
        "PICKED",
        "PICKING",
        "NOT PICKED",
        "PARTIALLY PICKED"
      ],
      "type": "string",
      "description": "Combined pick status."
    },
    "order_status": {
      "enum": [
        "NOT AVAILABLE",
        "DRAFT",
        "AUTHORISED",
        "VOIDED",
        "AUTH_NO_ALLOC",
        "FULFILLED",
        "CLOSED"
      ],
      "type": "string",
      "description": "Order status."
    },
    "quote_status": {
      "enum": [
        "NOT AVAILABLE",
        "DRAFT",
        "AUTHORISED",
        "VOIDED"
      ],
      "type": "string",
      "description": "Quote status."
    },
    "created_since": {
      "type": "string",
      "maxLength": 40,
      "description": "Only sales created after this time."
    },
    "updated_since": {
      "type": "string",
      "maxLength": 40,
      "description": "Only sales changed after this time."
    },
    "updated_until": {
      "type": "string",
      "maxLength": 40,
      "description": "Only sales changed before this time."
    },
    "invoice_status": {
      "enum": [
        "VOIDED",
        "DRAFT",
        "AUTHORISED",
        "NOT AVAILABLE",
        "PAID"
      ],
      "type": "string",
      "description": "Combined invoice status."
    },
    "shipping_status": {
      "enum": [
        "VOIDED",
        "NOT AVAILABLE",
        "SHIPPED",
        "SHIPPING",
        "NOT SHIPPED",
        "PARTIALLY SHIPPED"
      ],
      "type": "string",
      "description": "Combined shipping status."
    },
    "order_location_id": {
      "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": "Only sales from this order location (GUID)."
    },
    "credit_note_status": {
      "enum": [
        "NOT AVAILABLE",
        "DRAFT",
        "AUTHORISED",
        "VOIDED"
      ],
      "type": "string",
      "description": "Credit note status."
    },
    "ready_for_shipping": {
      "type": "boolean",
      "description": "true = only sales packed but not yet shipped."
    }
  }
}