Get Theme Customisation

About

The themeCustomization query retrieves detailed information about a single theme customisation by its ID. Use this query to:

• Display specific theme customisation details
• Fetch carousel or slider configurations by ID
• Retrieve footer links or static content sections
• Access all translations for a specific customisation
• Get customisation metadata including timestamps
• Display channel-specific customisations
• Access complete JSON configuration options

This query returns comprehensive customisation data including all translations, display settings, and channel information.

Arguments

Argument	Type	Required	Description
id	ID!	✅ Yes	Theme Customization ID. Supports two formats: numeric ID (e.g., 1) or IRI format (e.g., /api/theme_customizations/1). Required.

Possible Returns

Field	Type	Description
id	ID!	Unique theme customization API identifier.
_id	Int!	Numeric customization ID.
themeCode	String!	Theme code/identifier (e.g., 'default').
type	String!	Customization type (e.g., 'footer_links', 'image_carousel', 'product_carousel', 'category_carousel', 'static_content').
name	String!	Human-readable name of the customization.
sortOrder	Int	Sort order for display.
status	String	Status flag (0 = inactive, 1 = active).
channelId	String	Associated channel ID.
createdAt	DateTime!	Customization creation timestamp.
updatedAt	DateTime!	Last update timestamp.
translation	ThemeCustomizationTranslation!	Default locale translation.
translation.id	ID!	Translation identifier.
translation._id	Int!	Numeric translation ID.
translation.themeCustomizationId	String!	Associated customization ID.
translation.locale	String!	Language locale code (e.g., 'en', 'ar', 'fr').
translation.options	String!	JSON-formatted options/configuration for this translation.
translations	ThemeCustomizationTranslationCollection!	All available translations.
translations.edges	[Edge!]!	Translation edges with cursors.
translations.edges.node	ThemeCustomizationTranslation!	Individual translation.
translations.edges.cursor	String!	Pagination cursor for this translation.
translations.pageInfo	PageInfo!	Pagination info for translations.
translations.pageInfo.hasNextPage	Boolean!	More translations available.
translations.pageInfo.hasPreviousPage	Boolean!	Previous translations available.
translations.pageInfo.startCursor	String	First translation cursor.
translations.pageInfo.endCursor	String	Last translation cursor.
translations.totalCount	Int!	Total translations for this customization.

Customisation Types

Type	Description
image_carousel	Image slider/carousel on home page
product_carousel	Product carousel display
category_carousel	Category carousel display
static_content	HTML/CSS static sections
footer_links	Footer navigation links
services_content	Services information blocks

Use Cases

1. Display Specific Carousel

Use the "Basic" example to fetch and display a specific carousel configuration.

2. Multi-Language Support

Use the "Complete Details" example to get all translations for rendering in different languages.

3. Footer Links Display

Fetch footer links customisation and display them in the footer section.

4. Static Content Sections

Retrieve HTML/CSS static content sections for rendering on pages.

Best Practices

1. Use Correct ID Format - Use either numeric ID or IRI format consistently
2. Cache Results - Theme customisations change infrequently, cache the response
3. Parse JSON Options - The options field contains JSON; parse it in your application
4. Check Status - Verify status is active before displaying
5. Handle Multiple Translations - Fetch all translations for multi-language support
6. Validate Channel - Ensure customisation is for the correct channel

Related Resources

• Theme Customisations - Get all theme customisations with pagination
• Get Category - Query individual category details
• Get Products - Query products
• Pagination Guide - Cursor pagination documentation
• Shop API Overview - Overview of Shop API resources