General
Server Side SDKs
Core API
curl --request POST \
--url https://api.rootfi.dev/v4/payments/items \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"company_id": 123,
"name": "<string>",
"price": 123,
"currency_id": "<string>",
"description": "<string>",
"sku": "<string>",
"status": "DRAFT",
"variants": [
{
"name": "<string>",
"sku": "<string>",
"price": 123,
"attributes": {}
}
]
}
'{
"rootfi_id": 157,
"rootfi_created_at": "2024-01-22T05:07:31.465Z",
"rootfi_updated_at": "2024-01-22T05:07:31.000Z",
"rootfi_company_id": 1089,
"platform_id": "123456",
"rootfi_deleted_at": "2023-11-07T05:31:56Z",
"platform_unique_id": "<string>",
"raw_data": {},
"data_hash": "<string>",
"name": "<string>",
"description": "<string>",
"sku": "<string>",
"price": 123,
"currency_id": "<string>",
"type": "INVENTORY",
"status": "DRAFT",
"created_at": "<string>",
"updated_at": "<string>",
"variants": [
{
"rootfi_id": 123,
"platform_id": "<string>",
"name": "<string>",
"sku": "<string>",
"price": 123,
"attributes": {}
}
]
}Create Item
Create a new item (product or service) in the catalog.
curl --request POST \
--url https://api.rootfi.dev/v4/payments/items \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"company_id": 123,
"name": "<string>",
"price": 123,
"currency_id": "<string>",
"description": "<string>",
"sku": "<string>",
"status": "DRAFT",
"variants": [
{
"name": "<string>",
"sku": "<string>",
"price": 123,
"attributes": {}
}
]
}
'{
"rootfi_id": 157,
"rootfi_created_at": "2024-01-22T05:07:31.465Z",
"rootfi_updated_at": "2024-01-22T05:07:31.000Z",
"rootfi_company_id": 1089,
"platform_id": "123456",
"rootfi_deleted_at": "2023-11-07T05:31:56Z",
"platform_unique_id": "<string>",
"raw_data": {},
"data_hash": "<string>",
"name": "<string>",
"description": "<string>",
"sku": "<string>",
"price": 123,
"currency_id": "<string>",
"type": "INVENTORY",
"status": "DRAFT",
"created_at": "<string>",
"updated_at": "<string>",
"variants": [
{
"rootfi_id": 123,
"platform_id": "<string>",
"name": "<string>",
"sku": "<string>",
"price": 123,
"attributes": {}
}
]
}Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Display name of the item |
| description | string | No | Detailed description |
| sku | string | No | Stock Keeping Unit code |
| price | number | Yes | Base price for this item |
| currency_id | string | Yes | ISO 4217 currency code |
| status | string | No | Item status (default: active) |
| variants | array | No | Product variants |
Variant Fields
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Variant name (e.g., “Monthly”, “Annual”) |
| sku | string | No | Variant-specific SKU |
| price | number | No | Variant price (if different from base) |
| attributes | object | No | Key-value attributes |
Authorizations
Body
Response
Item created successfully
V4 Item model representing products or services with variant support.
The unique ID we assign for that data's information
157
The date at which RootFi first synced this data
"2024-01-22T05:07:31.465Z"
The latest date at which RootFi updated this data
"2024-01-22T05:07:31.000Z"
The ID of the company in the accounting platform
1089
An unique custom RootFi ID made from platform's unique_id.
"123456"
The date at which the data was deleted in the accounting platform
The ID of the data in the accounting platform.
A JSON containing fields that you can directly get from the accounting platform.
The hash of the data
Display name of the item.
Detailed description of the item.
Stock Keeping Unit code.
Base price for this item.
ISO 4217 currency code.
Type of item (INVENTORY, NON_INVENTORY, SERVICE, DIGITAL, UNKNOWN).
INVENTORY, NON_INVENTORY, SERVICE, DIGITAL, UNKNOWN Item availability status (DRAFT, ACTIVE, ARCHIVED, UNKNOWN).
DRAFT, ACTIVE, ARCHIVED, UNKNOWN Original creation timestamp (ISO 8601).
Last update timestamp (ISO 8601).
Product variants with different pricing/attributes.
Show child attributes
Show child attributes