Skip to main content
GET
/
products
/
search
Search products
curl --request GET \
  --url https://api.salesive.com/api/v1/products/search \
  --header 'Authorization: Bearer <token>'
{
  "status": 200,
  "success": true,
  "message": "Search products",
  "data": {
    "products": [
      {
        "_id": "66a1f2c4e1b3a40012ab34cd",
        "name": "Classic Tee",
        "slug": "classic-tee",
        "price": 19.99,
        "quantity": 120,
        "images": [
          "https://cdn.salesive.com/p/classic-tee.jpg"
        ],
        "shop": {
          "_id": "66a1eee0e1b3a40012ab0001",
          "name": "Acme Store",
          "currency": {
            "symbol": "$",
            "code": "USD"
          }
        },
        "createdAt": "2026-06-01T10:00:00.000Z"
      }
    ]
  }
}
Searches the store’s products by case-insensitive match against name, description or barcode and returns up to all matches (no pagination), newest first. The query parameter is required; omitting it returns 400. Requires the READ_INVENTORY scope.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Query Parameters

​
query
string
required

Search term matched against product name, description and barcode. Required.

Response

Search products — success.

​
status
integer
required
Example:

200

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Search products"

​
data
object
required
Example:
{
  "products": [
    {
      "_id": "66a1f2c4e1b3a40012ab34cd",
      "name": "Classic Tee",
      "slug": "classic-tee",
      "price": 19.99,
      "quantity": 120,
      "images": [
        "https://cdn.salesive.com/p/classic-tee.jpg"
      ],
      "shop": {
        "_id": "66a1eee0e1b3a40012ab0001",
        "name": "Acme Store",
        "currency": { "symbol": "$", "code": "USD" }
      },
      "createdAt": "2026-06-01T10:00:00.000Z"
    }
  ]
}