Linnworks MCP by usefulapi

List the stock locations (warehouses, fulfilment centres) of the Linnworks account: id, name, address, whether it is a fulfilment centre. Use the ids as location_id in other tools. GET /api/Inventory/GetStockLocations.

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

Search the product catalogue by SKU, title or barcode and return the items with their stock levels per location (and optionally pricing, suppliers, images, extended properties). An empty keyword lists items. POST /api/Stock/GetStockItemsFull.

{
  "type": "object",
  "properties": {
    "keyword": {
      "description": "Text to search for (SKU, title or barcode). Empty = list items.",
      "type": "string",
      "maxLength": 200
    },
    "search_in": {
      "description": "Fields to search (default: SKU, Title and Barcode).",
      "maxItems": 3,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "SKU",
          "Title",
          "Barcode"
        ]
      }
    },
    "include": {
      "description": "Extra data to load per item (default: StockLevels).",
      "maxItems": 9,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "StockLevels",
          "Pricing",
          "Supplier",
          "ShippingInformation",
          "ChannelTitle",
          "ChannelDescription",
          "ChannelPrice",
          "ExtendedProperties",
          "Images"
        ]
      }
    },
    "include_composite_parents": {
      "description": "Include composite (bundle) parent items (default true).",
      "type": "boolean"
    },
    "include_variation_parents": {
      "description": "Include variation parent items (default true).",
      "type": "boolean"
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "per_page": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One product by its stock item id: SKU (ItemNumber), title, barcode, quantities (in stock, in orders, due, available), prices, tax rate, category, dimensions and weight. GET /api/Inventory/GetInventoryItemById.

{
  "type": "object",
  "properties": {
    "stock_item_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "The stock item id (StockItemId) from linnworks_search_inventory."
    }
  },
  "required": [
    "stock_item_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The stock level of one product at every location: in stock, in open orders, due on purchase orders, available, minimum level, unit cost and when it last changed. GET /api/Stock/GetStockLevel.

{
  "type": "object",
  "properties": {
    "stock_item_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "The stock item id (StockItemId) from linnworks_search_inventory."
    }
  },
  "required": [
    "stock_item_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The stock-level change history of one product (date, new level, change quantity, value, note), newest data first as Linnworks returns it; optionally for a single location, otherwise combined. GET /api/Stock/GetItemChangesHistory.

{
  "type": "object",
  "properties": {
    "stock_item_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "The stock item id (StockItemId)."
    },
    "location_id": {
      "description": "Limit to one stock location (default: all locations combined).",
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "per_page": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "required": [
    "stock_item_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the product categories (id and name). GET /api/Inventory/GetCategories.

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

List the suppliers: id, name, contact, address, email, web page and currency. GET /api/Inventory/GetSuppliers.

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

Page through the open (not yet processed) orders of a fulfilment location, with general info (status, reference, source, received date), shipping, customer, totals and items. Narrow with text filters (reference, customer, SKU ...) and a received-date range. POST /api/Orders/GetOpenOrders.

{
  "type": "object",
  "properties": {
    "location_id": {
      "description": "Fulfilment location id from linnworks_list_stock_locations (default: the account's default location).",
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
    },
    "text_filters": {
      "description": "All filters must match.",
      "maxItems": 10,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "enum": [
              "GENERAL_INFO_ORDER_ID",
              "GENERAL_INFO_REFERENCE_NUMBER",
              "GENERAL_INFO_EXTERNAL_REFERENCE_NUMBER",
              "SHIPPING_INFORMATION_TRACKING_NUMBER",
              "CUSTOMER_ADDRESS_FULL_NAME",
              "CUSTOMER_ADDRESS_COMPANY",
              "CUSTOMER_ADDRESS_POSTCODE",
              "CUSTOMER_ADDRESS_TOWN",
              "CUSTOMER_EMAIL",
              "ITEMS_SKU",
              "ITEMS_TITLE"
            ],
            "description": "Order field to match."
          },
          "match": {
            "description": "How to match (default Contains).",
            "type": "string",
            "enum": [
              "Equal",
              "Contains",
              "StartWith",
              "EndsWith"
            ]
          },
          "text": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200,
            "description": "Text to match."
          }
        },
        "required": [
          "field",
          "text"
        ]
      }
    },
    "received_from": {
      "description": "Only orders received on or after this date.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
    },
    "received_to": {
      "description": "Only orders received on or before this date.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "per_page": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Full details of open orders by their ids (up to 50): general info, shipping, customer, totals, items, folders, notes, identifiers, extended properties and bin racks. Pass include to load only some of the optional parts. Only works for open orders. POST /api/OpenOrders/GetOpenOrdersDetails.

{
  "type": "object",
  "properties": {
    "order_ids": {
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
        "description": "A Linnworks id (GUID)."
      },
      "description": "Order ids (OrderId, a GUID) from linnworks_list_open_orders."
    },
    "include": {
      "description": "Limit the optional parts loaded (default: all of them).",
      "maxItems": 5,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "FOLDER",
          "NOTES",
          "IDENTIFIERS",
          "EXTENDEDPROPERTIES",
          "BINRACKS"
        ]
      }
    }
  },
  "required": [
    "order_ids"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

One order, open or processed, by its order id (a GUID): general info, shipping, customer, totals, items, notes. GET /api/Orders/GetOrderById.

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "The order id (OrderId / pkOrderId)."
    }
  },
  "required": [
    "order_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Find one order, open or processed, by its Linnworks order number (the integer shown in the order book). Returns an empty order when none matches. GET /api/Orders/GetOrderDetailsByNumOrderId.

{
  "type": "object",
  "properties": {
    "order_number": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 2147483647,
      "description": "The numeric Linnworks order number (NumOrderId)."
    }
  },
  "required": [
    "order_number"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Find orders by their channel reference number (for example an Amazon or eBay order number) or secondary reference. Returns at most 50 orders. GET /api/Orders/GetOrderDetailsByReferenceId.

{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "The reference number or secondary reference to look for."
    }
  },
  "required": [
    "reference"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Search processed (despatched) orders. Search by order number, tracking number, channel reference, customer name, email, postcode, address, SKU, source or sub-source, optionally within a date range (at most 3 months; a non-exact search covers only the last 3 months). POST /api/ProcessedOrders/SearchProcessedOrdersPaged.

{
  "type": "object",
  "properties": {
    "search_field": {
      "type": "string",
      "enum": [
        "nOrderId",
        "o.PostalTrackingNumber",
        "ReferenceNum",
        "CustomerName",
        "o.cEmailAddress",
        "o.cPostCode",
        "ShippingAddress",
        "SKU",
        "Source",
        "SubSource"
      ],
      "description": "What to search by: nOrderId (order number), o.PostalTrackingNumber, ReferenceNum, CustomerName, o.cEmailAddress, o.cPostCode, ShippingAddress, SKU (SKU or barcode), Source, SubSource."
    },
    "search_term": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "The text to search for."
    },
    "exact_match": {
      "description": "Exact match (default false: partial match over the last 3 months).",
      "type": "boolean"
    },
    "date_type": {
      "description": "Which date the range applies to (default ALLDATES = no range).",
      "type": "string",
      "enum": [
        "ALLDATES",
        "RECEIVED",
        "PROCESSED",
        "PAYMENTRECEIVED",
        "CANCELLED"
      ]
    },
    "date_from": {
      "description": "Start of the range (needs date_type other than ALLDATES).",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
    },
    "date_to": {
      "description": "End of the range.",
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d{1,3})?)?(Z|[+-]\\d{2}:\\d{2}))?$"
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "per_page": {
      "description": "Results per page, 1-200 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 200
    }
  },
  "required": [
    "search_field",
    "search_term"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

The notes on an order (text, internal or external, who wrote them and when). GET /api/Orders/GetOrderNotes.

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "The order id (OrderId / pkOrderId)."
    }
  },
  "required": [
    "order_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

List the postal (shipping) services with their courier vendor, tracking and weight requirements and linked channels. GET /api/PostalServices/GetPostalServices.

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

WRITE: set the stock level of one product (by SKU) at one location to an absolute quantity. This overwrites the current level and flows to the sales channels the item is listed on. Check the current level with linnworks_get_stock_levels first. POST /api/Stock/SetStockLevel.

{
  "type": "object",
  "properties": {
    "sku": {
      "type": "string",
      "minLength": 1,
      "maxLength": 150,
      "description": "The product SKU (ItemNumber)."
    },
    "location_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "The stock location id from linnworks_list_stock_locations."
    },
    "level": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000000,
      "description": "The new stock level (units, 0 or more)."
    }
  },
  "required": [
    "sku",
    "location_id",
    "level"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

WRITE: add a note to an order (open or processed). Internal notes are visible only inside Linnworks; external notes may be passed to the sales channel. Adds a new note each call (not idempotent). POST /api/Orders/AddOrdersNote.

{
  "type": "object",
  "properties": {
    "order_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "The order id (OrderId / pkOrderId)."
    },
    "note": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "The note text."
    },
    "internal": {
      "description": "Internal note (default true).",
      "type": "boolean"
    }
  },
  "required": [
    "order_id",
    "note"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}