List

get

https://restapi.ordergroove.com/entitlements/

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🔐
Authentication
✔️ Application API Scope
✔️ Storefront API Scope

Response Body Definitions

Name	Type	Description	Example
merchant	string	Merchant ID	"ac4f7938383a11e89ecbbc764e1107f2"
public_id	string	Entitlement ID	"c4cd7f86ccc411e8ada3bc764e101db1"
merchant_user_id	string	Customer ID	"11100-C01"
initial_activation_date	string	Initial activation date (UTC)	"2017-02-29T12:00:00.00Z"
latest_activation_date	string	Latest activation date (UTC)	"2017-02-29T12:00:00.00Z"
grace_period	string	Grace period in seconds	86400
live	bool	Whether the resource associated with this entitlement is accessible (considers grace_period)	true
access_type	string	Entitlement access type (enum)	"time_based"
expiration	string	Entitlement access expiration date (UTC)	"2017-02-29T12:00:00.00Z"
created	string	Date of resource creation (UTC)	"2017-02-29T12:00:00.00Z"
last_updated	string	Date of last resource update (UTC)	"2017-02-29T12:00:00.00Z"
resource	object	Resource information (see Resource Object below)	{"name": "sample resource", ... }
grantees	array	List of grantees associated to the entitlement. `null` if there are none.	[ { "external_id": "grantee-001", "name": "Grantee Name", "created": "2017-02-29T12:00:00.00Z", "updated": "2017-02-29T12:00:00.00Z" }, ... ]

Resource Object

Name	Type	Description	Example
merchant	string	Merchant ID	"ac4f7938383a11e89ecbbc764e1107f2"
public_id	string	Resource ID	"c4cd7f86ccc411e8ada3bc764e101db1"
name	string	Resource name	"4k Resolution Movies"
external_resource_id	string	Merchant resource ID	"id1234"
description	string	Resource description	"Unlocks streaming of movies in 4K resolution"
image_url	string	Resource image URL	"ordergroove.com/resource/resource_id.png"
created	string	Date of resource creation (UTC)	"2017-02-29T12:00:00.00Z"
last_updated	string	Date of last resource update (UTC)	"2017-02-29T12:00:00.00Z"

Grantee Object

Name	Type	Description	Example
external_id	string	Merchant ID	"grantee-001"
name	string	Resource ID	"Grantee Name"
created	datetime string	Datetime of creation	"2020-12-31 23:28:48"
updated	datetime string	Datetime of last update	"2020-12-31 23:28:48"

Query Params

merchant

string

required

Merchant ID

merchant_user_id

string

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_id

string

Filters entitlements by a single resource public ID.

resource_public_ids

string

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_id

string

Merchant resource ID

live

boolean

Filters entitlements by whether their associated resources are accessible

resource_name

string

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

grantee_external_ids_exact

string

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

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Authentication

Response Body Definitions

Resource Object

Grantee Object

200200

403403