Skip to main content

Search for content​

Searches for products and returns a slice of results as well facets and hints like spelling fixes.

Query Parameters
    query string

    Query string, typically the contents of a search box.

    Example: Apple iPad
    page int32

    Possible values: >= 1

    Default value: 1

    Page of results to retrieve, starting with 1.

    pageSize int32

    Possible values: >= 1 and <= 24

    Default value: 24

    PageSize is the number of results to return for the page.

    Example: 10
    locale string required

    Locale to use for i18n and l10n of content. If no locale is specified in the request, the caller's locale settings are used by default.

    Example: de-DE
    sort string[]

    Possible values: [score, id, -id, price, -price, sku, -sku, vendor, -vendor, delivery_days, -delivery_days]

    Sort order.

    vendor string[]

    Vendor ensures that only products from a specific vendor will be returned.

    vendorSize int32

    Possible values: >= 1 and <= 50

    Default value: 10

    VendorSize allows to specify how many elements are returned at maximum for the vendor facet.

    vendorOrder string

    Possible values: [name, -name, count, -count]

    VendorOrder specifies the sort order of the vendor facet.

    catalog string[]

    Catalog filters the results to only products from the given catalog.

    catalogSize int32

    Possible values: >= 1 and <= 50

    Default value: 10

    CatalogSize allows to specify how many elements are returned at maximum for the catalog facet.

    catalogOrder string

    Possible values: [name, -name, count, -count]

    CatalogOrder specifies the sort order of the catalog facet.

    manufacturer string[]

    Manufacturer narrows down the results to only products from of the specified manufacturer.

    manufacturerSize int32

    Possible values: >= 1 and <= 50

    Default value: 10

    ManufacturerSize allows to specify how many elements are returned at maximum for the manufacturer facet.

    manufacturerOrder string

    Possible values: [name, -name, count, -count]

    ManufacturerOrder specifies the sort order of the manufacturer facet.

    category string

    Category narrows down the results to return only products in the specified category.

    categorySize int32

    Possible values: >= 1 and <= 50

    Default value: 10

    CategorySize allows to specify how many elements are returned at maximum for the category facet.

    categoryOrder string

    Possible values: [name, -name, count, -count]

    CategoryOrder specifies the sort order of the category facet.

    eclass string

    Eclass narrows down the results to return only products with the specified eCl@ss code.

    eclassSize int32

    Possible values: >= 1 and <= 50

    Default value: 10

    EclassSize allows to specify how many elements are returned at maximum for the eCl@ss facet.

    eclassOrder string

    Possible values: [name, -name, count, -count]

    Default value: -count

    EclassOrder specifies the sort order of the eCl@ss facet.

    unspsc string

    Unspsc narrows down the results to return only products with the specified UNSPSC code.

    unspscSize int32

    Possible values: >= 1 and <= 50

    Default value: 10

    UnspscSize allows to specify how many elements are returned at maximum for the UNSPSC facet.

    unspscOrder string

    Possible values: [name, -name, count, -count]

    Default value: -count

    UnspscOrder specifies the sort order of the UNSPSC facet.

    leadtime int32

    Filters the search results to return only products with the given days of delivery.

    leadtimeSize int32

    Possible values: >= 1 and <= 50

    Default value: 10

    LeadtimeSize allows to specify how many elements are returned at maximum for the leadtime facet.

    minPrice float64

    Minimum price for the products.

    maxPrice float64

    Maximum price for the products.

Responses

Successful search response.

Schema
    id string required

    ID of the provider that returned the results. For results from local catalogs, the ID is always "local".

    name string required

    Name of the provider that returned the results. For results from local catalogs, the name typically is a translation of "My Catalogs".

    count object required

    Count holds information about the number of results found in this search. Notice that this number might be an exact value or an approximation.

    value int32 required

    Value of the count. Notice that this number might be an exact value or some lower bound, depending on the value of the Relation property.

    relation string

    Possible values: [eq, gte]

    Default value: eq

    Relation describes whether the Value property is an exact number, in which case Relation is "eq". If Relation is "gte", then the Value property is a lower bound.

    data object[]

    Slice of results returned.

  • Array [
    • id string required

    ID represents an opaque, unique identifier for the individual search result. It is required to pass into other API endpoints, e.g. the Get Product API.

    provider string required

    Provider of the result. For results from local catalogs, this property is always "local".

    sku string

    SKU is the stock-keeping unit, i.e. an identifier that uniquely references the product at the given vendor.

    name string required

    Name of the product.

    description string

    Description is a longer textual description of the product.

    vendor string

    Vendor name.

    price object required

    Price of the product per unit. In the search results, we will always return the best price for the product, if there are multiple offers. Notice that prices from local catalogs are typically net prices, i.e. they do can come with taxes excluded.

    amount float64 required

    Amount of the price, i.e. its monetary value.

    currency string required

    Currency code of the monetary value.

    formatted string

    Formatted monetary value in the caller's locale.

    priceQuantity float64

    Possible values: >= 1

    PriceQuantity describes the packaging unit. E.g. if the price is for a "€ 1.99 per 100 KGM", the price quantity is 100.

    orderUnit string

    OrderUnit describes the packaging unit. E.g. if the price is for a "€ 1.99 per 100 KGM", the order unit is "KGM".

    deliveryDays int32

    DeliveryDays is the delivery time in days.

    manufacturer string

    Manufacturer name.

    brand string

    Brand name.

    preview object

    Preview image to be used in the result list.

    url url required

    URL to the image.

    width int32

    Width of the image in pixels.

    height int32

    Height of the image in pixels.

    altText string

    Alternative Text to further describe the image.

    kind string

    Possible values: [thumbnail, small, medium, large]

    Kind describes the size/purpose of the image.

    quantityDiscountsAvailable boolean

    QuantityDiscountsAvailable indicates that this product comes with a quantity-based pricing tier.

    delivery string

    Delivery information.

    availability string

    Availability information.

    priceUnit string

    PriceUnit returns details about the price and the packaging unit. E.g. if the price is for a single piece, PriceUnit might be something like "per EA". However, if the price is per 100 kg of something, PriceUnit might be "per 100 KGM".

    priceTaxLabel string

    PriceTaxLabel describes the tax-related details of the price in textual form.

    preferred boolean

    Preferred indicates whether this product is preferred according to the buying guidelines of the organization.

    blocked boolean

    Blocked indicates whether this product must be blocked according to the buying guidelines of the organization.

    taxonomies object[]

    Taxonomies represents the list of standard classifications like UNSPSC or eCl@ss for this product.

  • Array [
    • type string required

    Possible values: [unspsc, eclass]

    Type of the taxonomy.

    code string required

    Code in the standard classification.

    version string

    Version of the standard classification.

    displayName string

    DisplayName returns a textual form of the classification code.

  • ]
    • dynamicPricingAvailable boolean

    dynamicPricingAvailable indicates that this product comes with a dynamic discount.

  • ]
    • facets object[]

    Possible way to filter and narrow the results by e.g. category or manufacturer.

  • Array [
    • id string required

    ID represents a unique, opaque identifier for the facet at hand. Notice that consumers can use this ID in subsequent search requests to narrow down search results by facet. E.g. if you have a facet ID of "vendor", you can use this ID as a query parameter in subsequent search requests.

    name string required

    Name of the facet in the locale of the request. You can use this label directly in the UI.

    selectionType string

    Possible values: [single, multiple]

    SelectionType indicates how values of the facet can be selected. E.g. some facets allow to select a single value only, while other allow to select multiple values at once.

    parents object[]

    Parents is used to return the parents in a hierarchical facets, e.g. categories.

  • Array [
    • id string required

    ID represents an opaque, unique identifier for the facet value. This ID must be used by the consumer as the value of a query string for subsequent queries. E.g. if the user clicks on the facet with the ID "category" and picks the value ID of "Office", the query string must be "category=Office".

    name string required

    Name of the facet value at hand. The name can be directly used in the UI.

    count object

    Count, when returned, holds information about the number of results found for this facet. Notice that this number might be an exact value or an approximation.

    value int32 required

    Value of the count. Notice that this number might be an exact value or some lower bound, depending on the value of the Relation property.

    relation string

    Possible values: [eq, gte]

    Default value: eq

    Relation describes whether the Value property is an exact number, in which case Relation is "eq". If Relation is "gte", then the Value property is a lower bound.

    selected boolean

    Selected indicates that this facet value is currently being filtered for in the search request.

  • ]
    • values object[]

    Values of this facet. E.g. if you have a facet of type "Brand", the values represent the actual brands you can filter for: "Apple", "Microsoft", "Samsung" etc.

  • Array [
    • id string required

    ID represents an opaque, unique identifier for the facet value. This ID must be used by the consumer as the value of a query string for subsequent queries. E.g. if the user clicks on the facet with the ID "category" and picks the value ID of "Office", the query string must be "category=Office".

    name string required

    Name of the facet value at hand. The name can be directly used in the UI.

    count object

    Count, when returned, holds information about the number of results found for this facet. Notice that this number might be an exact value or an approximation.

    value int32 required

    Value of the count. Notice that this number might be an exact value or some lower bound, depending on the value of the Relation property.

    relation string

    Possible values: [eq, gte]

    Default value: eq

    Relation describes whether the Value property is an exact number, in which case Relation is "eq". If Relation is "gte", then the Value property is a lower bound.

    selected boolean

    Selected indicates that this facet value is currently being filtered for in the search request.

  • ]
  • ]
    • spelling object[]

    Possible spelling corrections, aka "Did you mean?"

  • Array [
    • text string required

    Text of the user.

    fixes string[]

    List of possible fixes.

  • ]
Loading...