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

Allows a customer to redeem their loyalty points for a specific reward option. This deducts points from their balance and generates a discount code or applies the reward.

What happens:

1. Validates customer has enough points
2. Deducts points from customer's balance
3. Generates discount code (for discount rewards)
4. Records redemption in customer's history
5. Returns discount code or confirmation

Reward Types:

• Discount codes: Generates unique code customer can use at checkout
• Auto-apply discounts: Automatically applied to next order
• Free products: Adds free product to next order
• Free shipping: Waives shipping on next order

Important Notes:

• Points are deducted immediately and cannot be refunded
• Discount codes typically expire after 30 days
• Some rewards have minimum purchase requirements
• Rewards cannot be combined with other discounts (depends on configuration)

Use Cases:

• Customer clicks 'Redeem' button in customer portal
• Apply points at checkout
• Redeem points for subscription discount

Authentication: Customer must be logged in via Shopify customer session

Initiates the OAuth 2.0 authorization flow for Shopify's Customer Account API. This endpoint is used when a customer wants to grant the subscription app access to their Shopify customer account data.

What is Customer Account API? Shopify's Customer Account API allows apps to access customer data (orders, addresses, payment methods) on behalf of the customer. This requires customer consent through an OAuth flow.

How it works:

1. Customer portal calls this endpoint with a return URL
2. Backend generates PKCE challenge and state parameter
3. Returns authorization URL to redirect customer to Shopify
4. Customer authorizes on Shopify
5. Shopify redirects back to callback endpoint with authorization code
6. Callback endpoint exchanges code for access token

Important Notes:

• Requires customer to be logged in to the Shopify store
• Only works with stores that have 'New Customer Accounts' enabled
• Uses PKCE (Proof Key for Code Exchange) for security
• State parameter prevents CSRF attacks
• Access tokens are stored securely and used for subsequent Customer Account API calls

Authentication: Customer must be logged in via Shopify customer session

Executes GraphQL queries against Shopify's Customer Account API on behalf of the authenticated customer. This endpoint handles token management, refresh, and authentication automatically.

What you can query:

• Customer profile information
• Order history and details
• Saved addresses
• Payment methods
• Subscriptions (via Customer Account API schema)

Token Management:

• Automatically uses stored access token
• Refreshes expired tokens automatically
• Returns 401 if customer needs to re-authenticate

Example Queries:

query {
  customer {
    id
    emailAddress { emailAddress }
    defaultAddress { address1 city }
  }
}

Authentication: Customer must be logged in and have completed OAuth flow