Widgets
Create a Placement
POST /stores/{store_hash}/v3/content/placements
Request
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 headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
widget_uuidstring
requiredA widget identifier.
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: 1
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 support
entity_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
data
metaobject
Response metadata.
response
Get All Placements
GET /stores/{store_hash}/v3/content/placements
Request
Returns a list of Placements.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- 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.
- template_file in query - string
The template file, for example:
pages/home. - widget_uuid in query - string
The identifier for a specific widget.
- widget_template_uuid in query - string
The identifier for a specific widget template.
- channel_id:in in query - array
A comma-separated list of channel ids to filter the results by.
- site_id:in in query - array
A comma-separated list of site IDs to filter the results by.
example
Response
Body
dataarray[object]
metaobject
Data about the response, including pagination and collection totals.
response
Get a Placement
GET /stores/{store_hash}/v3/content/placements/{uuid}
Request
Returns a single Placement.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- uuid in path - stringrequired
The identifier for a specific placement.
example
Response
Body
data
metaobject
Response metadata.
response
Update a Placement
PUT /stores/{store_hash}/v3/content/placements/{uuid}
Request
Updates a Placement.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Content-Type in header with default of application/json - stringrequired
The MIME type of the request body.
Body
template_filestring
The template file that you would like to target.
widget_uuidstring
A widget identifier.
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 support
entity_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
data
metaobject
Response metadata.
response
Delete a Placement
DELETE /stores/{store_hash}/v3/content/placements/{uuid}
Request
Deletes a Placement.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequired
The MIME type of the response body.
- uuid in path - stringrequired
The identifier for a specific placement.
example
Response
An empty response.