For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
Knowledge CenterAcademy
GuidesAPI ReferenceGraphQL
GuidesAPI ReferenceGraphQL
  • Overview
    • Start Here
    • Authentication
    • API Rate Limits
    • Resource Overview
    • Cursor Pagination
    • API reference
  • REST RPC API
  • Entitlements Service API
  • Cart Management API
  • Payment API
  • Payment Attempt Data API
    • Webhooks API Overview
  • Webhooks API
  • Start Here
  • Authentication
  • API Rate Limits
  • Resource Overview
  • Cursor Pagination
  • API reference
  • List
  • Retrieve
  • Cancel
  • Change Quantity
  • Change Shipping Address
  • Change Payment
  • Change Email Reminder
  • Change Frequency
  • Reactivate
  • Update
  • Create in Order
  • Create From Item
  • Change Product
  • Retrieve Rotating Ordinal Subscription Context
  • Set Subscription Ordinal for Rotating Product
  • Apply Discount Code To Subscription
  • Remove Discount Code From Subscription
  • Change Next Order Date
  • Update Prepaid Subscription
  • Change Prepaid Renewal Behavior
  • Upgrade Subscription To Prepaid
  • List Discount Codes For Subscription
  • Retrieve Component
  • Update Components
  • List
  • Retrieve
  • Cancel
  • Send Now
  • Change Shipping Address
  • Change Payment
  • Change Place Date
  • Update
  • Finalize processing Order
  • Reject
  • Template Title
  • Skip Subscription
  • Rescue
  • Retry
  • Rescuable Check
  • List
  • Retrieve
  • Change Quantity
  • Change Price
  • Create
  • Create in Order
  • Delete
  • Update
  • Product Change
  • List
  • Retrieve
  • Create
  • Update
  • Set Contact Details
  • List Cancellation Reasons
  • List
  • Retrieve
  • Create
  • Update
  • Use address for all
  • List
  • Retrieve
  • Create
  • Update
  • Use payment for all
  • List
  • Retrieve
  • Group Check
  • Relationships
  • Bulk Create
  • Bulk Update
  • Manage Time-Window Rotating Product
  • Manage Ordinal Rotating Product
  • Retrieve Rotating Delivery Product
  • Manage Digital Plan Product
  • Create
  • Update
  • Delete
  • Update
  • List
  • Create
  • Update
  • List
  • Retrieve
  • Create
  • Update
  • List
  • Create or Update by Experience Name
  • Update by Experience ID
  • List
  • Dump
  • Load
  • Retrieve
  • List
  • Update Coupons
  • Bulk Standard Flex Incentive Operations
  • List
  • Retrieve
  • Update
  • Delete
  • Create
  • 1-Click Delay
  • 1-Click Reactivate
  • Get New Endpoint
  • Manage Product Specific Frequencies
  • List Product Specific Frequencies
  • Eligibility Evaluation
  • Create
  • List
  • Create
  • Retrieve
  • Update
  • List Experiments
  • Get Placement Logs Responses
  • List
  • Post Entitlements Entitlement Public Id Modify Expiration
  • Copy of
  • Retrieve
  • Purchase POST API
  • Purchase POST Status
  • Retrieve placement responses with cursor-based pagination
  • Webhooks API Overview
  • List
  • Retrieve
  • Update
  • Create
  • Retrieve Target Metrics
  • List
  • Create
  • Retrieve
  • Delete
  • Update
Knowledge CenterAcademy
On this page
  • Authentication
  • Environments
Overview

API reference

REST endpoints for the Ordergroove platform.
||View as Markdown|

Ordergroove exposes six REST APIs plus a webhooks API:

REST RPC API

The primary REST API for customers, subscriptions, items, orders, and offers.

Entitlements Service API

Manage customer entitlements for memberships and digital access.

Cart Management API

Server-side cart operations for headless checkouts.

Payment API

Tokenize and manage customer payment methods.

Payment Attempt Data API

Retrieve placement response details for processed orders.

Webhooks API

Subscribe to lifecycle events and 1-click actions.

Authentication

All Ordergroove APIs authenticate with either an API key or an HMAC signature. See HMAC and AES authentication for details.

Environments

  • Production: https://restapi.ordergroove.com
  • Sandbox: available per merchant — contact your Ordergroove representative.
Was this page helpful?
Edit this page
Previous

Cursor Pagination

Next

List

Built with