Linnworks
API integration

get_auth_get_application_profile_by_secret_key_by_id

Get the current linnworks application subscription profile for a specific user, typically after AuthorizeByApplication returned a session. Returns: PlanTag, PlanName, ActivationDate, LastPaymentDate, NextPaymentDate, ProfileExpires, IsProfileActive. Requires applicationId, applicationSecret, and userId (the session's Id). Returns null when the user has no current subscription.

create_a_linnworks_auth_authorize_by_application

Create a Linnworks session for an installed application, exchanging the developer-portal credentials for an authorization token and server. Returns: Id, EntityId, DatabaseName, DatabaseServer, PrivateDatabaseServer, DatabaseUser, DatabasePassword, AppName, sid_registration, UserName, Md5Hash, Locality, SuperAdmin, TTL, Token, AccessToken, GroupName, Device, DeviceType, UserType, Status, UserId,…

list_all_linnworks_dashboards_get_low_stock_levels

Get the "Low stock in location" report from Linnworks dashboards. Returns low stock rows including ItemTitle, ItemNumber, Quantity, MinimumLevel, InBooks, and Location.

list_all_linnworks_dashboards_get_performance_table_datas

Get the linnworks Performance table report data. Returns an array of report entries with Name, Price, and Currency.

list_all_linnworks_dashboards_get_performance_details

Get the linnworks "Performance through time chart" report: a dictionary of time-scale keys, each mapping to an array of performance detail points. Returns: Date, Value.

list_all_linnworks_dashboards_get_top_products

Get a report of the top ordered products in linnworks, grouped by quantity or turnover. Returns an array of product rows including RowNum, Quantity, Cost, Title, SKU, and Currency.

list_all_linnworks_dashboards_get_inventory_location_datas

Get the 'Stock info for locations' dashboard report from linnworks. Returns: StockLocationId, Location, StockLevel, StockValue. Pass date for a specific report date or omit it for the current period.

list_all_dashboards_get_inventory_location_categories_datas

Get the Linnworks "Stock info for categories in a specific location" report for a date and location. Returns an array of per-category records with StockLocationId, CategoryName, CategoryId, StockLevel, and StockValue. Pass date to target a report date (omit for the current period) and locationId to select the stock location.

list_all_dashboards_get_inventory_location_products_datas

Get a paged report of stock info for products in a specific category and location in linnworks. Returns: TotalResults and Results (per product: ItemNumber, ItemTitle, StockLevel, StockValue). Omit date to report on the current period.

list_all_linnworks_email_get_email_templates

List all email header templates in linnworks. Returns each template header with pkEmailTemplateRowId, Name, TemplateType, Condition, Enabled, AccountName, and HTML/attachment flags. Takes no parameters.

get_single_linnworks_email_get_email_template_by_id

Get the full data of a specific linnworks email template. Returns the template's pkEmailTemplateRowId, Name, Subject, Body, TemplateTypeDefinition, Condition, Enabled, and HTML/attachment flags. Required: pkEmailTemplateRowId.

create_a_linnworks_email_generate_adhoc_email

Generate and send a custom adhoc email in linnworks. Returns: isComplete (whether the send completed) and FailedRecipients (recipient addresses that failed). Requires a JSON request body (the adhoc email request object).

create_a_linnworks_email_generate_free_text_email

Generate and send a custom free-text email in Linnworks. Returns: isComplete (whether the send completed) and FailedRecipients (list of failed recipients). Required: a request body matching the upstream Email_GenerateFreeTextEmailRequest schema.

create_a_linnworks_generic_listings_save_template_field

Update the fields on a generic listing template in linnworks, such as one created with the CreateTemplates endpoint. Sends the template field data as a JSON request object and returns the template field save result object. Required: request.

create_a_linnworks_generic_listings_process_template

Process generic listing templates in linnworks: push templates created via the CreateTemplates endpoint to the channel, or use it to update, relist, or delete an existing template from the channel. Returns a 200 OK response object whose fields are not enumerated in the upstream reference. Required: request.

create_a_linnworks_generic_listings_create_template

Create generic listing templates in Linnworks based on inventory item details and configurator details; each template contains the full details of the item that will be listed on the channel. Returns: TemplatesInfo (created template objects) and AllCreatedIds (ids of the created templates). Required: request.

create_a_linnworks_generic_listings_open_templates_by_inventory

Open Generic Listing Tool templates for linnworks stock items by supplying the stock item identifiers in the request body. Returns: TotalEntries and TemplatesInfo (template details; fields vary by channel template). Requires a JSON request body identifying the inventory items.

get_generic_listings_get_configurators_info_paged_by_id

Get the existing Generic Listing Tool (GLT) configurators from linnworks, one page at a time. Returns a ConfiguratorsInfo array of configurator info objects whose fields are channel-specific. Requires a request body (paged configurator info request object).

create_a_linnworks_generic_listings_save_configurator_field

Update the fields of a Generic Listing Tool (GLT) configurator in linnworks. Returns the save response object. Requires a JSON request body.

get_generic_listings_get_configurator_description_by_id

Get the existing Generic Listing Tool configurator description from linnworks. Returns the Data field holding the configurator's description payload as a string. Requires a request body object.

create_generic_listings_save_configurator_description

Update the description of a Generic Listing Tool (GLT) configurator in linnworks. Returns: IsSaved, ErrorMessage. Requires a JSON request body identifying the configurator and its new description.

get_generic_listings_get_configurator_data_by_id

Get the existing Generic Listing Tool (GLT) configurator data in linnworks. Returns: Data. Requires a request body (the request object is mandatory); the method takes no query parameters.

create_a_linnworks_generic_listings_save_configurator_data

Update a Generic Listing Tool configurator's data (its attributes) in Linnworks. Returns: IsSaved, ValidationResults. Requires a JSON request body with the configurator's data; the body is required.

create_a_linnworks_generic_listings_create_configurator

Create a Generic Listing Tool configurator in linnworks. The configurator setup depends on the channel it is being created for, so the required request body is channel-specific. Returns: CreatedConfiguratorInfo, CreatedConfiguratorId.

delete_a_linnworks_generic_listings_delete_configurator_by_id

Delete a Generic Listing Tool configurator in Linnworks. Returns a 200 OK response body (DeleteConfiguratorsResponse); the discovered Linnworks docs do not enumerate its fields. Requires a JSON request body.

create_a_linnworks_import_export_enable_import

Enable or disable a specific import in linnworks. Returns the import register for the affected import, including its id and the upstream register fields (attributes). Requires a JSON request body.

create_a_linnworks_import_export_run_now_import

Queue a specific Linnworks import to run immediately by putting it in the processing queue. Returns an empty 204 response on success. Requires a JSON request body identifying the import to run.

list_all_linnworks_import_export_get_imports

Get a single import configuration in linnworks by its id. Returns the Import configuration object including its id. Required: id.

delete_a_linnworks_import_export_delete_import_by_id

Delete an import configuration in Linnworks. Returns an empty 204 response on success. Required: id (the import configuration to delete).

list_all_linnworks_import_export_get_fullfilment_center_settings

Get the fulfillment center import/export settings in Linnworks. Returns the settings record including its id and attributes; the attribute fields follow the upstream FulfilmentCenterImportExportSettings schema.

create_a_linnworks_import_export_enable_export

Enable or disable a specific export in Linnworks. Returns the export's register record including its id.

create_a_linnworks_import_export_run_now_export

Run a specific Linnworks export immediately by putting it in the processing queue. Returns an empty 204 response on success. Required: a JSON request body identifying the export to run.

list_all_linnworks_import_export_get_exports

Get an export configuration from Linnworks by its id. Returns the export configuration record identified by id. Required: id.

delete_a_linnworks_import_export_delete_export_by_id

Delete an export configuration in linnworks. Returns an empty 204 response on success. Requires a JSON body identifying the export to delete.

list_all_linnworks_import_export_get_import_lists

List all existing import configurations in Linnworks. Returns the collection of existing imports as a single GetImportListResponse payload; the upstream schema is not expanded, so individual import fields are not documented. Takes no parameters.

list_all_linnworks_import_export_get_export_lists

List all existing export configurations in Linnworks. Returns the export list payload (GetExportListResponse); the upstream API reference does not document its field-level structure. Takes no parameters.

create_a_linnworks_inventory_create_stock_supplier_stat

Create a supplier stat for a stock item in linnworks via CreateStockSupplierStat. The request must include a JSON body following the Inventory_CreateStockSupplierStatRequest schema. Returns an empty 204 response on success.

update_a_linnworks_inventory_update_stock_supplier_stat_by_id

Update an item supplier stat in linnworks. Requires a JSON request body matching the upstream Inventory_UpdateStockSupplierStatRequest schema (field-level breakdown not enumerated in the Linnworks docs). Returns an empty 204 response on success.

delete_a_linnworks_inventory_delete_stock_supplier_stat_by_id

Delete an item supplier stat in linnworks. Returns an empty 204 response on success. Requires a JSON request body identifying the supplier stat to remove, per the upstream Inventory_DeleteStockSupplierStatRequest schema.

list_all_linnworks_inventory_get_inventory_item_prices

Get a Linnworks stock item's prices by channel. Returns an array of price records with: id, attributes — the channel-specific price fields are defined in the upstream StockItemPrice schema but not enumerated in the docs. Takes inventoryItemId (stock item id, UUID).

create_a_linnworks_inventory_create_inventory_item_price

Create stock item prices for a specific channel in Linnworks. Requires a JSON request body (upstream schema: Inventory_CreateInventoryItemPricesRequest). Returns an empty 204 response on success.

update_a_linnworks_inventory_update_inventory_item_price_by_id

Update stock item prices in Linnworks. Returns an empty 204 response on success. Requires a JSON request body conforming to Linnworks' UpdateInventoryItemPrices request schema; the upstream docs do not enumerate its fields, so consult the Linnworks API reference for the exact payload shape.

delete_a_linnworks_inventory_delete_inventory_item_price_by_id

Delete stock item prices in linnworks. Returns an empty 204 response on success. Requires a JSON request body identifying the stock item prices to delete.

list_all_inventory_get_inventory_item_price_channel_suffixes

List all possible price change subsource suffixes across every channel in Linnworks. Returns a channel-keyed map where each channel name maps to an array of suffix strings.

list_all_linnworks_inventory_get_inventory_item_price_tags

Get all possible price change tags for all channels in Linnworks. Returns a map of channel name to the array of price change tag strings available for that channel. No required parameters.

list_all_inventory_get_inventory_item_price_rules_by_ids

Get the stock item price rules for a specific item price in Linnworks. Returns an array of stock item pricing rule objects matching the supplied price ID. Required: stockItemPriceId (UUID of an item price).

list_all_inventory_get_inventory_item_price_rules_by_sources

Get Linnworks stock item price rules for a stock item on a specific channel source and subsource. Returns an array of pricing-rule records, each with an id and the rule fields defined by Linnworks' StockItemPricingRule schema. Required: stockItemId, source, subSource.

create_a_linnworks_inventory_create_inventory_item_pricing_rule

Create stock item price rules in Linnworks by posting the rule definitions as a JSON request body. Returns an empty 204 response on success. Requires the pricing rule request body.

delete_inventory_delete_inventory_item_pricing_rule_by_id

Delete stock item pricing rules in linnworks by submitting the rules to remove. Requires a JSON request body per the upstream delete-pricing-rules request schema (its fields are not enumerated in the discovered documentation). Returns an empty 204 response on success.

update_inventory_update_inventory_item_pricing_rule_by_id

Update stock item pricing rules in linnworks. Returns an empty 204 response on success. Required: a JSON request body describing the pricing rules to apply.

list_all_linnworks_inventory_get_inventory_item_descriptions

Get stock item descriptions from Linnworks. Returns an array of StockItemDescription records for the stock item matching inventory_item_id (UUID).

create_a_linnworks_inventory_create_inventory_item_description

Create descriptions for stock items in linnworks. Requires a JSON request body matching the upstream Inventory_CreateInventoryItemDescriptionsRequest schema (its fields are not enumerated in the reference). Returns an empty 204 response on success.

update_inventory_update_inventory_item_description_by_id

Update stock item descriptions in Linnworks by sending the required JSON request body matching the upstream Inventory_UpdateInventoryItemDescriptionsRequest schema. Returns an empty 204 response on success.

delete_inventory_delete_inventory_item_description_by_id

Delete stock item descriptions in Linnworks. Requires a JSON request body identifying the descriptions to remove. Returns an empty 204 response on success.

get_single_linnworks_inventory_get_stock_item_label_by_id

Get stock item labels in Linnworks by search token. Returns an array of StockItemLabel objects; the label field structure is not enumerated in the upstream docs. Requires a JSON request body.

list_all_linnworks_inventory_get_batches_by_stock_item_ids

Get batch information for a stock item across all locations in Linnworks. Returns each batch with BatchId, SKU, BatchNumber, ExpiresOn, SellBy, and an Inventory array of per-location records including Quantity, StockValue, and BinRack. Required: stockItemId.

get_single_linnworks_inventory_get_batch_inventory_by_id_by_id

Get a batch's header and batch inventory in Linnworks by batch id. Returns: id. Required: the id of the batch to retrieve.

get_inventory_get_stock_item_batches_by_location_by_id

Get batch information for a stock item at a specific Linnworks location. Sent as a POST request with a JSON body identifying the stock item id and location id; returns the batch info payload Linnworks defines for that item-location pair.

get_single_linnworks_inventory_get_batch_audit_by_id

Get the audit trail for batches in linnworks. Returns the batch audit trail records for the requested batches; audit entry fields follow the upstream batch audit schema. Requires a request body identifying the batches to audit.

delete_inventory_delete_batch_inventory_in_bulk_by_id

Delete batch inventory info in bulk in linnworks. Requires a JSON request body (upstream DeleteBatchInventoryInBulkRequest schema). Returns an empty 204 response on success.

delete_inventory_delete_batches_by_stock_item_id_by_id

Delete the batches of a stock item in Linnworks. Requires a JSON request body identifying the stock item and the batches to remove. Returns an empty 204 response on success.

update_a_linnworks_inventory_update_batches_with_inventory_by_id

Update batches and batch inventory info for stock items in linnworks. Send a Products payload with each item's SKU, Reference, Quantity, and per-location MultiLocationLevels. Returns an empty 204 response on success. Requires a JSON request body.

create_a_linnworks_inventory_create_batch

Create new batches in Linnworks. Returns an empty 204 response on success. Requires a JSON request body; the payload fields follow the Linnworks CreateBatches request schema, see the Linnworks API reference for the full field list.

list_all_linnworks_inventory_has_stock_item_batches

Check whether a stock item in Linnworks has batches. Returns a boolean result indicating whether the specified stock item has batches. Required: stockItemId (the stock item's unique identifier).

update_inventory_update_composite_parent_stock_level_by_id

Update the stock level of a composite parent item in Linnworks. Requires a JSON request body matching the upstream Inventory_UpdateCompositeParentStockLevelRequest schema; the Linnworks docs do not expand its fields. Returns a bare integer (int32) result on success — the response carries no object fields.

update_a_linnworks_inventory_update_batch_date_by_id

Update the dates (such as expiry and sell-by) on inventory stock item batches in linnworks. Returns a 200 JSON update response whose fields are defined by the upstream UpdateBatchDatesResponse schema and not enumerated in the available documentation. Requires a JSON request body.

list_all_linnworks_inventory_get_ebay_compatibility_lists

List the eBay compatibility records for a stock item in Linnworks. Returns a collection of StockItemEbayCompatibility entries, each with an id and an attributes object carrying the item's compatibility details.

create_inventory_insert_update_ebay_compatibility_list

Insert and update a list of eBay compatibility entries for stock items in Linnworks. Returns a 200 OK response body matching the upstream InsertUpdateEbayCompatibilityList response schema; the available docs do not enumerate its individual fields. Required: a JSON request body matching the upstream Inventory_InsertUpdateEbayCompatibilityListRequest schema.

delete_inventory_delete_ebay_compatibility_list_by_id

Delete a list of eBay compatibility entries in linnworks via the Inventory API. Returns a JSON result object (upstream type DeleteEbayCompatibilityListResponse) whose fields are not enumerated in the linnworks docs. Requires a JSON request body identifying the compatibility list entries to remove.

list_all_linnworks_inventory_get_scrap_categories

List the scrap categories configured for inventory scrapping in Linnworks. Returns each category record including its id and its category attributes as defined upstream. Requires no parameters.

create_a_linnworks_inventory_add_scrap_category

Add scrap categories in linnworks. Returns an AddScrapCategoriesResponse object (200 OK). Required: a JSON request body matching the upstream AddScrapCategories request schema.

delete_a_linnworks_inventory_delete_scrap_category_by_id

Delete scrap categories in linnworks. Requires a JSON request body identifying the scrap categories to remove. Returns an empty 204 response on success.

update_a_linnworks_inventory_update_scrap_category_by_id

Update scrap categories in Linnworks using a JSON request body. Returns an empty 204 response on success.

get_single_linnworks_inventory_get_scrap_history_by_id

Get scrap history in Linnworks, returning the historical record of stock scrapped from inventory. Returns the scrap history report as a 200 OK response; the response field set is not enumerated in the source docs. Requires a JSON request body (GetScrapHistoryRequest).

create_a_linnworks_inventory_add_scrap_item

Add a scrap item in linnworks, recording stock as scrapped for the requested item. Returns the AddScrapItemResponse object on success — the upstream docs define it as a typed schema but do not enumerate its fields in the discovered source. Required: a JSON request body matching the upstream Inventory_AddScrapItemRequest schema.

create_a_linnworks_inventory_scrap_batched_item

Scrap a batched stock item in Linnworks, writing off batch-tracked inventory. Requires a JSON request body matching the upstream Inventory_ScrapBatchedItemRequest schema. Returns the ScrapBatchedItemResponse object on success; its field-level breakdown is defined by that upstream schema.

create_a_linnworks_inventory_bulk_scrap_batched_item

Scrap batched stock items in bulk without consumption in Linnworks by submitting a JSON request body. Returns an empty 204 response on success.

get_inventory_get_product_identifiers_by_stock_item_id_by_id

Get the product identifiers for a stock item in Linnworks. Returns the identifiers record with its id; the remaining fields are defined by the upstream response schema and are not enumerated in the source docs, so consult the Linnworks API reference for the full field-level breakdown. Requires a request body identifying the stock item.

create_a_linnworks_inventory_add_product_identifier

Add product identifiers to stock items in linnworks. Returns a batched response with the resulting product identifier records for each processed item. Requires a JSON request body.

update_a_linnworks_inventory_update_product_identifier_by_id

Update product identifiers for stock items in Linnworks. Requires a JSON request body; its fields follow the upstream Inventory_UpdateProductIdentifiersRequest schema, which the available documentation does not enumerate. Returns an empty 204 response on success.

delete_a_linnworks_inventory_delete_product_identifier_by_id

Delete product identifiers from stock items in linnworks. Requires a JSON request body identifying the product identifiers to remove; the individual body fields are not enumerated in the source documentation. Returns an empty 204 response on success.

list_all_linnworks_inventory_get_product_identifier_types

List the product identifier types available in Linnworks inventory, e.g. to populate identifier pickers when creating or updating stock items. Returns each identifier type entry with its id and upstream-defined attributes; the entry fields are not enumerated in the Linnworks docs, so consult the Linnworks API reference for the field-level breakdown. Takes no parameters.

list_all_inventory_get_product_identifier_extended_types

Get the available Product Identifier types in Linnworks with extended information, such as related sources and scanned-at-dispatch flags. Takes no parameters. Returns the extended type definitions with schema-defined fields per Linnworks' GetProductIdentifierExtendedResponse format.

get_inventory_get_scannable_product_identifiers_by_order_id

Get the available product identifier types with extended information, such as related sources and scanned-at-dispatch status, for a set of Linnworks orders. Returns an opaque result object whose field set is not enumerated in the upstream docs. Required: OrderIds.

get_inventory_get_product_identifiers_bulk_by_stock_item_id

Get product identifiers for multiple Linnworks stock items in a single call. Returns a map keyed by stock item id where each entry lists the identifiers found for that item, including their type, value, and site. Required: stock_item_ids.

create_a_linnworks_inventory_items_have_scannable_identifier

Check whether linnworks inventory items have scannable identifiers. Returns the scannable-identifier check result for the submitted items; supply a JSON request body.

list_all_linnworks_inventory_get_channels

List all channels configured in Linnworks inventory. Returns an array of channel records, each with an id and channel-specific configuration attributes. Takes no parameters.

list_all_linnworks_inventory_get_channels_by_sources

Get channels by source in Linnworks. Returns an array of channel configuration records including their id and channel-specific attributes.

list_all_linnworks_inventory_get_extended_property_names

Get all available extended property names for linnworks inventory items. Returns an array of extended property name strings, optionally narrowed by the propertyType filter.

list_all_linnworks_inventory_get_all_extended_property_names

List the extended property names available across all types in Linnworks. Returns an object keyed by extended property type, each mapping to an array of property name strings. Takes no parameters.

list_all_linnworks_inventory_get_extended_property_types

List the default extended property types in linnworks. Returns an array of extended property type name strings. Takes no parameters.

list_all_linnworks_inventory_get_package_groups

List all package groups in Linnworks inventory. Returns an array of package group entries, each with a Key (package group id) and a Value (package group name). No parameters required.

list_all_linnworks_inventory_get_postal_services

List all postal services in Linnworks. Returns an array of key/value entries: Key and Value (a GUID identifying the postal service).

create_a_linnworks_inventory_add_image_to_inventory_item

Add an image to a stock item in linnworks. Returns a 200 OK response whose body fields are not enumerated in the available source documentation. A JSON request body carries the image details.

update_a_linnworks_inventory_update_inventory_item_field_by_id

Update one or more field values on a Linnworks inventory (stock) item. Returns a 200 OK object with dynamic keys mapping updated field names to updated field value objects. Required: a JSON request body matching the upstream Inventory_UpdateInventoryItemFieldRequest schema; the endpoint takes no query parameters.

update_inventory_update_inventory_item_stock_field_by_id

Update the stock field of an inventory item in linnworks and return the resulting stock level. Returns the updated stock level object with dynamic key-value fields (an object whose values are nested objects, per the upstream schema). Requires a JSON request body following the Inventory_UpdateInventoryItemStockFieldRequest schema.

update_a_linnworks_inventory_update_inventory_item_level_by_id

Update stock level records for a stock item and any composite related items in linnworks. Returns the updated stock level records for the item and its composite related items. Requires a request body.

update_inventory_update_inventory_item_location_field_by_id

Update a stock item's inventory location field in linnworks and return the resulting stock level records for that item. Returns a dynamic object of updated stock level records whose field names are not enumerated in the upstream docs. Requires a JSON request body (upstream schema: Inventory_UpdateInventoryItemLocationFieldRequest; its fields are not published in the discovered documentation).

list_all_linnworks_inventory_get_inventory_item_by_ids

Get a Linnworks inventory item's product details by id. Returns the stock item's inventory record (StockItemInv), keyed by id. Required: id (UUID).

list_all_linnworks_inventory_get_inventory_items

Get stock item details for a single inventory item in Linnworks, looked up by either its stock item id or SKU — stockItemId is used in preference when both are supplied, and the call throws if they don't relate to the same Linnworks item. Returns the stock item record keyed by its id together with the full item attributes.

list_all_linnworks_inventory_get_user_specific_views

Get the user-specific inventory views stored in the linnworks database. Returns a list of inventory view records, each with an id and an attributes object holding the view's fields.

create_a_linnworks_inventory_create_user_specific_view

Create a new user-specific inventory view in linnworks. Sends the required Inventory_CreateUserSpecificViewRequest JSON body. Returns an empty 204 response on success.

update_a_linnworks_inventory_update_user_specific_view_by_id

Update an existing user-specific inventory view in linnworks. Returns an empty 204 response on success. Requires a JSON request body; the field-level schema is not documented upstream.

delete_a_linnworks_inventory_delete_user_specific_view_by_id

Delete a user-specific view from the database in Linnworks. Returns an empty 204 response on success. Requires a JSON request body identifying the view to delete.

list_all_linnworks_inventory_get_pre_defined_views

List the pre-defined (standard) inventory views in linnworks. Returns an array of view objects (InventoryView) with no caller-supplied parameters required.

list_all_linnworks_inventory_get_inventory_items_counts

Get the total count of inventory items in linnworks. Returns a bare integer count (not an object). Optional: include_deleted, include_archived to also count deleted or archived items.

create_a_linnworks_inventory_add_inventory_item

Add a new stock item in linnworks. Set MinimumLevel to null to use the Default Minimum Level from Settings; a JSON request body is required. Returns an empty 204 response on success.

create_a_linnworks_inventory_add_inventory_item_bulk

Add up to 200 stock items to linnworks inventory in a single batch call. Returns a BatchedAPIResponse of Guid values identifying the processed stock items. Requires a JSON batch request body (marked required in the upstream spec); its item fields are not enumerated in the docs.

create_a_linnworks_inventory_duplicate_inventory_item

Create a new Linnworks inventory item by duplicating an existing stock item. Returns an empty 204 response on success. Required: a JSON request body matching the upstream DuplicateInventoryItem request schema.

create_a_linnworks_inventory_archive_inventory_item

Archive one or more inventory items in linnworks. The required JSON body carries the list of item IDs to archive alongside an empty list of regions. Returns an empty 204 response on success.

create_a_linnworks_inventory_unarchive_inventory_item

Unarchive inventory items in Linnworks via POST /api/Inventory/UnarchiveInventoryItems. Requires a JSON request body (upstream schema Inventory_UnarchiveInventoryItemsRequest; its field-level structure is not enumerated in the available docs). Returns an empty 204 response on success.

list_all_linnworks_inventory_get_new_item_numbers

Get the next unused SKU in Linnworks inventory. Returns the new item number as a plain JSON string. Takes no parameters.

update_a_linnworks_inventory_update_inventory_item_by_id

Update a stock item in linnworks. This acts as a set endpoint — all stock item data is replaced, even if not provided in the request. Returns an empty 204 response on success. Supply StockItemId to identify the item, or ItemNumber when StockItemId is left empty.

delete_a_linnworks_inventory_delete_inventory_item_by_id

Delete inventory items in linnworks; all associated information is unlinked/removed from each deleted stock item. Returns an empty 204 response on success. Requires a JSON request body (the upstream DeleteInventoryItems request object).

delete_a_linnworks_inventory_delete_inventory_item_bulk_by_id

Delete inventory items in bulk in Linnworks; all associated information is unlinked and removed from each stock item. Accepts a JSON request body shaped by the upstream DeleteInventoryItemBulkRequest schema. Returns the batched delete result object with schema-specific fields defined by the upstream BatchedAPIResponse_DeleteInventoryItemBulkResponse schema; consult the Linnworks API reference for…

create_a_linnworks_inventory_adjust_templates_instant

Adjust templates in Linnworks instantly via the inventory API. Requires a JSON request body. Returns an empty 204 response on success.

list_all_linnworks_inventory_get_inventory_item_channel_sk_us

List the channel SKU link records for a Linnworks inventory item. Returns: a 200 OK array of StockItemChannelSKU records, each including the record id. Required: inventoryItemId (stockitem id, UUID).

create_inventory_batch_get_inventory_item_channel_sk_us

Batch-get the channel SKUs for a list of Linnworks inventory items in one call. Returns an array of channel SKU response records as defined by the upstream StockItemChannelSkuResponse schema. Required: a JSON request body (Inventory_BatchGetInventoryItemChannelSKUsRequest) listing the inventory items to look up.

list_inventory_get_inventory_item_channel_sk_us_with_locations

Use this call to retrieve all stock item channel sku's with location for a given channel sku RowId in Linnworks. Returns: LocationId, LocationName, IgnoreSync, MaxListedQuantity, EndWhenStock, StockPercentage, LastUpdate, UpdateStatus, SubmittedQuantity, ListedQuantity, fkRowId, RetryCount, and more.

update_a_linnworks_inventory_update_channel_mapping_by_id

Update mappings between Linnworks inventory items and channel items — such as the Max Listed Quantity — by submitting a channel mapping update request body. Returns the batched update response (a BatchedAPIResponse of ChannelMappingUpdateInfo) reporting the outcome of each mapping update.

inventory_update_inventory_item_channel_sk_us_with_locations_upd

Update Linnworks inventory channel SKU location properties, such as Max Listed Quantity. Requires a JSON request body describing the channel SKU location updates to apply. Returns an empty 204 response on success.

create_a_linnworks_inventory_create_channel_mapping

Create mappings between Linnworks inventory items and channel items. Returns a batched API response containing channel mapping creation info for each submitted mapping. Mapping details are supplied in the JSON request body.

delete_inventory_delete_inventory_item_channel_sk_us_by_id

Delete stock item channel SKUs in linnworks. Requires a JSON request body. Returns an empty 204 response on success.

list_all_inventory_is_inventory_item_channel_sku_linkeds

Check whether a ChannelSKU is linked to an inventory item in linnworks. Returns a boolean — true when the ChannelSKU is linked, false otherwise.

create_a_linnworks_inventory_unlink_channel_listing

Unlink a Linnworks inventory listing from its inventory item by sending an Inventory_UnlinkChannelListingRequest JSON body. Returns an empty 204 response on success.

list_all_linnworks_inventory_get_inventory_item_audit_trails

Get the audit trail for a Linnworks stock item. Returns an array of audit trail entries, each with an id and schema-specific StockItemAuditTrail audit fields. Required: inventoryItemId (the stock item's unique identifier, UUID).

get_inventory_get_inventory_item_audit_trail_paged_by_id

Get a paged list of Linnworks stock item audit trail entries filtered by request-body criteria. Returns the paged result envelope with Data (StockItemAuditTrail entries), PageNumber, EntriesPerPage, TotalEntries, and TotalPages. Requires a JSON request body matching the upstream Inventory_GetInventoryItemAuditTrailPagedRequest filter schema.

get_inventory_get_inventory_item_batch_information_by_id

Get the batch information for a specific Linnworks inventory item. Returns an array of StockItemBatch records with BatchId, SKU, StockItemId, BatchNumber, InventoryTrackingType, ExpiresOn, SellBy, and per-location Inventory rows. Requires a request body matching the upstream Inventory_GetInventoryItemBatchInformationRequest schema; see the Linnworks API docs for its field-level definition.

get_inventory_get_inventory_item_batch_information_by_id_by_id

Get batch information for multiple inventory items in Linnworks by their inventory item ids. Returns the batch-information response object defined by the upstream GetInventoryItemBatchInformationByIdsResponse schema on 200 OK (the Linnworks docs do not enumerate its fields). Requires a JSON request body matching the Inventory_GetInventoryItemBatchInformationByIdsRequest schema.

create_a_linnworks_inventory_has_stock_item_stock_level

Check whether stock items in Linnworks have a stock level recorded. Posts a batch of products to the Inventory API for a stock-level check. Returns: Products, each with SKU, Reference, Quantity (sum of multi-location levels), and MultiLocationLevels (Tag, Quantity); shape mirrors Linnworks' multi-location inventory batch examples. Requires a JSON request body.

update_a_linnworks_inventory_update_batch_detail_by_id

Update the batch details of a batched stock item in Linnworks, such as its batch number, expiry (ExpiresOn) and sell-by (SellBy) dates, and inventory tracking type. Returns an empty 204 response on success. Requires a JSON body identifying the batch to update (BatchId).

list_all_linnworks_inventory_get_inventory_item_images

Get the images for a Linnworks inventory item. Returns an array of inventory item image records (StockItemImage objects). Supply either inventoryItemId or itemNumber — one is required; if both are sent, itemNumber is ignored.

get_single_linnworks_inventory_get_stock_item_ids_by_skus_by_id

Resolve Linnworks inventory stock item ids from a list of SKUs. Returns a 200 OK JSON payload whose field-level shape is not enumerated in these docs (upstream schemas: Inventory_GetStockItemIdsBySKURequest / GetStockItemIdsBySKU). Requires a JSON request body.

get_single_linnworks_inventory_get_images_in_bulk_by_id

Get images for multiple inventory items in Linnworks in a single bulk request. Returns the bulk image response object with fields defined by the upstream GetImagesInBulkResponse schema (not expanded in the available source). Requires a JSON request body.

create_a_linnworks_inventory_set_inventory_item_image_as_main

Set the main image of a linnworks inventory item, marking the chosen image as the item's primary picture. Returns an empty 204 response on success. Required: a JSON request body identifying the inventory item and the image to set as main.

create_a_linnworks_inventory_upload_images_to_inventory_item

Upload images from Uploader to a Linnworks stock item (inventory item). Returns a 200 response containing an array of picture-source objects (upstream PictureSource schema; the source does not enumerate its fields). Required: a request body matching the Linnworks upload-images-to-inventory-item request schema. This endpoint is rate limited to 150 calls per minute.

update_a_linnworks_inventory_update_image_by_id

Update properties on inventory item images in linnworks by posting an UpdateImages JSON request body. Returns an empty 204 response on success.

delete_inventory_delete_images_from_inventory_item_by_id

Delete images from Linnworks inventory items. Returns an empty 204 response on success. Requires a JSON request body defining the images to remove.

delete_inventory_delete_inventory_item_image_bulk_by_id

Use this call to delete images from inventory items Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemDetailsNode in Linnworks. Returns: Results, TotalResults, ResultStatus.

list_all_linnworks_inventory_get_categories

List all inventory categories configured in Linnworks. Returns a bare JSON array of category objects matching the upstream LinnworksCategory schema — the upstream reference does not enumerate the individual category fields. Requires no parameters.

list_all_linnworks_inventory_get_inventory_batch_types

List the available inventory batch types in linnworks. Returns a map of batch type names to their integer identifiers. No required parameters.

create_a_linnworks_inventory_create_category

Use this call to create new category in Linnworks. Returns: CategoryId, CategoryName, StructureCategoryId, ProductCategoryId.

update_a_linnworks_inventory_update_category_by_id

Update the name of an existing inventory category in Linnworks. Returns an empty 204 response on success. Required: a JSON request body identifying the category and its new name.

delete_a_linnworks_inventory_delete_category_by_id_by_id

Use this call to delete category by id in Linnworks.

list_all_linnworks_inventory_get_country_codes

Use this call to get all country codes from ebay channel in Linnworks.

list_all_linnworks_inventory_get_countries

Use this call to get list of all countries in Linnworks. Returns: CountryId, CountryName, CountryCode, Continent, Currency, CustomsRequired, TaxRate, AddressFormat, Regions, RegionsCount.

create_a_linnworks_inventory_create_country

Use this call to create new countries in Linnworks.

update_a_linnworks_inventory_update_country_by_id

Use this call to udpate countries in Linnworks.

delete_a_linnworks_inventory_delete_country_by_id

Use this call to delete countries in Linnworks.

create_a_linnworks_inventory_create_country_region

CreateCountryRegions in Linnworks. Returns: regions.

update_a_linnworks_inventory_update_country_region_by_id

UpdateCountryRegions in Linnworks.

list_all_linnworks_inventory_get_stock_locations

Use this call to get all stock locations in Linnworks. Returns: Address1, Address2, City, County, Country, ZipCode, IsNotTrackable, LocationTag, CountInOrderUntilAcknowledgement, FulfilmentCenterDeductStockWhenProcessed, IsWarehouseManaged, StockLocationId, and more.

list_all_linnworks_inventory_is_owned_stock_locations

Checks whether a location is FBA or has an enabled inventory update import in Linnworks.

list_all_linnworks_inventory_get_inventory_item_locations

Use this call to get stock item locations bin/rack in Linnworks. Returns: StockLocationId, LocationName, BinRack, StockItemId, StockItemIntId.

create_a_linnworks_inventory_add_item_location

Use this call to add stock item locations bin/rack Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemBinRackNode in Linnworks.

update_a_linnworks_inventory_update_item_location_by_id

Use this call to update stock item locations bin/rack Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemBinRackNode in Linnworks.

delete_a_linnworks_inventory_delete_item_location_by_id

Use this call to delete stock item locations bin/rack Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemBinRackNode in Linnworks.

list_all_linnworks_inventory_get_inventory_item_compositions

Use this call to get all StockItem Compositions in Linnworks. Returns: LinkedStockItemId, ItemTitle, SKU, Quantity, PurchasePrice, InventoryTrackingType, DimHeight, DimWidth, DimDepth, Weight, PackageGroupId, TaxRate, and more.

get_inventory_get_inventory_items_composition_by_id_by_id

Use this call to get all StockItem Compositions in Linnworks. Returns: InventoryItemsCompositionByIds.

create_a_linnworks_inventory_create_inventory_item_composition

Use this call to create compositions for stockItem Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemDetailsNode in Linnworks.

update_inventory_update_inventory_item_composition_by_id

Use this call to update stockItem compositions Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemDetailsNode in Linnworks.

delete_inventory_delete_inventory_item_composition_by_id

Use this call to delete stockItem compositions Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemDetailsNode in Linnworks.

get_inventory_get_inventory_item_extended_property_by_id

Use this call to get stockitem Extended Properties in Linnworks. Returns: pkRowId, fkStockItemId, ProperyName, PropertyValue, PropertyType.

create_inventory_create_inventory_item_extended_property

Use this call to create stockitem Extended Properties Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemDetailsNode in Linnworks.

update_inventory_update_inventory_item_extended_property_by_id

Use this call to update stockitem Extended Properties Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemDetailsNode in Linnworks.

delete_inventory_delete_inventory_item_extended_property_by_id

Use this call to delete stockitem Extended Properties Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemDetailsNode in Linnworks.

list_all_linnworks_inventory_get_inventory_item_titles

Use this call to get stockitem Titles in Linnworks. Returns: pkRowId, Source, SubSource, Title, StockItemId, StockItemIntId.

create_a_linnworks_inventory_create_inventory_item_title

Use this call to create stockitem Titles Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemDetailsNode in Linnworks.

update_a_linnworks_inventory_update_inventory_item_title_by_id

Use this call to update stockitem Titles Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemDetailsNode in Linnworks.

delete_a_linnworks_inventory_delete_inventory_item_title_by_id

Use this call to delete stockitem Titles Permissions Required: GlobalPermissions.Inventory.Stock.StockWrite.ChangeStockItemDetailsNode in Linnworks.

list_all_linnworks_inventory_get_suppliers

Use this call to retrieve list of all Suppliers' names in Linnworks. Returns: pkSupplierID, SupplierName, ContactName, Address, AlternativeAddress, City, Region, Country, PostCode, TelephoneNumber, SecondaryTelNumber, FaxNumber, and more.

list_all_linnworks_inventory_get_supplier_details

Use this call to retrieve details of one Supplier Permissions Required: GlobalPermissions.Inventory.InventorySettings.SuppliersNode in Linnworks. Returns: pkSupplierID, SupplierName, ContactName, Address, AlternativeAddress, City, Region, Country, PostCode, TelephoneNumber, SecondaryTelNumber, FaxNumber, and more.

create_a_linnworks_inventory_add_supplier

Use this call to create a new supplier Permissions Required: GlobalPermissions.Inventory.InventorySettings.SuppliersNode in Linnworks. Returns: pkSupplierID, SupplierName, ContactName, Address, AlternativeAddress, City, Region, Country, PostCode, TelephoneNumber, SecondaryTelNumber, FaxNumber, and more.

update_a_linnworks_inventory_update_supplier_by_id

Use this call to update supplier Permissions Required: GlobalPermissions.Inventory.InventorySettings.SuppliersNode in Linnworks.

delete_a_linnworks_inventory_delete_supplier_by_id

Use this call delete Supplied by Id List of Supplier IDs Permissions Required: GlobalPermissions.Inventory.InventorySettings.SuppliersNode in Linnworks.

list_all_linnworks_inventory_get_stock_supplier_stats

Use this call to retrieve report about "item supplier stat" in Linnworks. Returns: IsDefault, Supplier, SupplierID, Code, SupplierBarcode, LeadTime, PurchasePrice, MinPrice, MaxPrice, AveragePrice, AverageLeadTime, SupplierMinOrderQty, and more.

list_all_linnworks_inventory_get_stock_supplier_stats_bulks

Use this call to retrieve report about "item supplier stat" in Linnworks. Returns: IsDefault, Supplier, SupplierID, Code, SupplierBarcode, LeadTime, PurchasePrice, MinPrice, MaxPrice, AveragePrice, AverageLeadTime, SupplierMinOrderQty, and more.

create_a_linnworks_listings_end_listings_pending_relist

End eBay listings pending relist Permissions Required: GlobalPermissions.Settings.ListingConfiguratorsNode in Linnworks.

create_a_linnworks_listings_set_listing_strike_off_state

Set eBay Listing Strike State Permissions Required: GlobalPermissions.Settings.ListingConfiguratorsNode in Linnworks.

list_all_linnworks_listings_gete_bay_configurators

Use this call to get eBay configurators. A configurator hosts common details for listings such as listing type, return policy, payment methods, shipping info, attributes, listing categories, etc. Configurators offer an efficient way of creating listings in bulk that follow a common theme.The… in Linnworks. Returns: pkConfigId, ConfigName, EbayAccount, Site, OriginalConfigId, OriginalSite, IsOutOfStockFeatureEnabled, MaxQuantity, MinQuantity, MaxQuantityPerBuyer, IsMaxQuantityPerBuyerEnabled, ShowInInventory, and more.

list_all_linnworks_listings_get_all_ebay_configurators

Use this call to get eBay configurators by source and subsource Permissions Required: GlobalPermissions.Settings.ListingConfigurators.GetListingConfiguratorsNode in Linnworks. Returns: SourceConfiguratorData.

create_a_linnworks_listings_createe_bay_configurator

Use this call to create eBay configurators. A configurator hosts common details for listings such as listing type, return policy, payment methods, shipping info, attributes, listing categories, etc. Configurators offer an efficient way of creating listings in bulk that follow a common theme.The… in Linnworks.

update_a_linnworks_listings_updatee_bay_configurator_by_id

Use this call to update eBay configurators. A configurator hosts common details for listings such as listing type, return policy, payment methods, shipping info, attributes, listing categories, etc. Configurators offer an efficient way of creating listings in bulk that follow a common theme. The… in Linnworks.

delete_a_linnworks_listings_deletee_bay_configurator_by_id

Use this call to delete eBay configurators. A configurator hosts common details for listings such as listing type, return policy, payment methods, shipping info, attributes, listing categories, etc. Configurators offer an efficient way of creating listings in bulk that follow a common theme. The… in Linnworks.

get_single_linnworks_listings_gete_bay_template_by_id

Use this call to return all created Ebay templates. Permissions Required: GlobalPermissions.Settings.ListingConfigurators.GetListingConfiguratorsNode in Linnworks. Returns: Items, TotalItems, CurrentPage, EntriesPerPage.

create_a_linnworks_listings_create_ebay_template

Use this call to return a template based on the configurator setting you have requested. This allows you to see the template which can then be retuned to the ProcessEbayListing endpoint which will build the listing. Permissions Required:… in Linnworks. Returns: Items, TotalItems, CurrentPage, EntriesPerPage.

create_a_linnworks_listings_create_templates_from_view_in_bulk

Use this call to create wireup to create templates in bulk Permissions Required: GlobalPermissions.Settings.ListingConfigurators.GetListingConfiguratorsNode in Linnworks.

list_all_linnworks_listings_get_ebay_listing_operations

Use this call to get ebay listing bulk creation operations Permissions Required: GlobalPermissions.Settings.ListingConfigurators.GetListingConfiguratorsNode in Linnworks.

create_a_linnworks_listings_cancel_listing_bulk_operation

Use this call to cancel ebay listing bulk creation operations Permissions Required: GlobalPermissions.Settings.ListingConfigurators.GetListingConfiguratorsNode in Linnworks.

create_a_linnworks_listings_processe_bay_listing

Use this call to create templates in Linnworks and can also be used to push the template to a channel. This will create the template even if it returns null. This will also push the template to the channel depending on what the status is set as.

delete_a_linnworks_listings_delete_ebay_template_by_id

Use this call to delete a Ebay template in Linnworks.

get_single_linnworks_listings_get_big_commerce_template_by_id

Use this call to return all created Big Commerce templates in Linnworks. Returns: Items, TotalItems, CurrentPage, EntriesPerPage.

create_a_linnworks_listings_create_bigcommerce_template

Use this call to return a template based on the configurator setting you have requested. This allows you to see the template which can then be retuned to the ProcessBigCommerceListing endpoint which will build the listing in Linnworks. Returns: Items, TotalItems, CurrentPage, EntriesPerPage.

create_a_linnworks_listings_process_bigcommerce_listing

Use this call to create templates in Linnworks and can also be used to push the template to a channel. This will create the template even if it returns null. This will also push the template to the channel depending on what the status is set as.

list_all_linnworks_listings_get_bigcommerce_configurators

Use this call to get all Bigcommerce configurators. A configurator hosts common details for listings such as listing type, return policy, payment methods, shipping info, attributes, listing categories, etc. Configurators offer an efficient way of creating listings in bulk that follow a common… in Linnworks. Returns: Attributes, OptionSetName, VarAttributes, UserAttributes, pkConfigid, Categories, Site, ConfigName, CategoryExtendedProperty, ManageStock, ShowInInventory, IsChanged, and more.

create_a_linnworks_listings_create_bigcommerce_configurator

Use this call to create BigCommerce configurators. A configurator hosts common details for listings such as listing type, return policy, payment methods, shipping info, attributes, listing categories, etc. Configurators offer an efficient way of creating listings in bulk that follow a common… in Linnworks.

update_listings_update_bigcommerce_configurator_by_id

Use this call to update BigCommerce configurators. A configurator hosts common details for listings such as listing type, return policy, payment methods, shipping info, attributes, listing categories, etc. Configurators offer an efficient way of creating listings in bulk that follow a common… in Linnworks.

delete_listings_delete_bigcommerce_configurator_by_id

Use this call to delete BigCommerce configurators. A configurator hosts common details for listings such as listing type, return policy, payment methods, shipping info, attributes, listing categories, etc. Configurators offer an efficient way of creating listings in bulk that follow a common… in Linnworks.

delete_a_linnworks_listings_delete_bigcommerce_template_by_id

Use this call to delete a Big Commerce template in Linnworks.

list_all_linnworks_locations_get_locations

Use this call to retrieve a location and basic information about it from your Linnworks account. Returns: Address1, Address2, City, County, Country, ZipCode, IsNotTrackable, LocationTag, CountInOrderUntilAcknowledgement, FulfilmentCenterDeductStockWhenProcessed, IsWarehouseManaged, StockLocationId, and more.

create_a_linnworks_locations_add_location

Use this call to add a new location in Linnworks.

update_a_linnworks_locations_update_location_by_id

Use this call to update a location's name and/or details in Linnworks.

delete_a_linnworks_locations_delete_location_by_id

Use this call to delete a location by its id in Linnworks.

get_single_linnworks_locations_get_warehouse_tot_e_by_id

Gets list of tots for a specific location or find a specific tot depending on the request parameters. Specify tot id or tot barcode to find specific tot in the location or if nothing is specified or parameters are omitted, all tots for the location will be returned in Linnworks. Returns: Totes.

delete_a_linnworks_locations_delete_warehouse_tote_by_id

Delete existing Tote from location Permissions Required: GlobalPermissions.Inventory.InventorySettings.LocationsNode in Linnworks. Returns: DeletedToteIds.

list_all_linnworks_macro_get_installed_macros

Get a list of all macros and their related applications as installed on the users system Permissions Required: GlobalPermissions.Applications.MacroConfigurationNode in Linnworks. Returns: Macros.

list_all_linnworks_macro_get_macro_configurations

Get all the macro configurations for the user account Permissions Required: GlobalPermissions.Applications.MacroConfigurationNode in Linnworks. Returns: MacroId, ApplicationName, MacroName, FriendlyName, Enabled, Started, Completed, Executing, CurrentState, MacroType, Parameters, Specification, and more.

get_single_linnworks_open_orders_get_view_stat_by_id

GetViewStats in Linnworks. Returns: ViewId, ViewName, IsSystem, TotalOrders, LocationId, ExpiryDate, IsCalculating, ViewExists, LastRequested, UserManagement, OrderViewUserPreference, Owner, and more.

list_all_linnworks_open_orders_filter_not_processed_open_orders

FilterNotProcessedOpenOrders in Linnworks. Returns: OrderIds.

linnworks_open_orders_search_orders_search

SearchOrders in Linnworks. Returns: OpenOrders, ProcessedOrders.

get_single_linnworks_open_orders_get_open_order_id_by_id

GetOpenOrderIds in Linnworks. Returns: PageNumber, EntriesPerPage, TotalEntries, TotalPages, Data. Required: ViewId, LocationId, EntriesPerPage.

get_single_linnworks_open_orders_get_open_order_by_id

GetOpenOrders in Linnworks. Returns: ResultCountRemovedByPostFilter, PageNumber, EntriesPerPage, TotalEntries, TotalPages, Data. Required: ViewId, LocationId, EntriesPerPage.

list_all_linnworks_open_orders_get_identifiers

Get all identifiers that are available to add to an order in Linnworks. Returns: IdentifierId, IsCustom, ImageId, ImageUrl, Tag, Name.

get_open_orders_get_identifiers_by_order_id_by_id

Get all identifiers for a list of orderIds in Linnworks. Returns: fkOrderId, IdentifierId, IsCustom, ImageId, ImageUrl, Tag, Name.

create_a_linnworks_open_orders_save_identifier

Create or update an order identifier in Linnworks. Returns: IdentifierId, IsCustom, ImageId, ImageUrl, Tag, Name.

delete_a_linnworks_open_orders_delete_identifier_by_id

Delete an identifier. This will also remove the identifier from all orders that it's assigned to in Linnworks.

create_a_linnworks_open_orders_assign_order_identifier

AssignOrderIdentifier in Linnworks. Returns: Changed, NotChanged.

create_a_linnworks_open_orders_unassign_order_identifier

Remove an identifier from an order in Linnworks. Returns: Changed, NotChanged.

get_single_linnworks_open_orders_get_orders_low_fidelity_by_id

Returns low fidelity view of open orders. The data is generally useful for very basic view or counters of what is in the open orders. Useful for finding orders quickly as it returns all scannable fields of the order and order items such as order ids, skus, barcodes etc. Permissions Required:… in Linnworks. Returns: Orders.

get_single_linnworks_open_orders_get_open_orders_detail_by_id

Open order details by order ids. Not limited by the number of orders you can retrieve. This call is designed to return ONLY open orders, it is much faster than GetOrderDetail call Permissions Required: GlobalPermissions.OrderBook.ViewOrderDetailsNode in Linnworks. Returns: Orders.

create_a_linnworks_open_orders_assign_stock_to_order

Assign Stock to Orders Permissions Required: GlobalPermissions.OrderBook.OpenOrdersNode in Linnworks. Returns: BatchActionResult.

delete_a_linnworks_open_orders_delete_assigned_stock_by_id

Permissions Required: GlobalPermissions.OrderBook.OpenOrdersNode in Linnworks. Returns: BatchActionResult.

list_all_linnworks_open_orders_get_available_channels

GetAvailableChannels in Linnworks. Returns: Channels.

get_single_linnworks_open_orders_get_order_item_indicator_by_id

Permissions Required: GlobalPermissions.OrderBook.OpenOrdersNode in Linnworks. Returns: Items.

create_a_linnworks_open_orders_mark_ready_for_collection

Permissions Required: GlobalPermissions.OrderBook.OpenOrdersNode in Linnworks. Returns: SuccessfulOrders, KeyedErrors.

list_all_linnworks_orders_get_order_details_by_reference_ids

Retrieves a list of order details for a given order reference number, returns maximum of 50 orders. For eBay orders, if Sellling Manager Pro sales number is available the order can be retrived by this number Permissions Required: GlobalPermissions.OrderBook.ViewOrderDetailsNode in Linnworks. Returns: OrderId, NumOrderId, Processed, ProcessedDateTime, FulfilmentLocationId, GeneralInfo, ShippingInfo, CustomerInfo, TotalsInfo, ExtendedProperties, FolderName, Items, and more.

list_all_linnworks_orders_get_order_details_by_num_order_ids

Retrieves the order detail for a given order numeric id. If not found empty class is returned. For working with open orders recommended to use OpenOrders/GetOpenOrdersDetails Permissions Required: GlobalPermissions.OrderBook.ViewOrderDetailsNode in Linnworks. Returns: OrderId, NumOrderId, Processed, ProcessedDateTime, FulfilmentLocationId, GeneralInfo, ShippingInfo, CustomerInfo, TotalsInfo, ExtendedProperties, FolderName, Items, and more.

list_all_linnworks_orders_get_order_by_ids

Get the full order detail for a single linnworks order by its unique system order id (pkOrderId). Returns: OrderId, NumOrderId, Processed, ProcessedDateTime, FulfilmentLocationId, GeneralInfo (status, source, subsource, reference numbers, received date, notes), ShippingInfo (vendor, postal service, tracking number, package details), CustomerInfo (channel buyer name, delivery and billing address), TotalsInfo (subtotal, postage, tax, total, currency, payment method), ExtendedProperties, FolderName, Items (order lines with SKU, quantity, pricing, tax and stock levels), Notes, PaidDateTime and TaxId. linnworks recommends OpenOrders/GetOpenOrdersDetails for open orders. Rate limit 150 requests per minute. Required: pkOrderId.

get_single_linnworks_orders_get_orders_by_id_by_id

Retrieves the order detail list for a list of order id identifiers (pkOrderId) For working with open orders recommended to use OpenOrders/GetOpenOrdersDetails Permissions Required: GlobalPermissions.OrderBook.ViewOrderDetailsNode in Linnworks. Returns: OrderId, NumOrderId, Processed, ProcessedDateTime, FulfilmentLocationId, GeneralInfo, ShippingInfo, CustomerInfo, TotalsInfo, ExtendedProperties, FolderName, Items, and more.

get_orders_get_order_packaging_calculation_by_id

Retrieves order packaging, weight and dimension information with split packaging. The method can perform ad hoc recalculation and saving of any changes. Permissions Required: GlobalPermissions.OrderBook.ViewOrderDetailsNode in Linnworks. Returns: pkOrderID, nOrderId, fkPostalServiceId, fkCountryId, cCountry, ItemWeight, fkPackagingGroupId, fkPackagingTypeId, IsSplitPackaging, PackagingWeight, TotalWeight, TotalWidth, and more.

create_a_linnworks_orders_recalculate_single_order_packaging

Designed to recalculate order packaging totals based on the object provided Permissions Required: GlobalPermissions.OrderBook.ViewOrderDetailsNode in Linnworks. Returns: pkOrderID, nOrderId, fkPostalServiceId, fkCountryId, cCountry, ItemWeight, fkPackagingGroupId, fkPackagingTypeId, IsSplitPackaging, PackagingWeight, TotalWeight, TotalWidth, and more.

create_orders_set_order_split_packaging_manual_overwrite

Designed to save order split packaging after a manual override Permissions Required: GlobalPermissions.OrderBook.ViewOrderDetailsNode in Linnworks. Returns: pkOrderID, nOrderId, fkPostalServiceId, fkCountryId, cCountry, ItemWeight, fkPackagingGroupId, fkPackagingTypeId, IsSplitPackaging, PackagingWeight, TotalWeight, TotalWidth, and more.

create_a_linnworks_orders_set_order_packaging

Save order packaging in linnworks that has already been calculated but not yet saved, or apply a manual packaging edit. Returns the saved order packaging record including pkOrderID, fkPackagingTypeId, TotalWeight, TotalWidth, TotalHeight, TotalDepth, Items, Bins, and DimMethod. Requires a request body containing the packaging payload to save.

get_orders_get_order_item_batchs_by_order_id_by_id

Get the list of order item batch information for a specified Linnworks order. Returns batches with OrderItemBatchId, OrderItemRowId, Quantity, nested Batch details (BatchId, BatchNumber, ExpiresOn), DespatchUnitValue, and AssignmentType (AUTO or MANUAL). Required: pkOrderId (order id) in the request body.

get_orders_get_order_item_batches_by_order_id_by_id

Get order item batch information for the specified orders in linnworks. Returns an OrderBatches array with pkOrderId, OrderId, and per-item Batches (BatchInventoryId, Quantity, and Batch details such as SKU, BatchNumber, and ExpiresOn). Required: pkOrderIds.

get_orders_get_all_available_order_item_batchs_by_order_id_by_id

Get a list of available stock item batches for each order item of the specified Linnworks order. Returns: BatchId, SKU, BatchNumber, ExpiresOn, SellBy, and per-location Inventory records. Requires the order id in the request body.

create_a_linnworks_orders_create_order

Create new orders in bulk in Linnworks. Returns the list of pkOrderId UUIDs for the orders that were saved; orders already marked as paid are skipped on save. Required: orders.

create_a_linnworks_orders_add_extended_property

Add extended properties to a Linnworks order. Existing properties that match on name/value are skipped rather than updated. Returns ExtendedPropertiesInserted (count of properties added) and Errors (add-attempt failure messages).

create_orders_create_serialised_values_for_order_item

Create serial data for the given order item rows in Linnworks: each entry in OrderItemSerialData identifies an OrderItemRowId and carries one collection of serial data per physical item being shipped (e.g. an order item with quantity 2 gets 2 collections), and values overwrite any existing serial data for that row. Required: OrderItemSerialData. Returns an empty 204 response on success.

get_orders_get_order_item_row_serial_values_by_order_id_by_id

Get order item row serial information for a set of orders in linnworks by order id. Returns OrderItemRowSerialValuesByOrderIds, a dictionary keyed by order id whose values list OrderItemRowId and CorrelationSerials collections with Type and Value entries. Required: OrderIds (array of UUIDs, maximum 25 per request).

get_single_linnworks_orders_get_assigned_order_item_batch_by_id

Get the batches assigned to order items in Linnworks. Returns: OrderItemBatchId, OrderItemRowId, Quantity, Batch (BatchId, SKU, BatchNumber, Inventory), DespatchUnitValue, and AssignmentType. Requires a JSON request body.

create_a_linnworks_orders_assign_order_item_batch

Assign batches to linnworks order items. Returns an empty 204 response on success. Requires a JSON request body following Linnworks' Orders_AssignOrderItemBatchesRequest schema.

create_a_linnworks_orders_assign_stock_to_order

Assign stock batches to a Linnworks order. Returns the resulting batch assignments as an array of OrderItemBatch objects with OrderItemBatchId, OrderItemRowId, Quantity, Batch, and AssignmentType. Required: request.

list_all_linnworks_orders_get_user_location_ids

Get the location id configured for the user in linnworks order settings. Returns the location id as a UUID string (e.g. 00000000-0000-0000-0000-000000000000).

get_single_linnworks_orders_get_open_order_by_id

Get a paged list of open orders in linnworks. Returns PageNumber, EntriesPerPage, TotalEntries, TotalPages, and a Data array of open order records including NumOrderId, GeneralInfo, ShippingInfo, CustomerInfo, TotalsInfo, and Fulfillment.

get_single_linnworks_orders_get_all_open_order_by_id

Get the ids of all open orders in Linnworks as a single unpaginated list. Returns: array of open order id UUID strings (e.g. "00000000-0000-0000-0000-000000000000"). Requires a request body; no individual body fields are required.

get_orders_get_all_open_orders_between_index_by_id

Get the ids of all open orders in Linnworks that fall between two index positions, with the current filters and sorting applied. Returns an array of open order id UUIDs.

create_a_linnworks_orders_set_labels_printed

Mark a list of orders as label printed in Linnworks. Returns the affected order ids as an array of UUID strings.

create_a_linnworks_orders_set_invoices_printed

Mark a list of orders as invoice printed in Linnworks; the operation cannot be executed on locked or parked orders. Returns the updated order ids as an array of UUID strings. Required: orderIds.

create_a_linnworks_orders_set_pick_list_printed

Mark the given orders as pick list printed in Linnworks. Returns an empty 204 response on success. Requires orderIds (list of Linnworks order ids). Cannot be executed on locked or parked orders.

create_a_linnworks_orders_run_rules_engine

Run the linnworks Rules Engine on open orders. Returns an array of UUID order identifiers the engine processed. Pass orderIds (list of order UUIDs) in the body; ruleId is optional — omit or null to run all rules.

list_all_linnworks_orders_get_order_item_compositions

Get the composition detail of a specific order item in Linnworks. Returns the full OrderItem including ItemId, SKU, Title, Quantity, AvailableStock, PricePerUnit, and CompositeSubItems.

create_a_linnworks_orders_change_order_tag

Change the tag for a list of linnworks orders. Tags 1-6 are custom tags, 7 sets a 'parked' status on the order, and null removes the tag. Returns the array of affected order ids (uuids).

list_all_linnworks_orders_get_available_folders

List the linnworks folders that orders can be assigned to. Returns an array of folders, each with its pkFolderId (UUID) and FolderName.

create_a_linnworks_orders_set_available_folder

Set the list of available folders that orders can be assigned to in linnworks. Returns the resulting array of folder objects with all documented fields: pkFolderId, FolderName. Required: folders.

create_a_linnworks_orders_assign_to_folder

Assign a list of linnworks orders to a specific folder. Returns an array of order id UUIDs for the orders processed. Requires orderIds and folder. Cannot be executed on locked or parked orders.

create_a_linnworks_orders_unassign_to_folder

Unassign a list of orders from a specific folder in linnworks. Returns an array of the affected order ids as UUID strings. Required: orderIds, folder. This operation cannot be executed on locked or parked orders.

list_all_linnworks_orders_get_order_xml_js_trees

Get the order XML JSTree data received from the sales channel in Linnworks. Returns the order XML as a raw string (available as JSON or XML depending on the requested content type).

list_all_linnworks_orders_get_order_xmls

Get the raw order XML received from the sales channel for an order in linnworks. Returns: Type.

create_a_linnworks_orders_change_shipping_method

Change the shipping service (provided by a shipping courier) for a list of orders in Linnworks. Returns the affected order ids as an array of UUIDs. Required: orderIds, shippingMethod.

create_a_linnworks_orders_change_status

Change the status of a list of Linnworks orders (status values: 0 = UNPAID, 1 = PAID, 2 = RETURN, 3 = PENDING, 4 = RESEND). Returns an array of uuid order ids for the orders the status was applied to. Requires a JSON request body.

create_a_linnworks_orders_lock_order

Lock a list of orders in Linnworks. Requires a JSON request body matching the LockOrderRequest schema. Returns an empty 204 response on success.

delete_a_linnworks_orders_delete_order_by_id

Delete a specific order in Linnworks. Requires a JSON request body identifying the order to delete. Returns an empty 204 response on success.

create_a_linnworks_orders_cancel_order

Cancel a specific order in Linnworks. Returns a plain string result on success. Requires a request body identifying the order to cancel.

create_a_linnworks_orders_move_to_location

Move a list of Linnworks orders to a specific location. Returns: SuccessfulOrders (the ids of the orders that were moved) and KeyedErrors (errors keyed by orderId). Requires LocationId and OrderIds.

create_a_linnworks_orders_clear_shipping_label_info

Clear shipping label info for a list of Linnworks orders. Returns an array of key/value result pairs — key (the submitted order id) and value (its clear outcome) — one per order. Requires a JSON request body (Orders_ClearShippingLabelInfoRequest).

create_a_linnworks_orders_clear_invoice_printed

Clear the invoice printed flag for a list of Linnworks orders. Returns an array of order UUID strings for the processed orders. Required: orderIds. This operation cannot be executed on locked or parked orders.

create_a_linnworks_orders_clear_pick_list_printed

Clear the pick list printed flag for a list of orders in Linnworks. Returns an array of the processed order ids (uuid strings). Required: orderIds. Cannot be executed on locked or parked orders.

list_all_linnworks_orders_get_shipping_methods

List the shipping methods available for orders in Linnworks. Returns an array of shipping method records, each with its id. No parameters are required.

list_all_linnworks_orders_get_packaging_groups

List the packaging groups available in linnworks. Returns an array of packaging group objects (PackageGroup items) with fields defined by the upstream linnworks schema.

list_all_linnworks_orders_get_extended_properties

Get the extended properties for a specific Linnworks order. Returns an array of extended property objects including RowId, Name, Value, Type, CreatedDate, and LastUpdatedDate. Required: orderId (UUID).

list_all_linnworks_orders_get_extended_property_types

Get the available types of extended properties for orders in linnworks. Returns an array of extended property type name strings; no parameters required.

list_all_linnworks_orders_get_extended_property_names

List the available types of extended properties for orders in Linnworks. Returns an array of strings, each naming one available extended property type. Takes no parameters.

create_a_linnworks_orders_set_extended_property

Set the extended properties for a specific Linnworks order. Returns the saved extended properties, each with RowId, Name, Value, Type, CreatedDate, and LastUpdatedDate. Required: OrderId, ExtendedProperties.

list_all_linnworks_orders_get_batch_pilots

List the available batch pilots in Linnworks. Returns an array of key-value pairs, each with Key (the pilot's GUID identifier) and Value (the pilot name). This call takes no parameters.

get_single_linnworks_orders_get_order_by_id

Get a specific open order in Linnworks. Returns the full open-order object including OrderId, NumOrderId, Processed, GeneralInfo, ShippingInfo, CustomerInfo, TotalsInfo, Items, and Notes. Required: the order id, passed in the request body.

list_all_linnworks_orders_get_orders

List open orders in Linnworks. Returns an array of full open-order objects including OrderId, NumOrderId, Processed, GeneralInfo, ShippingInfo, CustomerInfo, TotalsInfo, Items, and Notes. Filters are supplied in the request body.

list_all_linnworks_orders_get_order_audit_trails

Get the audit trail entries for a linnworks order. Returns each entry's id plus its audit trail fields under attributes. Required: orderId.

get_single_linnworks_orders_get_order_audit_trails_by_id_by_id

Get the audit trails for a list of linnworks orders in a single call. Returns the audit trail entries for the provided order ids; the upstream docs do not enumerate the entry fields. Required: order_ids (array of order id UUIDs).

list_all_linnworks_orders_get_order_notes

Get the order notes for a specific linnworks order. Returns an array of order note objects including OrderNoteId, OrderId, NoteDate, Internal, Note, CreatedBy, and NoteTypeId. Required: orderId.

get_single_linnworks_orders_get_orders_note_by_id

Get the notes for one or more linnworks orders in a single call. Returns a map of order id to an array of OrderNote objects with OrderNoteId, OrderId, NoteDate, Internal, Note, CreatedBy, and NoteTypeId. Requires a JSON request body.

list_all_linnworks_orders_get_order_note_types

List the order note types available for orders in linnworks. Returns an array of note type records, each with an id and content-specific attributes. No parameters are required.

create_a_linnworks_orders_set_order_note

Set the order notes for a specific order in linnworks. The provided list overwrites all existing notes — fetch current notes via GetOrderNotes and include them so none are lost. Requires a JSON request body per the upstream SetOrderNotes request schema. Returns an empty 204 response on success.

create_a_linnworks_orders_add_orders_note

Add a new note to one or more Linnworks orders in a single batch call. Returns the AddOrdersNote operation result on success. Required: OrderIds.

list_all_linnworks_orders_get_order_relations

Get order relations for an order in Linnworks. Returns a list of order relation records, each including its id and attributes (the upstream OrderRelation fields).

get_single_linnworks_orders_get_orders_relation_by_id

Get order relations for a list of orders in Linnworks. Returns a map of order id to the array of OrderRelation objects for that order. Requires a JSON request body identifying the orders to fetch relations for (schema per the Linnworks Orders_GetOrdersRelationsRequest definition).

list_all_linnworks_orders_get_order_items

List order items for a Linnworks order. Returns an array of order item records including SKU, ItemNumber, Title, Quantity, PricePerUnit, CostIncTax, stock levels, and BinRacks. Filter by orderId and fulfilmentCenter.

list_all_linnworks_orders_get_open_order_items_suppliers

List the item suppliers for a specific open order in linnworks. Returns an array of Key/Value UUID pairs, each linking an order item to its supplier. Required: orderId.

create_a_linnworks_orders_add_order_item

Add an item to a specific order in linnworks. Returns the update result object (UpdateOrderItemResult) with id and schema-specific result fields (attributes). Line pricing is optional: PricePerUnit defaults to the stock item retail price, DiscountPercentage to 0, TaxRatePercentage to the stock item tax rate, and TaxInclusive to true. Requires a JSON request body identifying the order and item.

create_a_linnworks_orders_add_order_service

Add a service to an order in Linnworks. Returns the UpdateOrderItemResult object confirming the order change; the Linnworks reference does not enumerate the fields of this result object.

update_a_linnworks_orders_update_order_item_by_id

Update an order item on a Linnworks order. Requires a JSON request body and returns the order item update result object with vendor-defined fields.

create_a_linnworks_orders_remove_order_item

Remove an item from a Linnworks order. Returns an UpdateOrderItemResult object describing the outcome of the removal. Requires a JSON request body identifying the order and the item to remove.

list_all_linnworks_orders_get_countries

List the available countries in linnworks. Returns an array of country records, each with an id and attributes; the attribute fields follow linnworks' OrderCountry schema. Takes no parameters.

list_all_linnworks_orders_get_payment_methods

Get the payment methods available in Linnworks. Returns: Name, Price, Currency. No required parameters.

list_all_orders_get_default_payment_method_id_for_new_orders

Get the default payment method for new direct orders in linnworks. Returns a single UUID string identifying the payment method id. No parameters are required.

create_orders_set_default_payment_method_id_for_new_order

Set the default payment method applied to new direct orders in Linnworks. Returns an empty 204 response on success. Requires a JSON request body (referenced upstream as Orders_SetDefaultPaymentMethodIdForNewOrderRequest; its fields are not enumerated in the source docs).

create_a_linnworks_orders_set_payment_method

Set the available payment methods in Linnworks. Returns an array of payment method objects. Requires a request body. Rate limited to 150 requests per minute.

create_a_linnworks_orders_create_new_order

Create an empty draft order in Linnworks (for fully-specified orders, use the CreateOrders call instead). Returns the new open order including OrderId, NumOrderId, ReferenceNum, Status, ShippingInfo, TotalsInfo, and Items.

list_all_linnworks_orders_get_draft_orders

List draft orders in Linnworks. Returns an array of draft order ids as UUID strings (one id per draft order, e.g. 00000000-0000-0000-0000-000000000000). No parameters required.

create_a_linnworks_orders_complete_order

Complete a specific order in linnworks. Returns a plain string acknowledgement on success rather than a structured object. Requires a CompleteOrder request body.

create_a_linnworks_orders_split_order

Split a Linnworks order into multiple separate orders. Returns an array of the resulting order objects, each with OrderId, NumOrderId, GeneralInfo, TotalsInfo, and Items. Requires a JSON request body.

create_a_linnworks_orders_merge_order

Merge a list of orders in Linnworks into a single new open order. Returns the merged open order object (id plus its upstream-defined OpenOrder fields). Requires a JSON request body identifying the orders to merge.

create_a_linnworks_orders_process_order

Process a specific order in linnworks, advancing it through the processing workflow. Returns a process-order result object (ProcessOrderResult) describing the outcome of the operation. Required: a JSON request body matching the upstream Orders_ProcessOrderRequest schema; the discovered source references that schema by name without enumerating its fields, so consult the linnworks API reference for…

create_a_linnworks_orders_process_order_required_batch_scan

Update a Linnworks order with the batch numbers scanned during process order (for items with batch number scanning required, including composite children); this overwrites any existing batch assignment for those items. Requires the batch scan request body, with batches supplied for every scan-required item. Returns an empty 204 response on success.

create_a_linnworks_orders_process_orders_in_batch

Process a list of orders in Linnworks in one batch call. Returns an array of per-order ProcessOrderResult objects. Requires a JSON batch request payload; its field structure is defined by the upstream Orders_ProcessOrdersInBatchRequest schema.

create_a_linnworks_orders_process_fulfilment_centre_order

Process orders associated with a Fulfilment Centre in Linnworks. Returns the process-order result object; the Linnworks API reference does not enumerate its fields. Requires a JSON request body.

create_a_linnworks_orders_set_order_general_info

Update the general info of a specific order in linnworks. Requires a JSON request body matching linnworks' SetOrderGeneralInfoRequest schema. Returns an empty 204 response on success.

create_a_linnworks_orders_set_order_shipping_info

Update the shipping info of a specific order in linnworks by posting a JSON request body. Returns an UpdateTotalsResult object reflecting the order's recalculated totals after the update.

create_a_linnworks_orders_set_order_customer_info

Update the customer info of a specific order in linnworks, supplying the buyer's shipping and billing details for that order. Returns the recalculated order totals including Subtotal, PostageCost, Tax, TotalCharge, TotalDiscount, and Currency. Required: a JSON request body.

create_a_linnworks_orders_set_order_totals_info

Update the totals info (subtotal, postage cost, tax, total charge, currency) of a specific order in linnworks. Required: a JSON body following the upstream Orders_SetOrderTotalsInfoRequest schema (its fields are not enumerated in the API docs). Returns an empty 204 response on success.

create_a_linnworks_orders_validate_coupon

Validate a coupon in linnworks. Returns a coupon validation result (upstream CouponValidationResult) with the record's id and an attributes object holding the validation fields. Required: a JSON request body matching the upstream Orders_ValidateCouponRequest schema.

create_a_linnworks_orders_add_coupon

Add a coupon to a specific order in linnworks. Returns the order-item update result object (UpdateOrderItemResult). Requires a JSON request body matching the upstream Orders_AddCouponRequest schema.

update_a_linnworks_orders_update_billing_addrese_by_id

Update the billing address of a specific order in Linnworks. Sends a JSON request body and returns an empty 204 response on success.

create_a_linnworks_orders_set_additional_info

Overwrite the existing order item additional info in Linnworks. Returns an empty 204 response on success.

update_a_linnworks_orders_update_additional_info_by_id

Update the additional info of a specific order item in Linnworks. Sends a JSON request body defined upstream by the Orders_UpdateAdditionalInfoRequest model (field-level shape not enumerated in the source docs). Returns an empty 204 response on success. Requires a JSON request body.

list_all_linnworks_orders_get_order_views

List the open order views saved in linnworks. Returns an array of UserOrderView view records, each including its pkViewId identifier.

get_single_linnworks_orders_get_order_view_by_id

Get a specific open order view in linnworks by id. Returns the UserOrderView record including its pkViewId identifier. Required: pkViewId.

create_a_linnworks_orders_save_order_view

Update an open order view in Linnworks. Returns an empty 204 response on success. Requires a JSON request body; its fields are defined by the upstream Orders_SaveOrderViewRequest schema.

list_all_linnworks_orders_customer_look_ups

Look up possible customer addresses in linnworks based on a search. Returns matching customer address records, each with an id and address attributes whose exact fields follow the upstream CustomerAddress schema.

list_all_linnworks_orders_get_linked_items

List the items linked to a stock item in Linnworks, looked up by itemId (the item's pkStockItemId). Returns an array of LinkedItem records; the source documentation does not enumerate their fields.

update_a_linnworks_orders_update_link_item_by_id

Update the linked item for a Linnworks order. Sends a JSON request body (Orders_UpdateLinkItemRequest, field-level contract defined in Linnworks' API reference) and returns an empty 204 response on success. Requires a JSON request body.

create_a_linnworks_orders_create_new_item_and_link

Create a new order item in linnworks and link it to a specific stock item. Returns the id of the newly created item as a UUID string. Requires a JSON request body conforming to linnworks' Orders_CreateNewItemAndLinkRequest schema.

list_all_linnworks_orders_get_order_packaging_splits

Get possible order splits by packaging for a Linnworks order. Returns an array of packaging-split proposals (OrderPackagingSplit objects; the split structure is defined upstream in the Linnworks API reference).

create_a_linnworks_orders_set_order_packaging_split

Split a linnworks order by packaging, applying the packaging split computed for the order. Returns an UpdateTotalsResult with the recalculated order totals. Requires a packaging split request body.

get_orders_get_open_order_id_by_order_or_reference_id_by_id

Get the open order id in linnworks by reference number or order number. Returns the open order id as a UUID string (e.g. 00000000-0000-0000-0000-000000000000). Requires a JSON request body.

create_a_linnworks_orders_process_order_by_order_or_reference_id

Process a Linnworks order by its order id or reference id. Requires a JSON request body identifying the order to process. Returns the order processing result object; Linnworks' published documentation does not enumerate the response fields for this endpoint.

get_orders_get_open_orders_by_item_barcode_by_id

Get open orders in Linnworks by order item barcode. Returns an array of key/value entries, each pairing an OrderSummary object (Key) with a string (Value). Requires a JSON request body (upstream schema: Orders_GetOpenOrdersByItemBarcodeRequest).

list_all_linnworks_picking_get_all_picking_wave_headers

List all pickwave headers in Linnworks. Returns the GetPickingWaveHeadersResponse object; the source documentation does not enumerate its fields.

list_all_linnworks_picking_get_my_picking_wave_headers

List pickwave headers assigned to the current user in linnworks. Returns the GetPickingWaveHeadersResponse pickwave header collection; optional state, locationId, and detailLevel filters narrow the results (all states returned when state is omitted).

list_all_linnworks_picking_get_all_picking_waves

List all pickwaves in Linnworks. Returns pickwave entries including their PickwaveId, state, and locationId.

list_all_linnworks_picking_get_my_picking_waves

List the pickwaves for the current user in Linnworks. Returns: PickwaveId, State, LocationId.

list_all_linnworks_picking_get_picking_waves

Get a specific pickwave in Linnworks by id. Returns the pickwave record including its id and its upstream schema-defined pickwave fields.

update_a_linnworks_picking_update_picking_wave_item_by_id

Update one or more pickwave items in Linnworks. Returns the updated pickwave response (upstream GetPickingWavesResponse schema — its field-level properties are not enumerated in the available documentation). Requires a JSON request body (the UpdatePickingWaveItem request payload).

update_a_linnworks_picking_update_picking_wave_header_by_id

Update a pickwave header in Linnworks by posting a PickingWaveUpdateRequest JSON body. Returns 200 with the updated pickwave data defined by the upstream GetPickingWavesResponse schema (shared with GetPickingWave); the available source does not expand its field list.

create_a_linnworks_picking_generate_picking_wave

Generate a new picking wave in Linnworks. Returns a GeneratePickingWaveResponse object; the upstream documentation does not enumerate its fields. Requires a PickingWaveGenerate JSON request body.

create_a_linnworks_picking_check_allocatable_to_pickwave

Check whether Linnworks order ids can be added to a pickwave. Returns the allocatability check results under attributes (the upstream CheckAllocatableToPickwaveResponse, per supplied order id). Requires a JSON request body listing the Linnworks order ids to check.

list_all_linnworks_picking_get_pickwave_users_with_summaries

List Linnworks pickwaves with per-user summary entries, including dummy entries with a PickwaveId of 0 for users permitted to complete pickwaves but with no wave currently assigned. Returns: PickwaveId, plus an attributes object holding the remaining upstream summary fields.

delete_a_linnworks_picking_delete_orders_from_picking_wave_by_id

Remove one or more orders from a pickwave in linnworks. Returns a 200 OK result body whose exact fields follow the upstream DeleteOrdersFromPickingWavesResponse schema (not expanded in the available source). Requires a JSON request body per the upstream Picking_DeleteOrdersFromPickingWavesRequest schema; the endpoint takes no other inputs.

list_all_linnworks_picking_get_item_binracks

List the alternative binrack locations where a requested stock item can be found in Linnworks, excluding the location already suggested for picking. Returns a list of place records; the field-level shape is defined by the upstream GetItemBinracksResponse schema and is not enumerated in the available documentation. All query parameters (stockItemId, stockLocationId, currentBinRackSuggestion,…

update_picking_update_picking_wave_item_with_new_binrack_by_id

Update the batch/binrack allocation for a Linnworks pickwave item. Returns the refreshed picking wave data in Linnworks' GetPickingWavesResponse format (same payload as the GetPickingWave endpoint). Only applicable to pickwave items that carry batch information.

update_a_linnworks_picking_update_picked_item_delta_by_id

Update the batch/binrack allocation for an allocated pickwave item in Linnworks. Returns the resulting pickwave data for the affected wave rather than the item alone. Only applicable to pickwave items with batch information.

list_all_picking_get_pickingwave_despatch_data_by_locations

Get picking wave despatch data by location in Linnworks. Returns despatch data records including id and upstream-defined attributes (PickingWaveDespatchData).

list_all_linnworks_postal_services_get_postal_services

List the Linnworks postal services available to the user, including information on the channels and couriers linked to each service. Returns an array of postal service objects with their linked channel and courier details. No caller-supplied parameters are required.

create_a_linnworks_postal_services_create_postal_service

Create a new postal service in Linnworks, adding it to the shipping database. Returns the created postal service object including its id and its upstream-defined service attributes. Requires a JSON request body conforming to the upstream CreatePostalService request schema.

update_a_linnworks_postal_services_update_postal_service_by_id

Update an existing postal service in linnworks. Requires a JSON request body matching the upstream PostalServices_UpdatePostalServiceRequest schema; its field-level contract is not enumerated in the source. Returns an empty 204 response on success.

delete_a_linnworks_postal_services_delete_postal_service_by_id

Delete an existing postal service from Linnworks. Returns an empty 204 response on success. Requires a JSON request body (upstream schema: PostalServices_DeletePostalServiceRequest); the source documentation does not enumerate its fields.

list_all_linnworks_postal_services_get_channel_links

List channel service link information for linnworks postal services. Returns channel service link records including id and attributes.

list_all_linnworks_post_sale_get_cancellation_options

Validate whether a channel cancellation can be submitted for a given Linnworks order. Returns the upstream CancellationOptions object for the order. Required: orderId (UUID).

create_a_linnworks_post_sale_create_cancellation

Create a cancellation in Linnworks: further validates the request, creates the cancellation, and submits it to the sales channel where requested. Returns the ValidatedCancellation result object (schema-defined upstream; the reference does not enumerate its fields). Requires the PostSale cancellation request body (PostSale_CreateCancellationRequest).

create_print_service_create_pd_ffrom_job_force_template_stock_in

Create a PDF file from a print job request via the linnworks Print Service, using a forced template for stock-in labels. Returns a CreatePDFResult object with schema-defined fields; the field-level shape is defined upstream.

create_print_service_create_pd_ffrom_job_force_template

Create a PDF file from a print job request in linnworks. Returns the CreatePDFResult object with fields describing the generated PDF. Requires the print job request body.

print_service_create_pd_ffrom_job_force_template_with_quantities

Create a PDF file of Stock Item labels from a print job request in Linnworks PrintService. Returns the CreatePDFResult object generated for the print job. Requires the print job request body defined by the PrintService_CreatePDFfromJobForceTemplateWithQuantitiesRequest schema.

create_a_linnworks_print_service_print_template_preview

Generate a PDF preview of a specific print template in linnworks. Requires a JSON request body defining the template preview. Returns the generated PDF result object with an opaque, upstream-defined shape.

list_all_linnworks_print_service_get_template_lists

List the print templates available in linnworks. Returns an array of template headers, each identified by id with template-specific attributes.

list_all_linnworks_print_service_vp_get_printers

List the virtual printers configured for your linnworks account. Returns an array of virtual printer records, each with an id and printer-specific attributes; Linnworks does not document the VirtualPrinter fields in detail.

list_all_linnworks_print_service_get_users_for_printer_configs

List the Linnworks users available for printer configuration. Returns an array of user records (PermissionsUser objects), including their id. Only super admins receive the full list; non-super-admins get only their own user record. Takes no parameters.

print_service_create_return_shipping_labels_pdf_with_sk_us_creat

Create a PDF file of return shipping labels for a single order in linnworks. Returns the PDF generation result (CreatePDFResult) with details of the generated PDF. Requires a JSON request body matching the upstream CreateReturnShippingLabelsPDFWithSKUs request schema.

create_print_service_create_return_shipping_labels_pdf

Create a PDF file of return shipping labels for a single Linnworks order. Returns the generated PDF result object; the upstream source does not enumerate its fields. Requires a JSON request body identifying the order.

list_all_linnworks_print_zone_get_all_print_zones

List all print zones configured in linnworks. Returns a 200 OK print-zone collection response whose per-item field set is not enumerated in the available Linnworks documentation. Takes no parameters.

create_a_linnworks_processed_orders_refund_free_text

Create or update a free text refund on a processed order in Linnworks; can also change the refund amount of a pending manual refund. Returns an array of refund records (id) whose remaining fields follow Linnworks' RefundInfo schema. Requires a JSON request body (upstream schema ProcessedOrders_RefundFreeTextRequest); verify any automated refunds are valid before calling.

create_a_linnworks_processed_orders_refund_shipping

Create a shipping refund for a processed order in Linnworks. Check the order's refund options first to confirm a shipping refund is possible. Requires a ProcessedOrders_RefundShippingRequest JSON body; returns an array of RefundInfo records describing the refunds created. Rate limited to 150 calls per minute.

create_processed_orders_mark_manual_refunds_as_actioned

Mark pending manual refunds in Linnworks as actioned, updating them from the pending state. Accepts a JSON request body and returns an empty 204 response on success.

create_a_linnworks_processed_orders_refund_service

Refund one or more services on a processed Linnworks order. Returns an array of refund information (RefundInfo) entries for the refunded services. Requires a JSON request body identifying the order and services to refund; validate that any automated refunds are valid before calling.

create_processed_orders_validate_complete_order_refund

Check whether an automated full-order refund is possible for a Linnworks processed order. Returns a validation result object (upstream ValidationResult schema; its fields are not enumerated in the available source). Requires a JSON request body matching the upstream ValidateCompleteOrderRefundRequest schema.

list_all_linnworks_processed_orders_get_refunds_options

Get the refund options for a linnworks processed order — which manual and automated refund types are possible for that order. Returns the refund options record (id, attributes). Required: pkOrderId (the order's id).

list_all_linnworks_processed_orders_get_refundable_service_items

Get the list of service items on a Linnworks processed order that are eligible for a refund. Returns each service item's id and attributes, with the item fields defined by the upstream ServiceItem schema.

list_all_linnworks_processed_orders_get_total_refunds

Get the total value of refunds against a processed order in linnworks. Returns the ExistingRefundTotal record with schema-specific fields (id, attributes) defined upstream. Required: pkOrderId.

create_a_linnworks_processed_orders_is_refund_valid

Validate whether the refunds in a given return set are valid in Linnworks. Returns a Linnworks ValidationResult object; the available Linnworks documentation does not enumerate its fields. Requires a JSON request body matching Linnworks' ProcessedOrders_IsRefundValidRequest schema.

list_processed_orders_is_refund_validation_required_by_order_ids

Check whether a linnworks order requires refund validation before refunds or returns/exchanges with refund components can proceed. Returns a boolean flag (true when validation is required for the given order). Required: pkOrderId (the order id to check).

list_all_linnworks_processed_orders_get_channel_refund_reasons

List the valid channel refund reasons for a given order in linnworks; these reasons are needed when making channel refunds. Returns an array of channel refund reason entries for the order identified by pkOrderId.

list_all_linnworks_processed_orders_get_returns_exchanges

List the returns, exchanges and resends recorded against a processed order in linnworks. Returns the basic list of return info entries for the order, one per return, exchange or resend. Supply the order id as pkOrderId (UUID).

list_all_linnworks_processed_orders_get_return_items_infos

Get all items on a Linnworks processed order together with their return and resend quantities, used to calculate how many items have already been returned. Returns an array of per-item return-info objects (Linnworks OrderItemReturnInfo schema), one entry for each item on the order. Required: pkOrderId.

list_all_linnworks_processed_orders_get_return_order_infos

Get basic information about a processed order in linnworks — source, subsource, and address as seen on the Returns/Refunds screens. Returns: source, subsource, address. Required: pkOrderId.

list_all_linnworks_processed_orders_get_order_infos

Get detailed header-level information about a processed order in linnworks. Returns the processed order (ProcessedOrderWeb) object including its pkOrderId. Required: pkOrderId (the order id).

get_processed_orders_get_order_tracking_ur_l_by_id

Get the tracking URLs for processed orders in Linnworks, looked up per order by vendor and tracking number. Returns the tracking URL details for the supplied orders. Requires a JSON request body identifying the orders to look up.

linnworks_processed_orders_search_processed_orders_search

Search processed orders in linnworks by posting search criteria. Returns the matched processed order results with the schema-defined fields of the upstream SearchProcessedOrdersResponse. Requires a JSON request body.

linnworks_processed_orders_search_processed_orders_pageds_search

Search for processed orders in Linnworks via a paged search. Returns paged results with page_number, entries_per_page, total_entries, total_pages and data.

create_a_linnworks_processed_orders_download_orders_to_csv

Download processed orders to CSV in Linnworks. Returns the DownloadOrdersToCSVResponse download result object; the upstream docs do not enumerate its fields. Requires a JSON request body.

create_a_linnworks_processed_orders_add_return_category

Create a new return category in linnworks. Returns the created order return category object. Requires a request body with the return category details.

create_a_linnworks_processed_orders_rename_return_category

Rename an existing return category in Linnworks. Returns an empty 204 response on success. Requires a JSON request body per the upstream ProcessedOrders_RenameReturnCategoryRequest schema identifying the category to rename and its new name.

delete_a_linnworks_processed_orders_delete_return_category_by_id

Delete an existing return category in linnworks. Returns an empty 204 response on success. Requires a request body identifying the return category to delete.

list_all_linnworks_processed_orders_get_processed_relatives

List the related orders for a processed order in linnworks. Returns an array of related-order (ProcessedOrderRelation) records; the upstream docs do not enumerate the fields of each record. Required: pkOrderId (the order id, UUID).

list_all_linnworks_processed_orders_get_package_splits

Get split packaging information for a processed order in Linnworks. Returns an array of SplitPackaging records for the order. Required: pkOrderId (the order id, UUID).

list_all_linnworks_processed_orders_get_processed_audit_trails

Get the audit trail for a processed order in Linnworks. Returns: entries (the audit trail records for the order, upstream type AuditEntry). Required: pkOrderId (the order id, UUID).

list_processed_orders_get_processed_order_extended_properties

Get order-level extended properties for a processed order in Linnworks. Returns a list of extended properties with RowId, Name, Value, Type, CreatedDate, and LastUpdatedDate. Filter by pkOrderId (the order id, UUID).

list_all_linnworks_processed_orders_get_return_categories

List the return categories configured in linnworks, used for refunds, resends and exchanges. Returns the collection of return category records including each category's id and attributes. No required parameters.

list_all_linnworks_processed_orders_get_processed_order_notes

Get the order notes for a processed order in linnworks. Returns a list of notes with OrderNoteId, OrderId, NoteDate, Internal, Note, CreatedBy, and NoteTypeId. Required: pkOrderId.

create_a_linnworks_processed_orders_add_order_note

Add a new note to a processed order in linnworks. Returns the UUID id of the created order note. Requires a JSON request body (upstream schema ProcessedOrders_AddOrderNoteRequest).

create_a_linnworks_processed_orders_change_order_note

Edit an existing order note on a processed order in Linnworks. Returns an empty 204 response on success. Requires a JSON request body with the order note details.

delete_a_linnworks_processed_orders_delete_order_note_by_id

Delete an existing note on a linnworks processed order. Requires a JSON request body identifying the note to delete. Returns an empty 204 response on success.

create_a_linnworks_processed_orders_create_exchange

Create an exchange for a processed order in Linnworks. Returns an array of return/exchange info records as defined by Linnworks' ReturnInfo schema. Requires an exchange request body.

create_a_linnworks_processed_orders_create_resend

Create a resend for a processed order in linnworks. Returns a 200 OK response as an array of ReturnInfo objects describing the created resend. Requires a JSON request body following the CreateResend request schema.

create_a_linnworks_processed_orders_create_full_resend

Create a full resend for a processed order in linnworks. A JSON request body is required (ProcessedOrders_CreateFullResendRequest); the source docs reference this schema but do not enumerate its fields. Returns 200 OK with an array of ReturnInfo objects for the created resend.

list_all_linnworks_processed_orders_get_refunds

List refund order items for a Linnworks processed order. Returns an array of refund records including the record id and the refund-specific detail fields in attributes. Supply pkOrderId (the order's UUID primary key) to select the order.

list_all_linnworks_processed_orders_check_order_fully_returneds

Check whether a Linnworks order was fully returned. Returns a boolean flag (true when the order was fully returned). Required: pkOrderId (UUID of the order).

linnworks_purchase_order_search_purchase_orders_2_s_search

Search Linnworks purchase orders by parameters such as date of purchase, status, and reference number. Returns a paged result of purchase order headers: Data (purchase order header records), PageNumber, EntriesPerPage, TotalEntries, and TotalPages. All search parameters are supplied in the request body.

linnworks_purchase_order_search_purchase_orders_search

Search Linnworks purchase orders by parameters such as date of purchase, status, or reference number. Returns a paged result of purchase order headers; the header fields follow Linnworks' Search_PurchaseOrdersResult schema. Requires a JSON request body of search parameters (upstream PurchaseOrder_Search_PurchaseOrdersRequest).

create_a_linnworks_purchase_order_create_purchase_order_initial

Create an initial purchase order in linnworks; the purchase order is created in pending status and stock items can be added to it afterwards. Returns: id. Requires a JSON request body whose fields are defined by the PurchaseOrder_Create_PurchaseOrder_InitialRequest schema.

update_purchase_order_update_purchase_order_header_by_id

Update a linnworks purchase order header. Only allowed while the order's status is not Delivered. Returns the modified/recalculated purchase order header with its updated status and recalculated totals.

create_purchase_order_modify_purchase_order_items_bulk

Modify Linnworks purchase order item lines in bulk: delete, add, and update item lines in one call, triggering a purchase order totals recalculation. Returns the recalculated purchase order result defined by the Modify_PurchaseOrderItems_BulkResponse schema. Required: a JSON request body matching the PurchaseOrder_Modify_PurchaseOrderItems_BulkRequest schema.

create_a_linnworks_purchase_order_add_purchase_order_item

Add a stock item line to an existing PENDING purchase order in linnworks. Returns the recalculated purchase order header and the modified purchase order item line after the addition. Items can only be added to PENDING purchase orders.

update_purchase_order_update_purchase_order_item_by_id

Update a purchase order item line in linnworks (quantity, cost, pack size, pack quantity); the order must be in PENDING status. Returns the recalculated purchase order header and the modified purchase order item line. Requires a JSON request body (upstream schema PurchaseOrder_Update_PurchaseOrderItemRequest; its field names are not enumerated in the discovered source).

delete_purchase_order_delete_purchase_order_item_by_id

Delete a purchase order item line from a PENDING purchase order in linnworks. Returns the recalculated purchase order header for the parent order (id, plus the upstream header fields in attributes). Item lines can only be removed while the order is PENDING. The required JSON body must identify the order and the item line to delete, per the upstream request schema.

get_purchase_order_get_purchase_orders_with_stock_item_by_id

Get the Linnworks purchase order ids that contain undelivered stock items. Returns an array of purchase order ids (UUID strings). Requires a JSON request body.

get_single_linnworks_purchase_order_get_purchase_order_by_id

Get a single linnworks purchase order by id — the order header and its item lines in one call. Returns: id. Required: id.

get_purchase_order_get_purchase_order_note_by_id

Get the purchase order notes for a purchase order in Linnworks. Returns a JSON array of purchase order note objects (upstream PurchaseOrderNote schema — the note's individual fields are not enumerated in the available documentation). Requires a JSON request body per the upstream PurchaseOrder_Get_PurchaseOrderNoteRequest schema.

create_a_linnworks_purchase_order_export_purchase_order

Export a Linnworks purchase order. Sends the purchase order to export in the required JSON request body and returns an opaque DownloadResponse descriptor whose fields the upstream docs do not enumerate. Requires a purchase order identifier in the request body.

create_a_linnworks_purchase_order_add_purchase_order_note

Add a note to a purchase order in linnworks. Returns the created purchase order note object. Requires a JSON request body describing the note.

delete_purchase_order_delete_purchase_order_note_by_id

Delete a note from a purchase order in linnworks. Returns a bare integer result value (200 OK). Requires a JSON request body identifying the note to delete — the upstream field names are not enumerated in the API docs.

create_a_linnworks_purchase_order_change_purchase_order_status

Change the status of a purchase order in linnworks (PENDING to OPEN, OPEN or PARTIAL to DELIVERED), updating Due (OnOrder) stock levels accordingly. Returns the updated purchase order header record including its id and attributes. The purchase order identifier and target status are supplied in the JSON request body.

purchase_order_deliver_purchase_item_all_except_batch_items_crea

Deliver all non-batch-tracked purchase order items in a linnworks purchase order (PENDING orders only). Returns a 200 response with the recalculated purchase order header and the delivered item lines. Requires a JSON request body following the PurchaseOrder_Deliver_PurchaseItemAll_ExceptBatchItemsRequest schema.

create_purchase_order_deliver_purchase_items_with_quantity

Deliver purchase order items with specified quantities in Linnworks. Returns an empty 204 response on success. Requires a JSON request body; the upstream docs reference a dedicated request schema but do not enumerate its fields.

create_a_linnworks_purchase_order_deliver_purchase_item_all

Deliver all remaining items of a linnworks purchase order in one call, updating item quantity, cost, pack size, and pack quantity — works on PENDING orders only. Returns: purchase_order_header (recalculated header), purchase_order_item_line. Requires a JSON request body.

create_a_linnworks_purchase_order_deliver_purchase_item

Deliver a purchase order item in linnworks, adjusting the current stock level by the delivered quantity; once all items are delivered the purchase order status changes to delivered. Returns a DeliverPurchaseOrderItemResponse describing the delivery outcome. Requires a JSON request body identifying the purchase order item and the total number of delivered items.

get_purchase_order_get_purchase_order_status_list_by_id

Get the list of available purchase order statuses in linnworks. Returns an array of status strings: PENDING, OPEN, PARTIAL, and DELIVERED. Requires a JSON request body (send an empty object).

delete_a_linnworks_purchase_order_delete_purchase_order_by_id

Delete a purchase order in Linnworks. Returns an empty 204 response on success. Requires a JSON request body identifying the purchase order to delete (per the upstream PurchaseOrder_Delete_PurchaseOrderRequest schema).

get_purchase_order_get_purchase_order_audit_by_id

Get the audit log for a purchase order in linnworks. Returns an array of purchase order audit records in descending order, capped at 1000 records. Requires a request body identifying the purchase order.

get_purchase_order_get_purchase_order_extended_property_by_id

Get all extended properties for a purchase order in linnworks. Returns: id. Requires a JSON request body (its fields are not enumerated in the upstream docs).

create_purchase_order_add_purchase_order_extended_property

Add extended properties to a purchase order in Linnworks. Property names must be unique per purchase order, and a purchase order can hold at most 50 extended properties before the call errors. Requires a JSON request body with the extended-property details to add. Returns the upstream Add_PurchaseOrderExtendedPropertyResponse object whose field-level shape is defined by Linnworks and not…

update_purchase_order_update_purchase_order_extended_property

Update an existing extended property on a linnworks purchase order by id. Returns an empty 204 response on success. Requires the id of the extended property to update in the request body; throws an error if the supplied id doesn't exist or the property name duplicates an existing one.

delete_purchase_order_delete_purchase_order_extended_property

Delete extended property items by id from a Linnworks purchase order. Requires a JSON request body identifying the extended property item id(s) to delete. Returns an empty 204 response on success.

get_purchase_order_get_additional_cost_type_by_id

Get the additional cost types configured for purchase orders in linnworks. Returns the collection of cost types as a JSON body; individual field definitions are not enumerated in the API documentation. Requires a JSON request body.

create_a_linnworks_purchase_order_add_additional_cost_type

Add a new additional cost type for purchase orders in Linnworks. Requires a JSON request body. Returns the Add_AdditionalCostTypesResponse payload; its fields are not enumerated in the available documentation.

update_purchase_order_update_additional_cost_type_by_id

Update an additional cost type in linnworks purchase orders. Returns a 200 OK response defined by the upstream Update_AdditionalCostTypesResponse schema; the discovered source does not enumerate its fields. Required: a JSON request body matching the upstream PurchaseOrder_Update_AdditionalCostTypesRequest schema.

delete_purchase_order_delete_additional_cost_type_by_id

Delete an additional cost type in linnworks. Returns an empty 204 response on success.

create_a_linnworks_purchase_order_modify_additional_cost

Modify purchase order additional costs in linnworks by adding new lines, updating, or deleting existing ones. Returns the modified additional cost list — each record identified by a unique identifier — plus the purchase order header with its total recalculated. Required: a JSON request body carrying the purchase order's modified additional cost lines.

get_single_linnworks_purchase_order_get_additional_cost_by_id

Get the additional costs of a purchase order in Linnworks. Returns the additional-cost response object; the source does not document its field-level shape. Required: a JSON request body selecting the purchase order.

create_purchase_order_modify_additional_cost_allocation

Modify the additional cost allocation items of a purchase order in Linnworks. Returns a Modify_AdditionalCostAllocationResponse object on success; its field-level shape is defined by that upstream schema and is not enumerated in the integration docs. Requires a JSON request body matching the PurchaseOrder_Modify_AdditionalCostAllocationRequest schema.

create_a_linnworks_purchase_order_modify_payment_statement

Modify purchase order payment statements in linnworks: add new lines, update or delete existing ones. Returns the modified list of payment statement records, each identified by a unique identifier. Requires a JSON request body.

get_single_linnworks_purchase_order_get_payment_statement_by_id

Get the payment statements of a purchase order in linnworks. Returns the payment statement record including its id and upstream-defined statement attributes. Requires a JSON request body.

create_a_linnworks_purchase_order_find_stock_item

Find a stock item in Linnworks by its SKU or supplier code, passing the lookup criteria in the JSON request body. Returns: id.

get_single_linnworks_purchase_order_get_delivered_record_by_id

Get delivered item records for a specific purchase order in linnworks. Returns the delivered-records response for that PO; the record fields are defined by the upstream Get_DeliveredRecords response schema and are not enumerated in the source documentation. Requires a JSON request body identifying the purchase order.

get_single_linnworks_purchase_order_get_emails_sent_by_id

Get the records of emails sent for a specific purchase order (PO) in Linnworks. Returns the upstream Get_EmailsSentResponse body on 200 OK — the available Linnworks documentation does not enumerate its fields. Requires a JSON request body matching the PurchaseOrder_Get_EmailsSentRequest schema (required; its fields are likewise not enumerated in the discovered docs).

get_single_linnworks_purchase_order_get_email_csv_file_by_id

Get the download URL of the CSV file for a specific purchase order in linnworks. Returns the CSV file download link for that purchase order; response fields are not broken out in the upstream documentation. Sends a JSON request body identifying the target purchase order.

create_a_linnworks_purchase_order_create_p_os_from_inventory

Create purchase orders from inventory in linnworks. Requires a JSON request body matching the upstream PurchaseOrder_CreatePOsFromInventoryRequest schema. Returns the CreatePOsFromInventory response object, whose field set is defined by the upstream CreatePOsFromInventoryResponse schema.

get_single_linnworks_returns_refunds_get_refund_option_by_id

Get refund options for an order in linnworks. Returns the channel-specific types of refund that can be applied to the given order. Requires a JSON request body specifying the target order.

get_returns_refunds_get_actionable_refund_header_by_id

List actionable booked refund headers in linnworks. Returns a paged refund-header payload whose fields are not enumerated in the upstream documentation. Requires a JSON request body.

get_returns_refunds_get_processed_or_acked_error_refund_header

Get a paged list of processed or acknowledged error refund headers in Linnworks. Sends a JSON request body and returns a 200 OK paged refund-headers response; the upstream request and response schemas are not enumerated in the available API reference. No required parameters.

get_returns_refunds_get_rma_headers_by_order_id_by_id

Get all RMA (return merchandise authorization) headers associated with a given order ID in Linnworks. Returns the RMA header records for that order in a response payload whose fields are defined by the upstream API (GetRMAHeadersByOrderIdResponse); the JSON request body carries the order identifier per the upstream request schema.

get_returns_refunds_get_refund_headers_by_order_id_by_id

Get all refund headers for a given order ID in linnworks. Returns the refund header records associated with that order. Required: order ID, passed in the request body.

get_returns_refunds_get_refund_lines_by_header_id_by_id

Get the refund lines for a refund in Linnworks by its refund header ID. Returns the refund lines belonging to the given refund header. Requires a JSON request body carrying the refund header ID.

create_a_linnworks_returns_refunds_create_refund

Create a refund in Linnworks for approval. Returns the created refund record with its id and the upstream-defined response attributes. Requires a JSON refund request body.

update_a_linnworks_returns_refunds_update_refund_by_id

Update an existing refund in Linnworks. Returns the UpdateRefundResponse object for the updated refund; the upstream reference does not enumerate the response fields. Required: a JSON request body matching the upstream ReturnsRefunds_UpdateRefundRequest schema.

create_a_linnworks_returns_refunds_acknowledge_refund_error

Acknowledge the error responses recorded against a given refund header in linnworks. Returns: a 200 OK acknowledgement result (upstream AcknowledgeRefundErrorsResponse). Requires a JSON request body identifying the refund header whose errors should be acknowledged (upstream ReturnsRefunds_AcknowledgeRefundErrorsRequest).

create_a_linnworks_returns_refunds_acknowledge_rma_error

Acknowledge all error responses for a given RMA header in linnworks. Returns the acknowledgement response (id, attributes; the Linnworks docs define the AcknowledgeRMAErrorsResponse schema but do not enumerate its fields). Requires a JSON request body per the upstream ReturnsRefunds_AcknowledgeRMAErrorsRequest schema.

create_a_linnworks_returns_refunds_action_refund

Send a refund to the selling channel for actioning in Linnworks. Returns the actioning result object from Linnworks (upstream ActionRefundResponse schema); its fields are defined by that component schema and depend on the channel integration, so they are not enumerated here. Requires a JSON request body carrying the refund actioning payload (upstream ReturnsRefunds_ActionRefundRequest schema).

delete_a_linnworks_returns_refunds_delete_refund_by_id

Delete all not-yet-processed refund lines from a refund header in linnworks, removing it from the Actionable Refunds screen; the header row is deleted once no lines remain. Returns an opaque DeleteRefundResponse acknowledgement on success. Required: a JSON request body identifying the refund header (per ReturnsRefunds_DeleteRefundRequest).

delete_a_linnworks_returns_refunds_delete_rma_by_id

Delete unprocessed, non-error lines from a Linnworks RMA header, removing the booking from the RMA Bookings screen (the header row is deleted once no lines remain). Requires a JSON request body identifying the RMA header. Returns the upstream DeleteRMAResponse body; its fields are not enumerated in the docs.

get_single_linnworks_returns_refunds_get_return_option_by_id

Get the channel-specific return and refund options that can be applied to a given order in Linnworks. Returns the GetReturnOptionsResponse object — channel-specific option details whose fields vary by sales channel and are not enumerated in the available documentation. Requires a JSON request body identifying the order.

get_returns_refunds_get_actionable_rma_header_by_id

List actionable RMA headers from linnworks Returns & Refunds. Returns a paged list of booked RMA header records; the upstream response schema is not field-enumerated in the linnworks documentation. Requires a JSON request body.

get_returns_refunds_get_processed_or_acked_error_rma_header

Get a paged list of processed or acknowledged error RMA headers in Linnworks, i.e. returns/exchanges bookings that were either fully processed or acknowledged after an error. Returns a paged response of RMA header records from the Returns & Exchanges module.

create_a_linnworks_returns_refunds_create_rma_booking

Create an RMA booking in Linnworks. Returns: id. Requires a JSON request body; the field-level shape comes from the upstream CreateRMABooking request schema.

update_a_linnworks_returns_refunds_update_rma_booking_by_id

Update an RMA booking in Linnworks. Returns the upstream UpdateRMABookingResponse object with HTTP 200 (the source documentation does not enumerate its fields). Required: a JSON request body matching the upstream UpdateRMABookingRequest schema.

create_a_linnworks_returns_refunds_action_rma_booking

Accept a booked return or exchange (book it in) in Linnworks. Returns the ActionRMABooking confirmation response on 200 OK; Linnworks does not document the field-level shape of this response. Required: a JSON request body.

list_all_linnworks_returns_refunds_get_refund_orders

List all refund order items for every order in linnworks. Returns an array of refund order records identified by their id; the upstream documentation references a RefundOrder schema but does not enumerate its fields.

list_all_returns_refunds_get_booked_returns_exchange_orders

List all booked returns/exchange orders in linnworks. Returns the booked order records including their id and the remaining schema-defined order fields under attributes.

delete_a_linnworks_returns_refunds_delete_booked_order_by_id

Delete a booked returns/exchange order in linnworks. Requires a JSON request body identifying the order to remove. Returns an empty 204 response on success.

create_a_linnworks_returns_refunds_action_booked_order

Action the booked returns/exchange items for a given order ID in linnworks. Returns an empty 204 response on success. Requires a JSON request body; returns for batched items must be booked in manually.

delete_a_linnworks_returns_refunds_delete_booked_item_by_id

Delete a booked returns/exchange order item in linnworks. Requires a JSON request body identifying the booked item to delete (upstream schema: ReturnsRefunds_DeleteBookedItemRequest). Returns an empty 204 response on success.

create_a_linnworks_returns_refunds_refund_order

Refund a Linnworks order by its order ID. Sends the refund request as a JSON body and returns an empty 204 response on success. Requires a JSON body identifying the order to refund.

list_all_linnworks_returns_refunds_get_warehouse_locations

List all warehouse locations configured in Linnworks for returns and refunds. Returns an array of warehouse location records; the endpoint takes no request parameters.

create_a_linnworks_returns_refunds_edit_booked_item_info

Edit a booked exchange/return item in linnworks Returns & Refunds. Requires a JSON request body following the upstream EditBookedItemInfoRequest schema. Returns an empty 204 response on success.

delete_returns_refunds_delete_pending_refund_item_by_id

Delete a pending refund item in Linnworks Returns & Refunds, removing it from the refund queue. Requires a JSON body (upstream DeletePendingRefundItemRequest schema; the docs do not enumerate its fields). Returns an empty 204 response on success.

list_all_linnworks_returns_refunds_get_total_refunds

Get the total refundable amount of an order in linnworks. Returns the amount as a bare number (double); pass the order's fkOrderId as a UUID query parameter.

list_all_linnworks_returns_refunds_search_returns_refunds_pageds

Search Linnworks returns, refunds, and cancellations history matching date-range and text-search criteria. Returns a paged result: PageNumber, EntriesPerPage, TotalEntries, TotalPages, and Data (the matching history records). Date range is capped at 3 months; up to 200 entries per page.

list_all_linnworks_returns_refunds_create_returns_refunds_csvs

Create a CSV file of the linnworks returns/refunds search results for download. Returns the CSV file content as a string. Maximum search date range (from to to) is 3 months.

list_all_linnworks_returns_refunds_get_search_types

List the valid search types in linnworks needed to search processed orders for returns and refunds. Returns an array of search field records, each exposing id and attributes.

list_all_linnworks_rules_engine_get_evaluator_types

List the valid evaluator types for the linnworks Rules Engine. Returns an array of evaluator descriptors, each identifying a valid evaluator and the group it belongs to; per-descriptor fields follow the upstream EvaluatorDescriptor schema, which the Linnworks reference does not enumerate. Takes no additional parameters.

list_all_linnworks_rules_engine_get_evaluation_fields

List the valid evaluation fields for a given rule type in the Linnworks Rules Engine. Returns field descriptors, each with an id and attributes describing one evaluation field.

list_all_linnworks_rules_engine_get_options

Get the valid option values for a given field in the linnworks Rules Engine. Returns an array of option strings for the requested field and rule type.

get_single_linnworks_rules_engine_get_multi_option_by_id

Get the valid options for a set of Linnworks rules engine fields (and, if relevant, keys) in a single call — the batch counterpart of GetOptions. Requires a JSON request body identifying the fields to look up. Returns a JSON array of MultiOptionResponse entries, one per requested field.

list_all_linnworks_rules_engine_get_key_options

Get the list of valid keys for a given field in the linnworks Rules Engine. Returns an array of valid key option strings. Pass type (Test or Orders) and fieldName to specify the rule type and field to look up.

get_single_linnworks_rules_engine_get_multi_key_option_by_id

Get the list of valid keys for a set of fields in the linnworks Rules Engine. Returns a list of key-option entries, one for each requested field. Requires a JSON request body identifying the fields to look up.

list_all_linnworks_rules_engine_get_rules

List all rules in the Linnworks Rules Engine. Returns an array of basic rule header records (RuleHeaderBasic), each including its id.

list_all_linnworks_rules_engine_get_rules_by_types

List rules engine rules of a given type in linnworks. Returns an array of basic rule header records with id and attributes (upstream RuleHeaderBasic fields, not enumerated in the docs). Filter by type (Test or Orders).

list_all_linnworks_rules_engine_get_rule_condition_nodes

Get the condition nodes belonging to a rule in Linnworks, excluding the condition items. Returns an array of rule condition node records; the upstream documentation references the RuleConditionHeader schema without enumerating its fields.

list_all_linnworks_rules_engine_get_condition_webs

Get details about a specific condition in the Linnworks Rules Engine. Returns the basic condition header record, including its pkConditionId and the remaining ConditionHeaderBasic attributes defined upstream. Required: pkConditionId.

list_all_linnworks_rules_engine_get_action_types

List the valid action types available for rules in the linnworks Rules Engine. Returns an array of action type information records (upstream RuleActionInformation); the source does not enumerate their fields. Only the orders rule type is currently supported.

create_a_linnworks_rules_engine_create_new_condition

Create a new condition in the Linnworks rules engine. Returns the created condition as a RuleConditionHeader object. Required: a JSON request body matching the upstream RulesEngine_CreateNewConditionRequest schema (see the Linnworks API reference for its field-level shape).

create_a_linnworks_rules_engine_save_condition_change

Update a condition and its condition items in the linnworks Rules Engine via SaveConditionChanges. Returns an empty 204 response on success. Requires a JSON body matching the upstream RulesEngine_SaveConditionChangesRequest schema.

list_all_linnworks_rules_engine_check_condition_name_exists

Check whether a condition name already exists at a specific level in the linnworks rules engine. Returns a boolean — true when the name is already in use. fkConditionId must be supplied when checking a sub-condition level, and excludeConditionId excludes the condition being renamed from the check.

list_all_linnworks_rules_engine_get_actions

Get details of a Linnworks Rules Engine action identified by the pkActionId query parameter. Returns the action object including its id and its action-specific attributes from the upstream RuleActionResponse schema.

list_all_linnworks_rules_engine_get_action_options

List valid options for a given Rules Engine action in linnworks. Returns a map of action type keys to arrays of option records. Required: type (one of the supported action types, e.g. AssignShippingService, ExecuteMacro, AddNoteToOrder).

update_a_linnworks_rules_engine_update_action_by_id

Update a rules engine action in linnworks. Returns an empty 204 response on success. Required: pkActionId and fkConditionId in the request body, both carrying their unchanged original values.

create_a_linnworks_rules_engine_add_action

Add a new action to a condition node in the linnworks rules engine. Returns the created action with its pkActionId and fkConditionId. Requires a JSON request body describing the action to add (upstream CreateActionRequest schema).

delete_a_linnworks_rules_engine_delete_action_by_id

Delete an action from a rule in the linnworks Rules Engine. Returns an empty 204 response on success. Required: id (of the action to delete).

delete_a_linnworks_rules_engine_delete_condition_by_id

Delete a condition in the linnworks Rules Engine together with its subconditions and actions. Returns an empty 204 response on success. Requires a JSON request body matching the upstream RulesEngine_DeleteConditionRequest schema identifying the condition to delete.

create_a_linnworks_rules_engine_swap_condition

Swap the sort order of two conditions belonging to the same parent in the linnworks Rules Engine. Returns an empty 204 response on success. Requires a JSON request body (the upstream SwapConditions request schema); its exact fields are not expanded in the discovered docs.

list_all_linnworks_rules_engine_get_required_fields_by_rule_ids

Get the fields and keys used by a given rule in the linnworks Rules Engine. Returns the rule's field and key definitions under attributes, following the upstream RulesFields schema (individual field keys are not enumerated in the source docs). Required: pkRuleId.

list_all_linnworks_rules_engine_get_required_fields_by_types

Get the list of fields and keys used by a given rule type in the linnworks Rules Engine. Returns the field and key definitions for the requested rule type. Requires type (the rule type: Test or Orders).

create_a_linnworks_rules_engine_test_evaluate_rule

Test-evaluate a Linnworks rules engine rule against a set of test values without running it on live orders. Returns the rule evaluation result object (upstream RuleEvaluationResult) produced from the supplied test values. Requires a JSON request body matching the upstream RulesEngine_TestEvaluateRuleRequest schema; see the Linnworks API reference for its field-level breakdown.

create_a_linnworks_rules_engine_set_draft_live

Set a draft rule live in the Linnworks Rules Engine — if the draft is a copy for editing an existing rule, the existing rule is deleted and the draft promoted in its place. Takes a JSON request body (RulesEngine_SetDraftLiveRequest). Returns an int32 integer response body on success.

create_a_linnworks_rules_engine_create_draft_from_existing

Create a draft copy of an existing Linnworks rule so it can be edited; once set live, the draft replaces the rule it was copied from. Returns an integer result on success. Required: a JSON request body identifying the existing rule to copy.

create_a_linnworks_rules_engine_create_new_draft_from_existing

Create a new draft rule in linnworks based on an existing rule; once set live, the draft becomes a unique rule in its own right. Returns the created rule header record (the RuleHeaderBasic object). Required: a JSON request body (RulesEngine_CreateNewDraftFromExistingRequest).

create_a_linnworks_rules_engine_create_new_draft

Create a new draft rule of a specified type in the Linnworks Rules Engine. Returns the created draft rule's basic header record, including its id and rule attributes. Requires a JSON request body specifying the rule type.

create_a_linnworks_rules_engine_set_rule_enabled

Set the enabled state of a rule in the Linnworks rules engine. Returns an empty 204 response on success. Requires a JSON request body identifying the rule and the desired enabled state.

create_a_linnworks_rules_engine_set_rule_name

Rename a rule in the Linnworks rules engine. Returns an empty 204 response on success. Requires a JSON request body identifying the rule and its new name.

delete_a_linnworks_rules_engine_delete_rule_by_id_by_id

Permanently delete a rule from the Linnworks rules engine by id. Returns an empty 204 response on success. Requires a JSON request body conforming to the upstream RulesEngine_DeleteRuleByIdRequest schema (send the id of the rule to remove).

create_a_linnworks_rules_engine_swap_rule

Swap the executing order of two rules in the linnworks Rules Engine by swapping them with each other. Returns an empty 204 response on success. Requires a JSON request body (RulesEngine_SwapRulesRequest) identifying the two rules to swap.

create_a_linnworks_rules_engine_set_condition_enabled

Enable or disable a rules engine condition in linnworks; while disabled, the condition's subconditions and actions are not evaluated or executed. Requires a JSON request body identifying the condition and the enabled state to apply. Returns an empty 204 response on success.

create_a_linnworks_rules_engine_copy_condition

Copy a condition in the linnworks Rules Engine as a new condition, cloning its subconditions and actions. Returns the copied condition's header (RuleConditionHeader), including its id and the remaining upstream-defined header fields (attributes). Requires a JSON request body specifying the condition to copy.

create_a_linnworks_rules_engine_copy_action

Copy an action from one condition to another in the linnworks Rules Engine. Returns the copied rule action object; the upstream API docs do not enumerate its fields. Requires a JSON request body. Actions cannot be attached to the rule header or to conditions with subconditions.

list_all_linnworks_settings_get_currency_conversion_rates

Get the currency conversion rates configured in linnworks Settings. Returns an array of CurrencyConversionRate records describing conversion rates between currencies, with optional filters to narrow by currency or include currencies from orders.

list_all_linnworks_settings_get_available_time_zones

List the available time zones in linnworks. Returns the upstream GetAvailableTimeZonesResponse object; its field structure is not enumerated in the source documentation. Takes no parameters.

update_settings_update_currency_conversion_rate_by_id

Update currency conversion rates in linnworks by posting the updated rates payload. Requires a JSON request body. Returns an empty 204 response on success.

create_a_linnworks_settings_insert_currency_conversion_rate

Insert currency conversion rates in Linnworks. Returns an empty 204 response on success. Requires a JSON request body matching the Settings_InsertCurrencyConversionRatesRequest schema; consult the upstream docs for the field-level breakdown.

delete_settings_delete_currency_conversion_rate_by_id

Delete currency conversion rates in Linnworks. Requires a JSON request body matching the upstream Settings_DeleteCurrencyConversionRatesRequest schema. Returns an empty 204 response on success.

list_all_linnworks_settings_get_measures

Get the user's measures units from the database in Linnworks. Returns the Measures response object; its field structure is defined by the upstream Measures schema — consult the Linnworks API reference for the field-level breakdown.

list_all_linnworks_settings_get_latest_currency_rates

Get the latest currency conversion rates for all known currencies in linnworks. Returns a mapping of currency codes to their latest conversion rates, keyed by currency code; the rates are updated every couple of hours.

list_all_linnworks_shipping_service_get_integrations

List all configured vendor shipping integrations in linnworks. The response is a JSON array of integration configuration records; the upstream API docs do not publish a field-level breakdown of each record. Returns: items.

create_a_linnworks_shipping_service_post_shipment_upload

Upload a shipment document to Linnworks via the Shipping Service. Returns an empty 204 response on success. Requires a JSON request body matching the upstream PostShipmentUploadRequest schema.

list_all_shipping_service_get_consignments_by_manifests

List the consignments for a specific vendor, account, and manifest in Linnworks. Returns a paged result with PageNumber, EntriesPerPage, TotalEntries, TotalPages, and a Data array of consignment records. Required: vendor, accountId, pkManifestId. Use /ShippingService/GetFiledManifestsByVendor to source the input arguments.

list_all_shipping_service_get_filed_manifests_by_vendors

List Linnworks filed shipping manifests for a vendor between two dates; use the GetIntegrations endpoint to get all vendor names and friendly names. Returns: PageNumber, EntriesPerPage, TotalEntries, TotalPages, and Data — the filed manifest records for the requested vendor and date range.

list_all_linnworks_shipping_service_get_shipping_quotes

Get a shipping quote for a single Linnworks order by running it against integrated shipping services (the available services are listed via ShippingService/GetIntegrations). Returns the shipping quote response for the order; a selected service can then be applied to the order with ShippingService/SetShippingMethodFromQuote.

create_a_linnworks_shipping_service_cancel_order_shipping_label

Cancels the shipping label for an order in Linnworks. Returns a cancellation response object whose structure is defined by the upstream CancelOrderShippingLabelResponse schema.

list_all_linnworks_ship_station_get_ship_station_integrations

List all ShipStation integrations in linnworks. Returns the integration config records including their id and attributes with the upstream ShipStationConfig fields.

get_ship_station_get_ship_station_integration_by_id

Get a single ShipStation integration in linnworks by id. Returns the integration config record including its id and attributes with the upstream ShipStationConfig fields.

create_a_linnworks_ship_station_create_ship_station_integration

Create a new ShipStation integration in Linnworks. Returns the created ShipStationConfig, including its integrationId (the identifier to pass to GetShipStationIntegration later). Requires a JSON request body; the field set follows Linnworks' ShipStation_CreateShipStationIntegrationRequest schema.

delete_ship_station_delete_ship_station_integration_by_id

Delete a ShipStation integration in Linnworks by its id. Returns an empty 204 response on success. Required: id.

create_a_linnworks_ship_station_edit_ship_station_integration

Update an existing ShipStation integration in Linnworks. Returns a boolean success flag. Requires a JSON request body matching the Linnworks ShipStation_EditShipStationIntegrationRequest schema.

list_all_linnworks_stock_check_variation_parent_sku_exists

Check whether a potential parent SKU already exists in Linnworks and report its current status. Returns one of: Exists, NotExists, AlreadyVariation. Required: parentSKU.

list_all_linnworks_stock_get_variation_group_search_types

List the search types available for searching variation groups in Linnworks. Returns a JSON array of GenericEnumDescriptor entries — the search types consumed by the searchType parameter of SearchVariationGroups (VariationName, ParentSKU, ItemSKU); the Linnworks spec references the descriptor schema without enumerating its fields. Takes no parameters.

list_all_linnworks_stock_search_variation_groups

Search Linnworks variation groups by variation name, parent SKU, or item SKU using a full or partial search term. Returns a paged result: Data, TotalEntries, TotalPages, PageNumber, EntriesPerPage.

list_all_linnworks_stock_delete_variation_groups

Delete a single Linnworks variation group by its id. Returns an empty 204 response on success. Required: pkVariationGroupId (uuid).

delete_a_linnworks_stock_delete_variation_group_by_id

Delete multiple Linnworks variation groups in bulk by their ids. Returns an empty 204 response on success. Requires a JSON request body matching the upstream Stock_DeleteVariationGroupsRequest schema.

list_all_linnworks_stock_get_variation_group_by_parent_ids

Get the Linnworks variation group that a parent SKU belongs to by searching with the parent's stock item id. Returns the matching variation group with its pkVariationGroupId. Required: pkStockItemId.

list_all_linnworks_stock_get_variation_group_by_names

Search Linnworks for a variation group by its group name. Returns the matched variation group record: id plus its vendor-defined group attributes. Required: variationName.

create_a_linnworks_stock_rename_variation_group

Rename a variation group in Linnworks. Returns an empty 204 response on success. Requires a JSON request body matching the upstream Stock_RenameVariationGroupRequest schema; the available documentation does not expand its field list, so consult the Linnworks API reference for the exact payload.

list_all_linnworks_stock_get_variation_items

Get the items in a Linnworks variation by its variation item id. Returns an array of variation item (VariationItem) records.

create_a_linnworks_stock_add_variation_item

Add one or more items to an existing variation group in Linnworks. Returns the added variation items as an array of VariationItem records, each with pkVariationItemId plus the remaining VariationItem fields under attributes. Requires a JSON request body matching the upstream Stock_AddVariationItemsRequest schema, identifying the variation group and the items to add.

delete_a_linnworks_stock_delete_variation_item_by_id

Delete a single Linnworks variation item, removing it from its variation group. Returns an empty 204 response on success. Requires a JSON request body identifying the item to remove (the upstream request schema's field names are not enumerated in the source).

linnworks_stock_delete_variation_items_bulk_delete

Delete multiple Linnworks variation items in bulk, removing them from their variation group. Returns an empty 204 response on success. Requires a JSON request body identifying the items to remove (the upstream request schema's field names are not enumerated in the source).

create_a_linnworks_stock_create_variation_group

Create a variation group in Linnworks. Returns the created variation group object as defined by the upstream VariationGroup schema; the available reference does not enumerate its fields. Requires the JSON request body defined by Stock_CreateVariationGroupRequest.

list_all_linnworks_stock_sku_exists

Check whether a SKU already exists in Linnworks. Returns a boolean — true when the SKU exists, false otherwise. Required: SKU.

list_all_linnworks_stock_get_stock_consumptions

Retrieve the linnworks stock consumption report between two dates. Returns report rows with id and attributes (fields defined by the upstream StockConsumption schema).

list_all_linnworks_stock_get_item_changes_histories

Get a paged report of stock changes for an item in Linnworks. Returns: PageNumber, EntriesPerPage, TotalEntries, TotalPages, and a Data array of item change history entries. Set pageNumber to -1 to return all pages.

list_all_linnworks_stock_get_item_changes_history_csvs

Get a link to a CSV file report of a Linnworks stock item's stock changes. Returns an opaque TempFile payload for the generated report; its fields are not enumerated in the upstream documentation.

list_all_linnworks_stock_get_stock_items

List Linnworks stock items matching a keyword, optionally scoped to a location, with flags to exclude composites, variations, or batches from the report. Returns a paged result with TotalResults and the matching stock item records in Data.

get_single_linnworks_stock_get_stock_items_by_key_by_id

Get Linnworks stock items for the provided key and location. Returns an array of stock item objects (the upstream StockItem record shape). Requires a JSON request body identifying the key and location to look up.

get_single_linnworks_stock_get_stock_items_full_by_id

Get basic-level inventory information for stock items in Linnworks. Returns a JSON array of stock item records (upstream StockItemFull schema), each identified by id. Requires a JSON request body (upstream Stock_GetStockItemsFullRequest schema).

get_single_linnworks_stock_get_stock_items_full_by_id_by_id

Get basic-level inventory item information in linnworks for one or more stock items by supplying their ids in the request body. Returns the matching inventory item records including each item's id and basic-level item attributes. Requires a request body (upstream schema Stock_GetStockItemsFullByIdsRequest) carrying the stock item ids.

list_all_linnworks_stock_get_stock_levels

Get the item stock level report from Linnworks. Returns an array of stock item levels with ItemId, SKU, Level, MinimumLevel, InOrderBook, and AvailableStock. Optional: stockItemId (uuid) to specify a stock item.

get_single_linnworks_stock_get_stock_level_by_location_by_id

Retrieve the item stock level report grouped by location in Linnworks. Returns the JSON report body defined by Linnworks' GetStockLevelByLocationResponse contract (its fields are not enumerated in the available source). Requires a JSON request body following the upstream Stock_GetStockLevelByLocationRequest schema.

get_single_linnworks_stock_get_stock_level_batch_by_id

Get a batch "item stock level" report from Linnworks by POSTing a JSON request body that follows the upstream Stock_GetStockLevel_BatchRequest schema. Returns a JSON array of GetStockLevel_BatchResponse report entries; the source documentation references these schemas but does not enumerate their fields.

update_a_linnworks_stock_update_stock_minimum_level_by_id

Update a stock item's minimum stock level in Linnworks. Returns an empty 204 response on success. Requires a JSON request body matching Linnworks' Stock_UpdateStockMinimumLevelRequest schema; the API reference does not enumerate its fields.

list_all_linnworks_stock_get_stock_solds

Get the Linnworks "item stock sold" report. Returns an array of stock-sold report rows with schema-specific StockItemSold fields.

list_all_linnworks_stock_get_stock_due_pos

List Linnworks stock due PO report entries. Returns an array of StockItemDuePO report records, each with a primary id and an attributes object whose fields are report-specific as defined upstream.

list_all_linnworks_stock_get_stock_item_return_stats

Get the item return stat report for a stock item in linnworks. Returns a JSON array of item return stat entries (StockItemReturn), each including id plus content-type-specific report fields.

list_all_linnworks_stock_get_stock_item_scrap_stats

Retrieve the Linnworks "item stock scrap stat" report for a stock item. Returns a 200 OK JSON array of StockItemScrap scrap-stat report entries; the upstream documentation does not enumerate the entry fields.

list_all_linnworks_stock_get_sold_stats

Get Linnworks' item sold stat report. Returns an array of sold-stat records, each carrying an id and attributes holding the upstream StockItemSoldStat fields.

create_a_linnworks_stock_set_stock_level

Set the stock level of a list of stock items in Linnworks, identified by SKU, to the provided values. Returns an array of stock item level records for the updated items. Requires a JSON body matching the SetStockLevel request schema.

update_a_linnworks_stock_update_stock_levels_by_skus_by_id

Update the stock levels of a list of Linnworks stock items identified by SKU, changing each level by the provided value. Returns an array of stock item level objects, one per updated item. Requires a JSON request body.

create_a_linnworks_stock_book_in_stock_item

Book in a stock item in Linnworks: increases its stock level and current stock value by the specified quantity. Requires a JSON request body (Stock_BookInStockItemRequest). Returns an empty 204 response on success.

create_a_linnworks_stock_create_stock_batch

Create one or more stock item batches in Linnworks. Returns the created batches as an array, each including BatchId, SKU, BatchNumber, ExpiresOn, SellBy, and per-location Inventory records. Requires a JSON request body following the upstream Stock_CreateStockBatchesRequest schema.

create_a_linnworks_stock_book_in_stock_batch

Book in stock for a batched stock item in Linnworks, increasing its stock level and current stock value by the specified quantity. Returns the updated StockItemBatch including BatchId, SKU, BatchNumber, StockItemId, ExpiresOn, SellBy, and its per-location Inventory records. Requires a JSON request body.

linnworks_stock_search_binracks_search

Search binracks in Linnworks where a stock item can be placed, ordered by the system's recommended move order. Returns matched binracks with id and binrack-specific attributes. Requires a JSON request body; if no binrack type ids are supplied, all binrack types are considered.

get_single_linnworks_stock_get_bin_racks_by_id_by_id

Get the list of binracks by binrack ids for Linnworks WMS locations. Returns the matching binrack records with their id.

get_single_linnworks_stock_get_binrack_skus_by_id

Get binrack SKU records in Linnworks. Returns the upstream BinrackSkuResponse object (200 OK); its field-level structure is not enumerated in the Linnworks documentation. Send the upstream GetBinRackSkusRequest JSON object as the request body.

delete_a_linnworks_stock_delete_move_by_id

Delete a stock move in Linnworks. Requires a JSON request body. Returns an empty 204 response on success.

get_single_linnworks_stock_get_warehouse_moves_by_binrack_by_id

Get details for stock moves within a specific binrack in Linnworks, returning both incoming and outgoing stock. Returns the warehouse-move details for that binrack, with fields defined by the upstream GetWarehouseMovesByBinrackResponse schema. Requires a JSON request body identifying the binrack.

get_single_linnworks_stock_get_warehouse_move_by_id

Get details for a single warehouse stock move in Linnworks. Returns the stock move object: id plus its move-detail fields (modeled here as attributes), which are defined by the upstream GetWarehouseMoveResponse schema. The request body identifies the stock move to fetch.

create_a_linnworks_stock_complete_warehouse_move

Complete a warehouse stock move in Linnworks. Requires a JSON request body (upstream Stock_CompleteWarehouseMoveRequest schema; the source does not enumerate its individual fields). Returns an empty 204 response on success.

update_a_linnworks_stock_update_warehouse_move_by_id

Update an existing warehouse stock move in Linnworks. Returns the updated stock move object (upstream GetWarehouseMoveResponse schema). Requires a JSON request body matching the upstream UpdateWarehouseMoveRequest schema.

create_a_linnworks_stock_create_warehouse_move

Create a warehouse move in Linnworks in state of In Transit or Open. Returns the created move's id. Required: BatchInventoryId. BinrackIdDestination is optional — omit it or send null to create the move without a specific destination bin.

create_a_linnworks_stock_batch_stock_level_delta

Apply a batch of stock level delta updates to stock items in Linnworks in a single request. Returns a batch stock level delta result object. Requires a batch stock level delta request body.

create_a_linnworks_stock_add_rolling_stock_take

Add a rolling stock take (count) entry in Linnworks. Each request creates a session for the UTC-day stock count, adds all entries, and recounts totals and discrepancies; it is rejected if any entry fails validation. Returns an opaque AddRollingStockTakeResponse acknowledgement — the upstream schema does not enumerate its fields. Required: BatchInventoryId for WMS locations or batched items.

update_a_linnworks_stock_update_stock_levels_bulk_by_id

Bulk update stock levels for non-batched and composite stock items in build in Linnworks. Returns the UpdateStockLevelsBulkResponse result; its individual fields are not enumerated in the docs (surfaced here as attributes). Accepts StockItemId or SKU (either identifier) plus a stock location name or id.

get_single_linnworks_stock_get_stock_items_by_id_by_id

Retrieve stock item records from Linnworks for a specified list of stock item ids. Requires a request body containing the stock item ids to retrieve. Returns the matching stock item records; Linnworks defines the response via a named schema (GetStockItemsByIdsResponse) whose fields are not enumerated in the published reference for this endpoint, so treat the response shape as opaque.

get_single_linnworks_stock_get_stock_item_type_info_by_id

Get stock item type information for linnworks stock items. Accepts a JSON request body and returns the upstream-defined type info response on success; the field-level shape of that response is not enumerated in the available source, so confirm fields against the Linnworks API reference (GetStockItemTypeInfoResponse).

update_a_linnworks_stock_update_sku_group_identifier_by_id

Update a SKU group identifier in linnworks. Returns the UpdateSkuGroupIdentifier response object as defined by the Linnworks API; its fields are not enumerated in the API docs.

get_single_linnworks_stock_get_stock_items_location_by_id

Get the warehouse location (including binrack) for a given list of stock items in Linnworks. Returns the location details for each requested item and location combination: StockItemId, StockLocationId, and BinRack. Requires stockItemIds and stockLocationIds in the request body.

list_all_warehouse_transfer_get_active_transfers_for_locations

List all active warehouse transfers related to a location in Linnworks. Returns an array of transfer records, each with an id and transfer-specific attributes. Accepts locationId (the pkLocationId of the location to look up).

list_all_warehouse_transfer_get_active_transfers_all_locations

List all active warehouse transfers across all locations in Linnworks. Returns a collection of transfer records, each with an id and the transfer fields defined by Linnworks's upstream WarehouseTransfer schema (attributes). Takes no parameters.

create_warehouse_transfer_create_transfer_request_with_return

Create a new warehouse transfer request in Linnworks with a default reference number. Returns the created warehouse transfer object. Requires a request body.

create_warehouse_transfer_create_transfer_from_descrepancy

Create a new warehouse transfer request in linnworks from detected stock discrepancies. Returns the created WarehouseTransfer object (field set defined by the upstream schema) on success. Send the transfer details as a JSON request body matching the upstream WarehouseTransfer_CreateTransferFromDescrepanciesRequest schema.

delete_a_linnworks_warehouse_transfer_delete_transfer_by_id

Delete a warehouse transfer in linnworks. Returns an empty 204 response on success. Requires a JSON request body identifying the transfer to remove.

delete_warehouse_transfer_delete_transfer_property_by_id

Delete a property from a warehouse transfer in linnworks. Returns an empty 204 response on success. Requires a JSON body identifying the transfer and the property to delete.

list_all_linnworks_warehouse_transfer_get_transfer_with_notes

Get a single Linnworks warehouse transfer together with its items and notes. Returns the transfer record as id plus an attributes object holding the transfer's details. Required: pkTransferId (UUID).

create_a_linnworks_warehouse_transfer_change_transfer_status

Change a warehouse transfer's status in Linnworks, moving it along its transfer workflow. Returns an empty 204 response on success. Requires a JSON request body identifying the transfer and the new status to set.

create_a_linnworks_warehouse_transfer_add_transfer_note

Add a note to a warehouse transfer in linnworks. Returns a UUID string identifying the added transfer note. Requires a JSON request body (fields defined by the upstream WarehouseTransfer_AddTransferNoteRequest schema).

create_a_linnworks_warehouse_transfer_add_transfer_bin_note

Add a note to a warehouse transfer bin in linnworks. Returns the id of the created bin note as a UUID string. Requires a JSON request body matching the upstream WarehouseTransfer_AddTransferBinNoteRequest schema.

create_a_linnworks_warehouse_transfer_add_item_to_transfer

Add a single item to a warehouse transfer in linnworks by posting the WarehouseTransfer_AddItemToTransferRequest JSON payload; only transfers in draft or request states accept items. Returns the added transfer item object (upstream WarehouseTransferItem schema; the source docs reference it without enumerating its fields).

create_a_linnworks_warehouse_transfer_add_items_to_transfer

Add one or more items to a Linnworks warehouse transfer; only works for transfers in draft or request states. Requires the AddItemsToTransferRequest body identifying the transfer and the items to add. Returns the AddItemsToTransfer response object with vendor-defined fields not enumerated in the API reference.

create_a_linnworks_warehouse_transfer_add_transfer_property

Add a property to a warehouse transfer in linnworks. Returns the result as a UUID string on success. Requires a JSON request body with the transfer property details.

create_a_linnworks_warehouse_transfer_remove_item_from_transfer

Remove an item from a warehouse transfer in linnworks. Requires a JSON request body (upstream schema WarehouseTransfer_RemoveItemFromTransferRequest; its field names are not enumerated in the reference). Returns an empty 204 response on success.

create_a_linnworks_warehouse_transfer_set_reference_number

Change a warehouse transfer's reference number in Linnworks; only works before the transfer is in transit. Returns an empty 204 response on success. Required: a JSON request body matching the upstream WarehouseTransfer_SetReferenceNumberRequest schema.

create_warehouse_transfer_change_transfer_from_location

Update the from location of a warehouse transfer in linnworks. Returns an empty 204 response on success. Requires a request body identifying the transfer and the location the stock should now come from.

create_warehouse_transfer_change_transfer_to_location

Change the to (destination) location of a warehouse transfer in Linnworks. Returns an empty 204 response on success. Requires a JSON request body identifying the transfer and the new destination location.

create_a_linnworks_warehouse_transfer_change_transfer_location

Update the from and to locations of a warehouse transfer in linnworks. Requires a JSON request body matching the upstream ChangeTransferLocations request schema. Returns an empty 204 response on success.

create_a_linnworks_warehouse_transfer_change_transfer_property

Change a property belonging to a given warehouse transfer in Linnworks by posting the property change details as a required JSON request body. Returns an empty 204 response on success.

list_all_linnworks_warehouse_transfer_get_transfer_items

List the items of a Linnworks warehouse transfer identified by pkTransferId. Returns an array of WarehouseTransferItem records, one entry per bin an item occupies, covering the item's order, request, sent, and received quantities. Each record's fields follow the upstream WarehouseTransferItem schema, which the available documentation does not enumerate.

create_warehouse_transfer_change_transfer_item_request_quantity

Change the requested quantity for an item on a linnworks warehouse transfer; only transfers in Draft or Request states are supported. Returns an empty 204 response on success. Requires a JSON request body.

create_warehouse_transfer_change_transfer_item_sent_quantity

Change the sent quantity of a warehouse transfer item in the specified bin in linnworks. Returns the updated transfer item: id plus its attributes object, which carries the upstream WarehouseTransferItem fields (item identifiers and request/sent/received quantity levels per bin). Requires a request body identifying the transfer item, bin, and the new sent quantity.

create_warehouse_transfer_change_transfer_item_received_quantity

Change the received quantity of a transfer item in Linnworks. Returns an empty 204 response on success. Requires a JSON request body matching the upstream WarehouseTransfer_ChangeTransferItemReceivedQuantityRequest schema.

list_all_linnworks_warehouse_transfer_get_transfer_notes

List transfer-level notes for a warehouse transfer in linnworks. Returns an array of note records, each with its id plus an attributes object holding the note fields defined by the upstream WarehouseTransferNote schema. Required: pkTransferId.

list_all_linnworks_warehouse_transfer_get_transfer_item_notes

Get the notes attached to a transfer item in linnworks. Returns an array of transfer item note objects. Required: pkTransferId, pkTransferItemId.

create_a_linnworks_warehouse_transfer_add_transfer_item_note

Add a note to a transfer item in linnworks. Returns a UUID string on success. Requires a JSON request body describing the note.

list_all_linnworks_warehouse_transfer_get_transfer_audits

Retrieve all audit entries for a specified warehouse transfer in linnworks. Returns an array of audit entry records, each with an id and attributes whose fields are specific to the upstream WarehouseTransferAudit schema and not enumerated in the API docs. Required: pkTransferId (the transfer's UUID).

list_all_linnworks_warehouse_transfer_get_transfer_properties

Get the properties associated with a given warehouse transfer in Linnworks, identified by its pkTransferId. Returns the list of transfer property records, each with its id and property attributes.

list_all_warehouse_transfer_search_transfers_all_locations

Search linnworks warehouse transfers across all locations matching a specific criteria such as SKU, item title, item barcode, transfer reference, or bin reference. Returns an array of matching transfer ids as UUID strings.

list_all_linnworks_warehouse_transfer_get_archived_transfers

List all archived warehouse transfers in Linnworks — transfers that are Delivered or Deleted. Returns: PageNumber, EntriesPerPage, TotalEntries, TotalPages, and a Data array of archived transfer records.

list_all_warehouse_transfer_get_archived_transfers_filtereds

Search archived warehouse transfers in Linnworks that match a specific search term. Returns a paged result: PageNumber, EntriesPerPage, TotalEntries, TotalPages, and Data (the matched transfers).

list_all_warehouse_transfer_get_archived_transfers_between_dates

Search Linnworks for archived warehouse transfers which were created between two dates. Returns a paged result including TotalEntries, TotalPages, PageNumber, EntriesPerPage, and a Data array of archived transfer records.

warehouse_transfer_get_archived_transfers_between_archived_dates

Search for Linnworks warehouse transfers that were archived between two dates. Returns a paged result: PageNumber, EntriesPerPage, TotalPages, TotalEntries, and a Data array of archived transfer records.

list_all_warehouse_transfer_search_transfers_by_locations

Search linnworks warehouse transfers matching specific criteria by SKU, item title, item barcode, transfer reference, or bin reference within a location. Returns an array of matching transfer id UUID strings.

get_single_linnworks_warehouse_transfer_get_list_transfer_by_id

List basic warehouse transfers in linnworks. Returns an array of transfer records, each with its id. Requires a JSON request body (the upstream GetListTransfers request object).

list_all_linnworks_warehouse_transfer_get_modified_basics

List Linnworks warehouse transfers that were significantly modified between a specified UTC date/time and now. Returns basic transfer records, each with an id and its transfer attributes.

list_all_linnworks_warehouse_transfer_get_server_times

Get the current UTC server time from linnworks. Returns the current UTC date as a single date-time string value. Takes no parameters.

list_all_linnworks_warehouse_transfer_get_transfer_with_items

Get a warehouse transfer with its items in linnworks by transfer id. Returns the transfer object with its items; the field set is defined by the upstream WarehouseTransfer schema and is not enumerated in the source docs. Required: pkTransferId.

create_a_linnworks_warehouse_transfer_change_bin_detail

Update the details of an existing bin via Linnworks' warehouse transfer API. Requires a JSON request body following the upstream WarehouseTransfer_ChangeBinDetailsRequest schema. Returns an empty 204 response on success.

create_a_linnworks_warehouse_transfer_allocate_item_to_bin

Allocate stock, in part or in full, from one bin to another in Linnworks. Returns an integer (int32) result value on success. Requires a JSON request body matching the upstream AllocateItemToBinRequest schema.

create_a_linnworks_warehouse_transfer_create_new_bin

Create a new bin in Linnworks for warehouse transfer use. Returns the created bin object (WarehouseTransferBin) with the new bin's details. Requires a JSON request body (CreateNewBinRequest).

create_a_linnworks_warehouse_transfer_remove_all_empty_bin

Remove all empty bins in Linnworks — deletes bins that have no items assigned (e.g. bins created but never used). Requires a JSON request body. Returns an empty 204 response on success.

list_all_linnworks_warehouse_transfer_get_transfer_bin_notes

Get the notes recorded against a specific warehouse transfer bin in linnworks, identified by the pkBinId query parameter. Returns a JSON array of bin note (WarehouseTransferBinNote) objects; the linnworks API reference does not enumerate the note fields.

list_all_linnworks_warehouse_transfer_get_discrepancy_items

Get Linnworks warehouse transfer items whose quantities do not match what was originally expected (e.g. fewer received than sent when the transfer is delivered, or fewer sent than requested when accepted). Returns an array of transfer item records identified by id with upstream-defined attributes. Call once after the transfer is Accepted and once when it has been Delivered. Required: pkTransferId.

list_all_linnworks_warehouse_transfer_get_stock_availabilities

Get stock availability for a transfer item in Linnworks, listing the inbound warehouse transfers and purchase orders due in for that item. Returns an array of StockAvailability records; the field-level shape is not enumerated in the available documentation. Lookup key: pkTransferItemId (UUID).

list_all_linnworks_warehouse_transfer_is_draft_transfer_changeds

Check whether a draft warehouse transfer in linnworks has been changed since it was created. Returns a boolean — true when the draft transfer has changed, false otherwise. Required: pkTransferId.

delete_warehouse_transfer_delete_empty_draft_transfer_by_id

Delete an empty draft warehouse transfer in linnworks — only draft transfers with no items, properties or notes can be removed this way. Returns an empty 204 response on success. Requires a JSON request body identifying the draft transfer.

list_all_linnworks_warehouse_transfer_check_for_draft_transfers

Check whether a draft warehouse transfer already exists between two locations in linnworks. Returns the UUID of the matching draft transfer, if one exists. Supply toLocationId (destination location) and fromLocationId (source location).

create_a_linnworks_warehouse_transfer_print_transfer

Create a printable PDF for a Linnworks warehouse transfer. Returns the URL of the generated PDF as a string. Required: a JSON request body matching the upstream WarehouseTransfer_PrintTransferRequest schema.

list_all_linnworks_fbatransfercards_metadata

Get metadata for the Linnworks FBA inbound transfer cards view. Returns the view metadata object; its field-level shape is defined by the upstream GetViewMetaDataResponse schema and is not itemized in the v1 documentation. No required parameters. Deprecated — use the v2 metadata endpoint instead.

create_a_linnworks_import_upload

Upload a CSV file to Linnworks for warehouse transfer import processing, selecting the kind of import via import_type. Required: import_type. Returns the upload result payload; its field structure is not enumerated in the Linnworks API documentation.

create_a_linnworks_import_importstockrequestitem

Import product items into a Linnworks warehouse-transfer stock request. Returns the import result response for the completed import. Required: importstockrequestitem_id (the stock request import id) and a JSON request body.

create_a_linnworks_import_importstocktransferitem

Import items into a Linnworks stock transfer via CSV import (ImportCsv). Returns the import result object on success. Required: importstocktransferitem_id (the id of the stock transfer to import items into, passed upstream as the transferId path parameter).

list_all_linnworks_warehousetransfer_stocks

Find Linnworks stock items by channel for warehouse transfers (FindStockItem). Returns a paged result containing Data (the matching stock items) plus PageNumber, EntriesPerPage, TotalEntries, and TotalPages. entriesPerPage is capped at 200 per page.

list_all_linnworks_stock_find_warehouse_transfer_stock_items

Find Linnworks stock items available for a warehouse transfer, optionally filtered by keyword and by source/destination location. Returns a paged result with PageNumber, EntriesPerPage, TotalEntries, TotalPages, and a Data array of stock items. Max 200 entries per page.

linnworks_transfers_add_items_bulk_update

Add an item to a Linnworks stock transfer. Only works for transfers in draft or request states. Requires an AddItemRequest JSON body. Returns a TransferItemViewModel transfer-item object; the upstream docs name this response schema but do not enumerate its fields.

create_a_linnworks_transfers_add_item_batch

Add item batches to a Linnworks warehouse transfer, providing batch-level detail such as batch number, quantity, stock item, and expiry/sell-by dates in a JSON body matching the AddItemBatchesRequest schema. Returns a boolean success flag. Required: a JSON body matching the AddItemBatchesRequest schema. Read back assigned batches with the transfers_get_transfer_item_batches method.

create_a_linnworks_transfers_add_items_in_bulk

Add multiple items in bulk to a linnworks stock transfer. Returns a boolean result (true on success). Call with an AddItemsInBulkRequest JSON body; the upstream docs do not enumerate its fields.

linnworks_transfers_check_for_draft_transfers_bulk_update

Check whether a draft stock transfer already exists between two locations in linnworks. Returns a single integer (int32) value on success. Requires a JSON request body of type CheckForDraftTransferRequest identifying the two locations to check.

create_a_linnworks_transfers_create_transfer

Create a new warehouse transfer request in Linnworks with a system-generated default reference number by posting a CreateTransferRequest JSON body. Returns the created transfer object (WarehouseTransferViewModel) including its id and transfer-specific attributes.

linnworks_transfers_delete_items_bulk_delete

Remove items from a stock transfer in linnworks. Returns a bare integer result on success rather than the transfer object. Requires a JSON request body (upstream schema: DeleteItemsRequest) identifying the transfer and the items to remove; the source documentation does not enumerate its fields, so consult the linnworks API reference for the exact payload shape.

linnworks_transfers_delete_warehouse_transfers_bulk_delete

Delete a stock transfer in Linnworks. Returns a bare integer success value (the 200 response body is a plain int32, not an object). Required: a JSON request body of type DeleteTransferRequest identifying the transfer to delete.

linnworks_transfers_archive_warehouse_transfers_bulk_update

Archive a warehouse transfer in Linnworks. Sends an ArchiveTransferRequest JSON payload and returns an integer (int32) result on success.

list_all_linnworks_transfers_get_list_transfers

List the item lines of Linnworks warehouse transfers at the order and request/sent/received levels. Returns the transfer's item entries, with multiple entries for a single item when it exists in more than one bin.

list_all_linnworks_transfers_get_transfer_cards

List all Linnworks warehouse transfers with their stock item details, available for searching. Returns the warehouse transfer card objects together with the stock items they contain. No required parameters.

list_all_linnworks_transfers_get_transfer_cards_by_locations

Get warehouse transfer cards for a specific location in linnworks. Returns the transfer card view model including its id and attributes; attribute fields follow the upstream WarehouseTransferViewModel schema, so consult the Linnworks API docs for the field-level breakdown.

get_single_linnworks_transfers_get_transfer_item_batch_by_id

Get the item batches for a Linnworks warehouse transfer by id. Returns the batch lookup response object including its id and the upstream-defined batch attributes. Required: id (the numeric transfer id).

linnworks_transfers_get_transfer_items_bulk_update

Get the stock items on a Linnworks warehouse transfer for the appropriate location, including item details for searching. Returns a transfer item record with its id and an attributes object whose fields are defined upstream in the TransferItemViewModel schema. Required: pkTransferId.

linnworks_transfers_update_from_locations_bulk_update

Update the from location of a Linnworks warehouse transfer. Returns an integer result on success. Requires an UpdateFromLocationRequest JSON body; Linnworks references this schema without documenting its individual fields.

linnworks_transfers_update_item_received_quantities_bulk_update

Update the received quantity of a stock transfer item in Linnworks, adjusting stock levels. Returns an integer (int32) value on success. Requires a JSON request body matching the upstream UpdateItemReceivedQuantityRequest schema.

linnworks_transfers_update_items_received_quantities_bulk_update

Update the received quantities of multiple items on a Linnworks stock transfer, adjusting stock levels; batched items are received into the same batches they were originally sent with. Requires a JSON body containing the transfer id and the items with their new received quantities. Returns the update-quantities response object; the source does not enumerate its fields.

linnworks_transfers_update_item_requested_quantities_bulk_update

Update the requested quantity of a stock transfer item in Linnworks, adjusting stock levels. Returns the updated quantity as an integer. Requires a JSON request body matching the UpdateItemRequestedQuantityRequest schema.

linnworks_transfers_update_item_sent_quantities_bulk_update

Update the sent quantity of a stock transfer item in Linnworks, adjusting stock levels. Returns a boolean success result on a 200 response. Requires a JSON request body matching Linnworks' UpdateItemSentQuantityRequest schema.

linnworks_transfers_update_status_bulk_update

Update the status of a Linnworks warehouse transfer. Returns the new status as a bare integer (HTTP 200). Required: a JSON request body matching the upstream UpdateStatusRequest schema.

linnworks_transfers_update_to_locations_bulk_update

Update the to-location of a stock transfer in Linnworks. Returns a bare integer (int32) success value. Requires a JSON request body matching the upstream UpdateToLocationRequest schema; its individual fields are not enumerated in the source documentation.

create_a_linnworks_transfers_add_item_received_batch

Add item received batches to a linnworks warehouse transfer, recording the batches received against the transfer's items. Returns a boolean success flag. Required: a JSON request body describing the received batches.

create_transfers_receive_selected_transfer_items_for_wm

Receive selected stock transfer items in Linnworks, setting each item's receive quantity to its sent quantity for a WMS location. Returns a 200 Success response as either an integer result or a ReceiveSelectedTransferItemsForWmsResponse object (the object's fields are not detailed in the available docs). Sends a ReceiveSelectedTransferItemsForWmsRequest JSON body.

list_all_linnworks_wms_get_warehouse_zone_types

List the warehouse zone types configured in linnworks. Returns the zone-type record including its id and the upstream-defined attributes. No required parameters.

update_a_linnworks_wms_update_warehouse_zone_type_by_id

Update a warehouse zone type in Linnworks. Sends a JSON body matching the upstream UpdateWarehouseZoneTypeRequest schema and returns the updated zone type record as id plus an attributes object (the Linnworks reference does not enumerate the response fields).

create_a_linnworks_wms_add_warehouse_zone_type

Create a warehouse zone type in linnworks WMS. Returns the AddWarehouseZoneTypeResponse object on a 200 OK response; the available docs reference its upstream schema but do not enumerate its fields. Requires a JSON request body following the upstream AddWarehouseZoneTypeRequest schema.

delete_a_linnworks_wms_delete_warehouse_zone_type_by_id

Delete a warehouse zone type in linnworks. Returns a success confirmation on completion. Requires a JSON request body identifying the zone type to remove.

list_all_linnworks_wms_get_warehouse_zones_by_locations

Get warehouse zones for a stock location in Linnworks, optionally limited to bin/rack-assignable zones. Returns a response object whose fields are defined by the upstream GetWarehouseZonesByLocationResponse schema (the discovered docs do not enumerate them). Both stockLocationIntId and onlyBinrackAssignable are optional.

get_wms_get_binrack_zones_by_binrack_id_or_name_by_id

Get the Linnworks warehouse zones assigned to binracks, looking the binracks up by id or name. Returns a 200 zone-assignment response whose shape is defined by the upstream GetBinrackZonesByBinrackIdOrNameResponse schema; the Linnworks docs do not enumerate its fields. Requires a request body identifying the binrack(s).

update_wms_update_warehouse_binrack_binrack_to_zone_by_id

Update the zone assignment for a warehouse binrack in Linnworks, moving the binrack into a zone. Takes a JSON request body defined by the upstream UpdateWarehouseBinrackBinrackToZone request schema and returns the corresponding response object; its fields are not enumerated in the available documentation.

get_wms_get_binrack_zones_by_zone_id_or_name_by_id

Get Linnworks WMS binrack zones matching a zone id or name. The 200 response follows Linnworks' GetBinrackZonesByZoneIdOrNameResponse schema, whose field-level structure is not enumerated in the available documentation. Sends a JSON request body per the GetBinrackZonesByZoneIdOrNameRequest schema; no required parameters are documented.

create_a_linnworks_wms_add_warehouse_zone

Add a new warehouse zone in Linnworks WMS. Returns the response object defined by the upstream AddWarehouseZoneResponse schema; consult the upstream Linnworks docs for the field-level breakdown. Requires a JSON request body matching the upstream AddWarehouseZoneRequest schema.

delete_a_linnworks_wms_delete_warehouse_zone_by_id

Delete a warehouse zone in linnworks via the Wms API. RPC-style POST — the zone identifier goes in the JSON request body, not the path. Returns the upstream DeleteWarehouseZoneResponse JSON object; its fields are not enumerated in the available source.

update_a_linnworks_wms_update_warehouse_zone_by_id

Update a warehouse zone in linnworks by posting an UpdateWarehouseZoneRequest JSON body. Returns the UpdateWarehouseZoneResponse object describing the updated zone. Required: a JSON body matching the UpdateWarehouseZoneRequest schema.

list_all_linnworks_orders

List orders in Linnworks, returning open orders by default with optional filters for processed and paid orders, location, and a last-updated date range. Returns per-order fields including id, NumOrderId, GeneralInfo, ShippingInfo, CustomerInfo, and TotalsInfo. If id is supplied, all other parameters are disregarded.

list_all_linnworks_orders_fulfillment_status

Get fulfillment statuses for one or more Linnworks orders by id. Returns each order's id and fulfillmentStatus. Filters: id (order ids), locationId, fulfillmentStatus.

update_a_linnworks_orders_fulfillment_status_by_id

Update fulfillment statuses for multiple Linnworks orders in a single call. Returns each updated order's id and fulfillmentStatus. Required: id and fulfillmentStatus in each body array item.

get_single_linnworks_order_fulfillment_status_by_id

Get the fulfillment status for a single Linnworks order by id. Returns the order's fulfillment status record including id and fulfillmentStatus. Required: id (the Linnworks order UUID).

linnworks_order_fulfillment_status_bulk_update

Update the fulfillment status of a Linnworks order by id. Returns the updated order fulfillment status object. Required: order_id (UUID) plus a fulfillment status request body.

create_a_linnworks_orderpickwave_identifier

Assign the provided identifiers to all provided pickwaves in Linnworks. Returns an empty response body on success. Pass the assign request (request) carrying the pickwaves and identifiers to assign.

list_all_linnworks_picking_pickwaveidentifiers

List all pickwave identifiers in Linnworks. Returns each identifier with its IdentifierId, Name, Tag, IsCustom flag, and ImageId/ImageUrl image details.

create_a_linnworks_picking_pickwaveidentifier

Create pickwave identifiers in Linnworks. Returns the created pickwave identifier object including its id, name, tag, and imageUrl. Requires a JSON body matching the upstream CreatePickwaveIdentifierRequest schema.

delete_a_linnworks_picking_pickwaveidentifier_by_id

Delete a pickwave identifier from Linnworks by id. Returns an empty 204 response on success. Required: id (the upstream identifierId, a numeric int32).

get_single_linnworks_fba_inbound_channel_by_id

Get details for a single FBA inbound channel in Linnworks by id. Returns the channel detail record; upstream does not enumerate its fields beyond the identifier id (the integer channelId in the path). Required: id.

list_all_linnworks_shipment_content_update_previews

List generated content update previews for a shipment in linnworks FBA inbound. Returns preview objects identified by their string id (pass it as content_update_preview_id when confirming a preview). Required: shipping_plan_id, shipment_id.

create_a_linnworks_content_update_preview_confirm

Confirm the content update preview for a shipment in a linnworks FBA inbound shipping plan. Returns the operation record including its id and type. Required: shipping_plan_id, shipment_id, content_update_preview_id.

create_a_linnworks_content_update_previews_generate

Generate content update previews for a given shipment within a shipping plan in Linnworks FBA inbound. Returns the operation record object (OperationModel) tracking the preview generation; the published docs define its shape upstream and do not enumerate its fields. The request body must match Linnworks' ContentUpdatePreviewRequestModel. Required: shipping_plan_id, shipment_id, boxes, items.

list_all_linnworks_fba_inbound_metadata

Get metadata for Linnworks FBA inbound transfer cards. Returns the view metadata object with upstream-specific fields (GetViewMetaDataResponse); the docs do not enumerate its structure. Takes no parameters.

get_single_linnworks_fba_inbound_operation_by_id

Get a single Linnworks FBA inbound operation by its id (UUID). Returns the operation record including its id and operationType. Required: id.

list_all_linnworks_fba_inbound_operations

List Linnworks FBA inbound operations, optionally filtered by entityId and operationType. Returns the operation record including its id and operationType.

list_all_linnworks_operations_latests

GetOperationLatestByEntityIdTypes. Returns: id, entityId, status, type, createdDate, problems, amazonOperationId. Required: entity_id, operation_types.

list_all_linnworks_shipping_plan_packing_groups

List the packing groups for an FBA inbound shipping plan in Linnworks. Returns each packing group record with its id and packing group attributes. Required: shipping_plan_id.

list_all_linnworks_shipping_plan_packing_options

Get the generated packing options for a Linnworks FBA inbound shipping plan. Returns an array of packing option records, each with its id and option-specific attributes (fields are defined by Linnworks' PackingOptionModel; consult the upstream docs for the full field breakdown). Required: shipping_plan_id.

create_a_linnworks_packing_option_confirm

Confirm a packing option for a given shipping plan in Linnworks. Returns the operation record (OperationModel) with its id and operationType (ConfirmingPackingOptions=3); track progress via the FBA inbound operations endpoints. Required: shipping_plan_id, option_id.

create_a_linnworks_packing_options_generate

Generate packing options for a given FBA inbound shipping plan in Linnworks. Returns the generated operation record including its id and operation type, which can be polled through the FBA inbound operations endpoints. Required: shipping_plan_id.

list_all_linnworks_shipping_plan_placement_options

List the generated placement options for a Linnworks FBA inbound shipping plan. Returns: placementOptionId, expirationDate, status, fees, discounts, shipments. Required: shipping_plan_id.

update_a_linnworks_shipping_plan_placement_option_by_id

Save (confirm) a placement option for a Linnworks FBA inbound shipping plan. Returns: id, entityId, status, type, createdDate, problems, amazonOperationId. Required: id, shipping_plan_id.

create_a_linnworks_placement_option_confirm

Confirm a placement option for a given FBA inbound shipping plan in Linnworks. Returns the operation record with its id and type. Required: shipping_plan_id, option_id.

create_a_linnworks_placement_options_generate

Generate placement options for a given Linnworks FBA inbound shipping plan. Returns the operation object describing the triggered generation, including its id (the full field shape is defined by the upstream OperationModel schema). Required: shipping_plan_id.

list_all_linnworks_shipping_plan_boxes

List the shipment boxes for a Linnworks FBA inbound shipping plan. Returns the shipping plan's box records (upstream ShipmentBoxModel), each including its box id. Required: shipping_plan_id.

create_a_linnworks_shipping_plan_box

Add one or more boxes to a Linnworks FBA inbound shipping plan. The body is a bare JSON array of box definitions (AddShipmentBoxModel); returns the shipping plan's box records including their ids. Required: shipping_plan_id.

delete_a_linnworks_shipping_plan_box_by_id

Remove a box from a Linnworks FBA inbound shipping plan by id. Returns an empty 204 response on success. Required: id, shipping_plan_id.

linnworks_shipping_plan_boxes_bulk_update

Update boxes on a Linnworks FBA inbound shipping plan. The body is a bare JSON array of box updates (UpdateShipmentBoxModel); returns the shipping plan's updated box records including their ids. Required: shipping_plan_id.

list_all_linnworks_shipping_plan_box_items

List the box items for an FBA inbound shipping plan in Linnworks. Returns an array of box item records (upstream model ShipmentBoxItemExtendedModel), each carrying its integer id plus an attributes object; the full field list of that model is not published in the Linnworks API reference. Required: shipping_plan_id.

create_a_linnworks_box_item_assigned_item

Assign an item from a source box to a destination box with a given quantity in a Linnworks FBA inbound shipping plan. Sends a JSON request body matching the upstream AssignItemToBoxRequest schema and returns the upstream AssignItemToBoxResponse result object; the individual field names of both payloads are not enumerated in the discovered source, so consult the Linnworks API reference for the…. Required: shipping_plan_id, shipment_box_item_id, destinationBoxId, quantity.

list_all_linnworks_shipment_box_trackings

List the box trackings for a FBA inbound shipment in linnworks. Returns each box tracking record with its id and model-specific attributes (the upstream ShipmentBoxTrackingExtendedModel fields). Required: shipping_plan_id, shipment_id.

update_a_linnworks_shipment_box_tracking_by_id

Update tracking details for a given box on a linnworks FBA inbound shipment. Returns the updated box tracking record with its id and model-specific attributes. Required: id, shipping_plan_id, shipment_id.

list_all_linnworks_shipment_delivery_window_options

List the delivery window options Amazon generated for a single Linnworks FBA inbound shipment. Returns delivery window option records including their id and attributes (option detail fields defined by the upstream schema). Required: shipping_plan_id, shipment_id.

get_single_linnworks_shipment_delivery_window_option_by_id

Get the saved/selected delivery window option for a Linnworks FBA inbound shipment. Returns the option record including its id and attributes (option detail fields defined by the upstream schema). Required: id, shipping_plan_id.

create_a_linnworks_delivery_window_options_generate

Generate available delivery window options for a shipment in a Linnworks FBA inbound shipping plan. Returns an operation record with its id and operation-specific attributes, which can be tracked via the FBA inbound operations endpoints. Required: shipping_plan_id, shipment_id.

create_a_linnworks_delivery_window_option_confirm

Confirm a delivery window option for a given FBA inbound shipment in linnworks. Returns the OperationModel confirmation result; the upstream reference does not enumerate its fields. Required: shipping_plan_id, shipment_id, delivery_window_option_id.

list_all_linnworks_shipments_items

List the shipment items of an FBA inbound shipping plan in Linnworks. Returns an array of shipment item records, each including an id and an attributes object with the upstream ShipmentItemResponse fields. Required: shipping_plan_id.

create_a_linnworks_shipments_item

Create shipment items in bulk for an FBA inbound shipping plan in Linnworks. Returns an array of the created shipment item records, each including an id and an attributes object with the upstream ShipmentItemResponse fields. Required: shipping_plan_id, items.

update_a_linnworks_shipments_item_by_id

Update a shipping plan item in Linnworks by id. Returns an empty 204 response on success. Required: id, shipping_plan_id, stockItemId, quantityToShip, shipmentId.

linnworks_shipments_items_bulk_delete

Delete specific shipment items of an FBA inbound shipping plan in Linnworks. Returns an empty 204 response on success. Required: shipping_plan_id, shipmentItemIds.

linnworks_item_quantities_bulk_update

Update the quantity of a shipment item in a linnworks FBA inbound shipping plan. Returns the updated shipment item record with its id and attributes (upstream ShipmentItemResponse). Required: shipping_plan_id, shipment_item_id.

linnworks_prep_instructions_prep_owners_bulk_update

Update the prep owner (who will prepare the item) for shipment items in a Linnworks FBA inbound shipping plan. Returns the updated shipment item records defined by the upstream ShipmentItemResponse schema (its fields are not enumerated in the API reference). Requires shipping_plan_id and a JSON request body (UpdateShipmentItemPrepOwnerRequestInput). Required: shipping_plan_id.

linnworks_prep_instructions_label_owners_bulk_update

Update the label owner for shipment items in a Linnworks FBA inbound shipping plan, specifying who will label the items. Returns the updated shipment item record including its id. Required: shipping_plan_id.

create_a_linnworks_items_import

Import shipment items into a Linnworks FBA inbound shipping plan. Returns the upstream ImportShipmentItemsResponse object; its fields are defined by Linnworks and not enumerated in the available docs. Required: shipping_plan_id, fileId, settings.

linnworks_items_prep_categories_bulk_update

Set the prep category and prep type for shipment items on an FBA inbound shipping plan in linnworks. Returns the operation status object for the SetPrepDetails operation. Required: shipping_plan_id, items.

linnworks_items_expiration_dates_bulk_update

Update the expiration date of shipment items in a Linnworks FBA inbound shipping plan. Returns the updated shipment item records (id), shaped per the upstream ShipmentItemResponse schema. Required: shipping_plan_id.

create_a_linnworks_items_batch

Add an item batch to a shipment of an FBA inbound shipping plan in Linnworks to set its item batch quantity. Returns a boolean success result. Required: shipping_plan_id, batches, fromLocation, shipmentItemId.

list_all_linnworks_shipment_pallets

List the pallets on an FBA inbound shipment in linnworks. Returns shipment pallet records including their numeric id and upstream-defined pallet attributes. Required: shipment_id, shipping_plan_id.

create_a_linnworks_shipment_pallet

Add one or more pallets to an FBA inbound shipment in linnworks by posting a JSON array of pallet objects. Returns the created shipment pallet records including their numeric id and upstream-defined pallet attributes. Required: shipment_id, shipping_plan_id.

delete_a_linnworks_shipment_pallet_by_id

Remove a pallet from an FBA inbound shipment in linnworks by id. Returns an empty 204 response on success. Required: id, shipment_id, shipping_plan_id.

update_a_linnworks_shipment_pallet_by_id

Update a pallet on an FBA inbound shipment in linnworks by sending a JSON array of patch operations. Returns the updated shipment pallet record including its numeric id and upstream-defined pallet attributes. Required: id, shipment_id, shipping_plan_id.

get_single_linnworks_shipment_pallet_by_id

Get a specific pallet on an FBA inbound shipment in linnworks by id. Returns shipment pallet records including their numeric id and upstream-defined pallet attributes. Required: id, shipment_id, shipping_plan_id.

list_all_linnworks_shipping_plan_shipments

List the Linnworks FBA inbound shipments belonging to a specific shipping plan. Returns an array of shipment records (upstream ShipmentResponse), each with a numeric id; the docs do not enumerate the other record fields. Required: shipping_plan_id.

get_single_linnworks_shipping_plan_shipment_by_id

Get a single Linnworks FBA inbound shipment by id within a shipping plan. Returns the shipment record (upstream ShipmentModel) including its numeric id; the Linnworks docs do not enumerate the record's other fields. Required: id, shipping_plan_id.

list_all_linnworks_shipment_pallet_labels

Get the pallet label download URLs for a specific shipment in a Linnworks FBA inbound shipping plan. Returns the label URL(s) ready for printing. Required: shipment_id, shipping_plan_id.

get_single_linnworks_shipment_bill_of_lading_by_id

Get the bill of lading PDF document data for printing an FBA inbound shipment in Linnworks. Returns the bill of lading document data as a single JSON object with document-data-specific fields. Required: id, shipping_plan_id.

create_a_linnworks_shipment_tracking_detail

Apply tracking information to an FBA inbound shipment in Linnworks (SendShipmentTrackingDetails). Returns the async operation record including its id and upstream operation attributes. Required: shipping_plan_id, shipment_id.

list_all_linnworks_shipment_transport_details

Get the transportation details for a shipment within a Linnworks FBA inbound shipping plan. Returns the transport details record with its id and upstream-defined transportation detail attributes. Required: shipment_id, shipping_plan_id.

list_all_linnworks_shipment_box_items

List the box items for a shipment in a Linnworks FBA inbound shipping plan. Returns: sku, title. Required: shipping_plan_id, shipment_id.

create_a_linnworks_fba_inbound_shipping_plan

Create an FBA inbound shipping plan with a default shipment in Linnworks. Returns the created shipping plan card response (upstream GetShippingPlanCardsResponse schema). Required: fromLocationId, toLocationId.

get_single_linnworks_fba_inbound_shipping_plan_by_id

Get a single FBA inbound shipping plan by id, including its shipments and shipping items. Returns the shipping plan response defined by Linnworks' GetShippingPlanByIdResponse schema. Required: id.

update_a_linnworks_fba_inbound_shipping_plan_by_id

Update an FBA inbound shipping plan by id in Linnworks. Returns the updated shipping plan card response (upstream GetShippingPlanCardsResponse schema). Required: id, channelId, fromLocation, toLocation.

delete_a_linnworks_fba_inbound_shipping_plan_by_id

Delete an FBA inbound shipping plan by id, removing it with related info and returning reserved stock back into inventory. Returns an empty 204 response on success. Required: id.

linnworks_shipping_plan_submits_bulk_update

Submit an FBA inbound shipping plan in Linnworks by id. Returns the shipping plan cards payload with its id and schema-specific attributes (Linnworks references a cards response schema without enumerating its fields). Required: shipping_plan_id.

create_a_linnworks_shipping_plan_packing_information

Apply packing information to an FBA inbound shipping plan in linnworks. Returns the operation record with its id (UUID) and type (operation kind, e.g. 10 = SettingPackingInfo); the operation can be polled via the fba-inbound operations endpoints. Required: shipping_plan_id.

list_all_linnworks_shipping_plan_prep_instructions

Get generated prep instructions for an FBA inbound shipping plan in linnworks. Returns the prep-instructions response payload with upstream-defined fields (not enumerated in the source documentation). Required: shipping_plan_id.

create_a_linnworks_shipping_plan_prep_instruction

Get and save prep instructions from Amazon for an FBA inbound shipping plan in linnworks. Returns the Amazon-defined prep-instructions response payload with upstream-defined fields (not enumerated in the source documentation). Required: shipping_plan_id.

list_all_linnworks_shipping_plan_delivery_informations

Get delivery information for a specific FBA inbound shipping plan in Linnworks. Returns a JSON array of delivery-information records for the plan (upstream GetDeliveryInformationResponse objects). Required: shipping_plan_id.

linnworks_shipping_plan_delivery_window_options_bulk_update

Save the delivery window option for a shipment in a Linnworks FBA inbound shipping plan. Returns the created operation record with its id and an attributes object of operation fields; track it via the FBA inbound operations endpoints. Required: shipping_plan_id.

list_all_linnworks_stock_items_batches

List the stock item batches for the items of a specific FBA inbound shipping plan in linnworks. Returns an array of stock item batch records (upstream schema StockItemBatchResponse; the docs do not enumerate the record fields). Required: shipping_plan_id.

create_a_linnworks_transfer_cards_archive

Archive one or more closed or delivered FBA inbound shipments in Linnworks by posting an ArchiveShipmentsRequest body. Returns an empty 200 response on success.

list_all_linnworks_transfer_cards_shipping_plans

List shipping plan transfer cards for FBA inbound in linnworks. Returns an array of card records, each with an id and its attributes (the card fields as defined by the upstream GetShippingPlanCardsResponse schema). No required parameters.

get_single_linnworks_transfer_cards_shipping_plan_by_id

Get a single shipping plan transfer card by id in linnworks. Returns the card record with id and attributes (the card fields as defined by the upstream GetShippingPlanCardsResponse schema). Required: id.

list_all_linnworks_transfer_cards_shipments

List FBA inbound transfer card shipments in Linnworks (GetShipmentCards). Returns: cards. No required parameters.

create_a_linnworks_transfer_cards_refresh

Start the refresh process for FBA inbound shipment cards in linnworks. Requires no request parameters. Returns a JSON response confirming the refresh was started; its fields are defined by the upstream RefreshShipmentCardsResponse schema and are not enumerated in the API documentation.

get_single_linnworks_warehousetransfer_transfer_by_id

Get a warehouse transfer in Linnworks by its unique id. Returns the transfer record's id and attributes (the full WarehouseTransferModel fields defined upstream). Required: id.

create_a_linnworks_transport_options_estimate

Generate transportation options for the shipments of a Linnworks FBA inbound shipping plan. Returns an OperationModel object describing the generation operation (the available documentation does not enumerate its fields; the operation can be tracked via the FBA inbound operations endpoints). Required: shipping_plan_id, placementOptionId, shipmentTransportationConfigurations.

list_all_linnworks_shipment_transport_options

List the generated transportation options for a shipment within a Linnworks FBA inbound shipping plan. Returns a list of transportation option objects (upstream TransportationOptionModel; the API reference does not document their individual fields). Required: shipping_plan_id, shipment_id.

create_a_linnworks_transport_options_confirm

Confirm transportation options for shipments of a linnworks FBA inbound shipping plan. Returns the confirmation operation with its id and type; the resulting operation can be tracked via the linnworks fba-inbound operations endpoints. Required: shipping_plan_id.

linnworks_shipments_transport_options_bulk_update

Save transportation options for shipments of a Linnworks FBA inbound shipping plan. Returns an empty response body on success. Required: shipping_plan_id.

list_all_linnworks_packing_group_box_items

List the box items that belong to a packing group in a Linnworks FBA inbound shipping plan. Returns each box item record's id plus its attributes; the full field set is defined by the upstream ShipmentBoxItemExtendedModel schema. Required: shipping_plan_id, packing_group_id.

list_all_linnworks_shipment_boxes

List the shipment boxes for a specific shipment in a Linnworks FBA inbound shipping plan. Returns each box with its id and attributes (upstream ShipmentBoxModel fields). Required: shipping_plan_id, shipment_id.

list_all_linnworks_shipment_labels

Get the package label URLs for a specific shipment in an Linnworks FBA inbound shipping plan. Returns a label response with its id and upstream-defined attributes containing the package label URLs for the requested boxes. Required: shipment_id, shipment_box_ids, shipping_plan_id.