linnworks_list_stock_locations
List stock locations
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.
Takes no parameters.
linnworks_search_inventory
Search inventory
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.
Parameterspageincludekeywordper_pagesearch_ininclude_composite_parentsinclude_variation_parents
linnworks_get_inventory_item
Get inventory item
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.
Parametersstock_item_idrequired
linnworks_get_stock_levels
Get stock levels
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.
Parametersstock_item_idrequired
linnworks_get_stock_history
Get stock change history
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.
Parameterspageper_pagelocation_idstock_item_idrequired
linnworks_list_categories
List categories
List the product categories (id and name). GET /api/Inventory/GetCategories.
Takes no parameters.
linnworks_list_suppliers
List suppliers
List the suppliers: id, name, contact, address, email, web page and currency. GET /api/Inventory/GetSuppliers.
Takes no parameters.
linnworks_list_open_orders
List open orders
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.
Parameterspageper_pagelocation_idreceived_totext_filtersreceived_from
linnworks_get_open_orders_details
Get open order details
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.
Parametersincludeorder_idsrequired
linnworks_get_order
Get order
One order, open or processed, by its order id (a GUID): general info, shipping, customer, totals, items, notes. GET /api/Orders/GetOrderById.
Parametersorder_idrequired
linnworks_find_order_by_number
Find order by order number
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.
Parametersorder_numberrequired
linnworks_find_orders_by_reference
Find orders by channel reference
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.
Parametersreferencerequired
linnworks_search_processed_orders
Search processed orders
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.
Parameterspagedate_toper_pagedate_fromdate_typeexact_matchsearch_termrequiredsearch_fieldrequired
linnworks_get_order_notes
Get order notes
The notes on an order (text, internal or external, who wrote them and when). GET /api/Orders/GetOrderNotes.
Parametersorder_idrequired
linnworks_list_postal_services
List postal services
List the postal (shipping) services with their courier vendor, tracking and weight requirements and linked channels. GET /api/PostalServices/GetPostalServices.
Takes no parameters.
linnworks_set_stock_level
Set stock level
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.
Parametersskurequiredlevelrequiredlocation_idrequired
linnworks_add_order_note
Add order note
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.
Parametersnoterequiredinternalorder_idrequired