POST

Query Checkout Templates


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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/ecom/v1/checkout-templates/query

Body Params
queryQuery

Query options.

Response Object
checkoutTemplatesArray <CheckoutTemplate>

Retrieved checkout templates.


pagingMetadataPagingMetadata

Paging metadata.

Query Checkout Templates using Cursor Paging
Request
cURL
Response
JSON
Errors

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

Did this help?