GET /products
Lists all products for the workspace
curl -X GET "https://api.us-west-2.fragment.dev/products" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json"{
"data": [
{
"id": "product_1234567890",
"workspaceId": "ws_1234567890",
"code": "PROD_001",
"description": "Premium subscription service",
"paid_by_roles": [
{
"name": "buyer",
"id": "role_def123"
}
],
"paid_to_roles": [
{
"name": "buyer",
"id": "role_def123"
}
],
"updateVersion": 1,
"created": "2024-01-13T00:00:00Z"
}
]
}POST /products
Creates a new product
curl -X POST "https://api.us-west-2.fragment.dev/products" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{"code":"PROD_001","description":"Premium subscription service","paid_by_roles":[{"name":"buyer"}],"paid_to_roles":[{"name":"seller"}]}'{
"data": {
"id": "product_1234567890",
"workspaceId": "ws_1234567890",
"code": "PROD_001",
"description": "Premium subscription service",
"paid_by_roles": [
{
"name": "buyer",
"id": "role_def123"
}
],
"paid_to_roles": [
{
"name": "buyer",
"id": "role_def123"
}
],
"updateVersion": 1,
"created": "2024-01-13T00:00:00Z"
}
}| Name | Description |
|---|---|
| code (required) - string | Product code (unique identifier) |
| description (required) - string | Description of the product |
| paid_by_roles - array | Roles that can pay for this product. Reference roles by id or name. At least one of paid_by_roles or paid_to_roles must be provided. |
| paid_to_roles - array | Roles that receive payment for this product. Reference roles by id or name. At least one of paid_by_roles or paid_to_roles must be provided. |
GET /products/{code}
Gets a product by code
curl -X GET "https://api.us-west-2.fragment.dev/products/prod_123" \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json"{
"data": {
"id": "product_1234567890",
"workspaceId": "ws_1234567890",
"code": "PROD_001",
"description": "Premium subscription service",
"paid_by_roles": [
{
"name": "buyer",
"id": "role_def123"
}
],
"paid_to_roles": [
{
"name": "buyer",
"id": "role_def123"
}
],
"updateVersion": 1,
"created": "2024-01-13T00:00:00Z"
}
}| Name | Description |
|---|---|
| {code} (required) - string | - |