Templates Resource
URL Endpoints
| Endpoint | Supported Metods |
|---|---|
| /[store-handle]/api/v2/webstore/templates.json | GET |
| /[store-handle]/api/v2/webstore/templates/[template-uuid].json | GET, PUT, DELETE |
Data Structure
Template resources hold information about their pages and assets and the author. Templates are used for the visual representation of your webstore.
GET
/[store-handle]/api/v2/webstore/templates/[template-uuid].json
/static/support/documentation/examples/template.json
| Name | Path | Type | Description | Example |
|---|---|---|---|---|
| type | type | string (readonly) | Resource type. Must match the resource type used in the endpoint. | "orders", "products", "customers" |
| uuid | uuid | uuid | Resource identifier. Must be a valid hex representation. | "06429e75a8ea11de80c09314b8ee4e52" |
| revision | revision | timestamp (readonly) | Resource version. Uses the timestamp format, precision up to seconds. | 1253783394 |
| name | name | string | Template name. | "Raconteurs", "Bishop" |
| author | author | string | Template author. | "Vincent van Gogh" |
| description | description | string | Template description. Most likely a description of what this template is capable of. | "Lorem ipsum dolor sit amet." |
| contextVersion | contextVersion | integer | Context version for template to use. | 1 |
| assets | assets | array with dictionaries (readonly) | Generated from the assets for this resource. | |
| pages | pages | array with strings (readonly) | Generated from the pages for this resource. |
Template Assets Resource
URL Endpoints
| Endpoint | Supported Metods |
|---|---|
| /[store-handle]/api/v2/webstore/templates/[template-uuid]/assets/[asset-uuid].[format] | GET, PUT, DELETE |
Data Structure
Templates assets can be sent the raw file data of the asset. Supported asset formats are: png, jpg, gif, css, js, htc. Format is detected based on file extension.
Template Pages Resource
URL Endpoints
| Endpoint | Supported Metods |
|---|---|
| /[store-handle]/api/v2/webstore/templates/[template-uuid]/pages/[page-name].html | GET, PUT, DELETE |
Data Structure
Templates pages can be sent the raw template data. The base format is html with template logic. For more information about template capabilities see the custom template documentation.