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:

Field	Supported Filters	Sortable
`id`	`$eq`, `$ne`, `$in`, `$startsWith`, `$exists`, `$hasSome`	Sortable
`status`	`$eq`, `$ne`, `$in`, `$exists`, `$hasSome`	Sortable

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

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.

Example shown:Query Checkout Templates using Cursor Paging

Request

cURL


curl -X POST \
  'https://www.wixapis.com/ecom/v1/checkout-templates/query' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  -d '{
    "query": {
      "sort": [],
      "filter": {
        "status": "ACTIVE"
      },
      "cursorPaging": {
        "limit": 3
      }
    }
  }'

Response

JSON


{
  "checkoutTemplates": [
    {
      "checkoutTemplate": {
        "id": "d447475f-34ed-4be5-b199-b120c6938c39",
        "status": "ACTIVE",
        "customization": {
          "webClient": {
            "disabledContinueShoppingButton": true,
            "disabledPolicyAgreementCheckbox": false
          },
          "lockedGiftCard": false,
          "lockedCoupon": true,
          "disabledManualPayment": true
        },
        "lineItems": [
          {
            "quantity": 2,
            "catalogReference": {
              "catalogItemId": "8df1afe4-90d1-162d-2d42-b8308125c193",
              "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
              "options": {
                "options": {
                  "Size": "Medium"
                },
                "variantId": "00000000-0000-0000-0000-000000000000"
              }
            }
          }
        ],
        "couponCode": "SUMMER_FLASH_SALE"
      }
    },
    {
      "id": "056e6325-fadb-4df3-b447-333639689e0a",
      "status": "ACTIVE",
      "customization": null,
      "lineItems": [
        {
          "quantity": 1,
          "name": "Shirt & Hat Bundle",
          "price": "10",
          "priceDescription": null,
          "descriptionLines": [],
          "media": {
            "id": "1",
            "url": "https://images.squarespace-cdn.com/content/v1/626c8a4c9f0cac0699248dcf/1666767197763-D3TOWRQHU36NKG3PVVM6/Tee-%2B-Hat.png",
            "height": 0,
            "width": 0,
            "altText": null,
            "urlExpirationDate": null,
            "filename": null,
            "sizeInBytes": null
          },
          "paymentOption": "FULL_PAYMENT_ONLINE",
          "id": null
        }
      ],
      "couponCode": "SUMMER_FLASH_SALE"
    },
    {
      "id": "090c1a79-b066-4588-8943-c940ad9dd531",
      "status": "ACTIVE",
      "customization": null,
      "lineItems": [
        {
          "quantity": 10,
          "name": "SHIRT",
          "price": "100",
          "priceDescription": null,
          "descriptionLines": [],
          "media": null,
          "paymentOption": "FULL_PAYMENT_ONLINE",
          "id": null
        }
      ],
      "couponCode": "SUMMER_FLASH_SALE"
    }
  ],
  "pagingMetadata": {
    "count": 3,
    "cursors": {
      "next": "25012ca406ecac3b31c45af1085bba46ac9580c3.EhYqFAoSCgZzdGF0dXMSCBoGQUNUSVZFIiQwOTBjMWE3OS1iMDY2LTQ1ODgtODk0My1jOTQwYWQ5ZGQ1MzE",
      "prev": null
    },
    "hasNext": true
  }
}

Errors

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

Did this help?