Purchase Orders

Scroll purchaseOrders by search

Scrolling is not intended for real time user requests, but rather for processing large amounts of data. Only use scroll endpoints if you intend to fetch all items returned by the search request. Paging (take, page) is disabled for scroll searches. Sample request for a delta query using modified date and filtering on an order type:

        POST /api/PurchaseOrders/Scroll
        {
           "ModifiedFrom": "2022-12-24T17:32:28Z"
        }
post/api/PurchaseOrders/Scroll

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/Scroll
  • Auth: API key in header Authorization

Request body

orderNumberstring nullable

Order number to search for.

emailstring nullable

Email address to search for.

phonestring nullable

Phone number to search for.

searchTextstring nullable

Text to search for.

selectedStatusesstring[] nullable

Selected statuses to filter the search results.

supplierNamestring nullable

Supplier name to search for.

supplierIdstring nullable

Supplier ID to search for.

supplierWarehouseCodestring nullable

Supplier warehouse code (warehouse used for sending internal transfers)

orderTypestring nullable

Purchase order type (InternalTransfer or PurchaseOrder)

createdFromstring date-time nullable

Minimum creation date to filter the search results.

createdTostring date-time nullable

Maximum creation date to filter the search results.

modifiedFromstring date-time nullable

Minimum modified date to filter the search results.

modifiedTostring date-time nullable

Maximum modified date to filter the search results.

requestedDeliveryDateFromstring date-time nullable

Minimum requested delivery date to filter the search results.

requestedDeliveryDateTostring date-time nullable

Maximum requested delivery date to filter the search results.

urgentboolean

Indicates whether the search should include urgent orders only.

selectedStoresstring[] nullable

Selected store names to filter the search results.

takeinteger

Number of records to retrieve per page.

pageinteger

Page number of the search results.

productNumbersstring[] nullable

List of product numbers to filter the search results.

externalIdsstring[] nullable

Search purchase orders with external IDs

sortOrderstring nullable

Sort order of the search results.

tagsstring[] nullable

Filter by tags

excludedTagsstring[] nullable

Filter by excluding tags

hasDeliveryboolean nullable

Filter by whether the purchase order has at least one order line with a delivery assigned. True returns only purchase orders with a delivery on one or more lines; false returns only purchase orders with no deliveries on any line; null (default) returns both.

Response

Search successful, returning orders

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.