NAV
Subscribe to developer updates

v3 API Reference

Storefront Widgets API (Early Access)

Widget Template

BigCommerce Widget Templates API definition.

createWidgetTemplate

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /content/widget-templates

Creates a widget template.

{
  "name": "string",
  "schema": {},
  "template": "string"
}

Parameters

Parameter Type Required Description
body WidgetTemplatePost true No description
name string true User friendly name.
schema object(json) true The JSON schema of data for this template. Used to validate a configuration.
template string(html) true Handlebars HTML content. Also has access to Stencil Paper helpers.
{
  "data": {
    "uuid": "string",
    "name": "string",
    "kind": "string",
    "schema": {},
    "template": "string",
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
201 Created A widget template. WidgetTemplateResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getWidgetTemplates

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates', headers=headers)

print r.json()

GET /content/widget-templates

Gets all widget templates.

Parameters

Parameter Type Required Description
page integer false Specifies the page number in a limited (paginated) list of products.
limit integer false Controls the number of items per page in a limited (paginated) list of products.
widget_template_kind string false The kind of widget template.
{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetTemplatesResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getWidgetTemplate

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates/{uuid}', headers=headers)

print r.json()

GET /content/widget-templates/{uuid}

Gets a widget template.

Parameters

Parameter Type Required Description
uuid string(uuid) true The identifier for a specific template.
{
  "data": {
    "uuid": "string",
    "name": "string",
    "kind": "string",
    "schema": {},
    "template": "string",
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetTemplateResponse
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

updateWidgetTemplate

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates/{uuid}', params={
 # Coming Soon 
 },
    headers=headers

)

print r.json()

PUT /content/widget-templates/{uuid}

Updates a widget template.

{
  "name": "string",
  "schema": {},
  "template": "string"
}

Parameters

Parameter Type Required Description
uuid string(uuid)(uuid) true The identifier for a specific template.
body WidgetTemplatePut true No description
name string false User-friendly name.
schema object(json) false The schema for this template. Describes how to build dynamic forms for widget configurations.
template string(html) false Handlebars HTML content. Also has access to Stencil Paper helpers.
{
  "data": {
    "uuid": "string",
    "name": "string",
    "kind": "string",
    "schema": {},
    "template": "string",
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetTemplateResponse
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

deleteWidgetTemplate

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/content/widget-templates/{uuid}', headers=headers)

print r.json()

DELETE /content/widget-templates/{uuid}

Deletes a widget template.

Parameters

Parameter Type Required Description
uuid string(uuid)(uuid)(uuid) true The identifier for a specific template.
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
204 No Content An empty response. None
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

Widget

BigCommerce Widgets API Definition.

createWidget

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /content/widgets

Creates a widget.

{
  "name": "string",
  "widget_configuration": {},
  "widget_template_uuid": "string"
}

Parameters

Parameter Type Required Description
body WidgetPost true No description
name string true User friendly name.
widget_configuration object(json) true The JSON data that populates the template.
widget_template_uuid string true The widget template UUID.
{
  "data": {
    "uuid": "string",
    "name": "string",
    "widget_configuration": {},
    "widget_template": {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getWidgets

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets', headers=headers)

print r.json()

GET /content/widgets

Gets all widgets.

Parameters

Parameter Type Required Description
page integer false Specifies the page number in a limited (paginated) list of products.
limit integer false Controls the number of items per page in a limited (paginated) list of products.
widget_template_kind string false The kind of widget template.
{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "widget_configuration": {},
      "widget_template": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetsResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getWidget

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/{uuid}', headers=headers)

print r.json()

GET /content/widgets/{uuid}

Gets a widget.

Parameters

Parameter Type Required Description
uuid string(uuid) true The identifier for a specific widget.
{
  "data": {
    "uuid": "string",
    "name": "string",
    "widget_configuration": {},
    "widget_template": {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetResponse
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

updateWidget

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/{uuid}', params={
 # Coming Soon 
 },
    headers=headers

)

print r.json()

PUT /content/widgets/{uuid}

Updates a widget.

{
  "name": "string",
  "widget_configuration": {},
  "widget_template_uuid": "string"
}

Parameters

Parameter Type Required Description
uuid string(uuid)(uuid) true The identifier for a specific widget.
body WidgetPut true No description
name string false User-friendly name.
widget_configuration object(json) false The JSON data that populates the template.
widget_template_uuid string false The widget template UUID.
{
  "data": {
    "uuid": "string",
    "name": "string",
    "widget_configuration": {},
    "widget_template": {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetResponse
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

deleteWidget

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/{uuid}', headers=headers)

print r.json()

DELETE /content/widgets/{uuid}

Deletes a widget.

Parameters

Parameter Type Required Description
uuid string(uuid)(uuid)(uuid) true The identifier for a specific widget.
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
204 No Content An empty response. None
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

searchWidgets

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/widgets/search', headers=headers)

print r.json()

GET /content/widgets/search

Gets all widgets by search.

Parameters

Parameter Type Required Description
page integer false Specifies the page number in a limited (paginated) list of products.
limit integer false Controls the number of items per page in a limited (paginated) list of products.
query string false The query string associated with a widget’s name and description.
{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "description": "string",
      "widget_configuration": {},
      "widget_template": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success WidgetsResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

Placement

BigCommerce Placements API definition.

createPlacement

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.post('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements', params={
 # Coming Soon
 },
    headers=headers

)

print r.json()

POST /content/placements

Creates a placement.

{
  "widget_uuid": "string",
  "entity_id": "string",
  "sort_order": "string",
  "region": "string",
  "template_file": "string",
  "status": "inactive"
}

Parameters

Parameter Type Required Description
body PlacementPost true No description
widget_uuid string true A widget identifier.
entity_id string false The specific instance of a page that you would like to target.
sort_order string false The sorting order to control the position of a content widget in a region.
region string true The name of the region in which to insert content widgets.
template_file string true The template file that you would like to target.
status string false Sets the placement as either inactive or active.

Enumerated Values

Parameter Value
status inactive
status active
{
  "data": [
    {
      "uuid": "string",
      "entity_id": "string",
      "status": "inactive",
      "template_file": "string",
      "region": "string",
      "widget": {
        "uuid": "string",
        "name": "string",
        "widget_configuration": {},
        "widget_template": {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
201 Created A placement. PlacementResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getPlacements

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements', headers=headers)

print r.json()

GET /content/placements

Gets all placements.

Parameters

Parameter Type Required Description
page integer false Specifies the page number in a limited (paginated) list of products.
limit integer false Controls the number of items per page in a limited (paginated) list of products.
widget_template_kind string false The kind of widget template.
template_file string false The template file, for example, pages/home.
{
  "data": [
    {
      "uuid": "string",
      "entity_id": "string",
      "status": "inactive",
      "template_file": "string",
      "region": "string",
      "widget": {
        "uuid": "string",
        "name": "string",
        "widget_configuration": {},
        "widget_template": {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success PlacementsResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

getPlacement

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements/{uuid}', headers=headers)

print r.json()

GET /content/placements/{uuid}

Gets a placement.

Parameters

Parameter Type Required Description
uuid string(uuid) true The identifier for a specific placement.
{
  "data": {
    "uuid": "string",
    "entity_id": "string",
    "status": "inactive",
    "template_file": "string",
    "region": "string",
    "widget": {
      "uuid": "string",
      "name": "string",
      "widget_configuration": {},
      "widget_template": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success PlacementResponse
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

updatePlacement

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Content-Type':'application/json',
    'Accept':'application/json'

}

r = requests.put('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements/{uuid}', params={
 # Coming Soon 
 },
    headers=headers

)

print r.json()

PUT /content/placements/{uuid}

Updates a placement.

{
  "entity_id": "string",
  "template_file": "string",
  "region": "string",
  "sort_order": "string",
  "widget_uuid": "string",
  "status": "inactive"
}

Parameters

Parameter Type Required Description
uuid string(uuid)(uuid) true The identifier for a specific placement.
body PlacementPut true No description
entity_id string false Optional. The specific instance of a page that you would like to target.
template_file string false The template file that you would like to target.
region string false The name of the region in which to insert content widgets.
sort_order string false The sort order to control the position of a content widget in a region.
widget_uuid string false A widget identifier.
status string false Sets the placement as either inactive or active.

Enumerated Values

Parameter Value
status inactive
status active
{
  "data": {
    "uuid": "string",
    "entity_id": "string",
    "status": "inactive",
    "template_file": "string",
    "region": "string",
    "widget": {
      "uuid": "string",
      "name": "string",
      "widget_configuration": {},
      "widget_template": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success PlacementResponse
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

deletePlacement

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.delete('https://api.bigcommerce.com/stores/{store_id}/v3/content/placements/{uuid}', headers=headers)

print r.json()

DELETE /content/placements/{uuid}

Deletes a placement.

Parameters

Parameter Type Required Description
uuid string(uuid)(uuid)(uuid) true The identifier for a specific placement.
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
204 No Content An empty response. None
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

Theme Regions

getRegions

import requests
headers = {
    'X-Auth-Client': 'SampleClientID',
    'X-Auth-Token': 'SampleTokenHere',
    'Accept':'application/json'

}

r = requests.get('https://api.bigcommerce.com/stores/{store_id}/v3/content/regions', headers=headers)

print r.json()

GET /content/regions

Gets an ordered list of unique regions that are defined in a template file.

Parameters

Parameter Type Required Description
templateFile string true The template file, for example: pages/home.
{
  "data": [
    {
      "name": "string"
    }
  ],
  "meta": {}
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 0,
  "title": "string",
  "type": "string",
  "instance": "string",
  "errors": {
    "property1": "string",
    "property2": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK Success A ThemeRegionsResponse object.
404 Not Found The resource was not found. ErrorResponse
422 Unprocessable Entity This is the result of missing required fields, or of invalid data. See the response for more details. ErrorResponse

Storefront Widgets Object References

This section lists object models corresponding to Storefront Widgets endpoints.

Placement

{
  "uuid": "string",
  "entity_id": "string",
  "status": "inactive",
  "template_file": "string",
  "region": "string",
  "widget": {
    "uuid": "string",
    "name": "string",
    "widget_configuration": {},
    "widget_template": {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  },
  "date_created": "string",
  "date_modified": "string"
} 

Properties

Name Type Required Description
uuid string(uuid) false The primary identifier.
entity_id string false The specific instance of a page
status string false Determines whether this placement is active or inactive.
template_file string false The page template name.
region string false The user-friendly name.
widget [Widget] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
widget_configuration object(json) false The JSON data that populates the template.
widget_template [WidgetTemplate] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
kind string false The kind of widget template.
schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.

Enumerated Values

Property Value
status inactive
status active

PlacementPost

{
  "widget_uuid": "string",
  "entity_id": "string",
  "sort_order": "string",
  "region": "string",
  "template_file": "string",
  "status": "inactive"
} 

Properties

Name Type Required Description
widget_uuid string true A widget identifier.
entity_id string false The specific instance of a page that you would like to target.
sort_order string false The sort order to control the position of a content widget in a region.
region string true The name of the region in which to insert content widgets.
template_file string true The template file that you would like to target.
status string false Sets the placement as eitherinactive or active.

Enumerated Values

Property Value
status inactive
status active

PlacementPut

{
  "entity_id": "string",
  "template_file": "string",
  "region": "string",
  "sort_order": "string",
  "widget_uuid": "string",
  "status": "inactive"
} 

Properties

Name Type Required Description
entity_id string false Optional. The specific instance of a page that you would like to target.
template_file string false The template file that you would like to target.
region string false The name of the region in which to insert content widgets.
sort_order string false The sorting order to control the position of a content widget in a region.
widget_uuid string false A widget identifier.
status string false Sets the placement as either inactive or active.

Enumerated Values

Property Value
status inactive
status active

PlacementResponse

{
  "data": {
    "uuid": "string",
    "entity_id": "string",
    "status": "inactive",
    "template_file": "string",
    "region": "string",
    "widget": {
      "uuid": "string",
      "name": "string",
      "widget_configuration": {},
      "widget_template": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  }
} 

Properties

Name Type Required Description
data Placement false No description
uuid string(uuid) false The primary identifier.
entity_id string false The specific instance of a page
status string false Determines whether this placement is active or inactive.
template_file string false The page template name.
region string false The user-friendly name.
widget [Widget] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
widget_configuration object(json) false The JSON data that populates the template.
widget_template [WidgetTemplate] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
kind string false The kind of widget template.
schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.

Enumerated Values

Property Value
status inactive
status active

PlacementsResponse

{
  "data": [
    {
      "uuid": "string",
      "entity_id": "string",
      "status": "inactive",
      "template_file": "string",
      "region": "string",
      "widget": {
        "uuid": "string",
        "name": "string",
        "widget_configuration": {},
        "widget_template": {
          "uuid": "string",
          "name": "string",
          "kind": "string",
          "schema": {},
          "template": "string",
          "date_created": "string",
          "date_modified": "string"
        },
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
} 

Properties

Name Type Required Description
meta CollectionMeta false Data about the response, including pagination and collection totals.
pagination Pagination false Data about the response, including pagination and collection totals.
total integer false Total number of items in the result set.
count integer false Total number of items in the collection response.
per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
current_page integer false The page you are currently on within the collection.
total_pages integer false The total number of pages in the collection.
links object false Pagination links for the previous and next parts of the whole collection.
previous string false Link to the previous page returned in the response.
current string false Link to the current page returned in the response.
next string false Link to the next page returned in the response.
data [Placement] false No description
uuid string(uuid) false The primary identifier.
entity_id string false The specific instance of a page
status string false Determines whether this placement is active or inactive.
template_file string false The page template name.
region string false The user-friendly name.
widget [Widget] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
widget_configuration object(json) false The JSON data that populates the template.
widget_template [WidgetTemplate] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
kind string false The kind of widget template.
schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.

Enumerated Values

Property Value
status inactive
status active

ThemeRegion

{
  "name": "string"
} 

Properties

Name Type Required Description
name string false The region name.

ThemeRegionsResponse

{
  "data": [
    {
      "name": "string"
    }
  ],
  "meta": {}
} 

Properties

Name Type Required Description
meta Meta false Empty meta object; might be used later.
data [ThemeRegion] false No description
ยป name string false The region name.

Widget

{
  "uuid": "string",
  "name": "string",
  "widget_configuration": {},
  "widget_template": {
    "uuid": "string",
    "name": "string",
    "kind": "string",
    "schema": {},
    "template": "string",
    "date_created": "string",
    "date_modified": "string"
  },
  "date_created": "string",
  "date_modified": "string"
} 

Properties

Name Type Required Description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
widget_configuration object(json) false The JSON data that populates the template.
widget_template [WidgetTemplate] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
kind string false The kind of widget template.
schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.

WidgetPost

{
  "name": "string",
  "widget_configuration": {},
  "widget_template_uuid": "string"
} 

Properties

Name Type Required Description
name string true User friendly name.
widget_configuration object(json) true The JSON data that populates the template.
widget_template_uuid string true The widget template UUID.

WidgetPut

{
  "name": "string",
  "widget_configuration": {},
  "widget_template_uuid": "string"
} 

Properties

Name Type Required Description
name string false User-friendly name.
widget_configuration object(json) false The JSON data that populates the template.
widget_template_uuid string false The widget template UUID.

WidgetResponse

{
  "data": {
    "uuid": "string",
    "name": "string",
    "widget_configuration": {},
    "widget_template": {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    },
    "date_created": "string",
    "date_modified": "string"
  }
} 

Properties

Name Type Required Description
data Widget false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
widget_configuration object(json) false The JSON data that populates the template.
widget_template [WidgetTemplate] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
kind string false The kind of widget template.
schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.

WidgetsResponse

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "widget_configuration": {},
      "widget_template": {
        "uuid": "string",
        "name": "string",
        "kind": "string",
        "schema": {},
        "template": "string",
        "date_created": "string",
        "date_modified": "string"
      },
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
} 

Properties

Name Type Required Description
meta CollectionMeta false Data about the response, including pagination and collection totals.
pagination Pagination false Data about the response, including pagination and collection totals.
total integer false Total number of items in the result set.
count integer false Total number of items in the collection response.
per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
current_page integer false The page you are currently on within the collection.
total_pages integer false The total number of pages in the collection.
links object false Pagination links for the previous and next parts of the whole collection.
previous string false Link to the previous page returned in the response.
current string false Link to the current page returned in the response.
next string false Link to the next page returned in the response.
data [Widget] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
widget_configuration object(json) false The JSON data that populates the template.
widget_template [WidgetTemplate] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
kind string false The kind of widget template.
schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.

WidgetTemplate

{
  "uuid": "string",
  "name": "string",
  "kind": "string",
  "schema": {},
  "template": "string",
  "date_created": "string",
  "date_modified": "string"
} 

Properties

Name Type Required Description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
kind string false The kind of widget template.
schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.

WidgetTemplatePost

{
  "name": "string",
  "schema": {},
  "template": "string"
} 

Properties

Name Type Required Description
name string true User friendly name.
schema object(json) true The JSON schema of data for this template. Used to validate a configuration.
template string(html) true Handlebars HTML content. Also has access to Stencil Paper helpers.

WidgetTemplatePut

{
  "name": "string",
  "schema": {},
  "template": "string"
} 

Properties

Name Type Required Description
name string false User-friendly name.
schema object(json) false The schema for this template. Describes how to build dynamic forms for widget configurations.
template string(html) false Handlebars HTML content. Also has access to Stencil Paper helpers.

WidgetTemplateResponse

{
  "data": {
    "uuid": "string",
    "name": "string",
    "kind": "string",
    "schema": {},
    "template": "string",
    "date_created": "string",
    "date_modified": "string"
  }
} 

Properties

Name Type Required Description
data WidgetTemplate false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
kind string false The kind of widget template.
schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.

WidgetTemplatesResponse

{
  "data": [
    {
      "uuid": "string",
      "name": "string",
      "kind": "string",
      "schema": {},
      "template": "string",
      "date_created": "string",
      "date_modified": "string"
    }
  ],
  "meta": {
    "pagination": {
      "total": 0,
      "count": 0,
      "per_page": 0,
      "current_page": 0,
      "total_pages": 0,
      "links": {
        "previous": "string",
        "current": "string",
        "next": "string"
      }
    }
  }
} 

Properties

Name Type Required Description
meta CollectionMeta false Data about the response, including pagination and collection totals.
pagination Pagination false Data about the response, including pagination and collection totals.
total integer false Total number of items in the result set.
count integer false Total number of items in the collection response.
per_page integer false The amount of items returned in the collection per page, controlled by the limit parameter.
current_page integer false The page you are currently on within the collection.
total_pages integer false The total number of pages in the collection.
links object false Pagination links for the previous and next parts of the whole collection.
previous string false Link to the previous page returned in the response.
current string false Link to the current page returned in the response.
next string false Link to the next page returned in the response.
data [WidgetTemplate] false No description
uuid string(uuid) false The primary identifier.
name string false The user-friendly name.
kind string false The kind of widget template.
schema object(json) false The JSON schema of data for this template. Used to validate a configuration.
template string(html) false The widget template HTML. Supports Handlebars and Paper helpers.
date_created string(datetime) false The date on which this object was initially created.
date_modified string(datetime) false The date on which this object was last updated.