Carts | Search

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

post/api/Cart/ScrollSearch

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

Request body

storeIdsstring[] nullable

Filter for store IDs

customerIdstring nullable

Filter by customer

namestring nullable

Filter by cart name (Not to be confused with customer name)

customerContactstring nullable

Filter by contact person

projectIdstring nullable

Filter by project

changedSincestring date-time nullable

Filter by changed date

createdFromstring date-time nullable

Filter by created from date

createdTostring date-time nullable

Filter by created to date

salesPersonIdstring nullable

Filter by sales person ID

statusesstring[] nullable

Filter by cart statuses

isActiveOnlyboolean

Get only active carts

tagsstring[] nullable

Filter by tags

excludedTagsstring[] nullable

Exclude tags

orderTypesstring[] nullable

Order types

followUpDateFromstring date-time nullable

Orders with follow-up from date

followUpDateTostring date-time nullable

Orders with follow-up to date

marketIdsstring[] nullable

Filter for market IDs

sortOrderstring nullable

Sort order for the results. Defaults to modified date descending. Possible values: CreatedAscending, CreatedDescending, ModifiedAscending, ModifiedDescending, CustomerNameAscending, CustomerNameDescending StatusAscending, StatusDescending, CartIdAscending, CartIdDescending, StoreAscending, StoreDescending, TotalAscending, TotalDescending and DocumentID. If you do not care about the order you should use DocumentId

lineItemSalesOriginIdstring nullable

Filter to only include carts that have at least one order line with a SalesOriginId matching the given value

searchQuerystring nullable

Free text search query

takeinteger

Number of items to take

pageinteger

Page (Fetches from [Page * Take] to [(Page + 1) * Take])

Response

Search successful, returning products

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.