Docs
Content API
Widgets
Widget

Widget

Create a Widget

POST /content/widgets

Request

Creates a Widget.

Note: There is a limit of 100,000 widgets per store and 150 widgets per page. For more information, see Store Limits.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • name    string
    required

    User friendly name.

  • description    string

    The user-friendly description.

  • widget_configuration    object

    The JSON data that populates the template.

  • widget_template_uuid    string
    required

    The widget template UUID.

  • channel_id    integer

    The ID of the channel on which to create this widget. Defaults to the first channel created on the store.

example

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

response

Get All Widgets

GET /content/widgets

Request

Returns a list of Widgets. Optional parameters can be passed in.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • page in query - integer

    Specifies the page number in a limited (paginated) list of products.

  • limit in query - integer

    Controls the number of items per page in a limited (paginated) list of products.

  • widget_template_kind in query - string
    The kind of widget template.
  • widget_template_uuid in query - string
    The identifier for a specific widget template.
  • name in query - string
    The URL-encoded name of the widget.
  • name:in in query - array
    Use to pass in comma-separated list of widget names. Example: /widgets?name:in=test-widget-name,header%20images
    Type: array[string]
  • channel_id:in in query - array
    A comma-separated list of channel ids to filter the results by.
    Type: array[integer]
  • site_id:in in query - array
    A comma-separated list of site IDs to filter the results by.
    Type: array[integer]

example

Response

Body

object | application/json

  • data    array[object]

  • meta    object

    Data about the response, including pagination and collection totals.

response

Get a Widget

GET /content/widgets/{uuid}

Request

Returns a single Widget.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • uuid in path - string
    required
    The identifier for a specific widget.

example

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

response

Update a Widget

PUT /content/widgets/{uuid}

Request

Updates a Widget.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • uuid in path - string
    required
    The identifier for a specific widget.
  • Content-Type in header with default of application/json - string
    required
    The MIME type of the request body.

Body

object | application/json

  • name    string

    The user-friendly name.

  • description    string

    The user-friendly description.

  • widget_configuration    object

    The JSON data that populates the template.

  • widget_template_uuid    string

    The widget template UUID.

  • channel_id    integer

  • upgrade    boolean

    Upgrade the Widget to latest version of the WidgetTemplate.

example

Response

Body

object | application/json

  • data    object

  • meta    object

    Response metadata.

response

Delete a Widget

DELETE /content/widgets/{uuid}

Request

Deletes a Widget.

Authentication

  • X-Auth-Token in header

Parameters

  • store_hash in path - string
  • Accept in header with default of application/json - string
    required
    The MIME type of the response body.
  • uuid in path - string
    required
    The identifier for a specific widget.

example

Response

An empty response.
Did you find what you were looking for?
Get Theme RegionsCreate a Widget