Customers | B2B

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

Request body

storeIdsstring[] nullable

Filter for store IDs

marketIdsstring[] nullable

Filter for market IDs

marketGroupIdsstring[] nullable

Filter for market group IDs

isMarketGroupIdsRequiredboolean nullable

Set to 'true' to exclude customers without any MarketGroupId set. If 'false', customers without market group IDs will be returned when market group ID filter is used

isStoreIdsRequiredboolean nullable

Set to 'true' to exclude customers without any Store IDs set. If 'false', customers without store IDs will be returned when store ID filter is used

storeGroupIdstring nullable

Filter by store group ID (will override StoreIds if set)

customerIdstring nullable

Filter by customer

customerIdsstring[] nullable

Filter by multiple customer IDs

customerNumbersstring[] nullable

Filter by multiple customer numbers

customerGroupsstring[] nullable

Filter by customer groups

createdFromstring date-time nullable

Customer created from date

createdTostring date-time nullable

Customer created before date

modifiedFromstring date-time nullable

Customer modified from date

modifiedTostring date-time nullable

Customer modified before date

taxIdstring nullable

Filter by customer

emailstring nullable

Filter by customer email

phonestring nullable

Filter by customer phone

hasErrorsboolean

Only show customers with errors

selectedErrorsstring[] nullable

Only show customers carrying one of these error keys. A connector that a tenant runs several instances of prefixes its error keys with the connector alias, so pass the key exactly as it appears on the customer.

querystring nullable

Search by free text query

searchStoreGroupsboolean

If true, search will include all stores with same store group ID as for the stores with given StoreIds

isInactiveboolean nullable

If true, search will include all customers marked as inactive. If false all customers marked as inactive will be excluded. Null returns all.

isGlobalboolean nullable

If true, search will include all customers marked as global. If false all customers marked as global will be excluded. Null returns all.

isCustomerClubMemberboolean nullable

If true, search will only include customers that are members of a customer club. If false, only non-members. Null returns all

externalIdsstring[] nullable

Search by external IDs

consentTypesstring[] nullable

List of consent types. Will filter customers for any active consent of given types.

projectTypeIdstring nullable

Filter on customers available as partners on a project type. (Only available on business customer search)

sortOrderstring nullable

Sort order (ModifiedAscending, ModifiedDescending, CreatedAscending, CreatedDescending)

tagsstring[] nullable

Customer tags

excludedTagsstring[] nullable

Filter by excluding tags

takeinteger

Number of items to take

pageinteger

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

Response

Search successful, returning business customers

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.