Product Catalog V2

 

The Product Catalog API provides Schneider Electric distributors and partners with the ability to retrieve product offer data.

This new version has been updated to ETIM-9.0 (International classification standard for technical products).

 

DOWNLOAD SPEC

 

Currently, the API has the capability to:

1- All the products which are in the distributor's scope those products with other necessary information will be returned if we provide supplierid, customerid, supplierid-type, customerid-type in the path params.

2- All the information related to a product will be returned through this API if we call this api with product's commercial reference, supplierid, customerid, supplierid-type, customerid-type in the path params.

3- If we request the API with supplierid, customerid, supplierid-type, customerid-type, date-of-reference, change-type parameters then it will return all the products which are in the distributor's scope and if the product's creation time is greater than the date given in the date-of-reference parameter.

API Access will require oAuth authentication, please refer to the details on portal.

 

 

 

Country Availability Assessment - Catalog of countries where we have conducted performance, availability, and response time testing for this API:

  • Argentina, Australia, Austria, Belgium, Brazil, Bulgaria, Canada, Chile, Colombia, Croatia, Denmark, Ecuador, Estonia, Finland, France, Germany, Greece, Hungary, India, Indonesia, Ireland, Italy, Kazakhstan, Latvia, Lithuania, Mexico, Netherlands, New Zealand, Norway, Peru, Poland, Portugal, Romania, Russia, Serbia, Singapore, Slovenia, Spain, Sweden, Switzerland, Tanzania, Turkey, Ukraine, United Kingdom, United States and Vietnam. 

If your country is not included in the list, please feel free to reach out to us directly or contact your designated Schneider Point of Contact (POC) to inquire about the API's accessibility in your country.  

 

 

 

Get Products

MethodGET
BaseURLhttps://api.se.com/v2/reference-data/product/product-catalog
ResourcePath/products

 

QueryParams:

ParamData-typeMandatoryExampleDescription
supplieridstringY99887766Product supplier identifier, configured in the Schneider Electric product master system.
supplierid-typestringYspecific(DUNS) ID number if available, else (Specific)

Available values: specific, duns
Default value: specific
customeridstringY1122334455Your Customer identifier (Duns if available) or the one configured in the Schneider Electric product master system (delivered by your Sales contact)
customerid-typestringYspecific(DUNS) ID number if available, else (Specific)

Available values: specific, duns
Default value: specific
date-of-referencestringN2021-12-01Starting date for any changes made to product data, which is used to query for delta changes.
change-typestringNallType of changes of interest since the date-of-reference.

Available values: new, update, delete, all
Default value: all
product-referencestringNQA_4659_DES_22One or multiple product references, entered as individual query parameters.
product-identifierstringNcommercialReference

Product reference type, commercial reference or gtin.


Available values: commercialReference, gtin
Default value: commercialReference

etim-versionstringNETIM-9.0

ETIM version, where ETIM is a standard for classifying product data.

Available values: ETIM-7.0, ETIM-8.0, ETIM-9.0
Default value: ETIM-7.0

english-descriptionsbooleanNtrue

Whether or not English descriptions are included in addition of the local language

Default value: false

mime-filteringstringNMD36

In this filter, provide multiple mime descriptor code such as MD01,MD04,MD99,etc. For the requested mime-filter all the doc-types associated with the mime descriptor code will be returned along with the doc-type which are allowed for the respective data-filters. - MD01 for Image of product - MD04 for Product Page Link - MD05 for REACh Declaration - MD14 for User guide - MD14 for System user guide - MD14 for Quick start guide - MD21 for Instruction sheet - MD22 for Product Data Sheet - MD36 for RoHs Declaration / RoHS China Declaration - MD99 for CAD / 3D Model / How to video / Promotional video / 360 set of image / Product environmental / End of life manual / Brochure / Catalog

Available values: MD01, MD04, MD05, MD14, MD21, MD22, MD36, MD99

data-filteringstringNup-selling

Product data filter. By default all data is returned but this allows a specified set of data to be requested. These are the supported values that can be used to return filtered data : all, etim, marketing, logistic-sales, followup, digital-asset-media, relationship, accessories, mandatory, select, spare-part, similar, cross-selling, up-selling

Definition :
all: all data related to the product (this is the default option)
- etim: only ETIM classification, features and valuation data
- marketing: only marketing data such as descriptions, keywords, assets
- logistic-sales: packing units data, ordering and pricing information - followup: only product substitution data
relationship: all the product relationship (except obsolete substitution)
- digital-asset-media: only the mimes part for media assets ( How To Video, Image of product, Image of product in real life situation, Promotional Video)

Note: If using data-filtering = digital-asset-media AND mime-filtering

  • Then the BSL will return all MD codes for digital-asset-media (How To Video, Image of product, Image of product in real life situation, Promotional video) + the MD codes that are not considered by digital-asset-media. 

If you want to return specific Product relationship, these values can be used instead of relationship :
- accessories: optional product accessories
- mandatory: mandatory additional product
- select: selectable additional product that cannot be ordered alone
- spare-part: replacement parts
- similar: Schneider Electric alternative product
- cross-selling: related or complementary items
- up-selling: comparable higher-end product

Available values: all, etim, marketing, logistic-sales, followup, digital-asset-media, relationship, accessories, mandatory, select, spare-part, similar, cross-selling, up-selling
Default value: all

 

 

Product Catalog