Purchase Orders

Returns internal transfer purchase orders that reserve inventory for a SKU from a source warehouse

Internal transfers reserve stock on the source (supplier) warehouse until they are completed. Returns purchase orders where the supplier warehouse matches the given warehouse (resolved to its physical warehouse when virtual) and an order line matches the given SKU, excluding purchase orders in status Completed, Deleted or OrderCanceled.

By default only transfers that actively reserve warehouse stock are returned: purchase orders created within the last two years (the reserved-quantity calculation window) whose order line for the SKU is not fully cancelled and not fully delivered. Partially delivered transfers are included, since they still reserve the undelivered remainder. Set includeAll=true to also return the excluded purchase orders, mirroring the "Show all" toggle in the reserved-inventory dialog.

Each purchase order is enriched with the properties hasCancelledLines, isDelivered and isPartiallyDelivered, computed for the given SKU. Sorted by created date, descending.

get/api/PurchaseOrders/WithReservedInventory

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/PurchaseOrders/WithReservedInventory
  • Auth: API key in header Authorization

Query parameters

skuIdstring nullable

SKU / variant code

warehouseCodestring nullable

Source (supplier) warehouse code (physical or virtual)

pageSizeinteger

Max 100. Minimum 1.(default is 20)

pageinteger

Current page of the search request. Minimum 1(default is 1)

includeAllboolean

Also return purchase orders that no longer reserve warehouse stock (default false)

Response

Success

totalHitsinteger

Total number of hits

scrollIdstring nullable

The Scroll ID is used when fetching large amounts of data. Whenever the search results yields a ContinuationToken, the Scroll endpoints should be used to continue fetching documents

isValidboolean

Deprecated

Changes

No recorded changes to this operation across all 1 revision of this API.