/

Docs
History
Schema
Generate

Filter operations

Accounts20

Auth3

Barcodes1

DataJobs2

Devices13

Dimensions10

DimensionValues9

Doors1

DynamicScanContent2

ExtendedProperties5

FeatureFlags1

FlagTypes5

GlobalSettings10

ItemPrices12

ItemQuantities2

Items46

get/v1/ItemsGet all items
post/v1/ItemsCreate new item
get/v1/Items/{serviceId}/itemsGet all service items
get/v1/Items/images/failedGet a paged, filterable list of items that have one or more images whose ingest failed, with the failure reason and timestamp (so a client can fix dead links). Portal only.
delete/v1/Items/images/failedPurge all failed-ingest images across the caller's visible items, returning how many were removed. Use after correcting dead links (a corrected URL is ingested as a new image, leaving the old failed record behind). The default image is never affected. Portal only.
get/v1/Items/images/failed/download/xlsxExport the items that have one or more failed-ingest images as the standard item xlsx (same columns as M:IO.CommonAPI.Controllers.v1.Catalog.ItemsController.GetItemsExcel(System.Nullable{System.Guid},IO.Catalog.Contracts.DTO.ItemSearchFilter,System.Threading.CancellationToken)), so the user can correct the data offline (e.g. fix dead image URLs) and re-import via the bulk-file endpoint. Scoped like the failed-images grid: honours the same search filter, covers all item types, and is not service-scoped. Serves the file inline for small result sets and queues a background export job for large ones (same gating as M:IO.CommonAPI.Controllers.v1.Catalog.ItemsController.GetItemsExcel(System.Nullable{System.Guid},IO.Catalog.Contracts.DTO.ItemSearchFilter,System.Threading.CancellationToken)). Portal only.
get/v1/Items/{itemId}Get item details
put/v1/Items/{itemId}Update existing item
delete/v1/Items/{itemId}Delete item
get/v1/Items/{itemId}/conversionsGet item unit conversions
get/v1/Items/{itemId}/altitemsGet item alternative items
put/v1/Items/{itemId}/altitemsUpdate item alternative item based on orig. itemId and account
post/v1/Items/{itemId}/altitemsCreate item alternative item
delete/v1/Items/{itemId}/altitemsDelete item alternative item by itemId and account Id
put/v1/Items/altitems/{altItemId}Update item alternative item based on alt item id
delete/v1/Items/altitems/{altItemId}Delete item alternative item by alt item id
post/v1/Items/altitems/bulkBulk upsert alternative items for multiple items
get/v1/Items/propertiesGet the list of all the properties added to items
get/v1/Items/properties/valuesGet the distinct values stored on items for a single property key
get/v1/Items/definedPropertiesGet the defined properties for items
post/v1/Items/definedPropertiesCreate new item property with parameters
put/v1/Items/definedProperties/{id}Update existing item property with parameters
delete/v1/Items/definedProperties/{id}Delete existing item property with parameters
post/v1/Items/definedProperties/bulkBulk upsert/delete item properties with parameters
post/v1/Items/bulkBulk upsert items masterdata. Accepts a JSON array of items. Items are matched by `code` — existing items are updated, new ones are created. Items missing `code` or `name` are silently skipped; validate your payload before sending. Unit identifiers (`inventUnitId`, barcode `unit`) are normalised to lowercase and auto-created if they do not exist. The server processes large arrays in internal batches of 5 000 items. Endpoint timeout is 5 minutes.
get/v1/Items/{itemId}/unit-of-measure/conversion-checkValidate whether an item's inventory (base) unit can be changed to a target unit. Reports the source units (sales/purch/barcode) that lack a usable conversion to the target so the caller can create them before committing. Read-only; changes nothing.
patch/v1/Items/{itemId}/unit-of-measureChange an item's inventory (base) unit. Requires `AcknowledgeNoRecalculation = true`: existing transactions and stock levels are NOT recalculated. The change is rejected if the required unit conversions do not exist for the new unit.
get/v1/Items/download/xlsxGet all items
post/v1/Items/sendToTenantSend item(s) to another tenant
get/v1/Items/{itemId}/barcodesGet item barcodes
post/v1/Items/{itemId}/barcodesCreate item barcodes
get/v1/Items/{itemId}/barcodes/locationGet item barcodes that are assigned to location
get/v1/Items/{itemId}/barcodes/{id}Get item barcode details
put/v1/Items/{itemId}/barcodes/{id}Update item barcode
delete/v1/Items/{itemId}/barcodes/{id}Delete item barcode
post/v1/Items/{itemId}/images/uploadUpload item images
post/v1/Items/{itemId}/images/linkAdd linked image (external)
put/v1/Items/{itemId}/images/default/{key}Set item default image
delete/v1/Items/{itemId}/images/{key}Delete item image
post/v1/Items/{itemId}/images/{key}/refreshRefresh a URL-sourced item image: re-fetch its source URL and, if the content changed, store a new variant set and remove the old. Returns the outcome (refreshed / unchanged / failed-with-reason). This is the only retry path for a previously failed ingest.
get/v1/Items/validateValidates whether a single item code exists
post/v1/Items/validateValidates multiple item codes. Returns only invalid codes.
post/v1/Items/bulk-fileQueue a bulk item import from a CSV or Excel file. Returns a job ID to poll for status.
get/v1/Items/{itemId}/flagsGet the active flags raised on an item. Cleared flags excluded. Visibility-filtered: tenant-primary callers see all rows; others see global flags plus those scoped to their own account. Returns an empty list if the `UNIQUE_ITEMS` feature is not enabled.
post/v1/Items/{itemId}/flagsManually raise a flag on an item under the caller's account scope. Idempotent: a duplicate raise of the same active flag is a no-op.
delete/v1/Items/{itemId}/flags/{flagTypeId}Manually clear a flag on an item under the caller's account scope. Idempotent: clearing a non-active flag is a no-op (returns 204).

ItemTransactions1

Journals13

Locations31

OperationDimGroups5

Operations31

Orders18

QuestionDefinitions5

Reports7

Roles8

ScaleLocker6

Scales1

Services2

Subscriptions5

UniqueItemStatuses5

UnitConversions6

Units8

UserProfiles14

Users18

WMSItemLocationParams11

WMSLocations14

Items

Changes to Get the distinct values stored on items for a single property key

get/v1/Items/properties/values

Sep 21, 20263d1ff0effc71 Revision changes
- info
  endpoint added