openapi: 3.0.0 info: title: BigCommerce Abandoned Cart Emails Widget Template API version: 3.0.0 termsOfService: https://www.bigcommerce.com/terms description: Abandoned Cart Emails V3 API managing Handlebars-based emails. contact: name: BigCommerce url: https://www.bigcommerce.com email: support@bigcommerce.com servers: - url: https://api.bigcommerce.com/stores/{store_hash}/v3 variables: store_hash: default: store_hash description: Permanent ID of the BigCommerce store. description: BigCommerce API Gateway security: - X-Auth-Token: [] tags: - name: Widget Template description: BigCommerce Widget Templates API Definition. paths: /content/widget-templates: post: tags: - Widget Template summary: BigCommerce Create a Widget Template operationId: createWidgetTemplate parameters: - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/ContentType' requestBody: content: application/json: schema: $ref: '#/components/schemas/widgetTemplate_Post' required: true x-examples: application/json: "{\n \"name\": \"Header Images\",\n \"template\": \"{{#each images}}{{/each}}\"\n}" Custom Configuration Widget: "{\n \"name\":\"Header Images\",\n \"template\":\"{{#each images}}{{/each}}\",\n \"schema\":[\n {\n \"type\":\"array\",\n \"label\":\"Images\",\n \"id\":\"images\",\n \"defaultCount\":3,\n \"entryLabel\":\"Image\",\n \"thumbnail\":\"imageUrl.src\",\n \"schema\":[\n {\n \"type\":\"tab\",\n \"label\":\"Content\",\n \"sections\":[\n {\n \"settings\":[\n {\n \"type\":\"imageManager\",\n \"id\":\"imageUrl\",\n \"default\":{\n \"src\":\"https://cdn11.bigcommerce.com/s-n0i50vy/images/stencil/1280x1280/products/109/361/kinfolkessentialissue_1024x1024__22507.1456436715.jpg?c=2&imbypass=on\",\n \"type\":\"IMAGE_MANAGER\"\n }\n },\n {\n \"label\":\"Link\",\n \"type\":\"input\",\n \"id\":\"link\",\n \"default\":\"#\"\n }\n ]\n }\n ]\n }\n ]\n }\n ]\n }" responses: '200': $ref: '#/components/responses/WidgetTemplate_Resp' '422': $ref: '#/components/responses/Error422_Resp' description: 'Creates a **Widget Template**. ***Note:*** *There is a limit of 1000 custom widget templates per store.* **Required Fields** * name * template' get: tags: - Widget Template operationId: getWidgetTemplates parameters: - name: page description: 'Specifies the page number in a limited (paginated) list of products. ' required: false in: query schema: type: integer - name: limit description: 'Controls the number of items per page in a limited (paginated) list of products. ' required: false in: query schema: type: integer - in: query name: widget_template_kind description: The kind of widget template. required: false schema: type: string - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/ContentType' - in: query name: channel_id:in description: Filter items by channel_id. schema: type: integer responses: '200': $ref: '#/components/responses/WidgetTemplateCollection_Resp' '422': $ref: '#/components/responses/Error422_Resp' description: Returns a list of **Widget Templates**. summary: BigCommerce Get All Widget Templates /content/widget-templates/{uuid}/preview: parameters: - schema: type: string name: uuid in: path required: true description: The identifier for a specific widget. post: tags: - Widget Template summary: BigCommerce Render a Widget Template description: Render a widget template and return the widget html. operationId: previewWidget parameters: - $ref: '#/components/parameters/TemplateUUID' requestBody: content: application/json: schema: $ref: '#/components/schemas/WidgetTemplatePreview' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/WidgetTemplatePreviewResponse' '404': description: Not Found '422': description: Unprocessable Entity /content/widget-templates/{uuid}: parameters: - $ref: '#/components/parameters/Accept' - $ref: '#/components/parameters/TemplateUUID' get: tags: - Widget Template summary: BigCommerce Get a Widget Template operationId: getWidgetTemplate parameters: - schema: type: string in: query name: version_uuid description: This is an optional query parameter used to attempt to fetch a specific Widget Template version. responses: '200': $ref: '#/components/responses/WidgetTemplate_Resp' '404': $ref: '#/components/responses/Error404_Resp' '422': $ref: '#/components/responses/Error422_Resp' description: Returns a single **Widget Template**. put: tags: - Widget Template summary: BigCommerce Update a Widget Template operationId: updateWidgetTemplate parameters: - $ref: '#/components/parameters/ContentType' requestBody: content: application/json: schema: $ref: '#/components/schemas/widgetTemplate_Put' required: true x-examples: application/json: name: Header Images template: '{{#each images}}{{/each}}' create_new_version: true responses: '200': $ref: '#/components/responses/WidgetTemplate_Resp' '404': $ref: '#/components/responses/Error404_Resp' '422': $ref: '#/components/responses/Error422_Resp' description: Updates a **Widget Template**. delete: tags: - Widget Template summary: BigCommerce Delete A Widget Template operationId: deleteWidgetTemplate responses: '204': description: An empty response. '404': $ref: '#/components/responses/Error404_Resp' '422': $ref: '#/components/responses/Error422_Resp' description: Deletes a **Widget Template**. components: schemas: metaCollection: type: object description: Data about the response, including pagination and collection totals. title: metaCollection properties: pagination: $ref: '#/components/schemas/pagination' x-internal: false widgetSchema: type: array description: 'The schema for the widget’s merchant-facing UI. For more information on the available schema settings, see [Widget UI Schema](/docs/storefront/widgets/input-reference/schema). ' title: '' items: anyOf: - $ref: '#/components/schemas/widgetSchemaTab' - $ref: '#/components/schemas/widgetSchemaArray' - $ref: '#/components/schemas/widgetSchemaHidden' x-internal: false Meta: title: Response meta type: object properties: {} additionalProperties: true description: Response metadata. widgetSchemaHidden: type: object title: widgetSchemaHidden description: '**Hidden.** Use the **hidden** settings type to create controls that have no user interface drawn in Page Builder. Hidden settings are not grouped into any other tabs or arrays.' x-internal: false properties: type: type: string enum: - hidden example: hidden settings: type: array items: type: object title: widgetSchemaSetting_Base description: For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs. properties: type: type: string description: 'The type of setting component to display. You can view the list of elements below to discover which are available to use. For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.' enum: - alignment - boolean - boxModel - code - color - imageManager - input - number - productId - productImage - range - regexInput - select - text - toggle label: type: string description: The user friendly message to inform the user how this setting will be used. id: type: string description: The variable name where the setting value will be available in the widget template. default: type: string description: The default value to use when rendering the widget for the first time. Make sure to set sensible defaults to make your widget easier to use. typeMeta: type: object description: Additional information needed based on the selected setting type. properties: selectOptions: type: array items: type: object properties: label: type: string example: Image value: type: string example: image conditional: type: object title: widgetSchemaConditional description: An optional property that can be added to each setting to control whether it should be displayed to the user while editing in Page Builder. This does not clear the value in the setting, just controls the display of the setting. x-examples: Conditional attribute: key: backgroundType operator: IN value: - color properties: key: type: string description: The ID of the `setting` object the conditional attribute is related to. example: backgroundType operator: type: string description: 'Specifies the operation used to determine whether to display the setting. The `IN` operator is currently the only supported operator. The setting will be displayed if the conditional’s `value` property is equal to the selected value of the `selectOptions`. ' example: IN value: type: array description: A single-object array containing a value from the `typeMeta`'s `selectOptions`. items: {} widgetTemplate_Put: allOf: - $ref: '#/components/schemas/widgetTemplate_Base' - type: object properties: create_new_version: type: boolean description: Can be added to create a new widget template version instead of updating the current one. channel_id: type: integer description: The id of the channel on which to place this template. title: widgetTemplate_Put x-internal: false WidgetTemplatePreviewResponse: type: object properties: data: properties: html: type: string description: The HTML render of the widget template. format: html x-tags: - Models title: '' WidgetTemplatePreview: properties: widget_configuration: type: object description: The JSON data that populates the template. format: json x-tags: - Models widgetSchemaArray: type: object title: widgetSchemaArray description: '**Array.** Use the **array** settings type to build collections of elements within the widget. Each element in the array can contain tabs, sections, and an entire schema.' properties: type: type: string enum: - array label: type: string id: type: string defaultCount: type: integer description: number of elements in the list to display by default. entryLabel: type: string description: name for each element in the list thumbnail: type: object description: used to display an image stored at the specified attribute name properties: type: type: string example: image valueKey: type: string example: imageUrl.src schema: description: The schema used for each element in the array. type: array items: anyOf: - $ref: '#/components/schemas/widgetSchemaHidden' - $ref: '#/components/schemas/widgetSchemaTab' x-internal: false widgetTemplate_Base: type: object title: widgetTemplate_Base properties: name: type: string description: The user-friendly name. schema: $ref: '#/components/schemas/widgetSchema' template: type: string format: html description: The widget template HTML. Supports Handlebars and Paper helpers. storefront_api_query: type: string description: The GraphQL Storefront API query that provides widget data. description: '' x-internal: false widgetTemplate_Post: title: widgetTemplate_Post type: object description: '' x-internal: false properties: name: type: string description: User-friendly name. schema: $ref: '#/components/schemas/widgetSchema' template: type: string description: Handlebars HTML content. Also has access to Stencil Paper helpers. format: html storefront_api_query: type: string description: The GraphQL Storefront API query that provides widget data. channel_id: type: integer description: The id of the channel on which to create this template. Defaults to the first channel created on the store. required: - name - template x-examples: example-1: name: string schema: - tab template: string storefront_api_query: string channel_id: 0 widgetTemplate_Full: allOf: - $ref: '#/components/schemas/widgetTemplate_Base' - type: object properties: uuid: type: string format: uuid description: The primary identifier. kind: type: string description: The kind of widget template. date_created: type: string format: date-time description: The date on which this object was initially created. date_modified: type: string format: date-time description: The date on which this object was last updated. current_version_uuid: type: string description: The identifier to the current version of this widget template. icon_name: type: string default: default description: A read-only value. Do not attempt to set or modify this value in a POST or PUT operation. title: widgetTemplate_Full description: '' x-internal: false widgetSchemaTab: type: object title: widgetSchemaTab description: '**Tab.** Use the **tab** settings type to create settings visible in Page Builder.' properties: type: type: string description: The type of setting component to display. enum: - tab label: type: string example: Content description: The user-friendly message to inform the user how this setting will be used. sections: type: array description: Groups of related settings. items: type: object title: widgetSchemaTabSections properties: label: type: string description: The user-friendly message to inform the user how this setting will be used. example: Product settings: type: array description: For examples of schema settings, see [Widget UI Input Types](/docs/storefront/widgets/input-reference/settings). items: type: object title: widgetSchemaSetting_Base description: For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs. properties: type: type: string description: 'The type of setting component to display. You can view the list of elements below to discover which are available to use. For examples of each type of setting, see [Page Builder > Schema Settings](/docs/storefront/widgets/input-reference/settings#alignment) in Theme Docs.' enum: - alignment - boolean - boxModel - code - color - imageManager - input - number - productId - productImage - range - regexInput - select - text - toggle label: type: string description: The user friendly message to inform the user how this setting will be used. id: type: string description: The variable name where the setting value will be available in the widget template. default: type: string description: The default value to use when rendering the widget for the first time. Make sure to set sensible defaults to make your widget easier to use. typeMeta: type: object description: Additional information needed based on the selected setting type. properties: selectOptions: type: array items: type: object properties: label: type: string example: Image value: type: string example: image conditional: type: object title: widgetSchemaConditional description: An optional property that can be added to each setting to control whether it should be displayed to the user while editing in Page Builder. This does not clear the value in the setting, just controls the display of the setting. x-examples: Conditional attribute: key: backgroundType operator: IN value: - color properties: key: type: string description: The ID of the `setting` object the conditional attribute is related to. example: backgroundType operator: type: string description: 'Specifies the operation used to determine whether to display the setting. The `IN` operator is currently the only supported operator. The setting will be displayed if the conditional’s `value` property is equal to the selected value of the `selectOptions`. ' example: IN value: type: array description: A single-object array containing a value from the `typeMeta`'s `selectOptions`. items: {} x-internal: false x-examples: {} pagination: type: object description: 'Data about the response, including pagination and collection totals. ' properties: total: type: integer description: 'Total number of items in the result set. ' count: type: integer description: 'Total number of items in the collection response. ' per_page: type: integer description: 'The amount of items returned in the collection per page, controlled by the limit parameter. ' current_page: type: integer description: 'The page you are currently on within the collection. ' total_pages: type: integer description: 'The total number of pages in the collection. ' links: type: object description: 'Pagination links for the previous and next parts of the whole collection. ' properties: previous: type: string description: 'Link to the previous page returned in the response. ' current: type: string description: 'Link to the current page returned in the response. ' next: type: string description: 'Link to the next page returned in the response. ' title: pagination x-internal: false error_Base: type: object description: Error payload for the BigCommerce API. properties: status: description: The HTTP status code. type: integer title: description: The error title describing the particular error. type: string type: type: string instance: type: string errors: type: object x-internal: false title: error_Base parameters: TemplateUUID: name: uuid description: The identifier for a specific template. required: true in: path schema: type: string format: uuid Accept: name: Accept in: header required: true description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body. schema: type: string default: application/json ContentType: name: Content-Type in: header required: true description: The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the request body. schema: type: string default: application/json responses: WidgetTemplate_Resp: description: '' content: application/json: schema: allOf: - type: object properties: data: $ref: '#/components/schemas/widgetTemplate_Full' - properties: meta: $ref: '#/components/schemas/Meta' examples: response: value: data: channel_id: 1 client_rerender: false current_version_uuid: 4bd7619e-7992-4454-8610-84fb16449761 date_created: '2020-12-21T19:36:16.896Z' date_modified: '2020-12-21T19:36:16.896Z' icon_name: default kind: custom name: Header Images schema: [] storefront_api_query: '' template: '{{#each images}}{{/each}}' template_engine: handlebars_v3 uuid: f8459145-da8f-4d98-93e4-83aa47da61c6 meta: {} Error422_Resp: description: 'This is the result of missing required fields, or of invalid data. See the response for more details. ' content: application/json: schema: $ref: '#/components/schemas/error_Base' Error404_Resp: description: The resource was not found. content: application/json: schema: $ref: '#/components/schemas/error_Base' examples: example-1: value: status: 0 title: string type: string instance: string errors: {} WidgetTemplateCollection_Resp: description: '' content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/widgetTemplate_Full' meta: $ref: '#/components/schemas/metaCollection' examples: response: value: data: - channel_id: 1 client_rerender: false current_version_uuid: 4bd7619e-7992-4454-8610-84fb16449761 date_created: '2020-12-21T19:36:16.896Z' date_modified: '2020-12-21T19:36:16.896Z' icon_name: default kind: custom name: Header Images schema: [] storefront_api_query: '' template: '{{#each images}}{{/each}}' template_engine: handlebars_v3 uuid: f8459145-da8f-4d98-93e4-83aa47da61c6 - channel_id: 1 client_rerender: false current_version_uuid: c23dd66b-fa3f-451d-88ef-9f4082c6051e date_created: '2020-12-21T19:36:59.384Z' date_modified: '2020-12-21T19:36:59.384Z' icon_name: default kind: custom name: Simple List schema: [] storefront_api_query: '' template: template_engine: handlebars_v3 uuid: 42b42cbb-e2d8-4f2a-97ea-06755032115a - channel_id: 1 client_rerender: false current_version_uuid: bc820372-368e-4a96-a6d6-f313edba5617 date_created: '2020-12-21T19:38:08.036Z' date_modified: '2020-12-21T19:38:08.036Z' icon_name: default kind: custom name: Simple Text with Styling schema: [] storefront_api_query: '' template: '{{text}} ' template_engine: handlebars_v3 uuid: 17dcc919-982a-4cc0-8ede-a5b49f9ab6dc - channel_id: 1 client_rerender: false current_version_uuid: 873b0a03-b219-46ec-8f06-c3c4522ef25d date_created: '2020-12-21T19:38:30.223Z' date_modified: '2020-12-21T19:38:30.223Z' icon_name: default kind: custom name: YouTube Embed schema: [] storefront_api_query: '' template: '' template_engine: handlebars_v3 uuid: d9e7fd0e-d5c2-45c9-8919-ce68a5590c12 - channel_id: 1 client_rerender: false current_version_uuid: 8fa7ff13-fcfb-4106-9c32-5a084224a444 date_created: '2020-12-21T19:38:46.557Z' date_modified: '2020-12-21T19:38:46.557Z' icon_name: default kind: custom name: Slider Template schema: [] storefront_api_query: '' template: '{{#each slides}} {{/each}}' template_engine: handlebars_v3 uuid: 30714957-0e01-4c4e-8551-25591261d0d0 - channel_id: 0 client_rerender: false current_version_uuid: 7494d009-c695-43ce-a1eb-ba75ef663ba2 date_created: '2020-06-23T18:07:12.110Z' date_modified: '2020-06-23T18:07:12.110Z' icon_name: default kind: pp-cartpage-fullbanner name: PayPal Credit Banner - Cart Page (728x90) schema: [] storefront_api_query: '' template: '' template_engine: handlebars_v3 uuid: 2ff24732-6848-47ba-9a7f-c8b1d444f270 - channel_id: 0 client_rerender: false current_version_uuid: ee4978a6-31f9-47e2-ab38-810dd1c78e34 date_created: '2020-06-23T18:07:12.136Z' date_modified: '2020-06-23T18:07:12.136Z' icon_name: default kind: pp-homepage-fullbanner name: PayPal Credit Banner - Home Page (728x90) schema: [] storefront_api_query: '' template: '' template_engine: handlebars_v3 uuid: 3002bf5b-5eca-4ac2-8f1f-5240c2b74712 meta: pagination: total: 7 count: 7 per_page: 50 current_page: 1 total_pages: 1 securitySchemes: X-Auth-Token: name: X-Auth-Token description: '### OAuth scopes | UI Name | Permission | Parameter | |:--|:--|:-| | Information & Settings | read-only | `store_v2_information_read_only`| | Information & Settings | modify | `store_v2_information` | ### Authentication header | Header | Argument | Description | |:-|:|:| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/docs/start/authentication/api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/docs/start/authentication#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/docs/start/authentication/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/docs/start/about/status-codes).' type: apiKey in: header