Search

Search API enables users to programmatically query Amazon Business.

Endpoint

GET /api/v1/amazon/search HTTP/1.1
Accept: application/json

Searches for products on Amazon Business.

Parameters

Parameter	In	Type	Required	Description
query	query	string	true	Query string, typically the contents of a search box, e.g. iPhone
page	query	integer(int32)	false	Page of results to retrieve, starting with 1 (default: 1)
pageSize	query	integer(int32)	false	Number of results to return for the page. Minimum is 1, maximum and default are 24.

Additional parameters

Notice that you may add an unlimited number of dynamic parameters to the query. Those are not known upfront and can be build from the response returned by a previous search. See the search tutorial for an example.

Example

Parameter	In	Type	Required	Description
category	query	string	false	A category to limit results to
is_prime	query	string	false	Limit results to Amazon Prime
price	query	string	false	Limit to a specific price range
availability	query	string	false	Filter for a products that are e.g. in stock only
lbr_brands_browse-bin	query	string	false	Filter for a specific brand
...	query	string	false	Additional, dynamically generated filters

Response

Overview

Status	Meaning	Description
200	OK	A list of search results.
400	Bad Request	The server understood your request but is unable to complete it, e.g. because a required parameter is missing.
401	Unauthorized	You sent invalid or expired credentials.
429	Too Many Requests	The server received too many requests in a given amount of time; you should throttle down and retry later.
500	Internal Server Error	Something went wrong on our side.

Response schema

Status Code 200

Name	Type	Required	Description
id	string	true	Always amazon for results from Amazon Business
name	string	true	A localized text for the term Amazon Business
count	object	true	Describes an exact or lower bound for the number of matching results
data	array	false	An array of individual search results
facets	array	false	An array of facets to further filter the search results

Search Count

Name	Type	Required	Description
value	integer(int32)	true	The total number of results. Notice that relation indicates whether this is an exact number or a lower bound.
relation	string	false	Indicates whether the count is exact (eq) or a lower bound (gte). Default is eq.

Search Result

Name	Type	Required	Description
id	string	true	An opaque, unique identifier for the individual search result; use it to retrieve product details or initiate the punchout process
provider	string	true	Always amazon for the Storefront API for Amazon Business
name	string	true	Name of the product
vendor	string	false	Name of the vendor
price	object(Money)	true	Price of the product per unit. This is typically the price of the buy box winner. Some prices come with taxes inluded, which is indicated by the priceTaxLabel.
preview	object(Image)	false	Preview image
quantityDiscountsAvailable	boolean	false	Indicates whether quantity discounts are available for this product
delivery	string	false	Describes delivery details of the product in textual form, e.g. FREE delivery on Friday, August 13th
priceTaxLabel	string	false	Describes tax-related details of the price in textual form, e.g. excl. taxes
preferred	boolean	false	Indicates whether this is a preferred product according to the buying guidance settings of the purchasing organization
blocked	boolean	false	Indicates whether this is blocked according to the buying guidance settings of the purchasing organization. These products should be disabled from adding to the shopping cart.
starRating	number(float64)	false	Rating of the product on Amazon in the form of a numerical value between 0.0 (bad) and 5.0 (good)

Search Facets

Name	Type	Required	Description
id	string	true	A unique, opaque string to identify the facet; it can be used to build subsequent search requests
name	string	true	A localized text that describes the facet, e.g. "Brand" or "Price range"
parents	array(SearchFacetValue)	false	Certain facets are hierarchical, e.g. categories, and return the parent categories
values	array(SearchFacetValue)	true	Array of the different values of the facet. E.g. for "Price range" the values could be "Up to 5$" and "5-10$"

Search Facet Value

Name	Type	Required	Description
id	string	true	A unique, opaque string to identify the facet value; it can be used to build subsequent search requests
name	string	true	A localized text that describes the facet value
selected	boolean	false	Indicates whether this facet value is currently selected

Money

Name	Type	Required	Description
amount	number	true	Amount of the price. Minimum is 0.0
currency	string	true	Currency code as of ISO 3166
formatted	string	false	A localized, textual form of the monetary value

Image

Name	Type	Required	Description
url	string	true	URL to the image
width	integer(int32)	false	Width of the image in pixels
height	integer(int32)	false	Height of the image in pixels
altText	string	false	Alternative text to further describe the image
kind	string	false	Describes the size/purpose of the image: thumbnail, small, medium, or large

Examples

200 response

```json
{
  "id": "amazon",
  "name": "Amazon Business",
  "count": {
    "value": 2404,
    "relation": "eq"
  },
  "data": [
    {
      "id": "s_CgpCMDdaUEtONllSEAIaAlVTIgVlbi1VUyjChT0",
      "provider": "amazon",
      "sku": "B07ZPKN6YR",
      "name": "Apple iPhone 11, 64GB, Black - Unlocked (Renewed)",
      "vendor": "Chubbiestech",
      "price": {
        "amount": 364,
        "currency": "USD",
        "formatted": "$ 364.00"
      },
      "preview": {
        "url": "https://m.media-amazon.com/images/I/31PpUfTCiFL._SY500_.jpg",
        "width": 366,
        "height": 500,
        "altText": "Apple iPhone 11, 64GB, Black - Unlocked (Renewed)"
      },
      "delivery": "Delivery Friday, June 3",
      "availability": "In Stock.",
      "priceTaxLabel": "incl. taxes"
    },
    ...
  ],
  "facets": [
    {
      "id": "category",
      "name": "Category",
      "parents": [
        {
          "id": "",
          "name": "Electronics",
          "selected": true
        }
      ],
      "values": [
        {
          "id": "search-alias#electronics,node#281407",
          "name": "Accessories \u0026 Supplies"
        },
        {
          "id": "search-alias#electronics,node#502394",
          "name": "Camera \u0026 Photo"
        },
        {
          "id": "search-alias#electronics,node#3248684011",
          "name": "Car \u0026 Vehicle Electronics"
        },
        ...
      ]
    },
    {
      "id": "price",
      "name": "Price",
      "values": [
        {
          "id": "1253503011",
          "name": "Under $25"
        },
        {
          "id": "1253504011",
          "name": "$25 to $50"
        },
        {
          "id": "1253505011",
          "name": "$50 to $100"
        },
        {
          "id": "1253506011",
          "name": "$100 to $200"
        },
        {
          "id": "1253507011",
          "name": "$200 \u0026 Above"
        }
      ]
    },
    {
      "id": "availability",
      "name": "Availability",
      "values": [
        {
          "id": "2661600011",
          "name": "In Stock Only"
        },
        {
          "id": "2661601011",
          "name": "Include Out of Stock"
        }
      ]
    },
    {
      "id": "delivery_day",
      "name": "Delivery Day",
      "values": [
        {
          "id": "8308920011",
          "name": "Get It Today"
        },
        {
          "id": "8308921011",
          "name": "Get It by Tomorrow"
        }
      ]
    },
    {
      "id": "review-rating",
      "name": "Avg. Customer Review",
      "values": [
        {
          "id": "1248879011",
          "name": "4 Stars \u0026 Up"
        },
        {
          "id": "1248880011",
          "name": "3 Stars \u0026 Up"
        },
        {
          "id": "1248881011",
          "name": "2 Stars \u0026 Up"
        },
        {
          "id": "1248882011",
          "name": "1 Star \u0026 Up"
        }
      ]
    },
    {
      "id": "is_prime",
      "name": "Delivery Option",
      "values": [
        {
          "id": "1249137011",
          "name": "Free Shipping by Amazon"
        }
      ]
    },
    {
      "id": "cpf_eligible",
      "name": "Climate Pledge Friendly",
      "values": [
        {
          "id": "21512497011",
          "name": "Climate Pledge Friendly"
        }
      ]
    },
    {
      "id": "lbr_brands_browse-bin",
      "name": "Brand",
      "values": [
        {
          "id": "SAMSUNG",
          "name": "SAMSUNG"
        },
        {
          "id": "Apple",
          "name": "Apple"
        },
        {
          "id": "LG",
          "name": "LG"
        },
        {
          "id": "Motorola",
          "name": "Motorola"
        },
        {
          "id": "Google",
          "name": "Google"
        },
        {
          "id": "Nokia",
          "name": "Nokia"
        },
        {
          "id": "HUAWEI",
          "name": "HUAWEI"
        }
      ]
    },
    {
      "id": "condition-type",
      "name": "Condition",
      "values": [
        {
          "id": "New",
          "name": "New"
        },
        {
          "id": "Used",
          "name": "Used"
        },
        {
          "id": "Certified Refurbished",
          "name": "Renewed"
        }
      ]
    }
  ]
}