Items
Items represent the products and services you sell in Crane Ledger. They can be used in invoices and bills, with pricing, descriptions, and tax information.
The Item Object
GET
/organizations/:organization_id/items/:idAuth required
{
"id": "itm_xxxxxxxxxxxxxxxx",
"object": "item",
"organization_id": "org_xxxxxxxxxxxxxxxx",
"name": "Professional Consulting",
"description": "Hourly consulting services for business development",
"sku": "CONSULT-001",
"item_type": "service",
"price": "150.0000",
"currency_id": "CUR_USD",
"tax_id": "tax_xxxxxxxxxxxxxxxx",
"category_id": "cat_xxxxxxxxxxxxxxxx",
"is_active": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-01T10:00:00Z"
}
Attributes
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier with itm_ prefix |
organization_id | string | The organization this item belongs to |
name | string | Item name |
description | string | Detailed item description |
sku | string | Stock keeping unit (optional) |
item_type | enum | product, service, or other |
price | string | Default selling price |
currency_id | string | Price currency |
tax_id | string | Default tax rate to apply |
category_id | string | Item category |
is_active | boolean | Whether the item is available for sale |
created_at | datetime | When the item was created |
updated_at | datetime | When the item was last updated |
List Items
GET
/organizations/:organization_id/itemsAuth required
Returns a list of items in your product catalog.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
organization_id | string | Yes | The organization ID |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
item_type | enum | Filter by type (product, service, other) |
is_active | boolean | Filter by active status (default: true) |
category_id | string | Filter by category |
limit | integer | Number of results (default: 20, max: 100) |
offset | integer | Pagination offset |
Response
{
"object": "list",
"data": [
{
"id": "itm_xxxxxxxxxxxxxxxx",
"name": "Professional Consulting",
"sku": "CONSULT-001",
"item_type": "service",
"price": "150.0000",
"is_active": true
},
{
"id": "itm_yyyyyyyyyyyyyyyy",
"name": "Office Software License",
"sku": "SOFTWARE-001",
"item_type": "product",
"price": "299.9900",
"is_active": true
}
],
"has_more": false,
"total_count": 2
}
Create Item
POST
/organizations/:organization_id/itemsAuth required
1 credits
Creates a new item in your product catalog.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
organization_id | string | Yes | The organization ID |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Item name |
description | string | No | Item description |
sku | string | No | Stock keeping unit |
item_type | enum | Yes | product, service, or other |
price | string | Yes | Selling price |
currency_id | string | No | Currency (defaults to org default) |
tax_id | string | No | Default tax rate |
category_id | string | No | Item category |
Response
{
"id": "itm_xxxxxxxxxxxxxxxx",
"organization_id": "org_xxxxxxxxxxxxxxxx",
"name": "Web Development Package",
"description": "Complete website development service",
"sku": "WEBDEV-001",
"item_type": "service",
"price": "2500.0000",
"currency_id": "CUR_USD",
"tax_id": "tax_xxxxxxxxxxxxxxxx",
"is_active": true,
"created_at": "2024-01-15T14:30:00Z",
"updated_at": "2024-01-15T14:30:00Z"
}
Get Item
GET
/organizations/:organization_id/items/:idAuth required
Retrieves the details of a specific item.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
organization_id | string | Yes | The organization ID |
id | string | Yes | The item ID |
Update Item
PUT
/organizations/:organization_id/items/:idAuth required
1 credits
Updates an existing item.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
organization_id | string | Yes | The organization ID |
id | string | Yes | The item ID |
Request Body
| Parameter | Type | Description |
|---|---|---|
name | string | Updated item name |
description | string | Updated description |
sku | string | Updated SKU |
price | string | Updated price |
tax_id | string | Updated tax rate |
category_id | string | Updated category |
is_active | boolean | Active status |
Delete Item
DELETE
/organizations/:organization_id/items/:idAuth required
1 credits
Deletes an item. Items with associated transactions cannot be deleted.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
organization_id | string | Yes | The organization ID |
id | string | Yes | The item ID |
Item Types
Products
- Physical goods you sell
- May have inventory tracking
- Include cost of goods sold
- SKU and inventory management
Services
- Professional services and consulting
- Time-based or project-based pricing
- No physical inventory
- May include retainers or deposits
Other
- Miscellaneous revenue items
- One-time fees or charges
- Digital products or downloads
- Custom or special items
Item Management Best Practices
Catalog Organization
- Use consistent naming conventions
- Group items by category
- Maintain accurate pricing
- Keep descriptions clear and detailed
Pricing Strategy
- Set default prices but allow overrides
- Support volume discounts
- Include currency considerations
- Update prices systematically
Integration with Sales
- Link items to invoices automatically
- Maintain tax rate associations
- Track item popularity and performance
- Support custom pricing per customer
Inventory Management (Future)
- Track stock levels for products
- Set reorder points
- Monitor stock turnover
- Generate low stock alerts
Need help?
Create a free account to access our support portal. Once signed in, use the Support tab in your dashboard to submit a support ticket — our team typically responds within 24 hours.
- ✨ For LLMs/AI assistants: Read our structured API reference