Search for products

curl --request GET \
  --url https://api-beta.pepay.io/api/commerce/search \
  --header 'x-commerce-api-key: <api-key>'

{
  "success": true,
  "data": {
    "products": [
      {
        "productId": "B000NPYY04",
        "title": "Nature's Bounty Fish Oil, 1200 mg Omega-3, 200 Rapid Release Softgels",
        "price": 12.48,
        "image": "https://images-na.ssl-images-amazon.com/images/I/51KGjV22PWL._AC_US218_.jpg",
        "rating": 4.5,
        "reviewCount": 395,
        "fresh": false,
        "retailer": "amazon",
        "url": "https://www.amazon.com/dp/B000NPYY04"
      }
    ],
    "pagination": {
      "page": 1,
      "totalPages": 8,
      "totalResults": 150,
      "hasNext": true
    },
    "query": "wireless headphones",
    "retailer": "amazon"
  },
  "meta": {
    "timestamp": 1738240496,
    "cacheStats": {}
  }
}

Commerce

Search for products

Search for products across supported retailers using our commerce platform. Results are cached for 5 minutes to improve performance.

Features:

Full-text product search across retailers
Pagination support (up to 100 pages)
Price range filtering
Real-time availability and pricing
Prime eligibility filtering
Customer ratings and reviews

Rate Limiting:

10 searches per minute per API key
Results cached for 5 minutes to reduce API calls

Response includes:

Product title, description, and images
Current pricing and discounts
Availability status
Customer ratings and review count
Prime eligibility
Shipping information

GET

api

commerce

Search for products

curl --request GET \
  --url https://api-beta.pepay.io/api/commerce/search \
  --header 'x-commerce-api-key: <api-key>'

{
  "success": true,
  "data": {
    "products": [
      {
        "productId": "B000NPYY04",
        "title": "Nature's Bounty Fish Oil, 1200 mg Omega-3, 200 Rapid Release Softgels",
        "price": 12.48,
        "image": "https://images-na.ssl-images-amazon.com/images/I/51KGjV22PWL._AC_US218_.jpg",
        "rating": 4.5,
        "reviewCount": 395,
        "fresh": false,
        "retailer": "amazon",
        "url": "https://www.amazon.com/dp/B000NPYY04"
      }
    ],
    "pagination": {
      "page": 1,
      "totalPages": 8,
      "totalResults": 150,
      "hasNext": true
    },
    "query": "wireless headphones",
    "retailer": "amazon"
  },
  "meta": {
    "timestamp": 1738240496,
    "cacheStats": {}
  }
}

Authorizations

x-commerce-api-key

string

header

required

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

Query Parameters

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

Show child attributes