Skip to main content

Search for content​

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

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
    shippingPostalCode string

    Postal code of the address to ship the products to.

    upc string

    UPC specifies the Universal Product Code of the product to search for.

    isbn string

    ISBN specifies the International Standard Book Number of the book to search for.

    sku string

    SKU specifies the Stock Keeping Unit of the product to search for.

    ean string

    EAN specifies the European Article Number of the product to search for.

    partNumber string

    PartNumber to search for.

    oemPartNumber string

    OEMPartNumber to search for.

    filter string[]

    Filter for criteria such as categories, brand, price range etc. The filter is build from the facets of a previous search response.

    params object

    Additional parameters such as filter criteria.

Responses

Successful search response.

Schema
    id string required

    ID of the provider that returned the results. For Amazon Business, the ID is always "amazon".

    name string required

    Name of the provider that returned the results. For Amazon Business, the name is typically "Amazon Business".

    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 Amazon Business, this property is always "amazon".

    name string required

    Name of the product.

    vendor string

    Vendor name, which can be "Amazon" or some other merchant on their platform.

    price object required

    Price of the product per unit. In the search results, we will always return the price of the buy box winner on Amazon. To get a list of more offers, load all product details. Notice also that the prices can come with taxes included or excluded. If Amazon returns a price with taxes excluded, we will use that by default. The PriceTaxLabel property will included more details about taxes in the price.

    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.

    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 describes the delivery details of the product in textual form.

    availability string

    Availability describes the availability details of the product in textual form.

    priceTaxLabel string

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

    preferred boolean

    Preferred indicates that this product is preferred according to the buying guidance settings of the purchasing organization.

    blocked boolean

    Blocked indicates that this product is blocked according to the buying guidance settings of the purchasing organization.

    starRating float64

    Possible values: <= 5

    StarRating is the rating of the product on Amazon in form of a numerical value between 0.0 (bad) and 5.0 (good).

  • ]
    • 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 "brand", 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.

    parents object[]

    Parents is used in 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 "brand" and picks the value ID of "Apple", the query string must be "brand=Apple".

    name string required

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

    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 "brand" and picks the value ID of "Apple", the query string must be "brand=Apple".

    name string required

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

    selected boolean

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

  • ]
  • ]
Loading...