A Product is a physical or digital item that you wish to license to people, classes, or schools. Products are created in the Edlink Dashboard or via the Meta API. Speak to your CSM to use the Products Meta API.
Products can represent a SKU, License, Service, etc in your platform. You can then use Licensing Rules to assign these Products to people, classes, or schools. This adds the product_id into that entity's product_ids array. When assigned to a Class or School, all members of that Class or School will receive the product as well.
These Licensing Rules work the same way as Sharing Rules if you are familiar with those except they assign Products to entities instead of "sharing" them. If you are not familiar with Sharing Rules, you can read about them in the Sharing Rules Overview documentation.
Properties
| Property | Type | Description |
|---|---|---|
id | string | The UUID for the object. |
name | string | The name of the product. |
code | string | Your unique identifier for this product (e.g. SKU) |
picture_url | string | A URL to a picture of the product. |
description | string | A description of the product. |
state | ProductState | The state of the product. |
team_id | string | The UUID of the team that owns this product. |
JSON Example
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Product Name",
"code": "SKU-123",
"picture_url": "https://example.com/product.jpg",
"description": "This is a product.",
"state": "active",
"team_id": "00000000-0000-0000-0000-000000000000"
}