Stores

Search stores and warehouses

post/api/Stores/SearchStores

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

Request body

takeinteger

Number of items pr page

pageinteger

Page to fetch

marketIdsstring[] nullable

Search by markets

storeIdsstring[] nullable

Search by individual stores

storeGroupIdstring nullable

Search by store group

marketGroupIdstring nullable

Search by market group

searchTextstring nullable

Search text

isWarehouseboolean nullable

If true, only warehouses will be returned, if false, only stores not warehouse will be returned. Null returns all stores.

includeInactiveboolean nullable

If null or false all inactive stores are excluded from search result

isInactiveboolean nullable

Null returns all stores, true returns only inactive stores, false returns only active stores (isInactive false or null).

zipCodeRangeFilterinteger nullable

Return only stores with ZipCode Range including the specified ZipCode

emailstring nullable

Search store by email

createdFromstring date-time nullable

Stores created from date (utc)

createdTostring date-time nullable

Stores created before date (utc)

modifiedFromstring date-time nullable

Stores modified from date (utc)

modifiedTostring date-time nullable

Stores modified before date (utc)

externalIdsstring[] nullable

Search stores with external IDs

sortOrderstring nullable

Sort order. E.g. ModifiedAscending, ModifiedDescending, CreatedAscending, CreatedDescending, ZipCodeMatchDescending

Response

Search successful, returning stores

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

Example response

{
  "result": [
    {
      "mondayOpeningHours": {
        "openFrom": "00:00:00",
        "openTo": "00:00:00"
      },
      "tuesdayOpeningHours": {
        "openFrom": "00:00:00",
        "openTo": "00:00:00"
      },
      "wednesdayOpeningHours": {
        "openFrom": "00:00:00",
        "openTo": "00:00:00"
      },
      "thursdayOpeningHours": {
        "openFrom": "00:00:00",
        "openTo": "00:00:00"
      },
      "fridayOpeningHours": {
        "openFrom": "00:00:00",
        "openTo": "00:00:00"
      },
      "saturdayOpeningHours": {
        "openFrom": "00:00:00",
        "openTo": "00:00:00"
      },
      "sundayOpeningHours": {
        "openFrom": "00:00:00",
        "openTo": "00:00:00"
      },
      "additionalOpeningHours": [
        {
          "openingHours": {
            "openFrom": "00:00:00",
            "openTo": "00:00:00"
          }
        }
      ],
      "storePickLimit": "00:00:00",
      "storeExtendedPickLimit": "00:00:00",
      "customerPickupDeadlineLimit": "00:00:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.