Placement
Create a Placement
POST https://api.bigcommerce.com/stores/{store_hash}/v3/content/placementsRequest
Creates a Placement.
Template Files
To view the list of values accepted by the template_file
property, including custom templates, see Placements.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
template_filestring
requiredThe template file that you would like to target.channel_idinteger
The id of the channel on which to create this placement. Defaults to the first channel created on the store.Example: 1entity_idstring
The identifier of a page you would like to target. For product pages, choose product ID. For category pages, choose category ID. Home page does not supportentity_id
.sort_orderinteger
The sort order to control the position of a content widget in a region.regionstring
The name of the region in which to insert content widgets.statusstring
Sets the placement as either inactive or active.Allowed: inactive | active
Default: inactive
example
Response
Body
object | application/json
dataobject
response
Get All Placements
GET https://api.bigcommerce.com/stores/{store_hash}/v3/content/placementsRequest
Returns a list of Placements.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe 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 - stringThe kind of widget template.
- template_file in query - stringThe template file, for example:
pages/home
. - widget_uuid in query - stringThe identifier for a specific widget.
- widget_template_uuid in query - stringThe identifier for a specific widget template.
- channel_id:in in query - arrayA comma-separated list of channel ids to filter the results by.Type: array[integer]
- site_id:in in query - arrayA comma-separated list of site IDs to filter the results by.Type: array[integer]
example
Response
Body
object | application/json
dataarray[object]
response
Get a Placement
GET https://api.bigcommerce.com/stores/{store_hash}/v3/content/placements/{uuid}Request
Returns a single Placement.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- uuid in path - stringrequiredThe identifier for a specific placement.
example
Response
Body
object | application/json
dataobject
response
Update a Placement
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/content/placements/{uuid}Request
Updates a Placement.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- uuid in path - stringrequiredThe identifier for a specific placement.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
template_filestring
The template file that you would like to target.channel_idinteger
The ID of the channel on which this placement exists.entity_idstring
The identifier of a page you would like to target. For product pages, choose product ID. For category pages, choose category ID. Home page does not supportentity_id
.sort_orderinteger
The sort order to control the position of a content widget in a region.regionstring
The name of the region in which to insert content widgets.statusstring
Sets the placement as either inactive or active.Allowed: inactive | active
Default: inactive
example
Response
Body
object | application/json
dataobject
response
Delete a Placement
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/content/placements/{uuid}Request
Deletes a Placement.
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- uuid in path - stringrequiredThe identifier for a specific placement.
example
Response
An empty response.
Did you find what you were looking for?