Catalog API Documentation
Rzain Team
Domains
4
Endpoints
45+
Auth
Bearer Token
Categories
| Method | Path | Description |
|---|---|---|
GET | /categories | List categories (pagination, filters) |
GET | /categories/tree | Get categories as hierarchical tree |
GET | /categories/{id} | Get single category details |
GET | /categories/{id}/children | Get direct children of a category |
POST | /categories | Create a new category |
PUT | /categories/{id} | Update existing category |
DELETE | /categories/{id} | Soft-delete category |
POST | /categories/{id}/restore | Restore a soft-deleted category |
POST | /categories/bulk/delete | Bulk soft-delete categories |
Inventory
| Method | Path | Description |
|---|---|---|
GET | /warehouses | List warehouses |
GET | /warehouses/{id} | Get warehouse |
POST | /warehouses | Create warehouse |
PUT | /warehouses/{id} | Update warehouse |
DELETE | /warehouses/{id} | Delete (soft) warehouse |
POST | /warehouses/{id}/restore | Restore warehouse |
GET | /warehouses/active/list | List active warehouses |
GET | /warehouses/search | Search warehouses |
POST | /warehouses/bulk/delete | Bulk delete warehouses |
GET | /inventory | List inventory records |
GET | /inventory/{id} | Get inventory record |
POST | /inventory | Create inventory record |
PUT | /inventory/{id} | Update inventory record |
DELETE | /inventory/{id} | Delete inventory record |
POST | /inventory/{id}/restore | Restore inventory record |
GET | /inventory/warehouse/{id} | Get inventory by warehouse |
GET | /inventory/variant/{id} | Get inventory by variant |
GET | /inventory/low-stock | Low stock items |
POST | /inventory/{id}/adjust | Adjust inventory quantity |
POST | /inventory/bulk/delete | Bulk delete inventory |
GET | /transactions | List transactions |
GET | /transactions/{id} | Get transaction |
POST | /transactions | Create transaction |
PUT | /transactions/{id} | Update transaction |
DELETE | /transactions/{id} | Delete transaction |
POST | /transactions/{id}/restore | Restore transaction |
GET | /transactions/by-type/{type} | Transactions by type |
GET | /transactions/warehouse/{id} | Transactions by warehouse |
GET | /transactions/date-range | Transactions by date range |
POST | /transactions/bulk/delete | Bulk delete transactions |
Products
| Method | Path | Description |
|---|---|---|
GET | /attribute-groups | List attribute groups |
POST | /attribute-groups | Create attribute group |
GET | /attribute-groups/{id} | Get attribute group |
PUT | /attribute-groups/{id} | Update attribute group |
DELETE | /attribute-groups/{id} | Delete attribute group |
GET | /attribute-groups/search | Search attribute groups |
GET | /attribute-groups/{id}/stats | Get attribute group stats |
POST | /attribute-groups/{id}/duplicate | Duplicate attribute group |
GET | /attributes | List attributes |
POST | /attributes | Create attribute |
GET | /attributes/{id} | Get attribute |
PUT | /attributes/{id} | Update attribute |
DELETE | /attributes/{id} | Delete attribute |
GET | /attributes/filterable | Get filterable attributes |
GET | /attributes/search | Search attributes |
GET | /attribute-options | List attribute options |
POST | /attribute-options | Create attribute option |
GET | /attribute-options/{id} | Get attribute option |
PUT | /attribute-options/{id} | Update attribute option |
DELETE | /attribute-options/{id} | Delete attribute option |
POST | /attribute-options/batch-create | Batch create options |
POST | /attribute-options/reorder | Reorder options |
GET | /attribute-options/search | Search attribute options |
GET | /products | List products |
POST | /products | Create product |
GET | /products/{id} | Get product |
PUT | /products/{id} | Update product |
DELETE | /products/{id} | Soft-delete product |
POST | /products/{id}/restore | Restore product |
DELETE | /products/{id}/force-delete | Force delete product |
DELETE | /products/bulk-delete | Bulk delete products |
POST | /products/bulk-restore | Bulk restore products |
DELETE | /products/bulk-force-delete | Bulk force delete products |
GET | /product-variants | List product variants |
POST | /product-variants | Create product variant |
GET | /product-variants/{id} | Get product variant |
PUT | /product-variants/{id} | Update product variant |
DELETE | /product-variants/{id} | Delete product variant |
GET | /product-variant-groups | List variant groups |
POST | /product-variant-groups | Create variant group |
GET | /price-types | List price types |
POST | /price-types | Create price type |
GET | /product-aliases | List product aliases |
POST | /product-aliases | Create product alias |
Units
| Method | Path | Description |
|---|---|---|
GET | /units | List units |
POST | /units | Create unit |
GET | /units/{id} | Get unit |
PUT | /units/{id} | Update unit |
DELETE | /units/{id} | Delete (soft) unit |
GET | /unit-categories | List unit categories |
POST | /unit-categories | Create unit category |
GET | /unit-categories/{id} | Get unit category |
PUT | /unit-categories/{id} | Update unit category |
DELETE | /unit-categories/{id} | Delete unit category |
GET | /unit-conversions | List unit conversions |
POST | /unit-conversions | Create unit conversion |
GET | /unit-conversions/{id} | Get unit conversion |
PUT | /unit-conversions/{id} | Update unit conversion |
DELETE | /unit-conversions/{id} | Delete unit conversion |