Products and surface types
Products are the items in your catalog. Each has a type that decides which surfaces in a scene it can go on.
Updated
Your catalog
Products are the items in your workspace’s catalog: fabrics, floors, wallcoverings, countertops, furniture, lights and more. You add them in the app, each with a flat swatch or a clear product image, and the API renders them by id. List all products returns every product your workspace can render, its own and any shared with it.
{
"id": 4410,
"name": "Emerald velvet",
"brand": "Northwind",
"sku": "NW-VEL-104",
"category": "Upholstery fabric",
"type": "furniture",
"material_type": "fabric",
"image_url": "https://…"
}Product types
A product’s type comes from its category, and decides which surfaces it can go on.
| type | Products | Examples |
|---|---|---|
wall | Wall finishes | Wallcoverings, acoustic panels, wall graphics |
floor | Floor finishes | Flooring and wood floors; outdoor pavers, gravel, mulch, pebbles and pool finishes |
counter | Worktop finishes | Countertops, stone, tile |
cabinetry | Cabinet finishes | Cabinet doors and fronts |
furniture | Textiles and upholstery | Upholstery fabrics for sofas and chairs |
furnishing | Furniture pieces | Sofas, tables and chairs placed in the room; plants; freestanding signs |
lighting | Lighting | Light fittings and bulbs |
Surface types
The surfaces found in a scene have one of these types:
| type | Surface |
|---|---|
wall | A wall |
ceiling | A ceiling |
floor | A floor, or outdoors, the ground: a patio, path, bed or pool area |
counter | A countertop or worktop |
cabinetry | Cabinet doors and fronts |
furniture | A sofa, chair, table or other piece in the room |
light_fixture | A light fitting in the picture |
lighting | The room's light as a whole: always scene_lighting |
Which products fit which surfaces
| Surface type | Product types that fit | Takes paint? |
|---|---|---|
wall | wall | Yes |
ceiling | None | Yes |
floor | floor | No |
counter | counter | No |
cabinetry | cabinetry | Yes |
furniture | furniture, furnishing | No |
light_fixture | lighting | No |
lighting | lighting | No |
When a render leaves out surface_id, the product goes on the first surface in the scene’s list that it fits. A render that names a surface the product does not fit is refused, and nothing is charged.
Signage, outdoor and lighting rules
| Products | Rule |
|---|---|
| Outdoor ground cover: pavers, gravel, mulch, pebbles, pools | Go on the ground (floor surfaces), and only in outdoor scenes. |
| Plants | Replace a plant found in the picture, indoors or out. |
| Floor graphics | Go on floors. |
| Wall graphics | Go on walls. |
| Freestanding signs | Replace a piece of furniture in the room. |
| Wall-mounted signs | Cannot be rendered through the API yet. |
| Lighting | Goes on a light fitting found in the picture or, failing that, on scene_lighting to relight the room. |
See Render outdoor scenes for ground cover, and Scene lighting for lights.
Material types
material_type says what a product is made of, and is other when that is not known. Values include fabric, wallcovering, paint, flooring, wood, tile, stone, acoustic, lighting, pavers, gravel, mulch, pebbles, pool, plant, the signage kinds signage_floor, signage_wall_graphic, signage_freestanding and signage_wall_mounted, and other.
Use it for your own sorting and filtering. To decide what can go where, use type, as above.
Product images that render well
No 3D or CAD files are needed. A flat swatch or a clear product image, as JPEG, PNG or WebP, is enough. The preparation guides show what works best for each kind of product, from fabric swatches to pavers.
Something these pages do not answer? Email admin@skipshoot.com and we’ll help.