Brand Partner Guide

This guide explains how Materialogue structures brand and product data. Use it when adding or updating your brand information and product catalog through the Brand Partner API.

Every field is described with its data type, whether it is required or optional, accepted formats, and real examples. Switch to the Simpolo Example tab above to see a fully worked product submission.

Quick Start

To start using the API, you need an API key issued by Materialogue. Once you have it, all requests must include it in the header:

X-API-Key: your-api-key-here
  1. Get your API key from the Materialogue team. Each key is scoped to your brand only — you cannot access or modify another brand's data.
  2. Check your brand profile to see what's currently on file.
  3. Update your profile — only send the fields you want to change.
  4. List your products and start adding or updating.

Brand Profile Fields

Your brand profile is what appears on the Materialogue brand information page. Fields marked Required must be provided for a complete listing.

FieldTypeRequiredDescription & FormatExample
nameStringRequiredYour brand name. Set by Materialogue — cannot be changed via API."Kohler"
logo_urlString (URL)RequiredFull URL to your brand logo. Host it on DigitalOcean Spaces or another CDN. SVG or PNG preferred, transparent background."https://materialogue.blr1.cdn..."
descriptionStringOptionalAbout your brand — history, manufacturing, positioning. Plain text. 100–500 words recommended."Kohler Co. is a global leader..."
hero_imagesArray of StringsOptionalArray of image URLs shown as banners on the brand page. Landscape orientation, minimum 1400px wide.["https://cdn.../hero.jpg"]
headquartersObjectRequiredTwo-line address object with address_line1 and address_line2 — both strings.See below
collectionsArray of ObjectsOptionalEach item has name (string) and cover_image (URL). Sending this replaces the entire list.See Collections section
channel_partnersArray of ObjectsOptionalEach item has state (string) and cities (array of strings). Sending this replaces the entire list.See Channel Partners section
contactObjectRequiredFields: brand_name, address, phone, email — all strings.See below

Complete brand update example

{
  "description": "Kohler Co. is a global leader in kitchen and bath products, founded in 1873.",
  "logo_url": "https://materialogue.blr1.cdn.digitaloceanspaces.com/brands/kohler/logo.svg",
  "hero_images": ["https://materialogue.blr1.cdn.digitaloceanspaces.com/brands/kohler/hero1.jpg"],
  "headquarters": {
    "address_line1": "6th Floor, Corporate Office Tower, Ambience Island, NH-08",
    "address_line2": "Gurugram, Haryana 122001, India"
  },
  "contact": {
    "brand_name": "Kohler India Corporation",
    "address": "6th Floor, Corporate Office Tower, Gurugram, Haryana 122001",
    "phone": "+91 124 4561000",
    "email": "[email protected]"
  }
}

Partial updates: You only need to send the fields you want to change. Omitting a field leaves it unchanged.

Collections

Collections represent your product ranges or lines. They appear on your brand page as visual tiles.

FieldTypeRequiredDescription
nameStringRequiredName of the collection, e.g. "Purist", "Alchimia", "Impatto"
cover_imageString (URL)OptionalCover image URL. Square or portrait preferred. Hosted on DigitalOcean Spaces.
"collections": [
  { "name": "Alchimia",  "cover_image": "https://materialogue.blr1.cdn.digitaloceanspaces.com/brands/simpolo/collections/alchimia.jpg" },
  { "name": "Impatto",   "cover_image": "https://materialogue.blr1.cdn.digitaloceanspaces.com/brands/simpolo/collections/impatto.jpg" },
  { "name": "Basaltino", "cover_image": "" }
]
Full replacement:

Sending collections replaces the entire list. Always include all collections when updating.

Channel Partners

Channel partners show your dealer/distributor network, organised by state and city.

FieldTypeRequiredDescription
stateStringRequiredState name, e.g. "Maharashtra", "Gujarat", "Delhi NCR"
citiesArray of StringsOptionalCities within that state, e.g. ["Mumbai", "Pune", "Nagpur"]
"channel_partners": [
  { "state": "Gujarat",      "cities": ["Ahmedabad", "Surat", "Vadodara", "Rajkot"] },
  { "state": "Maharashtra",  "cities": ["Mumbai", "Pune", "Nagpur"] },
  { "state": "Delhi NCR",    "cities": ["New Delhi", "Noida", "Gurgaon"] }
]
Full replacement:

Sending channel_partners replaces the entire list. Include all states when updating.

Required Product Fields

Every product must have these four fields. If any is missing, the product will be rejected.

FieldTypeDescriptionValid values
categoryStringTop-level product category. Must match exactly (case-sensitive).Walls & Floor · Sanitary · Paints · Surfaces · Fabrics · Lights · Electricals · Hardware
primary_sub_categoryStringSub-category within the main category. See the full Category Taxonomy below.e.g. Tile, Basin Area, Laminate, Fan
secondary_sub_categoryStringSpecific product type within the sub-category.e.g. Porcelain Tile, Wash Basin, Solid Laminate
product_nameStringThe product's display name. Keep it clear and descriptive.e.g. "Alchimia Graphite"
Category values are exact strings.

Use the Category Taxonomy section to find the correct spelling. Use "Walls & Floor" not "Walls and Floor".

Identification & Classification

FieldTypeDescription
product_codeStringYour internal SKU or model number, e.g. "INFB0RX0326". Indexed for fast lookup.
primary_skuStringPrimary SKU if different from product_code.
sku_variationStringVariation identifier for colour/size variants of the same base product. e.g. "1198x1198-Matt"
collectionStringThe collection/range this product belongs to, e.g. "Alchimia".
tagsArray of StringsFree-form search tags, e.g. ["vitrified", "large-format", "concrete-look"].

Descriptions & Pricing

FieldTypeDescription
tagline_descriptionStringA short one-line tagline shown on product cards. Keep under 80 characters.
descriptionStringFull product description. Plain text. No HTML. 50–300 words recommended.
price1NumberPrimary price. A number only — no currency symbols or commas. 850 not "₹850".
unit1StringUnit for price1. Common values below.
price2NumberSecondary price — used for alternate pricing tiers.
unit2StringUnit for price2.

Common unit values

/piece/set/sqft/sqm/mtr/rmt/roll/box/litre/kg/pair

Specification Fields

These fields describe the physical and technical properties of a product. All are optional strings unless noted. Only fill in fields relevant to your product category — see Specs by Category for guidance.

Appearance

color String
color_for_filter String
color_code String
finish String
pattern String
shape String
grain_type String

Physical

size String
thickness String
material String
marble_type String
stone_type String
wood_species String
installation_type String

Lighting / Electrical

wattage String
temperature String
beam_angle String
voltage Number
power_consumption Number
illumination String

Sanitary-specific

faucet_type String
cock_type String
rim_type String
thermostatic Boolean
shower_function String
no_of_outlets Number
water_saving String

Fan / Electrical

sweep_size String
number_of_blades Number
fan_speed Number
air_delivery Number
speed_levels Number
control_method String

Fabrics / Soft Furnishings

martindale Number
pile_height String
roll_size String
curtain_width String
pasting String
nrc_value Number

Paint

paint_type String
color_type String

Hardware / Security

lock_type String
door_thickness String
door_control_system_type String
camera_features String
actuation_type String

Technical Documents

hd_textures_pdf String (URL)
specs_sheet String (URL)
installation_guide String (URL)
special_features String

Product Images

Images are stored as an array of URL strings. All images must be hosted on DigitalOcean Spaces or another publicly accessible CDN before being added to Materialogue.

FieldTypeDescription
imagesArray of StringsArray of image URLs. First image is the primary/thumbnail. Minimum 1 image recommended.
"images": [
  "https://materialogue.blr1.cdn.digitaloceanspaces.com/Images/Simpolo/alchimia-graphite-main.jpg",
  "https://materialogue.blr1.cdn.digitaloceanspaces.com/Images/Simpolo/alchimia-graphite-r1.jpg"
]

Category Taxonomy — Walls & Floor

Use the exact strings below for category, primary_sub_category, and secondary_sub_category.

Walls & Floor
Tile
Ceramic TilePorcelain TileVitrified TileGVT TileGlass Tile
Marble
Italian MarbleIndian MarbleBrazilian MarbleTurkish MarbleSpanish MarbleIranian MarbleExotic Marble
Natural Stone
GraniteLimestoneSandstoneQuartziteTravertineOnyxSlate
Engineered Stone
Composite StoneQuartz SlabSolid SurfaceTerrazzo
Mosaic
Glass MosaicStone MosaicMetal MosaicCeramic MosaicShell Mosaic
Wood Flooring
Solid Wood FlooringEngineered Wood FlooringVinyl Wood FlooringLaminate Wood FlooringReclaimed Wood FlooringOutdoor Deck Flooring
Carpet
Carpet RollCarpet TileRug

Category Taxonomy — Sanitary

Sanitary
Toilet Area
WCToilet SeatFlush TankFlush ValveFlush PlateBidetHealth FaucetAngle ValveBib CockStop CockDrain Cover
Basin Area
Wash BasinBasin FaucetAngle ValveVanityMirror
Shower Area
Shower DiverterShower ArmHand ShowerOverhead ShowerBath SpoutBody ShowerShower Enclosure
Wellness
Bath TubJacuzziBath Tub FaucetSteam Generator
Accessories
Toilet Paper HolderRobe HookTowel HolderTumbler HolderSoap HolderToilet Brush Holder

Category Taxonomy — Paints

Paints
Indoor Paint
WhiteBeigeYellowOrangeRedPinkGreenBluePurpleBrownGreyBlack
Exterior Paint
WhiteBeigeYellowOrangeRedPinkGreenBluePurpleBrownGreyBlack
Wood Coating
Clear CoatSpecial Coat

For paints, secondary_sub_category is the colour family (e.g. "Beige"). The actual shade name goes in product_name.

Category Taxonomy — Surfaces

Surfaces
Veneer
Natural VeneerDyed VeneerReconstituted VeneerDecorative VeneerTextured Veneer
Laminate
Solid LaminateWood LaminateMetallic LaminateMarble LaminateStone LaminateDecorative LaminateFabric LaminateInternal Laminate
Panel
Aluminum Composite PanelCharcoal PanelPVC PanelMetal PanelFiber Cement PanelMDF / HDF PanelHardwood PanelResin Solid Surface PanelAlabaster PanelAcoustic PanelAcrylic PanelNatural Fiber Panel
Rattan / Cane
Natural Rattan/CaneSynthetic Rattan/Cane
Wallpaper
Non-Woven WallpaperVinyl WallpaperFabric WallpaperGrasscloth WallpaperMetallic WallpaperNatural Fibre Wallpaper

Category Taxonomy — Fabrics

Fabrics
Curtain
Sheer CurtainBlackout CurtainEyelet CurtainLinen CurtainVelvet CurtainGeometric CurtainFloral CurtainStriped Curtain
Upholstery
Leather UpholsteryVelvet UpholsteryLinen UpholsteryCotton UpholsteryBrocade UpholsteryJacquard UpholsteryOutdoor Upholstery
Sheer
Plain SheerPrinted SheerEmbroidered Sheer

Category Taxonomy — Lights

Lights
Architectural Light
DownlightSpotlightLinear LightStrip LightCove LightPanel LightTrack LightStep LightOutdoor LightFlood Light
Decorative Light
ChandelierPendant LightWall SconceTable LampFloor LampCeiling LightCluster Light

Category Taxonomy — Electricals

Electricals
Switches & Accessories
SwitchSwitch PlateSocketTouch PanelFan Regulator
Fan
Ceiling FanWall FanTable FanPedestal FanExhaust FanBladeless Fan
Electrical Accessories
Motion SensorPresence SensorNight LightDimmerBuzzerBellInfra Red SensorMosquito RepellantSpeaker

Category Taxonomy — Hardware

Hardware
Architectural Hardware
Mortise HandleMortise LockPull HandlePull KnobWall HookDoor Control System
Digital Solution
Digital Door LockDigital Drawer LockDigital SafeSmart CameraVideo Door Access Control
Glass Solution
Handle for GlassPivot FittingPatch FittingProfile FittingSliding FittingLock - Glass Door
Aluminium Profile
Frame ProfileHandle ProfileEdge Profile

Recommended Specs by Category

These are the fields shown on Materialogue's Selection Sheet and Order Sheet exports. Fill in the relevant fields for accurate export output.

CategorySub-CategorySpec 1Spec 2
Walls & FloorTilesizefinish
Walls & FloorMarblecollectionthickness
Walls & FloorNatural Stonecollectionthickness
Walls & FloorEngineered Stonesizethickness
Walls & FloorWood Flooringsizethickness
Walls & FloorCarpetsizethickness
SanitaryToilet Areacolorfinish
SanitaryBasin Areacolorfinish
SanitaryShower Areacolorfinish
SanitaryWellnesssizefinish
SanitaryAccessoriescolorfinish
SurfacesVeneersizefinish
SurfacesLaminatesizefinish
SurfacesPanelsizepattern
SurfacesRattan / Canesizepattern
SurfacesWallpaperpatternroll_size
PaintsIndoor Paintpaint_typecollection
PaintsExterior Paintpaint_typecollection
PaintsWood Coatingfinishcollection
FabricsCurtaincollectionmaterial
FabricsUpholsterycollectionmaterial
FabricsSheercollectionmaterial
LightsArchitectural Lightcolortemperature
LightsDecorative Lightsizematerial
All othersFirst 2 non-empty from: material, color, finish, size, thickness, wattage, pattern, shape, temperature

Image Guidelines

Images referenced in the API must be publicly accessible URLs. They can be hosted anywhere — on your own CDN, your website, or uploaded to Materialogue's DigitalOcean Spaces (see the Image Upload tab for details).

Image typeRecommended sizeFormatNotes
Brand logoAny (vector preferred)SVG or PNG (transparent bg)Used in headers and brand listings
Brand hero bannerMin 1400 × 600pxJPG or WebPLandscape. Full-width banner on brand page.
Collection cover600 × 600px or 600 × 800pxJPG or WebPSquare or portrait. Used as collection tile.
Product imageMin 800 × 800pxJPG, PNG, or WebPSquare recommended. White or neutral background for first image.

CDN URL format

If your images are hosted on Materialogue's DigitalOcean Spaces, the CDN URL follows this structure:

https://materialogue.blr1.cdn.digitaloceanspaces.com/[folder-path]/[filename]

Where:
[folder-path] — the folder within the bucket for your brand (provided by Materialogue)
[filename] — the uploaded file name including extension (e.g. logo.png, hero-1.jpg)

Examples by image type:

brands/[brand-name]/logo.png                       → Brand logo
brands/[brand-name]/hero-1.jpg                     → Hero banner
brands/[brand-name]/collections/[collection].jpg   → Collection cover
brands/[brand-name]/products/[sku-code].jpg        → Product image

Contact the Materialogue team to get upload access to DigitalOcean Spaces for your brand folder.