Brands Lookup

This endpoint fetches all brands available in the Pagamio VAS system. It is useful for filtering products by brand or displaying brand options dynamically in your application.

---

Path: POST BASE_URL/lookups/brands

Authorization: Bearer <YOUR_BEARER_TOKEN>

---

Description

• Returns a list of all brands registered in the system.
• Each brand includes a unique ID, code, description, and metadata fields.
• Useful for building brand filters, dropdowns, or selection components in your frontend.

---

Response Structure

[
    {
        "id": 1001,
        "createdById": 1000,
        "lastModifiedById": null,
        "createdDate": "2025-07-14T09:11:18.129716",
        "lastModifiedDate": null,
        "state": 1,
        "code": "VM",
        "description": "Vodacom",
        "type": "BRAND",
        "parentId": null
    },
    {
        "id": 1002,
        "createdById": 1000,
        "lastModifiedById": null,
        "createdDate": "2025-07-14T09:11:18.129716",
        "lastModifiedDate": null,
        "state": 1,
        "code": "TLK",
        "description": "Telkom",
        "type": "BRAND",
        "parentId": null
    },
    {
        "id": 1003,
        "createdById": 1000,
        "lastModifiedById": null,
        "createdDate": "2025-07-14T09:11:18.129716",
        "lastModifiedDate": null,
        "state": 1,
        "code": "MTN",
        "description": "MTN",
        "type": "BRAND",
        "parentId": null
    }
]

---

Fields Explained

Field	Type	Description
id	number	Unique identifier for the brand
createdById	number	ID of the user who created the brand
lastModifiedById	number	ID of the user who last modified the brand
createdDate	string	ISO 8601 timestamp of brand creation
lastModifiedDate	string	ISO 8601 timestamp of last modification
state	int	Brand state (1 = active, 0 = inactive)
code	string	Short code for the brand (used in product mappings)
description	string	Full name or description of the brand
type	string	Type of lookup (always BRAND for this endpoint)
parentId	number	If the brand is part of a parent group, the parent ID; otherwise null

---

Notes

1. Always include the Authorization Bearer token in your request headers.
2. Use this endpoint to populate brand filters or dropdowns when fetching products by brand.
3. The state field helps filter out inactive brands programmatically.
4. The code field can be used in product mappings or internal integrations.

---

Last updated: March 2026