Supply API Overview

Supply API is a read-only API designed to enhance the accessibility and usability of product information, enabling users to view and filter products. Supply API is designed to support filtering by market requirements such as BREEAM and deviations status, allowing users to suggest the right products based on these standards. 

This API offers the following primary functionality:  

  1. View and Filter Own Products: Wholesalers and distributors can specifically view and filter their own products, providing them with the most relevant data based on their need. 

You can use the Supply API to: 

  • View your own products. (wholesalers/distributers products) 

  • Filter product information based on specific criteria and standards. 

  • Access detailed product data and documents for comparison and compliance purposes. 

Glossary 

Product - a manufactured object. 

ID of the Product ("ProductGuid") - the unique identifier of the product in Cobuilder’s database. It is only given after a product is successfully created in our database.  

Country of distribution ("country") - the market or country where the product is offered in. 

Identifier - a characteristic describing the product’s unique reference numbers in different databases. Identifiers can be: 

  • GTIN number ("gtin") - Global Trade Item Number, a traded product’s identifier, developed by GS1. 

  • GMN number ("gmn") - Global Model Number, a number that identifies the product family or model that the traded product belongs to. 

  • SPN number ("spn") - manufacturer’s article or reference number for this product. 

  • Country-specific identifiers - reference numbers for products in different databases, operating in a limited number of countries. Identifier 1 /nobb number/, 2 /el number/, 3 /nrf number, 4 /pvnr/ 

Construction object ("constructionObjectGuid") - a characteristic describing the product’s general type (f.ex. window). 

Template ("templateGuid") - also called Product Data Template - PDT. Defines attributes for information exchange for a particular Construction object. Prepares the needed attributes for creation of product or requirement. 

Property ("propertyGuid") - a characteristic describing the product’s qualities (f.ex. height). 

Unit ("unitGuid") - unit of measurement (f.ex. millimeter)

How to use Supply API

The Supply API can suit different purposes.

Search Products

The Supply API offers own (wholesalers/distributors products) product search. The API is designed with specific endpoints to cater to this use case.

Demo access:

If the client has demo access subscription, they will be able to get only the first 10 results when calling the endpoint.

Wholesalers Product Search:

Wholesalers and distributors use a separate endpoint to access a search for their products. This search caters to products under their distribution, with filters like:

·       Product name

·       GTIN

·       SPN

·       Expiration status

Also the results might be filtered based on different requirements and their status:

·       DOP requirement

·       SDS requirement

·       BREEAM 2012A20 / 2016Hea02 / 2016A20 / 2012Hea9 / 6Hea02 / 6Mat02