For AI agents: visit https://developer.ordergroove.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Ordergroove API Reference
GuidesAPI ReferenceKnowledge CenterAcademy
Ordergroove API Reference
Guides
Jump to Content
Ordergroove API Reference
GuidesAPI ReferenceKnowledge CenterAcademy
  • Platform Overview
    • Start Here
    • Developer Fundamentals
    • Systems Landscape Map
    • Data model at a glance
    • Subscription Manager Tagging and Authentication
    • Customer and Payment Updates
  • Installation & Setup
    • Setting up a Sandbox Store
    • Custom Platform and Headless Subscription Implementation
    • Install Ordergroove on an Online Store 2.0 theme
      • Installing Ordergroove with App Embed
    • Removing Ordergroove code from your Shopify theme
  • General FAQ
  • Enrollment
    • Core Concepts
      • Offer Tagging
      • Tagging the Product Details Page (PDP)
      • Cart Opt-In Tagging
      • Subscription Creation via Purchase POST
    • Add a subscription to cart
      • Troubleshooting Cart Offers
      • Offer Code Elements
      • Domain Objects
      • Helper Methods
    • Display & UI Customization
      • Showing Discounted Price
      • Customizing the Initial Offer Incentive (IOI)
      • Real Time Stock Update
      • Add a subscription offer to quickview, homepage, or other areas of your site
      • Tracking Affiliate Codes on Recurring Orders
    • Advanced Enrollment
      • Advanced Offer Customizations & FAQ
      • Modify a subscription from email and SMS
      • First Order Place Date control for Shopify Merchants
      • Free shipping on initial orders
  • Subscription Manager
    • Introduction to Subscription Manager
      • Subscription Manager From The Customer's Perspective
      • Tour of Subscription Manager v25
      • Intro to v25 for Developers transitioning from v0
      • Subscription Manager File Descriptions
      • Loading the Subscription Manager inside a Single-Page App
    • Developing for Subscription Manager Overview
      • Convert your customers/account page to support Online Store 2.0
      • Tagging the Subscription Manager
      • Integrating External APIs in the Subscription Manager
      • Calling Ordergroove’s REST APIs from within Subscription Manager
      • Preserve Analytics Tracking while Customizing Subscription Manager Templates
      • Understanding Subscription Manager Custom Elements
      • Edit Code with the Advanced Editor
      • Subscription Manager Theme Editor Overview
      • Subscription Manager Development Guide
      • Customizing Subscription Manager Sections on Shopify
      • Refreshing data in the Subscription Manager
      • Objects
      • Object Reference
      • Translations
      • Subscription Manager Local Development
      • Debugging with Redux
      • Working with dates in the Subscription Manager
    • Common Customizations
      • Customizing calendars and dates in v25
      • Adding a Scrollbar to Inactive Subscriptions in the Subscription Manager
      • One Time SKU Swap Configuration in the Subscription Manager
      • Dynamic Shipping Restrictions in the Subscription Manager
      • Limiting Future Dates in the Change Date Calendar
      • Adding a Cancel Button to Modals
      • Implementing Country & State Dropdown in Subscription Manager Themes
      • Modify the Change Billing Process Button
      • Enabling Payment Updates for Shopify New Accounts
    • Subscription Manager Templates Changelog
  • Legacy Subscription Manager v0 Components & Containers
    • Subscription Manager Templates
    • Orders Unsent Section
      • Skip Order
      • Send Now
      • Change Date
    • Orders Processing Section
    • Inactive Subscriptions Section
  • Order Processing & Placement
    • Order Generation
      • Recurring Order Placement
    • Upsell & One-Click Actions
      • Instant Upsell Overview
      • Instant Upsell through API
      • 1-Click Actions in Emails
      • Using Webhooks for 1-Click Actions
  • Payments
    • Configuring PayPal
  • Product Catalog
    • Product Feed
  • Data Sync & Pipelines
    • Sync Ordergroove Data into Internal Systems
    • Sync Objects
      • Implement Custom Data Pipelines
      • Using Prebuilt Connectors
      • SFTP File Drops
    • Sync Events
  • Webhooks & APIs
    • HMAC and AES Authentication
    • Webhooks overview (Legacy)
      • Configure Webhooks via API
      • Expiring or Termed Subscriptions Using Webhooks
  • Digital Subscriptions
    • Migrating Digital Subscriptions
  • Rotating Subscriptions
    • Ordinal Based Rotating Products
    • Time Window Based Rotating Products
  • Prepaid Subscriptions
    • How to Manage Prepaid Renewal Behaviors
  • Curation Subscriptions: Rotating Box or Club
  • Guided Selling
  • Bundle Subscriptions
    • Configuring Bundles
    • Box Subscription Creation on Shopify
    • Bundle API Components
    • Build Your Own Box Subscriptions (Legacy)
      • Shopify - Build Your Own Box Subscriptions (Legacy)
  • Migrate my data to Ordergroove
  • Self-serve migration guide
  • Self-serve migration guide for Recharge
  • Staged Migrations
  • Getting Started
  • Rest vs GraphQL
  • GraphQL Documentation
  • Queries
    • orders
    • subscription
    • subscriptions
  • Objects
    • AddressType
    • ComponentType
    • CustomerType
    • DiscountIncentiveType
    • FreeTrialSubscriptionContextType
    • GiftIncentiveType
    • GranteeType
    • IncentiveType
    • ItemType
    • ItemsPage
    • OneTimeIncentiveType
    • OrderType
    • PaymentType
    • PrepaidSubscriptionContextType
    • ProductGroupType
    • ProductType
    • QueuedActionType
    • SubscriptionConnection
    • SubscriptionEdge
    • SubscriptionType
    • CancelReasonType
Powered by 
  1. Getting Started
  2. Platform Overview

Developer Fundamentals

Updated about 1 month ago


Start Here
Systems Landscape Map