External 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

Synchronizes customer subscription information from Shopify to the Appstle subscription system. This endpoint fetches the latest customer data from Shopify and updates the local database to ensure data consistency across platforms.

What Does This Endpoint Do? This endpoint triggers a synchronization process that pulls customer subscription data from Shopify's GraphQL API and updates the Appstle subscription database with the latest information. It ensures that customer details, subscription statuses, and associated metadata are current and accurate.

Sync Process:

1. Data Retrieval: Fetches customer subscription data from Shopify using their GraphQL API
2. Validation: Validates the retrieved data against existing records
3. Update: Updates customer subscription details in Appstle database
4. Reconciliation: Reconciles any discrepancies between Shopify and Appstle data
5. Logging: Logs all sync activities for audit trail

What Gets Synchronized:

Customer Information:

• Customer ID and Shopify GraphQL ID
• Customer name and email address
• Customer tags and metadata
• Customer acceptance status
• Marketing preferences

Subscription Details:

• Active subscription contracts
• Subscription statuses (ACTIVE, PAUSED, CANCELLED, EXPIRED)
• Next billing dates
• Billing interval and delivery interval
• Subscription line items (products and variants)
• Pricing and discounts

Payment Information:

• Associated payment methods
• Payment instrument status
• Billing address details

Delivery Information:

• Shipping address details
• Delivery method and profile
• Delivery preferences

Use Cases:

1. Data Consistency:

• Resolve data discrepancies between Shopify and Appstle
• Update customer information after changes in Shopify admin
• Sync subscription modifications made directly in Shopify

2. Troubleshooting:

• Fix sync issues for specific customers
• Recover from webhook delivery failures
• Debug customer portal display issues

3. Migration & Integration:

• Initial data sync after app installation
• Re-sync after system maintenance or updates
• Integration testing and validation

4. Customer Support:

• Refresh customer data when assisting with support tickets
• Verify latest subscription status during customer inquiries
• Update data after manual changes in Shopify

When to Use This Endpoint:

Recommended Scenarios:

• Customer reports incorrect subscription data in portal
• After making manual changes to subscriptions in Shopify admin
• When troubleshooting webhook sync failures
• Before running bulk operations on customer subscriptions
• During migration or data reconciliation processes

Avoid Using For:

• Real-time data refresh (webhooks handle this automatically)
• Frequent polling (use webhooks instead to avoid rate limits)
• Bulk syncs of many customers (use batch endpoints or scheduled jobs)

Sync Behavior:

Synchronous Operation:

• Endpoint blocks until sync completes
• Returns void on success
• Throws exception on failure

Data Precedence:

• Shopify data is always treated as source of truth
• Local Appstle data is overwritten with Shopify values
• Custom Appstle-specific fields are preserved

Error Handling:

• Invalid customer ID: Returns 400 Bad Request
• Customer not found in Shopify: Returns 404 Not Found
• Shopify API errors: Returns 502 Bad Gateway
• Rate limit exceeded: Returns 429 Too Many Requests

Important Considerations:

Performance:

• Sync duration depends on number of subscriptions (typically 1-5 seconds)
• May timeout for customers with 100+ active subscriptions
• Consider using asynchronous sync for high-volume customers

Rate Limiting:

• Subject to Shopify GraphQL API rate limits
• Frequent calls may exhaust rate limit budget
• Use webhooks for real-time sync instead of polling this endpoint

Data Integrity:

• Always creates audit log entries for tracking
• Preserves historical data and activity logs
• Does not delete local-only data (e.g., custom notes)

Best Practices:

1. Use Sparingly: Rely on webhooks for automatic sync; use this only when needed
2. Check Logs: Review activity logs after sync to verify changes
3. Validate Results: Query customer data after sync to confirm updates
4. Handle Errors: Implement retry logic with exponential backoff
5. Monitor Rate Limits: Track Shopify API usage to avoid hitting limits

Security Notes:

• Requires valid API key authentication via X-API-Key header
• Customer ID is validated against shop ownership
• Cannot sync customers from other shops
• All sync operations are logged for audit compliance

Response:

• Returns HTTP 204 No Content on successful sync
• No response body returned
• Check activity logs for detailed sync results

Alternative Approaches:

If you need to:

• Sync multiple customers: Use bulk sync endpoint or scheduled job
• Real-time updates: Rely on webhook subscriptions
• Verify data without modifying: Use GET endpoints to retrieve current data

Integration Workflow Example:

1. Customer contacts support about incorrect billing date
2. Support agent checks subscription in Appstle admin
3. Agent makes correction in Shopify admin
4. Agent calls sync endpoint for this customer
5. Sync retrieves latest data from Shopify
6. Appstle database is updated with corrected billing date
7. Customer portal now shows correct date
8. Support ticket resolved

Authentication: Requires valid X-API-Key header or api_key parameter (deprecated)

Retrieves comprehensive subscription contract details for a specific customer, including subscription status, products, billing information, delivery schedules, and more. This endpoint returns full subscription objects with all associated data, making it ideal for displaying subscription management interfaces and detailed analytics.

What This Endpoint Returns: Unlike the contract IDs endpoint which returns only numeric IDs, this endpoint provides complete SubscriptionContractDetailsDTO objects for each of the customer's subscriptions. Each object contains all information needed to display and manage a subscription.

Data Included in Response:

Subscription Identity:

• Subscription contract ID (Shopify numeric ID)
• Subscription GraphQL ID (Shopify GID format)
• Internal Appstle database ID
• Contract creation date

Subscription Status & Lifecycle:

• Current status (ACTIVE, PAUSED, CANCELLED, EXPIRED, FAILED)
• Status reason (why paused/cancelled)
• Next billing date and time
• Contract anchor date
• Cancellation date (if applicable)
• Current billing cycle number
• Min/max cycle limits

Billing Configuration:

• Billing interval (WEEK, MONTH, YEAR)
• Billing interval count (e.g., every 2 weeks)
• Billing policy (pricing details)
• Currency code
• Recurring total price
• Applied discounts and pricing policies

Delivery Configuration:

• Delivery interval (WEEK, MONTH, YEAR)
• Delivery interval count
• Delivery method (SHIPPING, PICK_UP, LOCAL_DELIVERY)
• Delivery policy details
• Delivery price

Products & Line Items:

• All subscribed products and variants
• Product titles, SKUs, and images
• Quantities per product
• Individual line item prices
• Product-specific discounts
• Line item attributes and custom fields

Customer Information:

• Customer ID and GraphQL ID
• Customer name and email
• Customer acceptance status

Address Details:

• Billing address (full address object)
• Shipping address (full address object)
• Address validation status

Payment Information:

• Payment instrument type
• Payment method details (card last 4, etc.)
• Payment gateway used

Order & Fulfillment:

• Last order ID and details
• Last order date
• Order note
• Fulfillment status

Additional Metadata:

• Custom note attributes
• Tags and labels
• Internal flags and settings
• Selling plan ID and group ID
• Shop domain

Use Cases:

1. Customer Portal:

• Display all subscriptions on customer dashboard
• Show subscription details page
• Enable subscription management actions
• Display upcoming order information

2. Admin Dashboard:

• View customer's complete subscription portfolio
• Analyze subscription health and status
• Identify at-risk or high-value subscriptions
• Generate customer subscription reports

3. Customer Support:

• Quick access to all customer subscription details
• Troubleshoot billing or delivery issues
• Verify subscription configurations
• Assist with subscription modifications

4. Analytics & Reporting:

• Calculate customer lifetime value
• Analyze subscription mix per customer
• Track subscription frequency distribution
• Identify cross-sell/upsell opportunities

5. Integration & Automation:

• Sync subscription data to CRM/analytics platforms
• Trigger workflows based on subscription details
• Build custom reporting dashboards
• Export subscription data for analysis

Response Format:

Returns an array of SubscriptionContractDetailsDTO objects:

[
  {
    "id": 789,
    "subscriptionContractId": 5234567890,
    "status": "ACTIVE",
    "nextBillingDate": "2024-03-15T00:00:00Z",
    "billingInterval": "MONTH",
    "billingIntervalCount": 1,
    "deliveryInterval": "MONTH",
    "deliveryIntervalCount": 1,
    "currencyCode": "USD",
    "currentTotalPrice": "49.99",
    "customerId": 12345,
    "customerEmail": "customer@example.com",
    "lineItems": [...],
    "billingAddress": {...},
    "shippingAddress": {...}
  },
  {...}
]

Response Scenarios:

Customer with no subscriptions:

[]

Returns empty array with 200 OK status (not an error).

Customer with multiple subscriptions: Array contains multiple subscription objects, each representing a separate subscription contract.

Performance Considerations:

Response Size:

• Each subscription object can be 5-50 KB depending on line items
• Customer with 10 subscriptions: ~100-500 KB response
• Consider pagination or filtering for customers with 20+ subscriptions

Query Performance:

• Typical response time: 200-500ms
• Slower for customers with many subscriptions or complex products
• Database query is optimized with indexed lookups

Best Practices:

1. Cache Results: Cache response data to minimize API calls
2. Filter Client-Side: Filter/sort subscriptions on client after retrieval
3. Selective Display: Don't display all fields if not needed
4. Handle Empty Array: Always gracefully handle case with no subscriptions
5. Optimize Images: Product images can be large - lazy load if displaying

Data Freshness:

• Data is retrieved from Appstle database (not real-time Shopify query)
• Updated via webhooks with < 1 second lag typically
• Use sync endpoint if data appears stale

Security Notes:

• Customer ID is validated against authenticated shop
• Returns only subscriptions belonging to specified customer
• Cannot access customers from other shops
• Sensitive payment details (full card numbers) are never returned

Comparison with Other Endpoints:

vs. GET /subscription-customers/valid/{customerId}:

• This endpoint: Returns complete subscription details
• Valid contracts endpoint: Returns only contract IDs
• Use this when you need full subscription information

vs. GET /subscription-contract-details:

• This endpoint: Filtered by single customer
• Contract details endpoint: Query across all customers with filters
• Use this for customer-specific views

vs. GET /subscription-contracts/contract-external/{contractId}:

• This endpoint: All contracts for a customer
• Contract external endpoint: Single contract with Shopify raw data
• Use this for customer overview, other for detailed single contract

Authentication: Requires valid X-API-Key header or api_key parameter (deprecated)

Retrieves all payment methods associated with a customer directly from Shopify's payment API. This endpoint returns detailed information about stored payment instruments including credit/debit cards, digital wallets, and other payment methods that the customer can use for subscription billing.

What This Endpoint Does: Queries Shopify's GraphQL API to fetch the customer's payment methods, including active instruments and optionally revoked (expired, removed, or failed) payment methods. This provides real-time payment method data directly from Shopify's payment vault.

Payment Method Types Supported:

Credit/Debit Cards:

• Visa, Mastercard, American Express, Discover
• Card last 4 digits
• Expiry month and year
• Card brand and type
• Billing address associated with card

Digital Wallets:

• Shop Pay
• Apple Pay
• Google Pay
• PayPal (when stored)

Alternative Payment Methods:

• Bank accounts (ACH, SEPA)
• Buy Now Pay Later instruments
• Store credit

Payment Method Information Returned:

For Each Payment Method:

• Payment Instrument ID: Unique identifier (used for updates)
• Display Name: Human-readable name (e.g., "Visa ending in 4242")
• Payment Type: Card, wallet, bank account, etc.
• Status: ACTIVE, REVOKED, EXPIRED, FAILED
• Is Default: Whether this is the customer's default payment method
• Last 4 Digits: For cards and bank accounts
• Expiry Date: For cards (month/year)
• Brand: Visa, Mastercard, Amex, etc.
• Billing Address: Address associated with payment method
• Created Date: When payment method was added

Query Parameters:

allowRevokedMethod (optional, default: false):

• false: Returns only active, usable payment methods
• true: Returns both active AND revoked payment methods

Revoked Payment Methods: Include expired cards, deleted payment methods, failed instruments, and customer-removed methods. Useful for historical records and troubleshooting, but cannot be used for new billing attempts.

Use Cases:

1. Customer Portal:

• Display saved payment methods
• Allow customer to select default payment method
• Show payment method update/delete options
• Validate payment methods before subscription modification

2. Subscription Management:

• Verify customer has valid payment method before creating subscription
• Check payment method expiry before next billing
• Identify subscriptions at risk due to expiring cards
• Prompt customer to update payment if needed

3. Payment Method Updates:

• List available payment methods for customer selection
• Identify payment instrument ID for update operations
• Validate payment method before switching subscription

4. Troubleshooting & Support:

• Debug payment failures
• Verify which payment method is being used
• Check if payment method is expired or revoked
• Assist customer with payment issues

5. Analytics & Alerts:

• Track payment methods approaching expiry
• Send proactive notifications to update cards
• Analyze payment method distribution
• Identify customers with no valid payment methods

Response Structure:

Returns CustomerPaymentMethodsQuery.PaymentMethods object from Shopify GraphQL:

{
  "nodes": [
    {
      "id": "gid://shopify/CustomerPaymentMethod/abc123",
      "instrument": {
        "__typename": "CustomerCreditCard",
        "brand": "VISA",
        "lastDigits": "4242",
        "expiryMonth": 12,
        "expiryYear": 2025,
        "name": "John Doe"
      },
      "revokedAt": null,
      "revokedReason": null,
      "subscriptionContracts": [...]
    }
  ]
}

Common Scenarios:

Scenario 1: Customer with multiple cards Returns array with multiple payment method objects, each representing a stored card.

Scenario 2: Customer with no payment methods Returns empty nodes array - customer needs to add payment method.

Scenario 3: Expired card included (allowRevokedMethod=true) Returns both active cards and expired/revoked cards with revokedAt timestamp.

Important Considerations:

Data Source:

• Queries Shopify API in real-time (not Appstle database)
• Always returns current Shopify payment method state
• Subject to Shopify API rate limits

Performance:

• Response time: 300-800ms (depends on Shopify API)
• Slower than database queries
• Consider caching for non-critical displays

Security:

• Never returns full card numbers (PCI compliance)
• Returns only last 4 digits
• CVV is never stored or returned
• Payment instrument IDs are tokenized references

Privacy:

• Customer ID validated against shop
• Cannot query payment methods from other shops
• Requires appropriate API permissions

Best Practices:

1. Default to Active Only: Use allowRevokedMethod=false for payment selection UIs
2. Check Expiry Dates: Validate card expiry before using for subscriptions
3. Cache Responsibly: Cache for short periods (5-10 min) to reduce API calls
4. Handle Empty Response: Always handle case where customer has no payment methods
5. Show User-Friendly Names: Display brand and last 4 (e.g., "Visa •••• 4242")
6. Indicate Default: Highlight the default payment method clearly

Integration Examples:

Example 1: Display payment methods in customer portal

const paymentMethods = await fetch(
  `/api/external/v2/subscription-contract-details/shopify/customer/${customerId}/payment-methods`,
  { headers: { 'X-API-Key': 'your-key' } }
).then(r => r.json());

paymentMethods.nodes.forEach(pm => {
  if (pm.instrument.__typename === 'CustomerCreditCard') {
    console.log(`${pm.instrument.brand} ending in ${pm.instrument.lastDigits}`);
    if (pm.instrument.expiryYear < currentYear) {
      console.warn('Card expired!');
    }
  }
});

Example 2: Check for valid payment before creating subscription

const paymentMethods = await fetch(...);
const hasValidPayment = paymentMethods.nodes.some(pm => 
  !pm.revokedAt && pm.instrument.expiryYear >= currentYear
);

if (!hasValidPayment) {
  alert('Please add a valid payment method before subscribing');
}

Related Endpoints:

• PUT /api/external/v2/subscription-contracts-update-payment-method - Update subscription payment method
• POST /api/external/v2/associate-shopify-customer-to-external-payment-gateways - Add external payment method

Authentication: Requires valid X-API-Key header