POST

Query Checkout Templates

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves a list of checkout templates, given the provided paging, filtering, and sorting.

Query Checkout Templates runs with these defaults, which you can override:

  • id sorted in ASC order

The following table shows field support for filters and sorting for the checkout template object:

FieldSupported FiltersSortable
id$eq, $ne, $in, $startsWith, $exists, $hasSomeSortable
status$eq, $ne, $in, $exists, $hasSomeSortable

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

PropertyFiltersSort
_id$eq, $ne, $exists, $in, $hasSome, $startsWith, $gt, $lt, $lte, $gteSort: ASC, DESC
status$eq, $ne, $exists, $in, $hasSomeSort: ASC, DESC
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage eCommerce - all permissions
Learn more about app permissions.
Method Declaration
Copy
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?