Store
Products
Manage your product and category catalog. Products can have inventory control, compare-at prices, taxes and custom metadata.
List categories
GET
/v1/product-categories
Optional parameters: is_active, parent_id (UUID or "root"), limit, page
Create category
POST
/v1/product-categories
Body
{
"name": "Electrónicos",
"description": "Productos electrónicos y gadgets",
"parent_id": null,
"sort_order": 1,
"is_active": true
}
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Category name |
parent_id | uuid | No | Parent category (for subcategories) |
description | string | No | Description |
sort_order | integer | No | Display order |
is_active | boolean | No | Whether it is active (default: true) |
Get / Update / Delete category
GET
/v1/product-categories/{'{id}'}
PATCH
/v1/product-categories/{'{id}'}
DELETE
/v1/product-categories/{'{id}'}
When a category is deleted, its subcategories move to the parent and its products are unlinked.
List products
GET
/v1/products
Optional parameters: status (active, draft, archived), category (UUID), search, featured, in_stock, limit, page
Create product
POST
/v1/products
Body
{
"name": "Laptop Pro 15",
"price": 25999.00,
"currency": "MXN",
"sku": "LAP-PRO-15",
"description": "Laptop profesional de 15 pulgadas",
"product_category_id": "uuid-de-la-categoria",
"track_stock": true,
"stock_quantity": 50,
"tax_rate": 16,
"is_featured": true,
"metadata": {
"brand": "TechCorp",
"warranty_months": 24
}
}
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Product name |
price | number | Yes | Price in decimals (100.00 = $100) |
currency | string | No | ISO 4217 currency (defaults to the account currency) |
status | string | No | active, draft, archived (default: active) |
product_category_id | uuid | No | Category UUID |
sku | string | No | SKU code |
description | string | No | Long description |
compare_at_price | number | No | Compare-at price (before) |
cost_price | number | No | Product cost |
track_stock | boolean | No | Enable inventory control |
stock_quantity | integer | No | Quantity in stock |
tax_rate | number | No | Tax rate (%) |
is_featured | boolean | No | Featured product |
image_url | url | No | Image URL |
metadata | object | No | Custom metadata |
Get / Update / Delete product
GET
/v1/products/{'{id}'}
PATCH
/v1/products/{'{id}'}
DELETE
/v1/products/{'{id}'}
A product with pending orders cannot be deleted.
Was this page helpful?
Thanks for letting us know.