Ordergroove Developer Documentation

curl -X POST https://restapi.ordergroove.com/entitlements/void/ \
     -H "Content-Type: application/json" \
     -d '{
  "entitlement_public_ids": [
    "4e9d934275734a859a7f8d98dc52c8af",
    "5289bf2ad76e4fde881ad1a89a55b5dc"
  ]
}'

{
  "results": {
    "4e9d934275734a859a7f8d98dc52c8af": {
      "entitlement_transaction": {
        "transaction_type": "entitlement_voided",
        "public_id": "b95671a531974f6a98d7156e72284c34",
        "entitlement_public_id": "4e9d934275734a859a7f8d98dc52c8af",
        "merchant_user_id": "23799452926316",
        "resource_public_id": "3fa56741671444bdbcdf7b1554f67bee",
        "merchant_public_id": "80c9a167fb434fa0abe215c7f19a86cc",
        "transaction_initiation_time": "2026-04-07T18:36:24.908319269Z",
        "transaction_execution_time": "2026-04-07T18:36:24.908319269Z",
        "source_action": "api-call",
        "source_object": "user",
        "source_object_id": "dd0756ea-f502-4292-931e-b48f26677ef9_2026-04-07T18:36:24.908319269Z",
        "access_type": "time_based",
        "grace_period": 0,
        "expiration": "2026-04-07T18:36:24.908319269Z",
        "grace_period_expiration": "2026-04-07T18:36:24.908319269Z"
      },
      "entitlement": {
        "merchant": "80c9a167fb434fa0abe215c7f19a86cc",
        "public_id": "4e9d934275734a859a7f8d98dc52c8af",
        "merchant_user_id": "23799452926316",
        "initial_activation_date": null,
        "latest_activation_date": null,
        "grace_period": 0,
        "live": false,
        "access_type": "time_based",
        "expiration": "2026-04-07T18:36:24.908319269Z",
        "created": "2026-03-16T17:00:13.059Z",
        "last_updated": "2026-04-07T18:36:24.912728516Z",
        "grantees": [
          {
            "external_id": "qveq35",
            "name": "vwW4w4fv",
            "created": "2026-03-16T17:00:12.907Z",
            "updated": "2026-03-16T17:00:12.907Z"
          },
          {
            "external_id": "F2VS",
            "name": "F4Q34",
            "created": "2026-03-16T17:00:12.907Z",
            "updated": "2026-03-16T17:00:12.907Z"
          },
          {
            "external_id": "BES576FYE4DS5ET",
            "name": "AE5 YBEYA5V",
            "created": "2026-03-16T17:00:12.907Z",
            "updated": "2026-03-16T17:00:12.907Z"
          },
          {
            "external_id": "W4T6C",
            "name": "A W AGW4",
            "created": "2026-03-16T17:00:12.907Z",
            "updated": "2026-03-16T17:00:12.907Z"
          },
          {
            "external_id": "EM. DTSCRTRGXTD",
            "name": "awww eh5q",
            "created": "2026-03-16T17:00:12.907Z",
            "updated": "2026-03-16T17:00:12.907Z"
          },
          {
            "external_id": "we5yyvw5",
            "name": "arg. ag",
            "created": "2026-03-16T17:00:12.907Z",
            "updated": "2026-03-16T17:00:12.907Z"
          },
          {
            "external_id": "yvac3y",
            "name": "we. WT4GW4",
            "created": "2026-03-16T17:00:12.907Z",
            "updated": "2026-03-16T17:00:12.907Z"
          },
          {
            "external_id": "QT4VQ3CRAE",
            "name": "SEH SRJMDSRZRGE",
            "created": "2026-03-16T17:00:12.907Z",
            "updated": "2026-03-16T17:00:12.907Z"
          },
          {
            "external_id": "Wr gcax4wEab",
            "name": "ag wGaawg",
            "created": "2026-03-16T17:00:12.907Z",
            "updated": "2026-03-16T17:00:12.907Z"
          }
        ],
        "resource": {
          "public_id": "3fa56741671444bdbcdf7b1554f67bee",
          "merchant": "80c9a167fb434fa0abe215c7f19a86cc",
          "name": "Advanced Phonics for Professionals - With Tutoring",
          "external_resource_id": "53204456309100",
          "identified_product_external_id": null,
          "description": null,
          "image_url": null,
          "created": "2026-02-26T15:54:29.306Z",
          "last_updated": "2026-02-26T15:54:29.306Z"
        }
      }
    },
    "5289bf2ad76e4fde881ad1a89a55b5dc": {
      "entitlement_transaction": {
        "transaction_type": "entitlement_voided",
        "public_id": "452c6a1b3f3d4c178257ae2449709157",
        "entitlement_public_id": "5289bf2ad76e4fde881ad1a89a55b5dc",
        "merchant_user_id": "23799452926316",
        "resource_public_id": "04f5d0ab2dca4111ba785abc714e9010",
        "merchant_public_id": "80c9a167fb434fa0abe215c7f19a86cc",
        "transaction_initiation_time": "2026-04-07T18:36:24.908266844Z",
        "transaction_execution_time": "2026-04-07T18:36:24.908266844Z",
        "source_action": "api-call",
        "source_object": "user",
        "source_object_id": "dd0756ea-f502-4292-931e-b48f26677ef9_2026-04-07T18:36:24.908266844Z",
        "access_type": "time_based",
        "grace_period": 0,
        "expiration": "2026-04-07T18:36:24.908266844Z",
        "grace_period_expiration": "2026-04-07T18:36:24.908266844Z"
      },
      "entitlement": {
        "merchant": "80c9a167fb434fa0abe215c7f19a86cc",
        "public_id": "5289bf2ad76e4fde881ad1a89a55b5dc",
        "merchant_user_id": "23799452926316",
        "initial_activation_date": null,
        "latest_activation_date": null,
        "grace_period": 0,
        "live": false,
        "access_type": "time_based",
        "expiration": "2026-04-07T18:36:24.908266844Z",
        "created": "2026-04-07T16:45:43.119Z",
        "last_updated": "2026-04-07T18:36:24.917619184Z",
        "grantees": null,
        "resource": {
          "public_id": "04f5d0ab2dca4111ba785abc714e9010",
          "merchant": "80c9a167fb434fa0abe215c7f19a86cc",
          "name": "taco",
          "external_resource_id": "taco",
          "identified_product_external_id": null,
          "description": null,
          "image_url": null,
          "created": "2026-02-25T17:17:27.623Z",
          "last_updated": "2026-02-25T17:17:27.623Z"
        }
      }
    }
  }
}

Voids up to 50 entitlements. Entitlements are voided independently, so one entitlement failing doesn’t stop the others from being voided. Check each entry in results for an error field to see which succeeded. If any entitlement fails, the response status is 207 instead of 200. For each entitlement voided:

live is updated to false
expiration is updated to the time of execution
grace_period is updated to 0
An EntitlementTransaction is created
An entitlement.entitlements_voided event is triggered upon successful modification

The request is checked as a whole before anything is voided. If any ID is invalid, or doesn’t match an entitlement belonging to the authenticated merchant, the request returns 400 or 404 and no entitlements are voided.

Requires Application API Scope authentication.

Request

This endpoint expects an object.

entitlement_public_idslist of stringsRequired

IDs of the entitlements to void. Provide 1 to 50 IDs, with no duplicates or empty values.

Response

resultsmap from strings to objects

Void results, keyed by entitlement public_id.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error