Skip to main content

Get deployable categories for product deployment

GET 
/v1/categories/deployable

Returns a flat list of leaf categories only (categories without children) that can be used for deploying products to marketplace platforms. *

  • Use Case: Use this endpoint to find the correct category_id when deploying products via /v2/deploy-products.
  • Key Features:
    • Only returns leaf categories - categories that can be used for product deployment
    • Optimized for product deployment workflows
    • Returns flat list with pagination (no nested tree structure)
    • Includes full category path for context
    • Fast performance with eager loading to avoid N+1 queries
    • Supports search and filtering
  • Important Notes:
    • This API always returns leaf categories only (is_leaf=1) - you cannot change this behavior
    • Parent categories (categories with children) cannot be used for product deployment
    • Different platforms have different category structures
    • The is_leaf field in response is calculated dynamically based on whether the category has children
    • Use the category_id field when creating products via deploy API
    • platform_id is REQUIRED - API will return 400 error if not provided

Request​

Responses​

Deployable categories retrieved successfully