GET Search?Query={Query}&Top={Top}&TopFacets={TopFacets}&Skip={Skip}&UseSuggestionOnEmptyResult={UseSuggestionOnEmptyResult}&OrderBy={OrderBy}&Filter={Filter}&Channel={Channel}&Facets={Facets}&MinMaxFacets={MinMaxFacets}&IncludeAdditonalAttributes={IncludeAdditonalAttributes}&GroupItemsByName={GroupItemsByName}&WithinGroupedItemsOrderBy={WithinGroupedItemsOrderBy}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Query

Der/die Begriff(e) nach denen gesucht werden soll.

string

Required

String length: inclusive between 2 and 1024

Top

Anzahl der Ergebnisse die zurückgeliefert werden sollen (Default: 20).

integer

Range: inclusive between 1 and 1000

TopFacets

Anzahl der Facets (innerhalb einer Gruppe) die zurückgeliefert werden sollen (Default: 20).

integer

Range: inclusive between 1 and 1000

Skip

Anzahl der Ergebnisse die übersprungen werden sollen (Default: 0).

integer

Range: inclusive between 1 and 999

UseSuggestionOnEmptyResult

Wenn keine Ergebnisse für den ursprünglichen Suchbegriff gefunden wurden, das Ergebnis des ersten Vorschlags zurückgeben.

boolean

None.

OrderBy

Feld(er) nach denen sortiert werden soll. Vom Speedfinder ABDA werden unterstützt: ArtikelNr, Name, Relevanz, Preis. Vom Speedfinder werden unterstützt: ArtikelNr, Artikelname, EAN, Hersteller, Warengruppe01, Warengruppe02, Warengruppe03, Warengruppe04, Warengruppe05, Verpackungseinheit, Verpackungsmenge, Darreichungsform, Wirkstoff, Rezeptpflicht, Anwendungshinweise, Wirkungsweise, Beschreibung, Kurzbeschreibung, Deeplink, BildGrossUrl, BildKleinUrl, Frei01, Frei02, Frei03, Frei04, Frei05, Verkaufsrang, Preis, Relevanz Reihenfolge: 'asc' und 'desc'.

string

String length: inclusive between 0 and 1024

Filter

Felder(er) auf denen gefiltert werden soll. Vom Speedfinder ABDA werden unterstützt: Hersteller, Warengruppe, Darreichungsform, Verpackungseinheit, Wirkstoff, Preis. Vom Speedfinder werden unterstützt: ArtikelNr, Artikelname, EAN, Hersteller, Warengruppe01, Warengruppe02, Warengruppe03, Warengruppe04, Warengruppe05, Verpackungseinheit, Verpackungsmenge, Darreichungsform, Wirkstoff, Rezeptpflicht, Anwendungshinweise, Wirkungsweise, Beschreibung, Kurzbeschreibung, Deeplink, BildGrossUrl, BildKleinUrl, Frei01, Frei02, Frei03, Frei04, Frei05, Verkaufsrang, Preis, Relevanz sowie evtl. vorhandene Zusatzattribute. Bei einem Filter für ein Zusatzattribut, muss dem Attributnamen ein 'ZusatzAttribute.' vorangestellt werden. Filter=Hersteller eq 'Ratiopharm GmbH' Filter=ZusatzAttribute.Aufloesung eq '1920x1080' Filter=Preis ge 5m and Preis le 9.99m and Warengruppe eq 'Blutzuckerteststreifen' Syntax für Filter s. http://www.odata.org/documentation/odata-version-3-0/odata-version-3-0-core-protocol/#thefiltersystemqueryoption

string

String length: inclusive between 0 and 4096

Channel

Der Channel der durchsucht werden soll. Darf leer sein, in diesem Fall wird der erste gefundene Channel verwendet.

string

String length: inclusive between 0 and 255

Facets

Kommaseparierte Liste von Feldern, für welche Facets generiert werden sollen. Standardmäßig werden keine Facets (mehr) generiert. Nicht unterstützt vom Speedfinder ABDA.

string

String length: inclusive between 0 and 65536

MinMaxFacets

string

String length: inclusive between 0 and 65536

IncludeAdditonalAttributes

Legt fest, ob die Suchergebnisse die Zusatzattribute enthalten sollen. (Default: true)

boolean

None.

GroupItemsByName

boolean

None.

WithinGroupedItemsOrderBy

string

String length: inclusive between 0 and 1024

Body Parameters

None.

Response Information

Resource Description

SearchResult
NameDescriptionTypeAdditional information
Suggestions

Alternative Vorschläge für Suchbegriffe basierend auf dem ursprünglichen Begriff.

Collection of string

None.

TotalFound

Die Gesamtzahl der gefundenen Ergebnisse.

integer

None.

Items

Die Suchergebnisse.

Collection of SearchResultItem

None.

FacetGroups

Die Facetten.

Collection of FacetGroup

None.

MinMaxFacets

Collection of MinMaxFacet

None.

OriginalSearchTerm

Der Suchbegriff der an die API gesendet wurde.

string

None.

ActualSearchTerm

Der Suchbegriff der für das Ergebnis verwendet wurde. Dieser kann vom eigentlichen Suchbegriff abweichen, wenn kein Ergebnis für diesen gefunden wurde und UseSuggestionOnEmptyResult = true in der Anfrage gesendet wurde.

string

None.

AutoCorrections

Liste von automatisch korrigierten Suchbegriffen (vorher/nachher).

Collection of AutoCorrectionInfo

None.

Campaigns

List der Kampaganen die für die Suche getroffen haben.

Collection of CampaignResult

None.

ContentPageResults

Liste von Content-Seiten welchen den Suchbegriff enthalten.

Collection of ContentPageResult

None.

AreSimilarSearchResults

Gibt an, ob die ermittelten Ergebnisse durch die Ähnlichkeitssuche gefunden wurden.

boolean

None.

AnalyticsCorrelationId

Gibt eine Id zurück, die zur Verknüpfung dieses Suchergebnisses mit einer Conversion genutzt werden kann.

globally unique identifier

None.

MinPrice

decimal number

None.

MaxPrice

decimal number

None.

Response Formats

application/json

Sample:
{
  "Suggestions": [
    "Aspirin"
  ],
  "TotalFound": 88,
  "Items": [
    {
      "Warengruppe": "Acetylsalicylsäure",
      "UVP": 0,
      "Name": "ASPIRIN 100 N",
      "ArtikelNr": "02842080",
      "Hersteller": "EMRA-MED Arzneimittel GmbH",
      "Preis": 0,
      "TrefferGewicht": 0
    }
  ],
  "FacetGroups": [
    {
      "Name": "Warengruppe",
      "Facets": [
        {
          "Value": "Acetylsalicylsäure",
          "Count": 52,
          "FilterValue": "Warengruppe eq 'Acetylsalicylsäure'"
        },
        {
          "Value": "Acetylsalicylsäure, Kombinationen exkl. Psycholeptika",
          "Count": 36,
          "FilterValue": "Acetylsalicylsäure, Kombinationen exkl. Psycholeptika"
        }
      ]
    },
    {
      "Name": "Hersteller",
      "Facets": [
        {
          "Value": "Bayer Vital GmbH",
          "Count": 28,
          "FilterValue": "Hersteller eq 'Bayer Vital GmbH'"
        },
        {
          "Value": "EMRA-MED Arzneimittel GmbH",
          "Count": 15,
          "FilterValue": "Hersteller eq 'EMRA-MED Arzneimittel GmbH'"
        }
      ]
    }
  ],
  "MinMaxFacets": null,
  "OriginalSearchTerm": "Apsirin",
  "ActualSearchTerm": "aspirin",
  "AutoCorrections": [],
  "Campaigns": [],
  "ContentPageResults": [],
  "AreSimilarSearchResults": false,
  "AnalyticsCorrelationId": "ed888c63a08849bb8061b7b777057726",
  "MinPrice": null,
  "MaxPrice": null
}