Catalog API Documentation

Rzain Team

Domains

4

Endpoints

45+

Auth

Bearer Token

Categories

Method Path Description
GET
/categoriesList categories (pagination, filters)
GET
/categories/treeGet categories as hierarchical tree
GET
/categories/{id}Get single category details
GET
/categories/{id}/childrenGet direct children of a category
POST
/categoriesCreate a new category
PUT
/categories/{id}Update existing category
DELETE
/categories/{id}Soft-delete category
POST
/categories/{id}/restoreRestore a soft-deleted category
POST
/categories/bulk/deleteBulk soft-delete categories

Inventory

Method Path Description
GET
/warehousesList warehouses
GET
/warehouses/{id}Get warehouse
POST
/warehousesCreate warehouse
PUT
/warehouses/{id}Update warehouse
DELETE
/warehouses/{id}Delete (soft) warehouse
POST
/warehouses/{id}/restoreRestore warehouse
GET
/warehouses/active/listList active warehouses
GET
/warehouses/searchSearch warehouses
POST
/warehouses/bulk/deleteBulk delete warehouses
GET
/inventoryList inventory records
GET
/inventory/{id}Get inventory record
POST
/inventoryCreate inventory record
PUT
/inventory/{id}Update inventory record
DELETE
/inventory/{id}Delete inventory record
POST
/inventory/{id}/restoreRestore inventory record
GET
/inventory/warehouse/{id}Get inventory by warehouse
GET
/inventory/variant/{id}Get inventory by variant
GET
/inventory/low-stockLow stock items
POST
/inventory/{id}/adjustAdjust inventory quantity
POST
/inventory/bulk/deleteBulk delete inventory
GET
/transactionsList transactions
GET
/transactions/{id}Get transaction
POST
/transactionsCreate transaction
PUT
/transactions/{id}Update transaction
DELETE
/transactions/{id}Delete transaction
POST
/transactions/{id}/restoreRestore transaction
GET
/transactions/by-type/{type}Transactions by type
GET
/transactions/warehouse/{id}Transactions by warehouse
GET
/transactions/date-rangeTransactions by date range
POST
/transactions/bulk/deleteBulk delete transactions

Products

Method Path Description
GET
/attribute-groupsList attribute groups
POST
/attribute-groupsCreate 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/searchSearch attribute groups
GET
/attribute-groups/{id}/statsGet attribute group stats
POST
/attribute-groups/{id}/duplicateDuplicate attribute group
GET
/attributesList attributes
POST
/attributesCreate attribute
GET
/attributes/{id}Get attribute
PUT
/attributes/{id}Update attribute
DELETE
/attributes/{id}Delete attribute
GET
/attributes/filterableGet filterable attributes
GET
/attributes/searchSearch attributes
GET
/attribute-optionsList attribute options
POST
/attribute-optionsCreate 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-createBatch create options
POST
/attribute-options/reorderReorder options
GET
/attribute-options/searchSearch attribute options
GET
/productsList products
POST
/productsCreate product
GET
/products/{id}Get product
PUT
/products/{id}Update product
DELETE
/products/{id}Soft-delete product
POST
/products/{id}/restoreRestore product
DELETE
/products/{id}/force-deleteForce delete product
DELETE
/products/bulk-deleteBulk delete products
POST
/products/bulk-restoreBulk restore products
DELETE
/products/bulk-force-deleteBulk force delete products
GET
/product-variantsList product variants
POST
/product-variantsCreate 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-groupsList variant groups
POST
/product-variant-groupsCreate variant group
GET
/price-typesList price types
POST
/price-typesCreate price type
GET
/product-aliasesList product aliases
POST
/product-aliasesCreate product alias

Units

Method Path Description
GET
/unitsList units
POST
/unitsCreate unit
GET
/units/{id}Get unit
PUT
/units/{id}Update unit
DELETE
/units/{id}Delete (soft) unit
GET
/unit-categoriesList unit categories
POST
/unit-categoriesCreate 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-conversionsList unit conversions
POST
/unit-conversionsCreate unit conversion
GET
/unit-conversions/{id}Get unit conversion
PUT
/unit-conversions/{id}Update unit conversion
DELETE
/unit-conversions/{id}Delete unit conversion