Orders | Get

Returns orders that currently reserve inventory for a SKU in a warehouse

Returns non-delivered orders (based on the delivered-status configuration per order type) that have an order line with the given SKU shipping from the given warehouse. If the warehouse is a virtual warehouse, orders are matched on the virtual warehouse and its first physical warehouse.

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

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

get/api/Orders/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/Orders/WithReservedInventory
  • Auth: API key in header Authorization

Query parameters

skuIdstring nullable

SKU / variant code

warehouseCodestring nullable

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 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.