SearchProducts

data class SearchProducts(val name: String? = null, val active: Boolean? = null, val shippable: Boolean? = null) : ProductEndpoints

Endpoint for searching products by filter criteria (GET /v1/products/search).

Constructors

Link copied to clipboard
constructor(name: String? = null, active: Boolean? = null, shippable: Boolean? = null)

Properties

Link copied to clipboard
val active: Boolean? = null

Filters results to active or inactive products.

Link copied to clipboard
open override val endpointURL: String

The fully qualified URL string for this endpoint.

Link copied to clipboard
open override val httpMethod: String

HTTP method, e.g. "GET", "POST", "DELETE".

Link copied to clipboard
val name: String? = null

Filters results to products whose name matches this value.

Link copied to clipboard
open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.

Link copied to clipboard
val shippable: Boolean? = null

Filters results to shippable or non-shippable products.