Get Default Theme

🔒

Requires read_themes access scope. More access scope

The Get Default Theme API retrieves the default theme associated with the store. This provides information about the pre-configured theme that comes with the store.

This API is especially useful for:

  1. Retrieving default theme settings for newly created stores.
  2. Programmatically understanding and customizing the default theme.

Request Parameters

Public Request Parameters

📘

Public Request Parameters

Response Explanation

Public Response Parameters

📘

Public Response Parameters

Successful Response

FieldTypeDescriptionExample
idstringThe unique ID of the theme.faf55ad1-03aa-4071-b250-e8507c022b19
namestringThe name of the default theme.Nova 2023
localestringThe default locale of the theme.en-US
presetstringThe preset configuration of the theme.Default
typestringThe type of the theme.shoplazza
descstringDescription of the theme, including its features.Simple and atmospheric design...
defaultstringIndicates whether the theme is set as the default (1 for yes, 0 for no).1
pc_cover_urlstringURL of the desktop preview image of the theme.https://img.staticdj.com/...png
mobile_cover_urlstringURL of the mobile preview image of the theme.https://img.staticdj.com/...png
publishedstringIndicates whether the theme is published (1 for yes, 0 for no).1
versionstringThe version number of the theme.24.65.0
change_logstringChangelog information for the theme.""
auto_save_timestringTimestamp for the last auto-save of the theme.1731686668
theme_save_timestringTimestamp for the last save of the theme.1731886066
publish_timestringTimestamp for the last publish action of the theme.1731886068

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

FieldTypeExampleDescription
errorString "store is not active"Indicates an error encountered during the process

Error Detail

Status CodeMessagePossible ReasonExample Response
400Bad RequestInvalid input format or request structure (e.g., missing required fields or incorrect data types).Bad Request
UnauthorizedThe request is missing valid authentication credentials or the credentials provided are invalid.Unauthorized

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!