/

/IO.CommonAPI

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 19h ago · Updated 3d ago

Filter operations

Accounts20

Auth3

Barcodes1

DataJobs2

Devices13

Dimensions10

DimensionValues9

Doors1

DynamicScanContent2

ExtendedProperties5

FeatureFlags1

FlagTypes5

GlobalSettings10

ItemPrices12

ItemQuantities2

Items45

getGet all items
postCreate new item
getGet all service items
getGet 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.
deletePurge 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.
getExport 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.
getGet item details
putUpdate existing item
deleteDelete item
getGet item unit conversions
getGet item alternative items
putUpdate item alternative item based on orig. itemId and account
postCreate item alternative item
deleteDelete item alternative item by itemId and account Id
putUpdate item alternative item based on alt item id
deleteDelete item alternative item by alt item id
postBulk upsert alternative items for multiple items
getGet the list of all the properties added to items
getGet the defined properties for items
postCreate new item property with parameters
putUpdate existing item property with parameters
deleteDelete existing item property with parameters
postBulk upsert/delete item properties with parameters
postBulk 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.
getValidate 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.
patchChange 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.
getGet all items
postSend item(s) to another tenant
getGet item barcodes
postCreate item barcodes
getGet item barcodes that are assigned to location
getGet item barcode details
putUpdate item barcode
deleteDelete item barcode
postUpload item images
postAdd linked image (external)
putSet item default image
deleteDelete item image
postRefresh 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.
getValidates whether a single item code exists
postValidates multiple item codes. Returns only invalid codes.
postQueue a bulk item import from a CSV or Excel file. Returns a job ID to poll for status.
getGet 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.
postManually 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.
deleteManually 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

Roles1

ScaleLocker6

Scales1

Services2

Subscriptions5

UniqueItemStatuses5

UnitConversions6

Units8

UserProfiles14

Users18

WMSItemLocationParams11

WMSLocations14

Items

Send item(s) to another tenant

post/v1/Items/sendToTenant

Query parameters

tenantIdstring uuid

Receiver tenant id

accountIdinteger

Receiver account id in sender tenant

Response

Success

Changes