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 headerrequired
Parameters
- store_hash in path - string
Body
application/json
example
Response
Body
object | application/json
data
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 headerrequired
Parameters
- store_hash in path - string
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 headerrequired
Parameters
- store_hash in path - string
example
Response
Body
object | application/json
data
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 headerrequired
Parameters
- store_hash in path - string
Body
application/json
example
Response
Body
object | application/json
data
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 headerrequired
Parameters
- store_hash in path - string
example
Response
An empty response.
Did you find what you were looking for?