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

Replaces existing product variants with new ones in a subscription contract. This endpoint supports both regular subscription products and one-time products, allowing you to swap products, update quantities, and manage the product mix in a subscription.

Key Features:

• Bulk Replace: Replace multiple products at once by providing lists of old and new variants
• Line-Specific Replace: Target a specific line item using oldLineId for precise replacement
• Quantity Management: Set new quantities for replaced products
• One-Time Products: Add or remove one-time purchase products independently
• Discount Preservation: Configurable discount carry-forward logic

Discount Carry Forward Options:

• PRODUCT_THEN_EXISTING: First tries to apply the new product's selling plan discount, then falls back to existing discount
• PRODUCT_PLAN: Always uses the new product's selling plan discount
• EXISTING_PLAN: Maintains the existing product's discount structure

Important Notes:

• At least one regular subscription product must remain in the contract
• One-time products and free products don't count towards the minimum product requirement
• The system automatically handles pricing adjustments based on billing/delivery intervals
• Shipping prices are automatically recalculated after changes

Use Cases:

• Product upgrades/downgrades (e.g., switching coffee blend or size)
• Quantity adjustments during product swap
• Adding limited-time or seasonal products as one-time purchases
• Bulk product replacements for subscription migrations

Authentication: Requires valid X-API-Key header

Creates a new subscription contract for a customer with specified products, billing frequency, and delivery details. This endpoint allows you to programmatically create subscriptions with custom pricing, delivery schedules, and multiple line items. The subscription will be created in Shopify and synchronized with the Appstle system.

Important Notes:

• Customer must have at least one valid payment method
• If paymentMethodId is not provided, the default payment method will be used
• If delivery interval is not specified, it defaults to the billing interval
• Custom pricing policies can be applied per line item
• All monetary values are in the store's base currency unless currencyCode is specified
• CustomAttributes and line item customAttributes use Shopify's AttributeInput format: {"key": "string", "value": "string"}

Pricing Policy Types:

• SELLING_PLAN_PRICING_POLICY: Uses the default pricing from the selling plan
• CUSTOM_PRICING_POLICY: Allows custom discount cycles defined in pricingPolicy array
• NO_PRICING_POLICY: Uses the base price without any discounts

Authentication: Requires valid X-API-Key header

Retrieves the complete, unprocessed subscription contract data directly from Shopify's GraphQL API. This endpoint returns the full Shopify subscription contract object exactly as Shopify provides it, including all nested fields, relationships, and GraphQL metadata.

What This Endpoint Returns: Unlike processed/transformed endpoints, this returns Shopify's raw SubscriptionContract GraphQL object with all available fields. This is the same data structure you would receive if querying Shopify's GraphQL API directly, making it ideal for:

• Debugging Shopify data synchronization issues
• Accessing fields not exposed in other endpoints
• Understanding complete Shopify contract structure
• Building custom integrations requiring full data
• Comparing Shopify source data with processed data

Data Included:

Contract Core:

• Full subscription contract object from Shopify
• All GraphQL __typename fields preserved
• Complete nested object structures
• All available Shopify contract fields

Customer Information:

• Complete customer object with all fields
• Default address details
• Customer tags and metadata
• Marketing preferences

Line Items:

• Full line item details with edges/nodes structure
• Product and variant complete objects
• Pricing policies with all cycle discounts
• Line item custom attributes
• Current and original prices

Billing & Delivery:

• Complete billing policy object
• Full delivery policy details
• Delivery method with all fields
• Delivery price breakdown
• Billing anchor details

Payment Information:

• Payment method details (if available)
• Customer payment instrument
• Payment gateway information

Orders & History:

• Origin order details
• Last payment status
• Historical billing attempts (in Appstle)

Use Cases:

1. Debugging & Troubleshooting:

• Investigate data sync discrepancies
• Verify what Shopify actually stores
• Debug webhook payload issues
• Compare expected vs actual data

2. Advanced Integrations:

• Access Shopify-specific fields not in standard APIs
• Build custom analytics using raw data
• Integrate with Shopify GraphQL directly
• Extract fields for custom processing

3. Data Analysis:

• Analyze complete contract structure
• Extract all available metadata
• Build comprehensive data exports
• Perform deep data audits

4. Development & Testing:

• Understand Shopify's data model
• Test new feature development
• Verify API responses
• Documentation and examples

Response Structure:

Returns SubscriptionContractQuery.SubscriptionContract object:

{
  "id": "gid://shopify/SubscriptionContract/123456789",
  "status": "ACTIVE",
  "nextBillingDate": "2024-03-15T00:00:00Z",
  "customer": {
    "id": "gid://shopify/Customer/987654321",
    "email": "customer@example.com",
    "displayName": "John Doe",
    "__typename": "Customer"
  },
  "lines": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/SubscriptionLine/111111",
          "quantity": 2,
          "variantId": "gid://shopify/ProductVariant/222222",
          "title": "Monthly Coffee Box",
          "variantTitle": "Medium Roast",
          "currentPrice": {
            "amount": "29.99",
            "currencyCode": "USD"
          },
          "pricingPolicy": {...},
          "__typename": "SubscriptionLine"
        }
      }
    ]
  },
  "billingPolicy": {
    "interval": "MONTH",
    "intervalCount": 1,
    "minCycles": 3,
    "maxCycles": 12
  },
  "deliveryPolicy": {...},
  "deliveryMethod": {...},
  "__typename": "SubscriptionContract"
}

Important Considerations:

Data Source:

• Queries Shopify GraphQL API in real-time
• NOT cached in Appstle database
• Always returns current Shopify state
• Subject to Shopify API rate limits

Performance:

• Slower than database queries (500-1500ms typical)
• Makes real-time call to Shopify
• Response size can be large (10-50 KB)
• Use sparingly to avoid rate limits

GraphQL Structure:

• Includes __typename fields throughout
• Uses GraphQL ID format (gid://shopify/...)
• Nested edges/nodes structure for lists
• All fields as defined in Shopify's schema

Best Practices:

1. Use for Debugging: Perfect for troubleshooting data issues
2. Avoid Polling: Don't call repeatedly - use cached/processed endpoints instead
3. Cache Response: Cache the response if using for display
4. Parse Carefully: Handle GraphQL structure (edges/nodes)
5. Monitor Rate Limits: Each call counts against Shopify API limits

When to Use vs Other Endpoints:

Use this endpoint when:

• Need complete Shopify contract data
• Debugging synchronization issues
• Accessing Shopify-specific fields
• Building Shopify GraphQL integrations

Use /api/external/v2/subscription-contract-details when:

• Need processed, filtered contract data
• Want faster response times
• Querying multiple contracts
• Building customer-facing UIs

Authentication: Requires valid X-API-Key header