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
        • Placements
        • Lab - Placements
    • Learning Changelog
Dev Portal
LogoLogo
On this page
  • Place a Widget
CoursesWidgets - REST APIModule 6: Placements

Lab - Placements

Was this page helpful?
Previous

Placements

Next

Third-Party Widgets and Page Builder

Built with

Plan: Stencil Developer

 Lesson 15 of 22 · 15 min

In this lab you will

  • Place a Widget using Postman

Prerequisites

  • BigCommerce sandbox store
  • API credentials for the store
  • Postman installed
  • Widgets API collection

Place a Widget

Place a widget using postman

  1. Navigate to the ‘Placements> Create’ directory in the ‘V3 Widgets API’ collection in the ‘Collections’ pane 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:
{
  "template_file": "pages/home",
  "entity_id": "",
  "region":"home-top",
  "sort_order": 1,
  "widget_uuid": "yourWidgetUUIDhere",
  "status": "active"
}
  1. Paste in the UUID copied from the previous lab
  2. Click the ‘Send’ button at the top right of the Postman window

Open your store’s homepage, and you should now see your slider.