Ordergroove Developer Documentation

{
  "next": "https://restapi.ordergroove.com/entitlements/?cursor=cD0yMDI0LTA0LTEwKz",
  "results": [
    {
      "merchant": "339536244b7c11eb8d37ee71e0f3a639",
      "public_id": "4c6dceaa1ddc4361962f9f6b11c0af7a",
      "merchant_user_id": "test_user_id",
      "initial_activation_date": "2024-08-12T20:35:19.04Z",
      "latest_activation_date": "2024-08-12T20:35:19.04Z",
      "live": false,
      "access_type": "time_based",
      "expiration": "2024-09-12T20:35:19.04Z",
      "created": "2024-08-12T20:35:19.04Z",
      "last_updated": "2024-08-12T20:35:19.04Z",
      "resource": {
        "public_id": "ecb42bee71ff11efb72ef29e3ec3bb34",
        "merchant": "339536244b7c11eb8d37ee71e0f3a639",
        "name": "Piano lesson",
        "external_resource_id": "123456",
        "image_url": "http://some.image.com",
        "created": "2020-12-31 23:28:48",
        "last_updated": "2020-12-31 23:28:48"
      },
      "grantees": [
        {
          "external_id": "grantee-001",
          "name": "Grantee Name",
          "created": "2020-12-31 23:28:48",
          "updated": "2020-12-31 23:28:48"
        }
      ]
    }
  ]
}

List entitlements associated to merchant's customers. Only relevant for merchants offering digital products.

Query parameters

merchantstringRequired

Merchant ID

merchant_user_idstringOptional

Customer ID. If the request is made on behalf of a customer, only the entitlements tied to the calling customer are returned, regardless of the value provided in this field

resource_public_idstringOptional

Filters entitlements by a single resource public ID.

resource_public_idsstringOptional

Filters entitlements to those associated with the specified resource public IDs. Provide a comma-separated list of resource public IDs. Cannot be used together with resource_public_id.

external_resource_idstringOptional

Merchant resource ID

livebooleanOptional

Filters entitlements by whether their associated resources are accessible

resource_namestringOptional

Filters entitlements by resource name (case-insensitive match).

grantee_external_ids_exactstringOptional

Filter entitlements by list of exact ids (returns entitlement if and only if every grantee passed in is present in the entitlement and no other grantees are present) example: grantee_external_ids_exact=grantee_a,grantee_b returns entitlements with both grantee_a and grantee_b, but not entitlements with just grantee_a or entitlements that have grantee_a, grantee_b, but also grantee_c

Response

200

nextstringOptional

URL to get the next page of results. null if there are no more pages.

previousstringOptional

URL to get the previous page of results. null if there are no previous pages.

resultslist of objectsOptional

Note: This endpoint returns up to 100 entitlements per request by default, which differs from other endpoints in this API.