Theme
A theme is the look and feel template for your haravan shop.

A shop can have multiple themes which take the role of either "published" or "unpublished". Each shop can have 20 themes total, including one main theme, and a max of 19 unpublished themes. The published theme is the one customers see when visiting the shop in a desktop browser. Unpublished themes are themes that customers cannot currently see. When you publish a theme, the previously published theme will become unpublished.
What can you do with Theme?
The haravan API lets you do the following with the Theme resource. More detailed versions of these general actions may be available:
- GET /web/themes.json Receive a list of all Themes
- GET /web/themes/#{id}.json Receive a single Theme
- POST /web/themes.json Create a new Theme
- PUT /web/themes/#{id}.json Modify an existing Theme
- DELETE /web/themes/#{id}.json Remove a Theme from the database
Theme Properties
created_at |
The date and time when the theme was created. The API returns this value in ISO 8601 format. |
id |
A unique numeric identifier for the theme. |
name |
The name of the theme. |
role |
Specifies how the theme is being used within the shop. Valid values are:
|
updated_at |
The date and time when the theme was last updated. The API returns this value in ISO 8601 format. |
previewable |
Indicates if the theme can currently be previewed. |
processing |
Indicates if files are still being copied into place for this theme. |
Endpoints
GET/web/themes.json
get a list of a shop's themes
fields | comma-separated list of fields to include in the response |
GET /web/themes.json
View ResponseHTTP/1.1 200 OK { "themes": [ { "created_at": "2015-03-28T13:31:19-04:00", "id": 828155753, "name": "Comfort", "role": "main", "theme_store_id": null, "updated_at": "2015-03-28T13:33:30-04:00", "previewable": true, "processing": false }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 976877075, "name": "Speed", "role": "mobile", "theme_store_id": null, "updated_at": "2015-03-28T13:33:30-04:00", "previewable": true, "processing": false }, { "created_at": "2015-03-28T13:31:19-04:00", "id": 752253240, "name": "Sandbox", "role": "unpublished", "theme_store_id": null, "updated_at": "2015-03-28T13:31:19-04:00", "previewable": true, "processing": false } ] }
GET/web/themes/828155753.json
get a single theme
fields | comma-separated list of fields to include in the response |
GET /web/themes/#{id}.json
View ResponseHTTP/1.1 200 OK { "theme": { "created_at": "2015-03-28T13:31:19-04:00", "id": 828155753, "name": "Comfort", "role": "main", "theme_store_id": null, "updated_at": "2015-03-28T13:31:19-04:00", "previewable": true, "processing": false } }
POST/web/themes.json
Create a theme by providing the public URL of a .zip containing the theme. The theme always starts out with a role of "unpublished." If a different role is provided in the POST request, the theme will be given that role only after all its files have been extracted and stored by haravan (which might take a couple of minutes).
Create a theme from a URL and give it a custom name and role.
POST /web/themes.json
{ "theme": { "name": "Lemongrass", "src": "http:\/\/themes.haravan.com\/theme.zip", "role": "main" } }View Response
HTTP/1.1 201 Created { "theme": { "created_at": "2015-03-28T13:33:29-04:00", "id": 1049083723, "name": "Lemongrass", "role": "unpublished", "theme_store_id": null, "updated_at": "2015-03-28T13:33:29-04:00", "previewable": false, "processing": false } }
Trying to create a theme without a name will return an error
HTTP/1.1 422 Unprocessable Entity { "errors": { "name": [ "can't be blank" ] } }
PUT/web/themes/752253240.json
updating a theme
change the theme's name
HTTP/1.1 200 OK { "theme": { "created_at": "2015-03-28T13:31:19-04:00", "id": 752253240, "name": "Experimental", "role": "unpublished", "theme_store_id": null, "updated_at": "2015-03-28T13:33:30-04:00", "previewable": true, "processing": false } }
changing the theme's role to main or mobile will publish the theme to that role
HTTP/1.1 200 OK { "theme": { "created_at": "2015-03-28T13:31:19-04:00", "id": 752253240, "name": "Sandbox", "role": "main", "theme_store_id": null, "updated_at": "2015-03-28T13:33:30-04:00", "previewable": true, "processing": false } }
DELETE/web/themes/752253240.json
remove a theme
remove a theme
DELETE /web/themes/#{id}.json
View ResponseHTTP/1.1 200 OK { "created_at": "2015-03-28T13:31:19-04:00", "id": 752253240, "name": "Sandbox", "role": "unpublished", "theme_store_id": null, "updated_at": "2015-03-28T13:31:19-04:00", "previewable": true, "processing": false }