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

Creates a new shipping or delivery profile for subscription orders. This endpoint allows you to configure custom shipping rates, delivery methods, and shipping zones for your subscription products. Delivery profiles control how subscription products are shipped to customers.

Key Features:

• Define custom shipping rates per zone
• Configure local delivery options
• Set up local pickup methods
• Manage shipping zones and countries
• Assign profiles to specific products or variants

Delivery Method Types:

• SHIPPING: Standard shipping with carrier rates or custom rates
• LOCAL_DELIVERY: Local delivery service within specific areas
• PICKUP: Customer pickup from store locations

Important Notes:

• Each delivery profile must have a unique name
• At least one delivery method is required
• Shipping rates can be set per zone and per weight/price range
• Profiles can be assigned to subscription products to control their shipping behavior

Authentication: Requires valid X-API-Key header

Replaces old product variants with new product variants across multiple subscription contracts in bulk. This powerful operation allows merchants to update products in active subscriptions when products are discontinued, reformulated, or repackaged.

What is Product Replacement? Product replacement updates the products in active subscriptions by swapping out old variant IDs with new variant IDs. This is commonly needed when:

• Products are discontinued and replaced with new versions
• Product packaging changes (size, quantity)
• Product reformulations or recipe updates
• SKU consolidation or reorganization
• Seasonal product variations
• Price structure changes

Key Features:

• Bulk Operation: Update thousands of subscriptions simultaneously
• Multi-Variant Support: Replace multiple old variants with new ones in single request
• Flexible Mapping: One-to-one, many-to-one, or one-to-many variant replacements
• Selective or Universal: Target specific subscriptions or all subscriptions
• Asynchronous Processing: Large batches processed in background
• Price Preservation Options: Maintain existing subscription pricing or update to new prices
• Activity Logging: All replacements are logged for audit trail

Operation Modes:

1. Specific Subscriptions: Provide subscription contract IDs to update only those subscriptions
2. All Subscriptions: Set allSubscriptions=true to replace products in ALL active subscriptions containing the old variants

How It Works:

1. Identify old variant IDs that need to be replaced
2. Identify new variant IDs that will replace them
3. Optionally specify which subscriptions to update (or use allSubscriptions=true)
4. Submit the bulk replacement request
5. System validates all variant IDs exist and are accessible
6. Bulk automation task is created and queued
7. Each subscription is updated with new variants
8. Customers receive updated subscription details
9. Next orders will include the new products

Variant ID Mapping: The replacement supports flexible mapping between old and new variants:

One-to-One Replacement:

{
  "oldVariantIds": [111111],
  "newVariantIds": [222222]
}

Old variant 111111 is replaced with new variant 222222

Multiple Variants Replacement:

{
  "oldVariantIds": [111111, 333333, 555555],
  "newVariantIds": [222222, 444444, 666666]
}

Each old variant is replaced with its corresponding new variant (by position)

Request Structure:

{
  "subscriptionIds": [
    "gid://shopify/SubscriptionContract/123456",
    "gid://shopify/SubscriptionContract/123457"
  ]
}

Query Parameters:

• api_key (required): Your API authentication key
• allSubscriptions (optional): Set to true to update all subscriptions, false/omit to update only specified IDs
• newVariantIds (required): Comma-separated list of new variant IDs (e.g., 222222,444444,666666)
• oldVariantIds (required): Comma-separated list of old variant IDs to replace (e.g., 111111,333333,555555)

Use Cases:

1. Product Discontinuation: When a product is being discontinued:

• Identify replacement product
• Map old variant IDs to new variant IDs
• Update all subscriptions containing the old product
• Notify customers of the change

2. Packaging Updates: When product packaging changes (e.g., 10oz to 12oz):

• Create new variant for new package size
• Replace old variant across subscriptions
• Adjust pricing if needed

3. Product Reformulation: When product recipes or formulas change:

• Create new product variant for reformulated version
• Bulk replace old formula with new formula
• Maintain customer subscription frequency and pricing

4. SKU Consolidation: When consolidating multiple variants into a single SKU:

• Map multiple old variant IDs to single new variant ID
• Update all affected subscriptions
• Simplify inventory management

5. Seasonal Product Rotation: For seasonal subscription boxes:

• Replace summer variants with fall variants
• Update all active seasonal subscriptions
• Maintain subscription continuity

Important Considerations:

• Pricing Impact: New variants may have different prices - verify pricing strategy
• Inventory Levels: Ensure adequate inventory for new variants
• Customer Communication: Consider notifying customers before replacement
• Variant Compatibility: New variants should be appropriate replacements
• One Operation at a Time: Only one bulk operation can run per shop simultaneously
• Irreversible: Product replacements cannot be automatically undone (must be manually reversed)
• Subscription Contract IDs: Must use Shopify GraphQL ID format

Processing Time:

• Small batches (<100 subscriptions): Seconds to minutes
• Medium batches (100-1000): Minutes
• Large batches (>1000): Minutes to hours
• Processing time depends on number of subscriptions and line items

Best Practices:

1. Test First: Test with a small subset of subscriptions before bulk operation
2. Verify Variants: Confirm all variant IDs are correct and products are active
3. Check Inventory: Ensure sufficient stock of new variants
4. Customer Communication: Notify affected customers about product changes
5. Price Review: Review and confirm pricing for new variants
6. Backup Data: Export subscription data before making bulk changes
7. Monitor Progress: Track bulk operation status to completion
8. Audit Trail: Document reason for replacement for future reference

Error Scenarios:

• Another bulk operation running: 400 error
• Invalid variant IDs: Operation may fail or skip invalid variants
• Mismatched array lengths: Ensure oldVariantIds and newVariantIds have same count
• Product not found: Variants must exist in your Shopify store
• Unauthorized access: Can only modify subscriptions belonging to your shop

Customer Impact:

• Next subscription order will contain new products
• Previous orders are not affected
• Subscription price may change if new variant has different price
• Customer portal reflects the new product immediately
• Subscription frequency and schedule remain unchanged

Authentication: Requires valid api_key parameter (X-API-Key header support coming soon)

Hides multiple subscription contracts from customer view in bulk. This operation allows merchants to quickly hide subscriptions from appearing in the customer portal without canceling or deleting them.

What Does 'Hide' Mean? Hiding a subscription makes it invisible to customers in their customer portal while keeping the subscription data intact. The subscription is not deleted or canceled - it's simply hidden from the customer's view. This is useful for:

• Temporarily removing subscriptions from customer access
• Managing test or dummy subscriptions
• Handling subscription disputes or issues
• Preparing subscriptions for migration or cleanup

Key Features:

• Bulk Operation: Process multiple subscriptions in a single request
• Non-Destructive: Subscriptions are hidden, not deleted
• Reversible: Hidden subscriptions can be unhidden later
• Asynchronous Processing: Large batches are processed in the background
• Conflict Detection: Prevents multiple simultaneous bulk operations

Operation Modes:

1. Specific Subscriptions: Provide a list of subscription contract IDs to hide
2. All Subscriptions: Set allSubscriptions=true to hide all active subscriptions (use with caution)

How It Works:

1. Submit a request with subscription IDs or allSubscriptions flag
2. System validates the subscription IDs belong to your shop
3. A bulk automation task is created and queued
4. Each subscription is marked as hidden
5. Subscriptions disappear from customer portal immediately
6. Subscriptions remain in merchant admin for management

Request Body Structure:

{
  "subscriptionIds": [
    "gid://shopify/SubscriptionContract/123456",
    "gid://shopify/SubscriptionContract/123457",
    "gid://shopify/SubscriptionContract/123458"
  ]
}

Use Cases:

• Subscription Cleanup: Hide test or duplicate subscriptions created during setup
• Customer Service: Temporarily hide problematic subscriptions while resolving issues
• Migration Preparation: Hide old subscriptions before migrating to new plans
• Dispute Management: Hide subscriptions involved in billing disputes
• Seasonal Management: Hide seasonal subscriptions during off-season
• Batch Processing: Clean up subscriptions that meet certain criteria

Important Notes:

• Only one bulk operation can run at a time per shop
• If a bulk operation is already in progress, the request will fail with 400 error
• Subscription IDs must be in Shopify GraphQL ID format (gid://shopify/SubscriptionContract/xxxxx)
• Hidden subscriptions stop appearing in customer portal but remain active for billing
• You can unhide subscriptions later through the admin interface
• Using allSubscriptions=true will hide ALL subscriptions - use with extreme caution

Processing Time:

• Small batches (<100): Usually complete within seconds
• Medium batches (100-1000): May take 1-2 minutes
• Large batches (>1000): May take several minutes to hours
• Progress can be tracked through the bulk automation status endpoint

Best Practices:

• Always specify exact subscription IDs rather than using allSubscriptions=true
• Test with a small batch first before processing large numbers
• Keep track of hidden subscription IDs for future reference
• Document the reason for hiding subscriptions for audit purposes
• Monitor bulk operation status to ensure completion
• Consider notifying customers before hiding their subscriptions

Workflow Example:

1. Identify subscriptions to hide (e.g., test subscriptions with specific tags)
2. Extract their subscription contract IDs
3. Call this endpoint with the list of IDs
4. Verify 204 No Content response indicating successful queue
5. Monitor processing status through admin or status endpoint
6. Confirm subscriptions are hidden from customer portal

Error Scenarios:

• Another bulk operation is running: 400 error with message about operation in progress
• Invalid subscription IDs: Silently skips invalid IDs, processes valid ones
• Unauthorized subscription access: Only subscriptions belonging to your shop are processed
• Empty subscription list: Operation completes successfully with no action

Authentication: Requires valid api_key parameter (X-API-Key header support coming soon)