For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • Overview
  • Learning Plans
    • Developer Foundations
    • Composable Developer
    • Stencil Developer
    • B2B Developer
  • Courses
        • Widgets
        • Widget Versioning
        • Lab - Widgets
    • Learning Changelog
Dev Portal
LogoLogo
On this page
  • Create a Widget
CoursesWidgets - REST APIModule 5: Widgets

Lab - Widgets

Was this page helpful?
Previous

Widget Versioning

Next

Placements

Built with

Plan: Stencil Developer

Lesson 13 of 22 · 30 min

In this lab you will

  • Create a Widget using Postman

Prerequisites

  • BC Sandbox
  • API credentials for the store (Content: Modify)
  • Postman installed
  • Widgets API collection

Create a Widget

Create a widget using Postman

  1. Navigate to the ‘Widgets > Create’ directory in the ‘V3 Widgets API’ collection in the ‘Collections’ panel on the left side of the Postman window
  2. Click the ‘Create’ post request
  3. Select the ‘Body’ tab in the main content window in Postman
  4. Update the content in the ‘Body’ tab to the following:
{
"name": "Home Page Slider",
"widget_configuration": {
"slides": [
{
"image": "https://tinyurl.com/2wwm4rc8"
},
{
"image": "https://tinyurl.com/3bffvvr8"
},
{
"image": "https://tinyurl.com/mrxfj7hs"
}
]
},
"widget_template_uuid":"yourWidgetTemplateUUIDhere"
}
  1. Paste the Widget Template UUID copied from the end of Module 3: Lab - Widget Template
  2. Click the ‘Send’ button at the top right of the Postman window
  3. Copy the Widget UUID from the response section at the bottom of the Postman window (Save this UUID as it will be used in the next section lab)