Customer Portal APIs (0.0.1)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Returns the customer ID of the currently authenticated customer from their Shopify session. This endpoint is used by the customer portal UI to identify which customer is logged in.

Use Cases:

• Customer portal initialization - determine who's logged in
• Fetch customer-specific data (subscriptions, orders, settings)
• Validate customer session before displaying sensitive information
• Personalize customer portal UI with customer name/email

How it works:

• Customer must be logged in to their Shopify customer account
• Session is validated via Shopify App Proxy
• Returns Shopify customer ID (numeric)

Important Notes:

• This endpoint only works when called from the shop domain (via Shopify App Proxy)
• Customer must be logged in to Shopify
• Returns null if customer is not authenticated
• Do not use this for external API integrations - use External APIs with explicit customer ID instead

Authentication: Requires active Shopify customer session (browser-based)

Retrieves the custom CSS styling configuration for the customer portal. This endpoint returns all custom CSS rules that have been configured to customize the appearance, layout, and branding of the subscription customer portal.

What is Custom CSS? Custom CSS allows merchants to fully customize the visual appearance of their customer portal beyond the basic theme settings. This enables complete brand alignment and creates a seamless experience that matches the merchant's main store design.

Custom CSS Capabilities:

• Layout Customization:

  • Modify page layouts and spacing
  • Adjust grid and flexbox configurations
  • Control responsive breakpoints
  • Customize navigation and sidebars

• Typography:

  • Custom fonts and font families
  • Font sizes, weights, and line heights
  • Letter spacing and text transforms
  • Heading and paragraph styles

• Colors and Branding:

  • Brand color palette application
  • Custom background colors and gradients
  • Button and link styling
  • Hover and focus states
  • Border colors and shadows

• Component Styling:

  • Subscription card appearances
  • Form input styling
  • Button designs and interactions
  • Modal and dialog boxes
  • Navigation menus
  • Product images and thumbnails

• Advanced Features:

  • CSS animations and transitions
  • Media queries for responsive design
  • Pseudo-elements and pseudo-classes
  • Custom icons using CSS
  • Transform and filter effects

CSS Structure: The returned CSS includes:

• Global styles for portal-wide consistency
• Component-specific styles
• Responsive design rules
• Theme overrides
• Custom animations
• Print styles (optional)

Common CSS Selectors Available:

/* Portal container */
.subscription-portal { }

/* Subscription cards */
.subscription-card { }
.subscription-card-header { }
.subscription-card-body { }

/* Buttons */
.btn-primary { }
.btn-secondary { }
.btn-cancel { }

/* Forms */
.form-control { }
.form-group { }
.form-label { }

/* Navigation */
.portal-nav { }
.nav-item { }

/* Product displays */
.product-item { }
.product-image { }
.product-title { }

Use Cases:

• Apply custom branding to match main store design
• Create unique visual experiences for different customer segments
• Implement seasonal or promotional themes
• Enhance mobile responsiveness
• Add accessibility improvements (high contrast, larger fonts)
• A/B test different portal designs
• Integrate with design systems
• Implement dark mode or theme switching

Important Notes:

• CSS is sanitized for security (XSS prevention)
• Certain properties may be restricted for security reasons
• External resources (fonts, images) must use HTTPS
• CSS is cached for performance - changes may take a few minutes to propagate
• Invalid CSS syntax is automatically filtered out
• Some core portal elements have !important styles that cannot be overridden

Best Practices:

• Use specific selectors to avoid conflicts
• Test across different browsers and devices
• Keep CSS organized with comments
• Use CSS variables for maintainability
• Minify CSS for production performance
• Consider accessibility in color choices (WCAG compliance)
• Provide fallbacks for advanced CSS features

Security Considerations:

• CSS is sanitized to prevent code injection
• External URLs are validated
• JavaScript in CSS is blocked (e.g., expression(), behavior())
• Data URIs are validated for malicious content

Authentication: Requires valid X-API-Key header

Calculates the refund amount that would be issued if a specific subscription order fulfillment were refunded. This provides a preview without actually processing the refund.

What it calculates:

• Total refund amount (order amount minus processing fees)
• Restocking fees (if applicable)
• Gateway fees that cannot be refunded
• Net refund amount customer will receive

Use Cases:

• Show customer how much they'll get back before confirming refund
• Display refund breakdown in customer portal
• Validate refund eligibility

Important Notes:

• This is a preview only - does not process refund
• Refund amount may vary based on payment gateway
• Some gateways don't refund processing fees
• Refunds can only be issued for fulfilled orders

Authentication: Customer must be logged in and own the subscription