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

Merchants

Your merchants, subject to the visibility model, ordered alphabetically by name — or nearest-first when a location is given.

List merchants

Subject to the visibility model.

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

Signed

Query parameters

Field	Type	Required	Description
`q`	string	Optional	Partial match on the merchant name (max 255). Note: q, not query.
`category_id`	integer	Optional	Only merchants linked to this category. Must be an existing category — an unknown id is a 400, not an empty list.
`lat`	number	Optional	Latitude, −90…90. Required together with lng.
`lng`	number	Optional	Longitude, −180…180. Required together with lat.
`distance`	number	Optional	Radius in kilometres, 0.1–1000. Requires lat + lng.
`page`	integer	Optional	Default 1.
`page_size`	integer	Optional	Default 20, max 100.

With lat + lng: results are nearest-first, each item gains distance_km (2 decimals), and merchants with no stored coordinates are excluded.

Response

{
    "data": [
        {
            "id": 42,
            "name": "Sound House",
            "logo": "https://<bucket>/logos/sound-house.png",
            "cover": "https://<bucket>/covers/sound-house.jpg",
            "business_type": "electronics",
            "domain": "soundhouse",
            "state": 5,
            "state_label": "بغداد",
            "district": 2044,
            "district_label": "الكرادة داخل",
            "latitude": 33.3107,
            "longitude": 44.4208,
            "distance_km": 1.42
        }
    ],
    "hasMore": false,
    "totalPages": 1,
    "totalCount": 1
}

Notes

logo and cover are full URLs, ready to render.
distance_km is present only on a proximity search.
state and district are Gini location ids — the same ids /states returns.

Previous Responses and errors Next Products