Purchase Orders | Deliveries

Search deliveries

Search deliveries

post/api/Deliveries/Search

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

Request body

createdFromstring date-time nullable

Minimum creation date to filter the search results.

createdTostring date-time nullable

Maximum creation date to filter the search results.

estimatedTimeOfArrivalFromstring date-time nullable

Minimum expected delivery date to filter the search results.

estimatedTimeOfArrivalTostring date-time nullable

Maximum expected delivery date to filter the search results.

customerNamestring nullable

Customer name to search for.

emailstring nullable

Email address to search for.

purchaseOrderNumberstring nullable

Purchase order number to search for.

selectedDeliveriesstring[] nullable

Selected delivery ID to filter the search results.

selectedStatusesstring[] nullable

Selected statuses to filter the search results.

pageinteger

Page number of the search results.

takeinteger

Number of records to retrieve per page.

selectedStoresstring[] nullable

Selected store names to filter the search results.

sortOrderstring nullable

Sort order of the search results.

searchTextstring nullable

Text to search for.

orderTypestring nullable

Purchase order type (InternalTransfer or PurchaseOrder)

tagsstring[] nullable

Filter by tags

excludedTagsstring[] nullable

Filter by excluding tags

supplierIdsstring[] nullable

Filter by supplier IDs

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.