CoursesWidgets - REST APIModule 3: Widget Templates

Widget Templates

Plan: Stencil Developer

 Lesson 6 of 22 · 15 min

Widget templates are reusable Handlebars-enabled HTML templates which define the structure of the widget on a page. You can use built-in Handlebars helpers such as {{if}} and {{each}} to add conditional logic to a widget template. Widget templates can be reused to build multiple widgets.

There is a limit of 1000 custom widget templates per store.

Create a Widget Template

POST /v3/content/widget-templates

Creates a widget template.

Required Fields

  • name
  • template

Get All Widget Templates

GET /v3/content/widget-templates

Returns a list of widget templates.

Request Parameters:

  • page - (integer) Specifies the page number in a limited (paginated) list of products.
  • limit - (integer) Controls the number of items per page in a limited (paginated) list of products.
  • widget_template_kind (string) - The kind of widget template.

Get a Widget Template

GET /v3/content/widget-templates/{uuid}

Returns a single widget template.

Update a Widget Template

PUT /v3/content/widget-templates/{uuid}

Updates a widget template.

Delete a Widget Template

DELETE /v3/content/widget-templates/{uuid}

Deletes a widget template.