This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a query to retrieve a list of checkout templates.
The queryCheckoutTemplates()
function builds a query to retrieve a list of checkout templates and returns a CheckoutTemplatesQueryBuilder
object.
The returned object contains the query definition, which is typically used to run the query using the find()
function.
You can refine the query by chaining CheckoutTemplatesQueryBuilder
functions onto the query. CheckoutTemplatesQueryBuilder
functions enable you to sort, filter, and control the results that queryCheckoutTemplates()
returns.
queryCheckoutTemplates()
runs with the following CheckoutTemplatesQueryBuilder
default that you can override:
ascending("_id")
The functions that are chained to queryCheckoutTemplates()
are applied in the order they are called. For example, if you apply ascending("status")
and then ascending("_id")
, the results are sorted first by the "status"
, and then, if there are multiple results with the same "status"
, the items are sorted by "_id"
.
The following CheckoutTemplatesQueryBuilder
functions are supported for the queryCheckoutTemplates()
function. For a full description of the checkout template object, see the object returned for the items
property in CheckoutTemplatesQueryResult
.
PROPERTY | SUPPORTED FILTERS & SORTING |
---|---|
_id | eq() ,ne() ,exists() ,in() ,hasSome() ,startsWith() ,ascending() ,descending() |
status | eq() ,ne() ,exists() ,in() ,hasSome() ,ascending() ,descending() |
You can only call this method when authenticated as a Wix app or Wix user identity.