Promotions | Campaigns

Search for campaigns

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

Request body

startFromstring date-time nullable

Filter campaigns that start after this date. Only campaigns where StartDate >= StartFrom will be included.

startTostring date-time nullable

Filter campaigns that start before this date. Only campaigns where StartDate <= StartTo will be included.

endFromstring date-time nullable

Filter campaigns that end after this date. Only campaigns where EndDate >= EndFrom will be included.

endTostring date-time nullable

Filter campaigns that end before this date. Only campaigns where EndDate <= EndTo will be included.

statusesstring[] nullable

Filter by campaign statuses. Empty means all statuses. Valid values: Planning, Active, Completed, Archived

marketIdsstring[] nullable

Filter by market IDs.

storeIdsstring[] nullable

Filter by store IDs.

tagsstring[] nullable

Filter by tags.

searchTextstring nullable

Free-text search across name, description, and tags.

campaignIdsstring[] nullable

Filter by specific campaign IDs.

pageinteger

Page number for pagination. Defaults to 1.

takeinteger

Number of results per page. Defaults to 20.

sortOrderstring nullable

Sort order. Options: StartDateAsc, StartDateDesc, EndDateAsc, EndDateDesc, NameAsc, NameDesc.

excludeArchivedboolean

If true, excludes archived campaigns from results. Defaults to true.

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.