# Zochil API

## Docs

- [Modules & Services](https://docs-kfhye.zochil.dev/docs/architecture/modules.md): Understanding the module structure and service organization
- [Architecture Overview](https://docs-kfhye.zochil.dev/docs/architecture/overview.md): Understanding the Zochil Platform architecture and design principles
- [Microservices Architecture](https://docs-kfhye.zochil.dev/docs/architecture/services.md): Overview of individual services and their responsibilities
- [Development Setup](https://docs-kfhye.zochil.dev/docs/development.md): Set up your local development environment for the Zochil API
- [Authentication](https://docs-kfhye.zochil.dev/docs/essentials/authentication.md): Learn how to authenticate with the Zochil API using access tokens and device IDs
- [Error Handling](https://docs-kfhye.zochil.dev/docs/essentials/errors.md): Understanding API error responses and how to handle them effectively
- [Pagination](https://docs-kfhye.zochil.dev/docs/essentials/pagination.md): Learn how to navigate through large datasets using pagination
- [Webhooks](https://docs-kfhye.zochil.dev/docs/essentials/webhooks.md): Set up real-time notifications using webhooks
- [Best Practices](https://docs-kfhye.zochil.dev/docs/guide/best-practices.md): Development best practices and guidelines for Zochil API
- [Code Style & Conventions](https://docs-kfhye.zochil.dev/docs/guide/code-style.md): Coding standards and conventions for Zochil API development
- [API Testing with Bruno](https://docs-kfhye.zochil.dev/docs/guide/testing.md): Comprehensive guide to testing APIs using Bruno collections
- [Introduction](https://docs-kfhye.zochil.dev/docs/introduction.md): Welcome to the Zochil API documentation. Build powerful e-commerce applications with our comprehensive API suite.
- [Quickstart](https://docs-kfhye.zochil.dev/docs/quickstart.md): Start building with the Zochil API in under 5 minutes
- [Login with password](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/authentication/login-with-password.md): Authenticate marketplace admin with username and password
- [Create marketplace banner](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/banners/create-marketplace-banner.md): Create a new banner for a marketplace
- [Get marketplace banner detail](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/banners/get-marketplace-banner-detail.md)
- [List marketplace banners](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/banners/list-marketplace-banners.md): Get a paginated list of banners for a specific marketplace
- [Remove marketplace banner](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/banners/remove-marketplace-banner.md): Remove a marketplace banner
- [Update marketplace banner](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/banners/update-marketplace-banner.md): Update an existing marketplace banner
- [List marketplace campaigns](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/campaigns/list-marketplace-campaigns.md): Get a list of marketplace campaigns
- [Create product main category](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/categories/create-product-main-category.md): Create a new product main category
- [Find child categories](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/categories/find-child-categories.md): Find child categories for a given parent category
- [Get categories by IDs](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/categories/get-categories-by-ids.md): Get categories by providing an array of IDs
- [Get category detail](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/categories/get-category-detail.md)
- [List all categories](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/categories/list-all-categories.md): Get all product main categories without pagination
- [List product main categories](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/categories/list-product-main-categories.md): Get a paginated list of product main categories
- [Remove category](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/categories/remove-category.md): Remove a product main category
- [Search categories](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/categories/search-categories.md): Search categories by various criteria
- [Update category](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/categories/update-category.md): Update an existing product main category
- [Change admin password](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplace-admins/change-admin-password.md): Change current admin's password
- [Create marketplace admin](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplace-admins/create-marketplace-admin.md): Create a new marketplace administrator
- [Get current admin detail](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplace-admins/get-current-admin-detail.md): Get current authenticated admin details
- [Get marketplace admin detail](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplace-admins/get-marketplace-admin-detail.md)
- [List marketplace admins](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplace-admins/list-marketplace-admins.md): Get a paginated list of marketplace administrators
- [Remove marketplace admin](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplace-admins/remove-marketplace-admin.md): Remove a marketplace administrator
- [Update marketplace admin](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplace-admins/update-marketplace-admin.md): Update marketplace administrator information
- [Activate marketplace](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplaces/activate-marketplace.md): Activate a marketplace
- [Archive marketplace](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplaces/archive-marketplace.md): Archive a marketplace
- [Create marketplace](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplaces/create-marketplace.md): Create a new marketplace
- [Create marketplace admin](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplaces/create-marketplace-admin.md): Create an admin user for a marketplace
- [Get marketplace detail](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplaces/get-marketplace-detail.md): Get detailed information about a specific marketplace
- [List marketplaces](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplaces/list-marketplaces.md): Get a paginated list of marketplaces
- [Remove marketplace option](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplaces/remove-marketplace-option.md): Remove a specific option from marketplace configuration
- [Update marketplace](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplaces/update-marketplace.md): Update an existing marketplace
- [Update marketplace options](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/marketplaces/update-marketplace-options.md): Update marketplace options and configurations
- [List main menu categories](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/menu-categories/list-main-menu-categories.md): Get a list of main menu categories
- [List kool merchants](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/merchants/list-kool-merchants.md): Get a paginated list of kool merchants
- [List notifications](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/notifications/list-notifications.md): Get a list of notifications
- [Get marketplace order detail](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/orders/get-marketplace-order-detail.md)
- [List marketplace orders](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/orders/list-marketplace-orders.md): Get a paginated list of marketplace orders
- [Create preorder admin user](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/preorder-admin-users/create-preorder-admin-user.md): Create a new preorder admin user with PIN authentication
- [Get preorder admin user detail](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/preorder-admin-users/get-preorder-admin-user-detail.md): Get detailed information about a specific preorder admin user
- [List preorder admin users](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/preorder-admin-users/list-preorder-admin-users.md): Get a paginated list of preorder admin users
- [Remove preorder admin user](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/preorder-admin-users/remove-preorder-admin-user.md): Remove a preorder admin user
- [Update preorder admin user](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/preorder-admin-users/update-preorder-admin-user.md): Update an existing preorder admin user
- [Get marketplace product detail](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/products/get-marketplace-product-detail.md)
- [List marketplace products](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/products/list-marketplace-products.md): Get a paginated list of marketplace products
- [Remove marketplace product](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/products/remove-marketplace-product.md): Remove a marketplace product
- [Remove selected products](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/products/remove-selected-products.md): Remove multiple selected products
- [Sync products to Elasticsearch](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/products/sync-products-to-elasticsearch.md): Sync marketplace products to Elasticsearch
- [Update marketplace product](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/products/update-marketplace-product.md): Update an existing marketplace product
- [Update product main category](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/products/update-product-main-category.md): Update main category for multiple products
- [Change password](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/profile/change-password.md): Alias for /marketplace-admins/change-password
- [Get admin profile](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/profile/get-admin-profile.md): Alias for /marketplace-admins/detail
- [List reports](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/reporting/list-reports.md): Get a list of available reports
- [Create shipment invoice](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipment-invoices/create-shipment-invoice.md): Create a new invoice for a shipment
- [List shipment invoices](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipment-invoices/list-shipment-invoices.md): Get a paginated list of shipment invoices
- [Remove shipment invoice](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipment-invoices/remove-shipment-invoice.md): Remove a shipment invoice
- [Update shipment invoice](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipment-invoices/update-shipment-invoice.md): Update an existing shipment invoice
- [Create shipment activity](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipments/create-shipment-activity.md): Create a new activity for a shipment
- [Create shipment for order](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipments/create-shipment-for-order.md): Create a new shipment for an order with tracking number
- [Create shipment with tracking](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipments/create-shipment-with-tracking.md): Create a new shipment for received package with auto-generated tracking number and barcode
- [Export shipments](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipments/export-shipments.md): Export shipments data
- [Get shipment activities](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipments/get-shipment-activities.md): Get activities for a specific shipment
- [Lookup order by code](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipments/lookup-order-by-code.md): Find order information by order code for shipment creation
- [Receive shipments](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipments/receive-shipments.md): Mark shipments as received
- [Update package information](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/shipments/update-package-information.md): Update package weight and price for a shipment
- [List marketplace subscriptions](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/subscriptions/list-marketplace-subscriptions.md): Get a paginated list of marketplace subscriptions
- [Create user](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/users/create-user.md): Create a new user account
- [List users](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/users/list-users.md): Get a paginated list of users
- [Remove user](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/users/remove-user.md): Remove a user account
- [Update user](https://docs-kfhye.zochil.dev/marketplace-monitoring-api/users/update-user.md): Update an existing user account
- [Create admin](https://docs-kfhye.zochil.dev/monitoring-api/admin-management/create-admin.md): Create a new administrator
- [Get admin detail](https://docs-kfhye.zochil.dev/monitoring-api/admin-management/get-admin-detail.md): Get detailed information about a specific administrator
- [List admins](https://docs-kfhye.zochil.dev/monitoring-api/admin-management/list-admins.md): Get a paginated list of administrators
- [Remove admin](https://docs-kfhye.zochil.dev/monitoring-api/admin-management/remove-admin.md): Remove an administrator
- [Update admin](https://docs-kfhye.zochil.dev/monitoring-api/admin-management/update-admin.md): Update administrator information
- [Login with password](https://docs-kfhye.zochil.dev/monitoring-api/authentication/login-with-password.md): Authenticate admin user with username and password
- [Change password](https://docs-kfhye.zochil.dev/monitoring-api/profile/change-password.md): Change current admin password
- [Get admin profile](https://docs-kfhye.zochil.dev/monitoring-api/profile/get-admin-profile.md): Get current authenticated admin profile details

## OpenAPI Specs

- [marketplace-monitoring](https://docs-kfhye.zochil.dev/docs/api-reference/marketplace-monitoring.yaml)
- [general-monitoring](https://docs-kfhye.zochil.dev/docs/api-reference/general-monitoring.yaml)
- [openapi-marketplace-monitoring](https://docs-kfhye.zochil.dev/docs/openapi-marketplace-monitoring.yaml)
- [openapi-general-monitoring](https://docs-kfhye.zochil.dev/docs/openapi-general-monitoring.yaml)
- [openapi](https://docs-kfhye.zochil.dev/docs/openapi.yaml)