openapi: 3.0.0 info: title: Product Catalog version: '2.0' contact: name: Contact Us email: distributorapiportal.global@se.com url: 'https://se.com' description: 'The Product Catalog API provides Schneider Electric distributors and partners with the ability to retrieve product offer data. 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.' paths: /products: get: responses: '200': description: Success Response content: application/json: schema: $ref: '#/components/schemas/ProductQueryResult' examples: Example - get ProductList: value: supplierID: '99887766' customerIDType: SPECIFIC customerID: '1122334455' supplierIDType: SPECIFIC products: - identifiers: commercialReference: DC_CR_RRN gtin: '1142344113643' - identifiers: commercialReference: QA_ADA_MAIN_SOURCE1_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_MAIN_DEST1_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_MAIN_DEST2_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_MAIN_DEST3_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_MAIN_DEST4_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_MAIN_DEST5_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_MAIN_DEST6_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_MAIN_DEST7_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_BSL5328_Prod1 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_SOURCE_1 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_DEST_1 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_DEST_2 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_DEST_3 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_DEST_4 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_DEST_5 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_DEST_11 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_DEST_12 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_DEST_13 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_DEST_14 gtin: '163854974' - identifiers: commercialReference: QA_4659_NEW_DEST_15 gtin: '163854974' - identifiers: commercialReference: QA_ADA_BSL5328_Prod3 gtin: '163854974' - identifiers: commercialReference: QA_ADA_SOURCE2_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_DEST2_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_SOURCE5_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_DEST5_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_BSL5328_Prod2 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_11 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_12 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_13 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_14 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_15 gtin: '163854974' - identifiers: commercialReference: QA_ADA_BSL5328_Prod4 gtin: '163854974' - identifiers: commercialReference: QA_ADA_BSL5328_ProdTest1 gtin: '163854974' - identifiers: commercialReference: QA_ADA_SOURCE6_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_DEST6_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_DEST1_23072021 gtin: '163854974' - identifiers: commercialReference: QA_ADA_SOURCE1_23072021 gtin: '163854974' - identifiers: commercialReference: QA_4659_SOURC_1 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_1 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_2 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_3 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_4 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_5 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_21 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_22 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_23 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_24 gtin: '163854974' - identifiers: commercialReference: QA_4659_DES_25 gtin: '163854974' Example - get ProductList changes: value: supplierID: '99887766' customerIDType: SPECIFIC customerID: '1122334455' supplierIDType: SPECIFIC products: - identifiers: gtin: '1142344113643' productReference: DC_CR_RRN delta: NEW - identifiers: gtin: '163854974' productReference: QA_ADA_MAIN_SOURCE1_23072021 delta: NEW - identifiers: gtin: '163854974' productReference: QA_ADA_MAIN_DEST1_23072021 delta: NEW - identifiers: gtin: '1234567879311' productReference: MYNEW_CRID3_TES delta: DELETE - identifiers: gtin: '3606485195452' productReference: BMH1001P12F1A delta: DELETE - identifiers: gtin: '3606485195858' productReference: BMH1001P27F2A delta: DELETE Example - get full ProductData: value: supplierID: '99887766' supplierIDType: specific customerID: '1122334455' customerIDType: specific products: - manufacturer: name: Schneider Electric brand: Schneider Electric identifiers: supplierPID: QA_4659_DES_22 supplierAltPID: QA_4659_DES_22 manufacturerPID: QA_4659_DES_22 gtin: '163854974' branch: - {} descriptions: - lang: eng manufacturerType: QA_4659_DES_22 keywords: [] series: [] short: Test for BSL NRT_BSL4434 logistics: netLength: '23' netWidth: '1815' netHeight: '1850' netDepth: '1852' netWeight: '1907' packingUnits: - packingLevel: '4' bareProductQty: 4 minQty: 2 maxQty: 2 unit: units: PK name: [] length: '23' width: '1815' height: '1850' weight: '1907' customsTariff: - customsNumber: TEST CODE countryOrigin: - TR reach: info: no_data etim: [] substitutions: - details: substitutionGroups: - productReference: QA_AKL_PRODUCT_5969_P1 newQty: 1 ranking: 1 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_1 - productReference: QA_AKL_PRODUCT_5969_P2 newQty: 1 ranking: 2 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_2 - productReference: QA_AKL_PRODUCT_5969_P3 newQty: 1 ranking: 3 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_3 - productReference: QA_AKL_PRODUCT_5969_P4 newQty: 1 ranking: 4 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_4 - productReference: QA_AKL_PRODUCT_5969_P5 newQty: 1 ranking: 5 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_5 - productReference: QA_AKL_PRODUCT_5969_P6 newQty: 1 ranking: 6 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_6 - productReference: QA_AKL_PRODUCT_5969_P7 newQty: 1 ranking: 7 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_7 - productReference: QA_AKL_PRODUCT_5969_P8 newQty: 1 ranking: 8 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_8 - productReference: QA_AKL_PRODUCT_5969_P9 newQty: 1 ranking: 9 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_9 - productReference: QA_AKL_PRODUCT_5969_P10 newQty: 1 ranking: 10 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_10 - productReference: QA_AKL_PRODUCT_5969_P11 newQty: 1 ranking: 11 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_11 - productReference: QA_AKL_PRODUCT_5969_P12 newQty: 1 ranking: 12 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_12 - productReference: QA_AKL_PRODUCT_5969_P13 newQty: 1 ranking: 13 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_13 - productReference: QA_AKL_PRODUCT_5969_P14 newQty: 1 ranking: 14 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_14 - productReference: QA_AKL_PRODUCT_5969_P15 newQty: 1 ranking: 15 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_15 - productReference: QA_AKL_PRODUCT_5969_P16 newQty: 1 ranking: 16 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_16 - productReference: QA_AKL_PRODUCT_5969_P17 newQty: 1 ranking: 17 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_17 - productReference: QA_AKL_PRODUCT_5969_P18 newQty: 1 ranking: 18 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_18 - productReference: QA_AKL_PRODUCT_5969_P19 newQty: 1 ranking: 19 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_19 - productReference: QA_AKL_PRODUCT_5969_P20 newQty: 1 ranking: 20 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_20 - productReference: QA_AKL_PRODUCT_5969_P21 newQty: 1 ranking: 21 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_21 - productReference: QA_AKL_PRODUCT_5969_P22 newQty: 1 ranking: 22 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_22 - productReference: QA_AKL_PRODUCT_5969_P23 newQty: 1 ranking: 23 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_23 - productReference: QA_AKL_PRODUCT_5969_P24 newQty: 1 ranking: 24 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_24 - productReference: QA_AKL_PRODUCT_5969_P25 newQty: 1 ranking: 25 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_25 - productReference: QA_AKL_PRODUCT_5969_P26 newQty: 1 ranking: 26 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_26 - productReference: QA_AKL_PRODUCT_5969_P27 newQty: 1 ranking: 27 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_27 - productReference: QA_AKL_PRODUCT_5969_P28 newQty: 1 ranking: 28 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_28 - productReference: QA_AKL_PRODUCT_5969_P29 newQty: 1 ranking: 29 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_29 - productReference: QA_AKL_PRODUCT_5969_P30 newQty: 1 ranking: 30 replacementTypeDetail: - lang: mac value: QA_SGI_Replacement_Type_Detail_30 oldQty: 5 replacementType: QA_SGI_Replacement_Type ranking: 1 noSubstitutionReason: [] references: [] mimeInfos: - sources: - 'https://eref.se.com/fr/fr/scope/product-pdf/QA_4659_DES_22' designation: [] fileName: [] codeEnum: MD22 type: Product Data Sheet lang: [] - sources: - 'https://eref.se.com/fr/fr/scope/product/QA_4659_DES_22' designation: [] fileName: [] codeEnum: MD04 type: Product Page Link lang: [] sustainability: - lang: fra greenPremiumStatus: QA_ADA_ATS_GreenValBE_frBE energyStar: QA_ADA_QA_ATS_ENERGY_STARVal_frBE declare: QA_ATS_DECLAREValBE_frBE sundahus: QA_ATS_SUNDAHUSValBE_frBE bvb: QA_ATS_BVBValBE_frBE chinaGreenDesignedProduct: false rohsEurFinalStatus: QA_ATS_ROHS_EUR_FINAL_STATUSValBE_frBE rohsEurInScope: false reachRegulation: QA_ATS_REACH_FULL_COMPLIANCE_STATUSValBE_frBE reachComplianceDate: '2022-12-03' reachFreeOfSvhc: false scipNumber: QA_ATS_SCIP_NUMBERValBE_frBE endOfLifeManualAvailability: Pas d'opérations particulières de recyclage requises weee: QA_ATS_WEEEValBE_frBE halogenContentPerformance: QA_ATS_HALOGEN_CONTENT_PERFORMANCE_frBE californiaProposition65: QA_ATS_CALIFORNIA_PROPOSITION_65_frBE durability: QA_ATS_DURABILITYValBE_frBE upgradeability: QA_ATS_UPGRADEABILITYValBE_frBE minimumPercentageOfRecycledPlasticContent: 3000 recyclability: QA_ATS_RECYCLABILITYValBE_frBE takeBack: QA_ATS_TAKE_BACKValBE_frBE sustainablePackaging: true - lang: nld greenPremiumStatus: QA_ADA_ATS_GreenValBE_nlBE energyStar: QA_ADA_QA_ATS_ENERGY_STARVal_nlBE declare: QA_ATS_DECLAREValBE_nlBE sundahus: QA_ATS_SUNDAHUSValBE_nlBE bvb: QA_ATS_BVBValBE_nlBE chinaGreenDesignedProduct: false rohsEurFinalStatus: QA_ATS_ROHS_EUR_FINAL_STATUSValBE_nlBE rohsEurInScope: false reachRegulation: QA_ATS_REACH_FULL_COMPLIANCE_STATUSValBE_nlBE reachComplianceDate: '2022-12-02' reachFreeOfSvhc: false scipNumber: QA_ATS_SCIP_NUMBERValBE_nlBE endOfLifeManualAvailability: Geen specifieke recyclering vereist weee: QA_ATS_WEEEValBE_nlBE halogenContentPerformance: QA_ATS_HALOGEN_CONTENT_PERFORMANCE_nlBE californiaProposition65: QA_ATS_CALIFORNIA_PROPOSITION_65_nlBE durability: QA_ATS_DURABILITYValBE_nlBE upgradeability: QA_ATS_UPGRADEABILITYValBE_nlBE minimumPercentageOfRecycledPlasticContent: 2000 recyclability: QA_ATS_RECYCLABILITYValBE_nlBE takeBack: QA_ATS_TAKE_BACKValBE_nlBE sustainablePackaging: true '400': $ref: '#/components/responses/Common_Oas3_400' '401': $ref: '#/components/responses/Common_Oas3_401' '403': $ref: '#/components/responses/Common_Oas3_403' '404': $ref: '#/components/responses/Common_Oas3_404' '429': $ref: '#/components/responses/Common_Oas3_429' '500': $ref: '#/components/responses/Common_Oas3_500' summary: Get Products description: | This operation returns a list of product data for a specified customer id and supplier id. From the set of optional query parameters, these ones are designed to be used together. Set 1 (to get the changes of your products list) : date-of-reference, change-type Set 2 (to get Product informations): product-reference, product-identifier, etim-version, english-descriptions, data-filtering, mime-filtering If both date-of-reference and product-reference are specified, the query for date-based changes will be performed and product-reference query parameters will be ignored. operationId: get-productList parameters: - in: query name: supplierid required: true schema: type: string example: '99887766' description: 'Product supplier identifier, configured in the Schneider Electric product master system.' - in: query name: supplierid-type required: true schema: type: string default: specific enum: - specific - duns example: specific description: '(DUNS) ID number if available, else (Specific)' - in: query name: customerid required: true schema: type: string example: '1122334455' description: Your Customer identifier (Duns if available) or the one configured in the Schneider Electric product master system (delivered by your Sales contact) - in: query name: customerid-type required: true schema: type: string default: specific enum: - specific - duns example: specific description: '(DUNS) ID number if available, else (Specific)' - in: query name: date-of-reference schema: type: string format: date example: '2021-12-01' description: 'Starting date for any changes made to product data, which is used to query for delta changes.' - in: query name: change-type description: Type of changes of interest since the date-of-reference. schema: type: string enum: - new - update - delete - all default: all - in: query description: 'One or multiple product references, entered as individual query parameters.' name: product-reference schema: type: string example: QA_4659_DES_22 - in: query name: product-identifier description: 'Product reference type, commercial reference or gtin.' schema: type: string default: commercialReference enum: - commercialReference - gtin example: commercialReference - in: query name: etim-version description: 'ETIM version, where ETIM is a standard for classifying product data.' schema: type: string enum: - ETIM-7.0 - ETIM-8.0 - ETIM-9.0 default: ETIM-7.0 example: ETIM-7.0 - in: query name: english-descriptions description: Whether or not English descriptions are included in addition of the local language schema: type: boolean default: false example: false - in: query name: mime-filtering description: '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' schema: type: string enum: - MD01 - MD04 - MD05 - MD14 - MD21 - MD22 - MD36 - MD99 example: MD36 - in: query name: data-filtering description: '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
- 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)
- relationship: all the product relationship (except obsolete substitution)

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
' schema: type: string default: all enum: - all - etim - marketing - logistic-sales - followup - digital-asset-media - relationship - accessories - mandatory - select - spare-part - similar - cross-selling - up-selling - sustainability example: all parameters: [] security: - security: [] servers: - url: 'https://api.qa.se.com/v2/reference-data/product/product-catalog' description: QA/test environment - url: 'https://api.se.com/v2/reference-data/product/product-catalog' description: Production server components: securitySchemes: security: type: oauth2 flows: clientCredentials: tokenUrl: '/token' scopes: {} description: OAuth2 API access token. schemas: ProductQueryResult: type: object description: GET /products result data. title: ProductQueryResult x-examples: {} properties: supplierID: type: string description: 'Product supplier identifier, configured in the Schneider Electric product master system.' supplierIDType: type: string description: 'Product supplier identifier type, configured in the Schneider Electric product master system.' enum: - SPECIFIC - DUNS - specific - duns customerID: type: string description: Your Customer identifier (Duns if available) or the one configured in the Schneider Electric product master system (delivered by your Sales contact) customerIDType: type: string description: Your Customer identifier type (Duns if available) or the one configured in the Schneider Electric product master system (delivered by your Sales contact) enum: - SPECIFIC - DUNS - specific - duns products: type: array description: Product list. items: $ref: '#/components/schemas/Product' required: - supplierID - supplierIDType - customerID - customerIDType Product: type: object description: 'Resource containing all data for an individual product. ' title: Product properties: status: type: object description: | This element classifies a product in terms of its special characteristics. The status type is specified by the `type` field. The value of the element reflects the text description of the special characteristics. If a product cannot be mapped to any of the predefined status types (listed below), `others` must be used. If a product is a discontinued line with expiration date, the value `others` must be set for this field and the field `expiryDate` should hold the expiry date properties: commercialStatus: type: array description: Commercial status of the product items: $ref: '#/components/schemas/localizedString' statusCode: type: string enum: - bargain - core_product - new - new_product - old_product - refurbished - used - others description: |- Related mapped status type based on the commercialStatus attribute and the prededined list of value in BMEcat guideline. If a product commercialSatatus can not be mapped to any of the predefined status types "others" must be used. expirationDate: type: string description: Expiration date of the document format: date validFrom: type: string description: |- Date from when the product should become active. This is useful for central databases, where a supplier might submit the product in advance in order to allocate a branch product number. If the product is not tradable at the time of submission, this date indicates when the product is available for trade required: - commercialStatus - statusCode manufacturer: type: object description: Product manufacturer information properties: name: type: string description: Name of the manufacturer of the product maxLength: 50 brand: type: string description: 'A brand name for a specific product, e.g. Supplier = “Master Company”, Manufacturer = “Miller”, Brand = “Brandy”' maxLength: 50 identifiers: type: object description: |- Product identifiers. For a basic query involving only the required supplier and customer query parameters, the returned data includes fields: commercialReference, gtin For a changes-only query involving optional date-of-reference query parameter, the returned data includes fields: productReference, gtin For a product reference details query involving optional product-reference query parameter, the returned data includes at least these fields: supplierPID, manufacturerPID properties: supplierPID: type: string description: Contains the product number issued by the supplier. It is determining for ordering the product. It identifies the product in the supplier's catalog (commercialReference). maxLength: 32 supplierAltPID: type: string description: Additional (internal) product identifier of the supplier if different to the supplierPID maxLength: 50 manufacturerPID: type: string description: Product ID from the manufacturer (this PID can be the same as the supplierPID) maxLength: 50 commericalReference: type: string description: Product identifier in the Schneider Electric catalog example: DC_CR_RRN productReference: type: string description: Alternative field holding the product identifier in the Schneider Electric catalog example: DC_CR_RRN gtin: type: string description: Indicates the “Global Trade Item Number” according to GS1 maxLength: 14 branch: description: | Many products are traded in several markets that have a central branch database. Some products could possibly exist in several branch databases in a single market. This element allows the supplier to provide one or more branch- and country specific product numbers. NOTE: Only one branch number may be supplied for each country and branch. type: array items: type: object properties: sector: type: string enum: - electrical - HVAC - building - shipbuilding description: The branch or industry where this identifier applies country: $ref: '#/components/schemas/countryList' productNumber: type: number description: Country specific branch number descriptions: type: array description: Products description (according to the language requested) items: type: object properties: lang: $ref: '#/components/schemas/languageList' short: type: string description: 'Short, concise product description' maxLength: 150 veryShort: type: string description: Very short description of a product e.g. for ERP systems or invoices/delivery notes maxLength: 40 long: type: string description: Extensive and detailed product description maxLength: 64000 manufacturerType: type: string description: 'A name for the product which may, in certain circumstances be more widelyknown than the correct product name' maxLength: 50 keywords: type: array description: Keyword that makes it easier to find the product items: type: string maxLength: 50 series: type: array description: 'Indication to which product series, e.g. switch program(s) a product belongs' items: type: string maxLength: 50 remarks: type: array description: B2B bullet points for the product items: type: string maxLength: 100 required: - lang - short - keywords orderDetails: type: object description: Product ordering information properties: orderUnit: $ref: '#/components/schemas/pUnits' contentUnit: $ref: '#/components/schemas/pUnits' noCuPerOu: type: integer description: | Number of content units per order unit of the product. If order unit and content unit are identical, the value is always `1` priceQty: type: integer description: | A multiple of the order unit indicating to which quantity all the specified prices refer to minQty: type: number description: | Minimum order quantity with respect to the order unit. This minimum order quantity is not the same as the minimum quantity in the sub tree of the packing units, even if the numerical value can be the same intervalQty: type: number description: | Number indicating the quantity steps in which the product can be ordered, e.g. `5` This information doesn’t have to be the same to the packing unit in the sub tree packing units, even if the numerical value can be the same required: - orderUnit - contentUnit - noCuPerOu - priceQty - minQty - intervalQty logistics: type: object description: Product logistics details properties: netLength: type: string description: Net length (normally the longest dimension) of the product in reference to one orderUnit. The unit of measurement is given in the same field as of the netLength value. netWidth: type: string description: Net width of the product in reference to one orderUnit. The unit of measurement is given in the same field as of the the netWidth value. netHeight: description: Net height of the product in reference to one orderUnit. The unit of measurement is given in the same field as of the the netHeight value. type: string netDepth: description: Net depth of the product in reference to one orderUnit. The unit of measurement is given in the same field as of the the netDepth value. type: string netVolume: description: Net volume of the product in reference to one orderUnit. The unit of measurement is given in the same field as of the the netVolume value. type: string netWeight: type: string description: 'Net weight of the product in reference to one orderUnit, e.g. cable duct per 1 m. The unit of measurement is given in the same field as of the netWeight value.' packingUnits: type: array description: | Contains information about the different packing units. At a minimum the smallest regular product packing unit has to be supplied items: type: object properties: packingLevel: type: string description: Contains information about the packing level of the packingUnit. minQty: type: number description: | Minimum quantity with respect to the order unit (orderUnit), beginning with this order quantity, the respective packing unit is used. maxQty: type: number description: | Maximum quantity with respect to the order unit (orderUnit), up to this order quantity, the respective packing unit is used. bareProductQty: type: number description: | If the characteristics like “ATS_PACKAGE_{X}_BARE_PRODUCT_QUANTiTY” (where X= 1,2,3,4,5) are associated with the product, “X” will be returned by this attribute. unit: $ref: '#/components/schemas/pUnits' name: type: array description: Name of the packing unit items: $ref: '#/components/schemas/localizedString' length: description: 'Length of the packing unit, normally the longest dimension. The unit of measurement is given in the same field as of the length value.' type: string width: description: Width of the packing unit.The unit of measurement is given in the same field as of the width value. type: string height: description: Depth of the packing unit. The unit of measurement is given in the same field as of the heigth value. type: string volume: description: Volume of the packing unit. The unit of measurement is given in the same field as of the volume value. type: string weight: description: Gross weight of the packing unit. The unit of measurement is given in the same field as of the weight value. type: string gtin: type: string description: GTIN of packing unit maxLength: 14 required: - minQty - maxQty customsTariff: type: array description: Collection of tariffs by country items: type: object properties: customsNumber: type: string description: | Product number for the index of goods of the foreign trade statistics. It matches with the first 8 digits of the code number of the customs tariff of the applicable trade item. Only current custom numbers are allowed (acc. to SOVA master file) maxLength: 60 countryOrigin: type: array description: Collection of tariffs by country items: $ref: '#/components/schemas/countryList' required: - customsNumber required: - customsTariff reach: type: object description: REACH information properties: listDate: type: string format: date description: | Date, on which the product was checked by the manufacturer for REACH If “no data” is delivered in the following `info` the date of the catalog production has to be given here info: type: string description: | Indication, if the product contains a “SVHC = substance of very high concern” in a concentration of more than 0.1 mass percentage (referring to the candidates/substances that were published by ECHA at the previous given date). Possible values: * `true`: contains substances > 0.1 mass percentage. A deeplink to info is mandatory. The indication only refers to the check at the given date and explicitly does not indicate anything about products that were already delivered to the data receiver or about products that will be the delivered in the future (valid is always the indication on the delivery note) * `false`: contains substances < 0.1 mass percentage * `no_data`: REACH info is not yet available for this product enum: - 'true' - 'false' - no_data required: - info etim: type: array description: Contains elements for the classification of products items: type: object properties: version: type: string description: ETIM version number class: type: string description: | Identification code of the ETIM class e.g. `EC001234`; if there is no existing class in the ETIM classification version, `EC000000` is allowed exceptionally. But `EC000000` is not part of the ETIM classification model maxLength: 8 minLength: 8 group: type: string description: Identification code of the ETIM group e.g. `EG001234 maxLength: 8 minLength: 8 className: type: array description: Contains localized class names of the ETIM class items: $ref: '#/components/schemas/localizedString' groupName: type: array description: Contains localized group names of the ETIM group items: $ref: '#/components/schemas/localizedString' features: type: array description: ETIM product features items: type: object properties: id: type: string description: Identification code of the ETIM feature e.g. `EF001234` maxLength: 8 minLength: 8 unit: type: string description: Identification code of the ETIM unit value: type: array description: | Defined feature values according to the ETIM classification: * Number value in case of numeric feature * Array of numeric values in case of range feature where the first number in the collection is the lower value in the range * Boolean value in case of logical feature * String identification code of the ETIM value, e.g. `EV001234` in case of alphanumerical feature items: type: string names: type: array description: Localized names of the ETIM feature and value items: type: object description: Localized name of the ETIM feature and value properties: lang: $ref: '#/components/schemas/languageList' name: type: string description: ETIM feature name maxLength: 250 unitName: type: string description: ETIM unit name maxLength: 250 valueName: type: string description: ETIM feature value name. This is the localized name of the feature value as defined in the model. Only used in case of an alphanumeric feature maxLength: 250 details: type: string description: | Usage * Explanation of the feature characteristics. A manufacturer specific color can be transmitted here: (polar white, magenta, ash-grey, ...) * Explanation why a specific value will not be transmitted maxLength: 250 required: - lang - name required: - features substitutions: type: array description: Describes a substitution group of products items: type: object properties: details: type: object description: Obsolete product substitution is considered as follow-up product in ETIM BMEcat standard properties: substitutionGroups: type: array description: A substitution group contains product(s) which composes it items: type: object properties: productReference: type: string description: New product in the substitution group newQty: type: integer description: Quantity of the new product in the substitution group ranking: type: integer description: Ranking of each substituted product replacementTypeDetail: type: array description: Replace type details informations of a substituted product items: type: object properties: lang: description: The set of languages of this document items: $ref: '#/components/schemas/languageList' value: type: string description: Replace type details value of a substituted product. oldQty: type: integer description: Substitution quantity of old CR replacementType: type: string description: Substitution’s replacement type information will be rendered. ranking: type: integer description: For each substitution ranking information will be rendered. noSubstitutionReason: type: array description: Cannot be substituted information will be displayed items: type: object properties: lang: type: array description: The set of languages of this document items: $ref: '#/components/schemas/languageList' reason: type: string description: Reason of the no substitution. references: type: array description: Describes a relationship to other products items: type: object description: Describes a relationship to another product properties: type: type: string description: | Describes the relationship between the two products. Possible values: * Accessories (accessories): The reference product listed under PROD_ID_TO is an accessory product of the source product. An accessory product is considered to extend the functionality of the source product * Base product (base_product): The reference product listed under PROD_ID_TO is the base product of the source product, thus the base product is an abstract, packing-independent description of the source product * Component part (consists_of): The reference product listed under PROD_ID_TO is a component part of this source product. This type of reference can be used to build up parts lists. Reference is always made from the parent part to the parts it consists of. In order to reference the number of reference parts contained, the attribute "quantity" can be added * Follow-up article (followup): The reference product listed under PROD_ID_TO is the follow-up product to this source product. A follow-up product is defined as a product which has the same purpose and functions as the source product and can be considered a more advanced version of it * Mandatory additional product (mandatory): The reference product listed under PROD_ID_TO is a mandatory additional product which must always be ordered at the same time as the product article. The source product described cannot be ordered alone. If several products are marked "mandatory" they must all be ordered together with the source product * Similar product (similar): The reference product listed under PROD_ID_TO is similar to this source product. A similar product is defined as a product which is similar in purpose and functions to the source product and can possibly be used in its place * Selectable mandatory product (select): The reference product listed under PROD_ID_TO is a selectable additional product. The described reference product cannot be ordered alone. If several products are connected by "select" at least one of the additional products for the source product listed under PROD_ID_TO must be ordered * Spare part (sparepart): The reference product listed under PROD_ID_TO is a spare part for this source product. A spare part is defined as a part of the product that can be replaced separately in the course of maintenance and repair activities * Other reference type (others): This reference type can be used if none of the other reference types adequately describes the relationship between the reference product and the source product enum: - accessories - base_product - consists_of - followup - mandatory - similar - select - sparepart - others qty: type: integer description: Describes how many products are being reference productReference: type: string description: Unique number of the product to which a reference is made maxLength: 80 description: type: array description: Localized description of the reference items: $ref: '#/components/schemas/localizedString' required: - type - productReference pricing: type: object description: Product price and dscount information properties: discountGroup: type: object description: Discount and bonus group information properties: manufacturer: type: string description: | Discount group key of the manufacturer. At least one group of the manufacturer or the supplier has to be specified; also both discount groups can be given. (A list of all included discount groups with factors and possibly descriptions has to be agreed separately.) If there is no fixed discount group (e.g. all products have the same discount): `no_discount_group` If there is no discount group for this product (net price): `net_price` maxLength: 20 supplier: type: string description: | Discount group key of the supplier. At least one group of the supplier or the manufacturer has to be specified; also both discount groups can be given. (A list of all included discount groups with factors and possibly descriptions has to be agreed separately.) If there is no fixed discount group (e.g. all products have the same discount): `no_discount_group` If there is no discount group for this product (net price): `net_price` maxLength: 20 bonusGroup: type: string description: Bonus group key of the supplier. If there is no fixed bonus group the value `no_bonus_group` should be used maxLength: 20 pricesDetails: type: array description: Product price details items: type: object properties: startDate: type: string description: Date for the start of the period of validity format: date endDate: type: string description: Date for the end of the period of validity format: date dailyPrice: type: boolean description: | Is used in the ETIM BMEcat to transmit, that a product has no fixed price (prices on request). In this case `true` has to be transmitted. If products have a fixed price this field is not required. price: type: array description: Product price information items: type: object properties: type: type: string description: | Specifies the type of price: * List price (net_list): (Purchasing) list price excluding sales tax; discountable list (gross) price * Customer price (net_customer): Customer-specific end price excluding sales tax; net purchase price without sales tax * Nonbinding recommended price (nrp): Nonbinding recommended (retail) price; suggested retail price incl. sales tax enum: - net_list - net_customer - nrp amount: type: number description: 'Amount of the price (0.00 is not a valid price, except for products without list price)' currency: type: string description: Currency of the price enum: - ADP - AED - AFA - ALL - ANG - AOK - ARA - ATS - AUD - AWG - BBD - BDT - BEF - BGL - BHD - BIF - BMD - BND - BOB - BRC - BSD - BTN - BUK - BWP - BZD - CAD - CHF - CLF - CLP - CNY - COP - CRC - CZK - CUP - CVE - CYP - DDM - DEM - DJF - DKK - DOP - DZD - ECS - EGP - ESP - ETB - EUR - FIM - FJD - FKP - FRF - GBP - GHC - GIP - GMD - GNF - GRD - GTQ - GWP - GYD - HKD - HNL - HTG - HUF - IDR - IEP - ILS - INR - IQD - IRR - ISK - ITL - JMD - JOD - JPY - KES - KHR - KMF - KPW - KRW - KWD - KYD - LAK - LBP - LKR - LRD - LSL - LUF - LYD - MAD - MGF - MNT - MOP - MRO - MTL - MUR - MVR - MWK - MXP - MYR - MZM - NGN - NIC - NLG - NOK - NPR - NZD - OMR - PAB - PEI - PGK - PHP - PKR - PLZ - PLN - PTE - PYG - QAR - ROL - RWF - SAR - SBD - SCR - SDP - SEK - SGD - SHP - SLL - SKK - SOS - SRG - STD - SUR - SVC - SYP - SZL - THB - TND - TOP - TPE - TRL - TTD - TWD - TZS - UGS - USD - UYP - VEB - VND - VUV - WST - YDD - YER - YUD - ZAR - ZMK - ZRZ - ZWD tax: type: number description: Factor for tax applicable to this price `0.19` (is `19%`) lowQtyLimit: type: integer description: 'Lower quantity limit for graduated prices. The unit for the graduated price limit is the order unit (orderUnit), default value = 1' territories: type: array description: Territories in which the product price is valid items: $ref: '#/components/schemas/countryList' required: - amount - lowQtyLimit required: - price surcharges: type: array description: | Specifies the transmission of surcharge data of a product (e.g. primary materials like copper, brass, WEEE-charge etc.). The surcharge data element can be given multiple times if a product contains several metals. The information about surcharges is country specific and must be defined in detail between a data supplier and a data receiver. Based on these surcharge rules, the necessary fields to be selected, including their combination items: type: object description: Surcharge rule properties: type: type: string description: | If possible, the suggested English values for this element must be used. If there is no value for a required type of surcharge, the data supplier is free to create his own value, preferably also in English. Suggested values for primary materials: * copper * MK copper (= processed copper) * aluminum * lead * silver * brass * gold * platinum Suggested values for other surcharges: * packaging * insurance * dearness * recycling * recycling WEEE * SLRS (recycling fee for luminaires, lamps etc.) * SENS (recycling fee for household appliances or similar) * SWICO (recycling fee for office equipment or similar) * INOBAT (battery recycling) * VOC (Volatile organic compounds) manner: type: string description: | Manner of surcharge base / cumulated. Allowed values: | Code | Meaning | | --------- | ----------------------------------------------------------------------------------- | | base | The value is calculated by the product price | | cumulated | Suitable when an up- or down stroke is already made by an additional surcharge list | enum: - base - cumulated percentage: type: number description: | On the product price, a percentage surcharge is calculated. Example: 0.05 (corresponds to 5%) This must not be given if material weight is specified. If a step size is specified either the surcharge factor or the surcharge price amount must be indicated. priceAmount: type: number description: | On the product price, a surcharge price amount is calculated. Example: 0.02 (corresponds to 2 cents) This must not be given if material weight is specified. If a step size is specified either the surcharge price amount or the surcharge factor must be indicated calculation: type: number description: | Describes if the surcharge that is indicated in 'percentage` must be calculated on base of the gross list price (net_list) or the net price (net_customer respectively gross price ./. discount): 1 = gross price 2 = net price If no value is given, the gross price (1) will be assumed. This only has to be declared if `percentage` is given. enum: - 1 - 2 materialBasis: type: object description: | Material basis must be specified for calculating primary material surcharges. This element is mandatory if a material basis is defined by the data supplier properties: amount: type: number description: | An amount in €/100 kg, basic quotation of the primary material is already included in the price. Example: Flexible cable CU 150€/100kg Medium voltage power cable CU 000€/100kg (respectively another currency depending on the country) weight: type: number description: | Material weight for the surcharge in gram/price reference quantity. This must not be given if step size is specified threshold: type: number description: | Step size as triggering moment for the calculation of the surcharge with surcharge factor or amount. This must not be given if material weight is specified. If this value is indicated, `percentage` or `amount` must be specified shutter: type: number description: | Description at which point the step is triggered 1 = per started 2 = per finished If no value is indicated, finished step (2) will be assumed enum: - 1 - 2 credit: type: number description: | Describes if only a surcharge or a surcharge/credit takes place: 1 = only surcharge 2 = surcharge/credit if no value is indicated, surcharge (1) will be assumed enum: - 1 - 2 table: type: array description: Information about the reference to a sucharge table of a product maxLength: 50 items: $ref: '#/components/schemas/localizedString' required: - pricesDetails mimeInfos: type: array description: Collection of product pictures and documentation items: type: object properties: sources: type: array description: A file name relative to the above root value or a url. The url may be absolute or relative to the root maxItems: 512 items: {} designation: type: array description: Detailed description of the MIME element maxItems: 250 items: $ref: '#/components/schemas/localizedString' fileName: type: array description: The filename of the MIME document maxItems: 100 items: $ref: '#/components/schemas/localizedString' code: type: string enum: - MD01 - MD02 - MD03 - MD04 - MD05 - MD06 - MD07 - MD08 - MD09 - MD10 - MD11 - MD12 - MD13 - MD14 - MD15 - MD16 - MD17 - MD18 - MD19 - MD20 - MD21 - MD22 - MD23 - MD24 - MD25 - MD26 - MD27 - MD28 - MD29 - MD30 - MD31 - MD32 - MD33 - MD34 - MD35 - MD37 - MD38 - MD39 - MD40 - MD41 - MD42 - MD43 - MD44 - MD45 - MD46 - MD47 - MD48 - MD49 - MD50 - MD51 - MD52 - MD53 - MD54 - MD55 - MD56 - MD60 - MD99 description: Describes the kind and usage of the MIME document with one of the allowed MIME codes publicationDate: type: string format: date description: Publication date of the document expirationDate: type: string format: date description: Expiration date of the document type: type: string description: Document type lang: type: array description: The set of languages of this document items: $ref: '#/components/schemas/languageList' version: type: string description: The version of this document codeEnum: type: string description: Mime code Based on the BMEcat 3.1 standard example: MD01 enum: - MD01 - MD02 - MD03 - MD04 - MD05 - MD06 - MD07 - MD08 - MD09 - MD10 - MD11 - MD12 - MD13 - MD14 - MD15 - MD16 - MD17 - MD18 - MD19 - MD20 - MD21 - MD22 - MD23 - MD24 - MD25 - MD26 - MD27 - MD28 - MD29 - MD30 - MD31 - MD32 - MD33 - MD34 - MD35 - MD37 - MD38 - MD39 - MD40 - MD41 - MD42 - MD43 - MD44 - MD45 - MD46 - MD47 - MD48 - MD49 - MD50 - MD51 - MD52 - MD53 - MD54 - MD55 - MD56 - MD60 - MD99 required: - sources sustainability: type: array description: If data filtering is set as 'sustainability' / 'all' then in this tag product's sustainability related information will be rendered. items: type: object properties: lang: description: The set of languages of this document. items: $ref: '#/components/schemas/languageList' greenPremiumStatus: type: string description: For 'ATS_GREEN_PREMIUM_STATUS' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. energyStar: type: string description: For 'ATS_ENERGY_STAR' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. declare: type: string description: For 'ATS_DECLARE' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. cradleToCradle: type: string description: For 'ATS_CRADLE_TO_CRADLE' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. sundahus: type: string description: For 'ATS_SUNDAHUS' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. bvb: type: string description: For 'ATS_BVB' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. chinaGreenDesignedProduct: type: boolean description: 'For ''ATS_CHINA_GREEN_DESIGNED'' characteristics if valuation is present for the corresponding requested supplier country then if valuation id is LOV_YES_NO_EXTERNALLY:1, then it will return true, else if the valuation id is ''LOV_YES_NO_EXTERNALLY:0'' then it will return false.' rohsEurFinalStatus: type: string description: For 'ATS_ROHS_EUR_FINAL_STATUS' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. rohsEurInScope: type: boolean description: 'For ''ATS_ROHS_EUR_IN_SCOPE'' characteristics if valuation is present for the corresponding requested supplier country then if valuation id is LOV_YES_NO_EXTERNALLY:1, then it will return true, else if the valuation id is ''LOV_YES_NO_EXTERNALLY:0'' then it will return false.' reachRegulation: type: string description: For 'ATS_REACH_FULL_COMPLIANCE_STATUS' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. reachComplianceDate: type: string format: date description: For 'ATS_REACH_COMPLIANCE_DATE' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. reachFreeOfSvhc: type: boolean description: 'For ''ATS_REACH_FREE_OF_SVHC'' characteristics if valuation is present for the corresponding requested supplier country then if valuation id is LOV_YES_NO_EXTERNALLY:1, then it will return true, else if the valuation id is ''LOV_YES_NO_EXTERNALLY:0'' then it will return false.' scipNumber: type: string description: For 'ATS_SCIP_NUMBER' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. endOfLifeManualAvailability: type: string description: For 'ATS_END_OF_LIFE_AVAILABILITY' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. weee: type: string description: For 'ATS_WEEE' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. halogenContentPerformance: type: string description: For 'ATS_HALOGEN_CONTENT_PERFORMANCE' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. californiaProposition65: type: string description: For 'ATS_CALIFORNIA_PROPOSITION_65' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. durability: type: string description: For 'ATS_DURABILITY' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. upgradeability: type: string description: For 'ATS_UPGRADEABILITY' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. minimumPercentageOfRecycledPlasticContent: type: number description: For 'ATS_PERCENTAGE_RECYCLED_PLASTIC' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. recyclability: type: string description: For 'ATS_RECYCLABILITY' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. takeBack: type: string description: For 'ATS_TAKE_BACK' characteristics related valuation for the corresponding requested Supplier Country Locale will be rendered. sustainablePackaging: type: boolean description: 'For ''ATS_SUSTAINABLE_PACKAGE'' characteristics if valuation is present for the corresponding requested supplier country then if valuation id is LOV_YES_NO_EXTERNALLY:1, then it will return true, else if the valuation id is ''LOV_YES_NO_EXTERNALLY:0'' then it will return false.' delta: type: string description: Type of change with respect to a changes-only query. enum: - NEW - UPDATE - DELETE languageList: type: string description: 'Define the list of language code for language dependent fields according to ISO 639-2:1998' enum: - aar - abk - ace - ach - ada - afa - afh - afr - aka - akk - alb - ale - alg - amh - ang - apa - ara - arc - arm - arn - arp - art - arw - asm - ath - aus - ava - ave - awa - aym - aze - bad - bai - bak - bal - bam - ban - baq - bas - bat - bej - bel - bem - ben - ber - bho - bih - bik - bin - bis - bla - bnt - bod - bos - bra - bre - btk - bua - bug - bul - bur - cad - cai - car - cat - cau - ceb - cel - ces - cha - chb - che - chg - chi - chk - chm - chn - cho - chp - chr - chu - chv - chy - cmc - cop - cor - cos - cpe - cpf - cpp - cre - crp - cus - cym - cze - dak - dan - day - del - den - deu - dgr - din - div - doi - dra - dua - dum - dut - dyu - dzo - efi - egy - eka - ell - elx - eng - enm - epo - est - eus - ewe - ewo - fan - fao - fas - fat - fij - fin - fiu - fon - fra - fre - frm - fro - fry - ful - fur - gaa - gay - gba - gem - geo - ger - gez - gil - gla - gle - glg - glv - gmh - goh - gon - gor - got - grb - grc - gre - grn - guj - gwi - hai - hau - haw - heb - her - hil - him - hin - hit - hmn - hmo - hrv - hun - hup - hye - iba - ibo - ice - ijo - iku - ile - ilo - ina - inc - ind - ine - ipk - ira - iro - isl - ita - jav - jpn - jpr - jrb - kaa - kab - kac - kal - kam - kan - kar - kas - kat - kau - kaw - kaz - kha - khi - khm - kho - kik - kin - kir - kmb - kok - kom - kon - kor - kos - kpe - kro - kru - kua - kum - kur - kut - lad - lah - lam - lao - lat - lav - lez - lin - lit - lol - loz - ltz - lua - lub - lug - lui - lun - luo - lus - mac - mad - mag - mah - mai - mak - mal - man - mao - map - mar - mas - may - mdr - men - mga - mic - min - mis - mkd - mkh - mlg - mlt - mnc - mni - mno - moh - mol - mon - mos - mri - msa - mul - mun - mus - mwr - mya - myn - nah - nai - nau - nav - nbl - nde - ndo - nds - nep - new - nia - nic - niu - nld - nno - nob - non - nor - nso - nub - nya - nym - nyn - nyo - nzi - oci - oji - ori - orm - osa - oss - ota - oto - paa - pag - pal - pam - pan - pap - pau - peo - per - phi - phn - pli - pol - pon - por - pra - pro - pus - qaa - que - raj - rap - rar - roa - roh - rom - ron - rum - run - rus - sad - sag - sah - sai - sal - sam - san - sas - sat - scc - sco - scr - sel - sem - sga - sgn - shn - sid - sin - sio - sit - sla - slk - slo - slv - sme - smi - smo - sna - snd - snk - sog - som - son - sot - spa - sqi - srd - srp - srr - ssa - ssw - suk - sun - sus - sux - swa - swe - syr - tah - tai - tam - tat - tel - tem - ter - tet - tgk - tgl - tha - tib - tig - tir - tiv - tkl - tli - tmh - tog - ton - tpi - tsi - tsn - tso - tuk - tum - tur - tut - tvl - twi - tyv - uga - uig - ukr - umb - und - urd - uzb - vai - ven - vie - vol - vot - wak - wal - war - was - wel - wen - wol - xho - yao - yap - yid - yor - ypk - zap - zen - zha - zho - znd - zul externalDocs: url: 'https://www.iso.org/obp/ui/#iso:std:iso:639:-2:ed-1:v1:en' title: languageList localizedString: title: localizedString description: 'Localization of language-dependant fields ' type: object properties: lang: $ref: '#/components/schemas/languageList' value: type: string description: Localized field required: - lang - value countryList: type: string description: Define the list of country code according to ISO-3166-1 enum: - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BM - BN - BO - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IN - IO - IQ - IR - IS - IT - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MG - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - ST - SV - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - YU - ZA - ZM - ZW title: countryList example: FR pUnits: title: pUnits type: object properties: units: type: string description: Unit of the pUnits enum: - BE - BG - BO - BX - C62 - CA - CL - CQ - CR - CS - CT - DR - KG - PA - PF - PK - PL - PR - PU - RG - RL - RO - SA - SET - TN - TU - Z2 - Z3 - MTR description: Details of pUnits ErrorResponse: type: object title: Error Response - OAS3 description: Error response returned to the consumer when an HTTP error status has occurred. properties: code: type: string example: MISSING_FIELD or 12345 description: |- Service-defined error code which may be numeric or a string. Errors detected by the APIM platform result in the following codes. BAD_REQUEST (for 400) UNAUTHORIZED (for 401) FORBIDDEN (for 403) NOT_FOUND (for 404) GONE (for 410) PRECONDITION_FAILED (for 412) TOO_MANY_REQUESTS (for 429) INTERNAL_SERVER_ERROR (for 500) NOT_IMPLEMENTED (for 501) Any specific service validation errors would replace BAD_REQUEST. userMessage: type: string example: 'Request is invalid and cannot be processed due one or more issues such as syntax errors, missing required fields, out of range values, conflicting query parameters, or unknown URI.' description: Human-readable general description of the error. developerMessage: type: string description: Optional human-readable description of the error details. example: 'Required field is missing: productSku' moreInfo: type: string description: 'Optional error details or link to error documentation, which has more information about the error.' example: 'https://example.com/product-master/v1/error/12345' responses: Common_Oas3_400: description: 'Request is invalid and cannot be processed due one or more issues such as syntax errors, missing required fields, out of range values, conflicting query parameters, or unknown URI.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: BAD_REQUEST userMessage: 'Request is invalid and cannot be processed due one or more issues such as syntax errors, missing required fields, out of range values, conflicting query parameters, or unknown URI.' developerMessage: Request content is malformed or exceeded structural limits moreInfo: 'https://example.com/error/123' Common_Oas3_401: description: 'The client is not authorized to perform this request because its identity has not yet been established, or the token is invalid or has expired.' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: UNAUTHORIZED userMessage: 'The client is not authorized to perform this request because its identity has not yet been established, or the token is invalid or has expired.' developerMessage: Invalid Access Token moreInfo: 'https://example.com/error/123' Common_Oas3_403: description: The client does not have permission to perform the requested action e.g. POST or DELETE. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: FORBIDDEN userMessage: The client does not have permission to perform the requested action e.g. POST or DELETE. developerMessage: Http verb DELETE is not supported for path suffix /installed-products/track moreInfo: 'https://example.com/error/123' Common_Oas3_404: description: Requested resource does not exist on the server. It is assumed that the URI is valid for this type of resource. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: NOT_FOUND userMessage: Requested resource does not exist on the server. It is assumed that the URI is valid for this type of resource. developerMessage: Records not found moreInfo: 'https://example.com/error/123' Common_Oas3_429: description: Number of requests has exceeded the client's rate limits. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: TOO_MANY_REQUESTS userMessage: Number of requests has exceeded the client’s rate limits. developerMessage: Spike arrest violation moreInfo: 'https://example.com/error/123' Common_Oas3_500: description: Requested operation encountered an unexpected server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Example: value: code: INTERNAL_SERVER_ERROR userMessage: Requested operation encountered an unexpected server error. developerMessage: 'Target service is unavailable, please try again later.' moreInfo: 'https://example.com/error/123'