Perform a search for products

POST 
/search

Perform a search for products

Request

Query Parameters

limit integer

Possible values: >= 1 and <= 100

The maximum number of results to return

Header Parameters

X-SaleCycle-Id stringrequired

Your SaleCycle API Subscription key

application/json

Body

required

data objectrequired

type string

Possible values: [simple, full]

The type of search.

orderBy string

Possible values: [name, price, brand, inStock, stockQuantity]

The field to order by.

orderDirection string

Possible values: [asc, desc]

The order direction.

query stringrequired

Possible values: >= 3 characters and <= 100 characters

The query to search for.

select string[]

Possible values: [name, description, price, tags, currency, category, brand, imageUrl, stockQuantity, inStock]

The fields to select from the result.

Array [

string

Possible values: [name, description, price, tags, currency, category, brand, imageUrl, stockQuantity, inStock]

]

filter string

The filter to apply to the search.

Responses

200

Successful operation

application/json

Schema

Schema

data object[]required
Array [
id stringrequired
type stringrequired
Possible values: [product]
Default value: product
attributes objectrequired
name string
description string
price number
inStock boolean
stockQuantity integer
imageUrl string
tags string[]
currency string
productId string
category string
brand string
property name* any
]
meta object
totalResults integer

Example (from schema)

{
  "data": [
    {
      "id": "product-1",
      "type": "product",
      "attributes": {
        "name": "Product Name",
        "description": "Product Description",
        "price": 100,
        "inStock": true,
        "stockQuantity": 10,
        "imageUrl": "https://example.com/image.jpg",
        "tags": [
          "clothing",
          "t-shirt"
        ],
        "currency": "USD",
        "productId": "2ed25db3-d34a-4a8c-8439-7e9f3bb9c9a7",
        "category": "Clothing",
        "brand": "SaleCycle"
      }
    }
  ],
  "meta": {
    "totalResults": 12
  }
}

400

Validation Error

application/json

Schema

Schema

errors object[]required
Array [
status stringrequired
title stringrequired
detail stringrequired
]

Example (from schema)

{
  "errors": [
    {
      "status": "string",
      "title": "string",
      "detail": "string"
    }
  ]
}

Loading...