Items

On this page, we'll dive into the different item endpoints you can use to manage Items programmatically. We'll look at how to query, create, update, and delete Items.

The item model

The Item model represents a product available in your store, containing all relevant metadata such as pricing, categorization, and inventory tracking. It is associated with a specific project and is designed to support e-commerce or catalog-based systems within the Botu ecosystem.

Properties

Name
id
Type
uuid
Description
Unique identifier for the item in the Botu ecosystem.
Name
sku
Type
string?
Description
Store-specific stock keeping unit (SKU) for the item.
Name
name
Type
string
Description
Name of the item.
Name
description
Type
string?
Description
Detailed description of the item.
Name
image_url
Type
string?
Description
URL pointing to an image representing the item.
Name
categories
Type
List[string]?
Description
Categories the item belongs to (e.g., ["electronics", "smartphones"]).
Name
tags
Type
List[string]?
Description
Tags for keyword-based filtering or searching.
Name
price
Type
float?
Description
Standard price of the item.
Name
discounted_price
Type
float?
Description
Discounted price for the item, if applicable.
Name
stock
Type
float?
Description
Current stock quantity. Can be null if not tracked.

POST/v1/items

Create an item

This endpoint allows you to add a new item to your catalog in Botu.
Check out: https://api.botu.bot/docs#/Items/create_item_v1_items_post

Request

POST

/v1/items

curl https://api.botu.bot/v1/items \
-H "X-API-Key: YOUR_API_KEY_HERE"

Response

[{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"sku": "string",
"project_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"image_url": "string",
"categories": ["string"],
"tags": ["string"],
"price": 0,
"stock": 0,
"discounted_price": 0,
"created_at": "2025-05-28T10:18:10.832Z",
"updated_at": "2025-05-28T10:18:10.832Z"
}]

GET/v1/items/:id

Retrieve an item

This endpoint allows you to retrieve an item by providing their botu id. Refer to the list at the top of this page to see which properties are included with contact objects.

Request

GET

/v1/items/3fa85f64-5717-4562-b3fc-2c963f66afa6

curl https://api.botu.bot/v1/items/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H "X-API-Key: YOUR_API_KEY_HERE"

Response

{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sku": "string",
    "name": "string",
    "description": "string",
    "image_url": "string",
    "categories": ["string"],
    "tags": ["string"],
    "price": 0,
    "stock": 0,
    "discounted_price": 0,
    "created_at": "2025-05-28T10:18:10.832Z",
    "updated_at": "2025-05-28T10:18:10.832Z"
}

PUT/v1/items/:id

Update an item

This endpoint allows you to perform an update on an item.

Try Out: https://api.botu.bot/docs#/Items/update_item_v1_items__item_id__put

Optional attributes

Name
sku
Type
string
Description
Name
name
Type
string
Description
Name
description
Type
string
Description
Name
image_url
Type
string
Description
Name
categories
Type
List[string]
Description
Name
tags
Type
List[string]
Description
Name
price
Type
float
Description
Name
discounted_price
Type
float
Description
Name
stock
Type
float
Description

Request

PUT

/v1/items/3fa85f64-5717-4562-b3fc-2c963f66afa6

curl -X PUT https://api.botu.bot/v1/items/3fa85f64-5717-4562-b3fc-2c963f66afa6 \
-H "X-API-Key: YOUR_API_KEY_HERE"

Response

{
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "sku": "string",
    "name": "string",
    "description": "string",
    "image_url": "string",
    "categories": ["string"],
    "tags": ["string"],
    "price": 0,
    "stock": 0,
    "discounted_price": 0,
    "created_at": "2025-05-28T10:18:10.832Z",
    "updated_at": "2025-05-28T10:18:10.832Z"
}

DELETE/v1/items/:id

Delete an item

This endpoint allows you to delete Items from your project knowledgebase in botu.

Request

DELETE

/v1/items/d7108faa-440e-4bca-ab2a-7421090d3988

curl -X DELETE https://api.botu.bot/v1/items/d7108faa-440e-4bca-ab2a-7421090d3988 \
-H "X-API-Key: YOUR_API_KEY_HERE"