Skip to main content
GET
Search for products

Overview

Use this endpoint to search Commerce inventory and build a product browsing experience.

Authentication

Commerce search requires a commerce-scoped API key (see Commerce APIs).

Request

SDK

cURL

Response

Errors

  • 400 invalid search parameters
  • 401 missing/invalid commerce auth

Examples

  • Build “search → cart → checkout” flows using the adjacent Commerce endpoints in the sidebar. Next: Create a checkout invoice

Authorizations

x-commerce-api-key
string
header
required

Legacy alias for commerce-scoped API keys. Prefer x-api-key with scope=commerce.

Query Parameters

q
string
required

Search query (1-200 characters)

Required string length: 1 - 200
page
integer
default:1

Page number for pagination (1-100)

Required range: 1 <= x <= 100
retailer
enum<string>
default:amazon

Retailer to search (currently only Amazon supported)

Available options:
amazon,
walmart
minPrice
number<float>

Minimum price filter in USD

Required range: x >= 0
maxPrice
number<float>

Maximum price filter in USD

Required range: x >= 0

Response

Search results with pagination info

success
boolean
Example:

true

data
object
meta
object