Create

POST/products

Creates a new product

Body ParametersJSONExpand Collapse

code: string

Product code (unique identifier)

description: string

Description of the product

paid_by_roles: optional array of object { id } or object { name }

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.

Accepts one of the following:

RoleMatchByID = object { id }

id: string

The unique ID of the role

RoleMatchByName = object { name }

The name of the role

paid_to_roles: optional array of object { id } or object { name }

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.

Accepts one of the following:

RoleMatchByID = object { id }

id: string

The unique ID of the role

RoleMatchByName = object { name }

The name of the role

ReturnsExpand Collapse

data: object { id, code, created, 5 more }

Product object

id: string

Unique identifier for the product

code: string

User-defined product identifier.

created: string

ISO 8601 timestamp when the product was created

formatdate-time

description: string

Description of the product

paid_by_roles: array of object { id, name }

User roles that can pay for this product

id: string

The unique ID of the role

The name of the role

paid_to_roles: array of object { id, name }

User roles that receive payment for this product

id: string

The unique ID of the role

The name of the role

updateVersion: number

Version number for optimistic locking

workspaceId: string

Workspace ID this product belongs to

Create

curl https://api.us-west-2.fragment.dev/products \
    -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",
    "code": "PROD_001",
    "created": "2024-01-13T00:00:00Z",
    "description": "Premium subscription service",
    "paid_by_roles": [
      {
        "id": "role_def123",
        "name": "buyer"
      }
    ],
    "paid_to_roles": [
      {
        "id": "role_def123",
        "name": "buyer"
      }
    ],
    "updateVersion": 1,
    "workspaceId": "ws_1234567890"
  }
}

Returns Examples

{
  "data": {
    "id": "product_1234567890",
    "code": "PROD_001",
    "created": "2024-01-13T00:00:00Z",
    "description": "Premium subscription service",
    "paid_by_roles": [
      {
        "id": "role_def123",
        "name": "buyer"
      }
    ],
    "paid_to_roles": [
      {
        "id": "role_def123",
        "name": "buyer"
      }
    ],
    "updateVersion": 1,
    "workspaceId": "ws_1234567890"
  }
}