FrameSDK/com.framepayments.framesdk.products/ProductEndpoints/SearchProducts

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

SearchProducts

constructor(name: String? = null, active: Boolean? = null, shippable: Boolean? = null)

Properties

active

val active: Boolean? = null

Filters results to active or inactive products.

additionalHeaders

open val additionalHeaders: Map<String, String>

Optional extra HTTP headers to attach to the request (e.g. Accept: application/json). Defaults to empty. Applied after the standard Frame Authorization/User-Agent headers but before Content-Type (set on POST/PATCH), so an entry may override the former but not the latter. Prefer supplemental headers like Accept; don't rely on this to set auth headers.

endpointURL

open override val endpointURL: String

The fully qualified URL string for this endpoint.

httpMethod

open override val httpMethod: String

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

name

val name: String? = null

Filters results to products whose name matches this value.

queryItems

open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.

shippable

val shippable: Boolean? = null

Filters results to shippable or non-shippable products.