### Ordergroove Webhook Example

Source: https://developer.ordergroove.com/reference/webhooks-overview

This example demonstrates a simplified webhook interaction, illustrating how Ordergroove proactively sends HTTP requests to an application when a specific event occurs within the subscription program. It highlights the event-driven nature of webhooks for automating or extending Ordergroove's native functionality.

```text
Webhooks allow you to create custom applications that automate or create additional functionality and experiences not otherwise native to Ordergroove's platform. Some examples you might use a webhook for:
  * Automatically cancel a subscription after a certain number of shipments
  * Update your CRM with information about subscribers, subscriptions, and orders
  * Send additional marketing emails at significant points in a subscription or subscriber's lifecycle
```

--------------------------------

### JSON Rotation Configuration Example

Source: https://developer.ordergroove.com/reference/manage-time-window-rotating-product

This JSON structure represents a typical rotation configuration for products. It includes a public ID, selection rule type, a list of product selection elements with their respective public IDs and starting dates, and configuration details like reveal moment and pricing policy.

```JSON
[
   {
      "public_id":"e1a61e620ed411ef8740767250df1ed7",
      "selection_rule_type":"TIME_WINDOW",
      "product_selection_list_elements":[
         {
            "public_id":"e1a626000ed411ef8740767250df1ed7",
            "product":"48398751432995",
            "starting_date":"2024-05-01T00:00:00Z"
         },
         {
            "public_id":"e1a62b140ed411ef8740767250df1ed7",
            "product":"48398752317731",
            "starting_date":"2024-06-01T00:00:00Z"
         },
         {
            "public_id":"e1a62fe20ed411ef8740767250df1ed7",
            "product":"48398760149283",
            "starting_date":"2024-07-01T00:00:00Z"
         }
      ],
      "configuration": {
            "reveal_moment": "ORDER_PLACEMENT",
            "pricing_policy": "BEST_PRICE"
        }
   }
]
```

--------------------------------

### JSON Example of Product Rotation Configuration

Source: https://developer.ordergroove.com/reference/manage-ordinal-rotating-product

This JSON structure represents the configuration for an ordinal rotating product. It includes details such as the product's public ID, selection rule type, a list of product selection elements with their respective public IDs and starting ordinals, and overall configuration settings like reveal moment, cyclical rotation status, starting ordinal, and pricing policy.

```JSON
[
   {
      "public_id":"e1a61e620ed411ef8740767250df1ed7",
      "selection_rule_type":"ORDINAL",
      "product_selection_list_elements":[
         {
            "public_id":"e1a626000ed411ef8740767250df1ed7",
            "product":"48398751432995",
            "starting_ordinal":"0"
         },
         {
            "public_id":"e1a62b140ed411ef8740767250df1ed7",
            "product":"48398752317731",
            "starting_ordinal":"1"
         },
         {
            "public_id":"e1a62fe20ed411ef8740767250df1ed7",
            "product":"48398760149283",
            "starting_ordinal":"4"
         }
      ],
      "configuration": {
            "reveal_moment": "ORDER_PLACEMENT",
            "cyclical_rotation_enabled": true,
            "cyclical_starting_ordinal": 1,
            "pricing_policy": "BEST_PRICE"
        }
   }
]
```

--------------------------------

### Manage Products - List

Source: https://developer.ordergroove.com/reference/introduction

Allows for listing all products via a GET request.

```REST
GET /products
```

--------------------------------

### List Products (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves a list of all products.

```REST
GET /products
```

--------------------------------

### Get Products with Product Selection Rules

Source: https://developer.ordergroove.com/reference/products-retrieve

This cURL example demonstrates how to retrieve product information, with an option to exclude product selection rules. It targets the Ordergroove REST API.

```cURL
curl --request GET \
     --url 'https://restapi.ordergroove.com/products/product_id/?include_product_selection_rules=false' \
     --header 'accept: application/json'
```

--------------------------------

### Manage Resources - List

Source: https://developer.ordergroove.com/reference/introduction

Allows for listing all resources via a GET request.

```REST
GET /resources
```

--------------------------------

### Retrieve Rotating Ordinal Subscription Context (GET)

Source: https://developer.ordergroove.com/reference/webhooks-subscriber-events

Fetches the context for a subscription that involves rotating products based on ordinal position. Useful for managing complex recurring product setups.

```REST
GET /subscriptions/{subscription_id}/rotating-ordinal-context
```

--------------------------------

### Ordergroove API - One Time Incentives

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section covers the API endpoints for managing one-time incentives, including listing, retrieving, creating, updating, and deleting incentives.

```text
One Time Incentives
Listget
Retrieveget
Createpost
Updatepatch
Deletedel
```

--------------------------------

### Ordergroove API - Product Groups

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section details the API endpoints for managing product groups, including listing, creating, and updating product group information.

```text
PRODUCT GROUPS
Listget
Createpost
Updatepatch
```

--------------------------------

### Ordergroove API - Page-based Pagination Example

Source: https://developer.ordergroove.com/reference/pagination

Demonstrates how to loop through results using the `page` query string parameter for page-based pagination in the Ordergroove API. This method is suitable for datasets that do not exceed 20 pages.

```HTTP
https://restapi.ordergroove.com/orders?page_size=100&page=3
```

--------------------------------

### Ordergroove API - Resources

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section outlines the API endpoints for managing resources, including listing, retrieving, creating, and updating resource details.

```text
RESOURCES
Listget
Retrieveget
Createpost
Updatepatch
```

--------------------------------

### Page-Based Pagination - Sample Request Header (Deprecated)

Source: https://developer.ordergroove.com/reference/pagination

This example demonstrates a sample request header for page-based pagination, which is now deprecated. It shows how page numbers and sizes were specified in older implementations, highlighting the transition to cursor-based methods.

```HTTP
GET /resource?page=2&pageSize=20

```

--------------------------------

### Ordergroove API - Products

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section covers the API endpoints for managing products, including listing, retrieving, updating, and bulk operations. It also details management for time-window rotating and ordinal rotating products.

```text
Products
Listget
Retrieveget
Group Checkget
Relationshipsget
Updatepatch
Bulk Createpost
Bulk Updatepatch
Time-Window Rotating Product
Manage Time-Window Rotating Productpost
Ordinal Rotating Product
Manage Ordinal Rotating Productpost
Retrieve Rotating Delivery Productget
Manage Digital Plan Productpost
```

--------------------------------

### Ordergroove API - Entitlements

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section details the API endpoint for listing entitlements.

```text
ENTITLEMENTS (ENTITLEMENTS-SERVICE.ORDERGROOVE.COM)
Listget
```

--------------------------------

### Manage Ordinal Rotating Product

Source: https://developer.ordergroove.com/reference/manage-ordinal-rotating-product

This cURL example demonstrates how to manage an ordinal rotating product by updating its configuration. It sends a POST request to the Ordergroove API with a JSON payload specifying the reveal moment, pricing policy, and cyclical starting ordinal.

```cURL
curl --request POST \
     --url https://restapi.ordergroove.com/products/product_id/selection_rules/ordinal/manage/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "configuration": {
    "reveal_moment": "ORDER_REMINDER",
    "pricing_policy": "BEST_PRICE",
    "cyclical_starting_ordinal": 0
  }
}'
```

--------------------------------

### Ordergroove API - Items

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section provides details on API endpoints for managing items, including listing, retrieving, updating quantities and prices, creating, deleting, and handling product changes.

```text
Items
Listget
Retrieveget
Change Quantitypatch
Change Pricepatch
Createpost
Create in Orderpost
Deletedel
Updatepatch
Product Changepatch
```

--------------------------------

### List Products (GET)

Source: https://developer.ordergroove.com/reference/troubleshooting-webhooks

Retrieves a list of products. Supports filtering and pagination.

```REST
GET /products
```

--------------------------------

### Ordergroove API - Composites

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section outlines the API endpoints for composites, including purchasing via POST and checking the status of a purchase.

```text
Composites (SC.ordergroove.com)
Purchase POST
Purchase POST APIpost
Purchase POST Statusget
```

--------------------------------

### Manage Items - List

Source: https://developer.ordergroove.com/reference/introduction

Allows for listing all items via a GET request.

```REST
GET /items
```

--------------------------------

### Ordergroove API - 1-click actions

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section details the API endpoints for 1-click actions, specifically for retrieving delay and reactivation information.

```text
1-click actions
1-Click Delayget
1-Click Reactivateget
```

--------------------------------

### Ordergroove API: List Resources GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all resources. This is a GET request within the 'RESOURCES' resource.

```REST
GET /resources

```

--------------------------------

### Product Selection Rules Configuration

Source: https://developer.ordergroove.com/reference/rotating-product

This JSON structure defines the product selection rules for time-window based rotation. It includes product IDs, starting dates, and configuration details like reveal moment and pricing policy. The 'starting_date' is inclusive, and the implicit ending date is exclusive, determined by the next rule's start date.

```json
{
  "product_selection_rules": [
    {
      "public_id": "e1a61e620ed411ef8740767250df1ed7",
      "selection_rule_type": "TIME_WINDOW",
      "product_selection_list_elements": [
        {
          "public_id": "e1a626000ed411ef8740767250df1ed7",
          "product": "48398751432995",
          "starting_date": "2024-05-01T00:00:00Z"
        },
        {
          "public_id": "e1a62b140ed411ef8740767250df1ed7",
          "product": "48398752317731",
          "starting_date": "2024-06-01T00:00:00Z"
        },
        {
          "public_id": "e1a62fe20ed411ef8740767250df1ed7",
          "product": "48398760149283",
          "starting_date": "2024-07-01T00:00:00Z"
        }
      ],
      "configuration": {
          "reveal_moment": "ORDER_PLACEMENT",
          "pricing_policy": "BEST_PRICE"
        }
    }
  ]
}
```

--------------------------------

### Ordergroove API: List Customers GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all customers. This is a GET request within the 'Customers' resource.

```REST
GET /customers

```

--------------------------------

### Manage Digital Plan Product (POST)

Source: https://developer.ordergroove.com/reference/webhook-subscription-events

Manages product configurations for digital plan products. This allows for the setup and management of digital subscription offerings.

```REST
POST /products/digital-plan
```

--------------------------------

### Ordergroove API: List Orders GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all orders. This is a GET request within the 'Orders' resource.

```REST
GET /orders

```

--------------------------------

### Manage Products - Create

Source: https://developer.ordergroove.com/reference/introduction

Allows for the creation of new products via POST requests, including bulk creation.

```REST
POST /products
POST /products/bulk-create
```

--------------------------------

### Ordergroove API: List Subscriptions GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all subscriptions. This is a GET request within the 'Subscriptions' resource.

```REST
GET /subscriptions

```

--------------------------------

### Manage Digital Plan Product (POST)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Manages product configurations for digital plan products.

```REST
POST /products/digital-plan
```

--------------------------------

### Get 1-Click Delay (GET)

Source: https://developer.ordergroove.com/reference/troubleshooting-webhooks

Retrieves the current delay setting for 1-click actions. May require authentication.

```REST
GET /1-click/delay
```

--------------------------------

### Ordergroove API: Retrieve Resource GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the details of a specific resource by its ID. This is a GET request under the 'RESOURCES' resource.

```REST
GET /resources/{resourceId}

```

--------------------------------

### Ordergroove API - Offer Profile

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section details the API endpoint for listing offer profiles.

```text
Offer Profile
Listget
```

--------------------------------

### Ordergroove API - Products Bulk Create

Source: https://developer.ordergroove.com/reference/webhooks-overview

Bulk create products. This endpoint is part of the Products resource in the Ordergroove API.

```REST
Bulk Createpost
```

--------------------------------

### Ordergroove API: Product Relationships GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves information about the relationships between products. This GET request is part of the 'Products' resource.

```REST
GET /products/relationships

```

--------------------------------

### Create Customer

Source: https://developer.ordergroove.com/reference/introduction

Creates a new customer.

```REST
POST /customers
```

--------------------------------

### Ordergroove API: Retrieve Product GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the details of a specific product by its ID. This is a GET request under the 'Products' resource.

```REST
GET /products/{productId}

```

--------------------------------

### List Offer Profiles (GET)

Source: https://developer.ordergroove.com/reference/webhooks-item-events

Retrieves a list of offer profiles.

```HTTP
GET /offer-profiles
```

--------------------------------

### Ordergroove API: List Products GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all products in the catalog. This is a GET request within the 'Products' resource.

```REST
GET /products

```

--------------------------------

### Manage Digital Plan Product (POST)

Source: https://developer.ordergroove.com/reference/webhooks-item-events

Manages product configurations for digital plan products.

```HTTP
POST /products/digital-plan
```

--------------------------------

### List Products

Source: https://developer.ordergroove.com/reference/prepaid-subscriptions

This API endpoint retrieves a list of products. It is a GET request.

```HTTP
GET /products
```

--------------------------------

### Ordergroove API: Retrieve Address GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the details of a specific address by its ID. This is a GET request under the 'Addresses' resource.

```REST
GET /addresses/{addressId}

```

--------------------------------

### Create Item (POST)

Source: https://developer.ordergroove.com/reference/webhooks-subscriber-events

Creates a new item in the product catalog. This requires providing all necessary item details, such as name, description, and price.

```REST
POST /items
```

--------------------------------

### Ordergroove API: Retrieve Customer GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the details of a specific customer by their ID. This is a GET request under the 'Customers' resource.

```REST
GET /customers/{customerId}

```

--------------------------------

### Manage Digital Plan Product

Source: https://developer.ordergroove.com/reference/manage-digital-plan-product

This API allows you to configure an existing standard product into a digital plan product or manage an existing configuration. It involves selecting a product, defining resource grants (like time amounts in seconds), and making an API call to associate these grants with the product, thereby setting its type to 'plan'.

```REST
POST https://restapi.ordergroove.com/products/{product_id}/resource_grants/manage/
```

--------------------------------

### List Offer Profiles (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves a list of all offer profiles.

```REST
GET /offer-profiles
```

--------------------------------

### Ordergroove API: Retrieve Item GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the details of a specific item by its ID. This is a GET request under the 'Items' resource.

```REST
GET /items/{itemId}

```

--------------------------------

### Manage Digital Plan Product (POST)

Source: https://developer.ordergroove.com/reference/troubleshooting-webhooks

Manages configurations for products that are part of a digital plan. Requires product ID and plan details.

```REST
POST /products/digital-plan
```

--------------------------------

### Bulk Create Products

Source: https://developer.ordergroove.com/reference/prepaid-subscriptions

This API endpoint allows for the bulk creation of products. It is a POST request.

```HTTP
POST /products/bulk_create
```

--------------------------------

### Ordergroove API: List Items GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all available items. This is a GET request within the 'Items' resource.

```REST
GET /items

```

--------------------------------

### Create Customer

Source: https://developer.ordergroove.com/reference/prepaid-subscriptions

Creates a new customer record. This endpoint is used to onboard new users.

```REST
POST /customers
```

--------------------------------

### Ordergroove API: Retrieve Order GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the details of a specific order by its ID. This is a GET request under the 'Orders' resource.

```REST
GET /orders/{orderId}

```

--------------------------------

### Manage Customers - List

Source: https://developer.ordergroove.com/reference/introduction

Allows for listing all customers via a GET request.

```REST
GET /customers
```

--------------------------------

### Ordergroove API: Retrieve Subscription GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the details of a specific subscription by its ID. This is a GET request under the 'Subscriptions' resource.

```REST
GET /subscriptions/{subscriptionId}

```

--------------------------------

### cURL - Create Resource

Source: https://developer.ordergroove.com/reference/resource-create

This example demonstrates how to create a resource using a POST request to the Ordergroove API. It includes setting the appropriate accept and content-type headers.

```cURL
curl --request POST \
     --url https://restapi.ordergroove.com/resources/create/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

--------------------------------

### Manage Digital Plan Product (POST)

Source: https://developer.ordergroove.com/reference/rotating-product

Manages settings for digital plan products. Requires specific product and plan configurations.

```REST
POST /products/digital-plan
```

--------------------------------

### Ordergroove API: Retrieve Payment GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the details of a specific payment method by its ID. This is a GET request under the 'Payments' resource.

```REST
GET /payments/{paymentId}

```

--------------------------------

### Ordergroove API - Subscriptions

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section details various API endpoints for managing subscriptions, including listing, retrieving, canceling, and updating subscription details. It also covers prepaid subscriptions and bundle components.

```text
Subscriptions
Listget
Retrieveget
Cancelpatch
Change Quantitypatch
Change Shipping Addresspatch
Change Paymentpatch
Change Email Reminderpatch
Change Frequencypatch
Reactivatepatch
Updatepatch
Create in Orderpost
Create From Itempost
Change Productpatch
Change Next Order Datepatch
Retrieve Rotating Ordinal Subscription Contextget
Set Subscription Ordinal for Rotating Productpatch
Prepaid subscriptions
Upgrade Subscription To Prepaidpatch
Change Prepaid Renewal Behaviorpatch
Update Prepaid Subscriptionpatch
Bundle Components
Update Componentspost
Retrieve Componentget
```

--------------------------------

### Ordergroove API: List Addresses GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all addresses associated with the account. This is a GET request within the 'Addresses' resource.

```REST
GET /addresses

```

--------------------------------

### Ordergroove API: Retrieve Subscription Component GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the components for a specific subscription. This GET request is part of the 'Subscriptions' resource.

```REST
GET /subscriptions/{subscriptionId}/components

```

--------------------------------

### Ordergroove API - Webhooks Overview

Source: https://developer.ordergroove.com/reference/events-and-payloads

This section provides an overview of Ordergroove webhooks, including default and extended payload formats, and details the information sent for various entities like customers, orders, items, addresses, payments, subscriptions, and products. It also includes a snapshot example.

```English
Webhooks default payload
Extending webhooks payload
Webhooks extended payload format
Information sent:
  Customer
  Orders
  Items
  Addresses
  Payments
  Subscriptions
  Products
  Snapshot example
```

--------------------------------

### Create Resource (POST)

Source: https://developer.ordergroove.com/reference/ordergroove-api-rate-limits

Creates a new resource entry. Used for adding new system entities or configurations.

```REST
POST /resources
```

--------------------------------

### Get 1-Click Reactivate (GET)

Source: https://developer.ordergroove.com/reference/troubleshooting-webhooks

Retrieves information related to reactivating subscriptions via 1-click actions. May require authentication.

```REST
GET /1-click/reactivate
```

--------------------------------

### Manage Customers - Create

Source: https://developer.ordergroove.com/reference/introduction

Allows for the creation of new customers via POST requests.

```REST
POST /customers
```

--------------------------------

### Ordergroove API: List Offer Profiles GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all offer profiles. This is a GET request within the 'Offer Profile' resource.

```REST
GET /offer-profiles

```

--------------------------------

### Ordergroove API - Prepaid Subscription Context

Source: https://developer.ordergroove.com/reference/subscriptions-create-from-item

Provides an example of the 'prepaid_subscription_context' object, returned when prepaid subscriptions are enabled, detailing remaining orders, billing frequency, and renewal behavior.

```json
{
  "prepaid_orders_remaining": 0,
  "prepaid_orders_per_billing": 3,
  "renewal_behavior": "autorenew",
  "last_renewal_revenue": 100.8,
  "prepaid_origin_merchant_order_id": "#3082"
}
```

--------------------------------

### Ordergroove API: List Product Groups GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all product groups. This is a GET request within the 'PRODUCT GROUPS' resource.

```REST
GET /product-groups

```

--------------------------------

### Ordergroove Webhook Request Details

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

Details the technical specifications for Ordergroove webhook requests, including the protocol, method, payload format, signature header, retry mechanisms, and considerations for duplicate or out-of-order deliveries.

```General
Protocol: HTTPS
Method: POST
Payload: JSON (content depends on user configuration)
Header: Ordergroove-Signature for verification
Retry Policy: Retries for 5xx errors at increasing intervals (1 min, 3 min, 10 min) up to 5 attempts.
Duplicate Handling: Clients should implement logic to handle potential duplicates.
Order Guarantee: Sequential delivery is not guaranteed due to network latencies; clients should accommodate non-sequential arrival.
```

--------------------------------

### Ordergroove API: Product Group Check GET

Source: https://developer.ordergroove.com/reference/purchase-post

Checks the status or details of a product group. This GET request is part of the 'Products' resource.

```REST
GET /products/group-check

```

--------------------------------

### Ordergroove API: List Payments GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all payment methods associated with the account. This is a GET request within the 'Payments' resource.

```REST
GET /payments

```

--------------------------------

### Ordergroove API - Addresses

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section outlines the API endpoints for managing addresses, including listing, retrieving, creating, updating, and applying an address to all associated entities.

```text
Addresses
Listget
Retrieveget
Createpost
Updatepatch
Use address for allpost
```

--------------------------------

### Customers - Create

Source: https://developer.ordergroove.com/reference/webhooks-order-events

Creates a new customer record. Used to onboard new users.

```REST
POST /customers
```

--------------------------------

### Ordergroove API: List Merchant Cancellation Reasons GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of reasons for merchant-initiated cancellations. This is a GET request within the 'Merchant' resource.

```REST
GET /merchant/cancellation-reasons

```

--------------------------------

### Purchase POST (Composites)

Source: https://developer.ordergroove.com/reference/introduction

Initiates a purchase via POST request for composites.

```REST
POST /composites/purchase
```

--------------------------------

### Ordergroove API: Retrieve Rotating Subscription Context GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the context for a rotating ordinal subscription. This GET request is part of the 'Subscriptions' resource.

```REST
GET /subscriptions/{subscriptionId}/rotating-ordinal-context

```

--------------------------------

### List Products

Source: https://developer.ordergroove.com/reference/introduction

Retrieves a list of all products.

```REST
GET /products
```

--------------------------------

### Get Product Relationships

Source: https://developer.ordergroove.com/reference/product-relationships

Retrieves the relationships for a specific product using the Ordergroove REST API. This GET request requires an 'accept' header set to 'application/json'.

```cURL
curl --request GET \
     --url https://restapi.ordergroove.com/products/product_id/relationships/ \
     --header 'accept: application/json'
```

--------------------------------

### Ordergroove API - Successful Response (200)

Source: https://developer.ordergroove.com/reference/subscriptions-create-from-item

Example of a successful API response (200 OK) body, detailing various subscription and order-related fields returned by the Ordergroove platform.

```json
{
  "customer": "string",
  "merchant": "string",
  "product": "string",
  "payment": "string",
  "shipping_address": "string",
  "offer": "string",
  "subscription_type": "string",
  "components": [
    {
      "product": "string"
    }
  ],
  "components": {
    "product": "string"
  },
  "extra_data": {},
  "public_id": "string",
  "product_attribute": "string",
  "quantity": "integer",
  "price": "string",
  "frequency_days": "integer",
  "reminder_days": "integer",
  "every": "integer",
  "every_period": "integer",
  "start_date": "string",
  "cancelled": "string",
  "cancel_reason": "string",
  "cancel_reason_code": "string",
  "iteration": "string",
  "sequence": "string",
  "session_id": "string",
  "merchant_order_id": "string",
  "customer_rep": "string",
  "club": "string",
  "created": "string",
  "updated": "string",
  "live": "boolean"
}
```

--------------------------------

### Ordergroove API: List One Time Incentives GET

Source: https://developer.ordergroove.com/reference/purchase-post

Retrieves a list of all one-time incentives. This is a GET request within the 'One Time Incentives' resource.

```REST
GET /one-time-incentives

```

--------------------------------

### Ordergroove API: Retrieve One Time Incentive GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches the details of a specific one-time incentive by its ID. This is a GET request under the 'One Time Incentives' resource.

```REST
GET /one-time-incentives/{incentiveId}

```

--------------------------------

### Ordergroove API: Retrieve Rotating Delivery Product GET

Source: https://developer.ordergroove.com/reference/purchase-post

Fetches details for products that are part of a rotating delivery schedule. This GET request is part of the 'Products' resource.

```REST
GET /products/rotating-delivery

```

--------------------------------

### Ordergroove API - Orders

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section outlines the API endpoints for managing orders, including listing, retrieving, canceling, and updating order statuses. It also covers sending orders immediately and skipping subscriptions.

```text
Orders
Order Status Codes
Listget
Retrieveget
Cancelpatch
Send Nowpatch
Change Shipping Addresspatch
Change Paymentpatch
Change Place Datepatch
Updatepatch
Skip Subscriptionpatch
Finalize processing Orderpatch
```

--------------------------------

### List Offer Profiles (GET)

Source: https://developer.ordergroove.com/reference/webhook-subscription-events

Retrieves a list of all offer profiles. Offer profiles likely define terms and conditions for various promotions or discounts.

```REST
GET /offer-profiles
```

--------------------------------

### Get 1-Click Reactivate

Source: https://developer.ordergroove.com/reference/1-click-reactivate

This snippet demonstrates how to retrieve the reactivation status for a 1-click order using a GET request to the Ordergroove API. It includes the necessary URL and headers for the request.

```curl
curl --request GET \
     --url https://restapi.ordergroove.com/one_click/reactivate \
     --header 'accept: application/json'
```

--------------------------------

### JSON: Example Error Responses for Purchase POST

Source: https://developer.ordergroove.com/reference/purchase-post

Provides examples of common JSON error responses that may be received from Ordergroove's Purchase POST endpoint. These errors indicate issues with merchant IDs, missing data, or invalid payment information.

```JSON
400 - no records will be created
{"error": "Invalid Merchant MERCHANT_PUBLIC_ID"}
{"error": "Merchant ID must be a string"}
{"error_message": "Merchant order id cannot be null"}
{"error_message": "Session id cannot be null"}
{"error_message": "Session ID must be a string"}
{"error_message": "Missing payment data to create record"}
{"error_message": "The credit card encryption is not valid"}
{"error_message": "Expiration date is not valid, received: "}
{"error_message": "Paymetric tokenization error"}
```

--------------------------------

### Manage Subscription Components

Source: https://developer.ordergroove.com/reference/introduction

Handles the creation and retrieval of bundle components for subscriptions.

```REST
POST /subscriptions/components/update
GET /subscriptions/components/retrieve
```

--------------------------------

### List Offer Profiles (GET)

Source: https://developer.ordergroove.com/reference/webhooks-subscriber-events

Retrieves a list of offer profiles. Offer profiles likely define different types of promotions or discounts available.

```REST
GET /offer-profiles
```

--------------------------------

### Ordergroove API - Prepaid Subscription Context

Source: https://developer.ordergroove.com/reference/subscriptions-create-in-order

Provides an example of the 'prepaid_subscription_context' object, which contains details relevant to prepaid subscriptions, such as remaining orders and renewal behavior.

```JSON
{
  "prepaid_orders_remaining": 0,
  "prepaid_orders_per_billing": 3,
  "renewal_behavior": "autorenew",
  "last_renewal_revenue": 100.8,
  "prepaid_origin_merchant_order_id": "#3082"
}
```

--------------------------------

### Manage Ordinal Rotating Product

Source: https://developer.ordergroove.com/reference/manage-ordinal-rotating-product

Configures a standard product as an ordinal rotating product or manages an existing configuration. It requires at least one selection rule with a starting ordinal of 0, and all starting ordinals must be unique non-negative integers. The `cyclical_starting_ordinal` parameter, if used, must be between 0 and the largest `starting_ordinal`.

```HTTP
post https://restapi.ordergroove.com/products/{product_id}/selection_rules/ordinal/manage/
```

--------------------------------

### List Entitlements (GET)

Source: https://developer.ordergroove.com/reference/order-status-codes

Retrieves a list of customer entitlements.

```REST
GET /entitlements
```

--------------------------------

### Products - List

Source: https://developer.ordergroove.com/reference/webhooks-order-events

Retrieves a list of products. Provides access to all available product offerings.

```REST
GET /products
```

--------------------------------

### Product Relationships (GET)

Source: https://developer.ordergroove.com/reference/order-status-codes

Retrieves information about relationships between products.

```REST
GET /products/{product_id}/relationships
```

--------------------------------

### Bulk Create/Update Products (cURL)

Source: https://developer.ordergroove.com/reference/bulk-update

This snippet demonstrates how to perform bulk operations for creating or updating products using cURL. It includes setting the request URL, headers for content type and acceptance, and the HTTP method.

```cURL
curl --request PATCH \
     --url https://restapi.ordergroove.com/products-batch/update/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
```

--------------------------------

### Retrieve Cart (GET)

Source: https://developer.ordergroove.com/reference/order-status-codes

Fetches the contents or status of a shopping cart.

```REST
GET /cart
```

--------------------------------

### Ordergroove API - Customers

Source: https://developer.ordergroove.com/reference/configuring-your-server-for-ordergroove-webhooks

This section covers the API endpoints for managing customer information, including listing, retrieving, creating, and updating customer details, as well as setting contact details.

```text
Customers
Listget
Retrieveget
Createpost
Updatepatch
Set Contact Detailspatch
```

--------------------------------

### 1-Click Reactivate (GET)

Source: https://developer.ordergroove.com/reference/order-status-codes

Fetches information regarding the 1-click reactivation functionality.

```REST
GET /1-click/reactivate
```

--------------------------------

### 1-Click Delay (GET)

Source: https://developer.ordergroove.com/reference/order-status-codes

Retrieves information related to the 1-click delay feature.

```REST
GET /1-click/delay
```

--------------------------------

### Resources - Create

Source: https://developer.ordergroove.com/reference/webhooks-order-events

Creates a new resource. Used for adding new system resources.

```REST
POST /resources
```

--------------------------------

### Purchase POST (Composites)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Initiates a purchase through the Composites service.

```REST
POST /composites/purchase
```

--------------------------------

### Ordergroove API - Resources Create

Source: https://developer.ordergroove.com/reference/webhooks-overview

Create a new resource. This endpoint is part of the Resources resource in the Ordergroove API.

```REST
Createpost
```

--------------------------------

### List Addresses (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves a list of all addresses.

```REST
GET /addresses
```

--------------------------------

### List Customers (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves a list of all customers.

```REST
GET /customers
```

--------------------------------

### List Products

Source: https://developer.ordergroove.com/reference/prepaid-subscriptions

Retrieves a list of all products. This endpoint provides access to the product catalog.

```REST
GET /products
```

--------------------------------

### List Orders (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves a list of all orders.

```REST
GET /orders
```

--------------------------------

### Manage Digital Plan Product

Source: https://developer.ordergroove.com/reference/rotating-product

This section outlines the management of digital plan products. It details how to handle products that are part of digital subscription plans.

```REST
POST /products/manage-digital-plan-product
```

--------------------------------

### 1-Click Reactivate (GET)

Source: https://developer.ordergroove.com/reference/webhooks-item-events

Retrieves information about a 1-click reactivation action.

```HTTP
GET /1-click-actions/reactivate
```

--------------------------------

### 1-Click Delay (GET)

Source: https://developer.ordergroove.com/reference/webhooks-item-events

Retrieves information about a 1-click delay action.

```HTTP
GET /1-click-actions/delay
```

--------------------------------

### Product Relationships (GET)

Source: https://developer.ordergroove.com/reference/webhooks-item-events

Retrieves information about the relationships between products.

```HTTP
GET /products/relationships
```

--------------------------------

### Manage Resources - Create

Source: https://developer.ordergroove.com/reference/introduction

Allows for the creation of new resources via POST requests.

```REST
POST /resources
```

--------------------------------

### Ordergroove API - Customers Create

Source: https://developer.ordergroove.com/reference/webhooks-overview

Create a new customer. This endpoint is part of the Customers resource in the Ordergroove API.

```REST
Createpost
```

--------------------------------

### List One-Time Incentives (GET)

Source: https://developer.ordergroove.com/reference/order-status-codes

Retrieves a list of one-time incentives available.

```REST
GET /one-time-incentives
```

--------------------------------

### Create Customer

Source: https://developer.ordergroove.com/reference/urls

Creates a new customer record. This endpoint is used to register new users.

```REST
POST /customers
```

--------------------------------

### Product Group Check (GET)

Source: https://developer.ordergroove.com/reference/order-status-codes

Checks the status or details of a product group.

```REST
GET /products/group-check
```

--------------------------------

### Products - Manage Digital Plan Product

Source: https://developer.ordergroove.com/reference/webhooks-order-events

Manages digital products within a plan structure. Handles configurations for digital subscriptions or offerings.

```REST
POST /products/digital-plan
```

--------------------------------

### List Addresses (GET)

Source: https://developer.ordergroove.com/reference/order-status-codes

Retrieves a list of addresses. Can be filtered by customer or order.

```REST
GET /addresses
```

--------------------------------

### List Customers (GET)

Source: https://developer.ordergroove.com/reference/order-status-codes

Retrieves a list of customers. Useful for customer management.

```REST
GET /customers
```

--------------------------------

### Purchase POST (Composites)

Source: https://developer.ordergroove.com/reference/webhooks-item-events

Initiates a purchase through the Composites service using a POST request.

```HTTP
POST /composites/purchase
```

--------------------------------

### List Items (GET)

Source: https://developer.ordergroove.com/reference/order-status-codes

Retrieves a list of items. Useful for inventory management.

```REST
GET /items
```

--------------------------------

### Purchase POST API (Composites)

Source: https://developer.ordergroove.com/reference/introduction

Initiates a purchase via POST API request for composites.

```REST
POST /composites/purchase-api
```

--------------------------------

### 1-Click Reactivate (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves information related to 1-click reactivation.

```REST
GET /1-click/reactivate
```

--------------------------------

### Ordergroove API - Products Manage Digital Plan Product

Source: https://developer.ordergroove.com/reference/webhooks-overview

Manage digital plan products. This endpoint is part of the Products resource in the Ordergroove API.

```REST
Manage Digital Plan Productpost
```

--------------------------------

### 1-Click Delay (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves information about the 1-click delay feature.

```REST
GET /1-click/delay
```

--------------------------------

### Resources - List

Source: https://developer.ordergroove.com/reference/webhooks-order-events

Retrieves a list of resources. Provides access to general system resources.

```REST
GET /resources
```

--------------------------------

### List Resources (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves a list of available resources.

```REST
GET /resources
```

--------------------------------

### Manage Product Groups - Ordergroove REST RPC

Source: https://developer.ordergroove.com/reference/bundle-components

Endpoints for managing product groups, including listing, creating, and updating product group configurations.

```REST
GET /product-groups
POST /product-groups
PATCH /product-groups/{id}
```

--------------------------------

### Product Relationships (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves information about the relationships between products.

```REST
GET /products/relationships
```

--------------------------------

### List Payments (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves a list of all payment methods.

```REST
GET /payments
```

--------------------------------

### List Products

Source: https://developer.ordergroove.com/reference/urls

Retrieves a list of all products. This endpoint is used to browse the product catalog.

```REST
GET /products
```

--------------------------------

### Ordergroove API - Purchase POST

Source: https://developer.ordergroove.com/reference/bundle-components

Handles the creation of a purchase, likely for composite products or services. This endpoint initiates the purchase process.

```REST
POST /purchase
Purchase POST APIpost
```

--------------------------------

### List Items (GET)

Source: https://developer.ordergroove.com/reference/events-and-payloads

Retrieves a list of all available items.

```REST
GET /items
```