Application API

For partner applications: browse merchants and products, hand customers a checkout link, and follow the orders it creates.

Getting started API reference Resources

Merchants Products Categories Reels Checkout tokens Orders States and districts

API reference

Categories

The category tree your merchants actually sell in. Only categories and subcategories with at least one visible product from your merchants appear.

List categories

The whole category tree in one call: every category with at least one visible product from your merchants, with its subcategories nested. Empty subcategories are omitted, and a category left with none is omitted entirely. Prefer this over calling /categories and /sub-categories separately.

GET /api/third-party/v1/applications/categories

Signed

Query parameters

Field	Type	Required	Description
`query`	string	Optional	Search on the category name (max 255).
`with_products`	boolean	Optional	1 → embed up to products_size products per subcategory, from your merchants only.
`products_size`	integer	Optional	Products per subcategory when with_products=1. Default 7, max 20.
`page`	integer	Optional	Default 1.
`page_size`	integer	Optional	Default 100, max 100.

One category

{
    "id": 3,
    "name": "Electronics",
    "slug": "electronics",
    "is_active": 1,
    "image": "https://.../cat.png",
    "icon": "https://.../icon.png",
    "description": "…",
    "products_count": 42,
    "subcategories": [
        {
            "id": 17,
            "category_id": 3,
            "name": "Phones",
            "slug": "phones",
            "is_active": 1,
            "products_count": 12,
            "products": []
        }
    ]
}

Notes

products_count, on both levels, counts only visible products from your merchants.
With with_products=1, each subcategory's products holds its newest products, respecting each merchant's configured order.

List sub-categories

Subcategories with at least one visible product from your merchants.

Most integrations only need List categories, which returns these nested. This flat listing is for paginating subcategories directly.

GET /api/third-party/v1/applications/sub-categories

Signed

Query parameters

Field	Type	Required	Description
`query`	string	Optional	Search on the subcategory name (max 255).
`categories`	integer[]	Optional	Array form, unlike /products: ?categories[]=1&categories[]=3. Each must be an existing category.
`with_products`	boolean	Optional	1 → embed up to 7 products per subcategory, from your merchants. The count is fixed.
`page`	integer	Optional	Default 1.
`page_size`	integer	Optional	Default 4, max 100.

One sub-category

{
    "id": 17,
    "category_id": 3,
    "category": {
        "id": 3,
        "name": "Electronics",
        "slug": "electronics"
    },
    "name": "Phones",
    "slug": "phones",
    "is_active": 1,
    "image": "https://.../sub.png",
    "description": "…",
    "products_count": 12,
    "products": []
}

Previous Products Next Reels