Skip to main content

Get company branding for a store (public API key only - no JWT required)

GET 
/api/v1/sdk/store/:storeId/branding

This endpoint retrieves company branding and visual identity information for a store. Use this to customize your UI to match the store's brand.

Authentication: Requires Public API Key (pk_*) - NO customer authentication needed. Safe for client-side use.

Response Data:

  • Company name and business information
    • Logo URLs (primary logo, favicon, etc.)
    • Brand colors (primary, secondary, accent colors)
    • Font preferences and typography
    • Social media links
    • Contact information
    • Store description and tagline
    • Custom CSS/styling preferences

Use Cases:

  • White-labeling checkout and product pages
    • Matching store's visual identity in your UI
    • Displaying store logos and brand elements
    • Customizing color schemes and typography
    • Building branded customer experiences

Important Notes:

  • Branding data is cached for performance
    • Logo URLs are CDN-hosted and optimized
    • This endpoint is safe to call from client-side code
    • Use provided assets to maintain consistent brand experience

Error Scenarios:

  • 404 NOT FOUND - Store not found or inactive (Error code: STORE_NOT_FOUND)
    • 401 UNAUTHORIZED - Invalid or missing API key (Error code: INVALID_API_KEY)
    • 403 FORBIDDEN - API key doesn't have access to this store (Error code: NO_STORE_ACCESS)

Request​

Responses​

Company branding retrieved successfully