2. Public API Explorer
  3. Product Information

Public API: Product Information

Active
Zurück
Provides various services for requesting product information.

Fetch Complete Information of Products V2

Allows to fetch extensive product information in different formats (existence flag, JSON or HTML). Up to 30 products can be requested in a single call.

POST JSON /portals/api/v2/product/data
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
user User name true john.doe
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
Requests
Description Example
General and product-specific queries.
Content-Type: application/json 
{
  "outputMode": "normal",
  "queries": {
       "product-images": {
        "type": "json",
        "settings": {
            "limit": 5
        }
        },
        "attachments": {
        "type": "json",
        "settings": {
            "hideGroups": true
        }
     }
  },
  "products": [
    {
      "itemNumber": "2186 183",
      "supplierNumber": "WI",
      "queries": {
        "cover": {
          "type": "exists"
        }
      }
    },
    {
      "itemNumber": "2186 183",
      "supplierNumber": "WI",
      "queries": {
      }
    }
  ]
}
Responses
Description Example
200 General and product-specific queries.
Content-Type: application/json 
{
    "success": true,
    "error": false,
    "products": [{
         "productId": "ABC123",
         "supplierNumber": "WI",
         "itemNumber": "2186 183",
         "resolved": true,
         "queries": [
             {
                 "name": "product-images",
                 "error": false,
                 "images": [{
                     "type": "COLORED_IMAGE",
                     "typeName": "Produktbild",
                     "description": null,
                     "filename": "product.png",
                     "iconUrl": "https://oxomi.com/shared-media/epoch/.../oxomi/attachments/other.png",
                     "downloadUrl": "https://oxomi.com/dasd/pd/attachments/.../.../.../product.png",
                     "fingerprint": "ABC123",
                     "fileSize": "189.54 KB",
                     "fileSizeInBytes": 189537
                 }]
             },
             {
                 "name": "attachments",
                 "error": false,
                 "documents": [{
                     "id": "11002077",
                     "name": "Dokument 1",
                     "internalName": "document 1",
                     "brand": "Marke 1",
                     "brandIcon": "http://localhost:9000/assets/images/brand-preview.png",
                     "outdated": false,
                     "previewUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                     "mediumUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                     "pages": [
                         {
                             "pageNumber": 1,
                             "pageName": "1",
                             "previewUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                             "mediumUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg"
                         }
                     ]
                 }]
             },
             {
                "name": "cover",
                "error": false,
                "exists": true
            }
         ]
     },{
         "productId": "ABC124",
         "supplierNumber": "WI",
         "itemNumber": "2186 184",
         "resolved": true,
         "queries": [
             {
                 "name": "product-images",
                 "error": false,
                 "images": [{
                     "type": "COLORED_IMAGE",
                     "typeName": "Produktbild",
                     "description": null,
                     "filename": "product2.png",
                     "iconUrl": "https://oxomi.com/shared-media/epoch/.../oxomi/attachments/other.png",
                     "downloadUrl": "https://oxomi.com/dasd/pd/attachments/.../.../.../product2.png",
                     "fingerprint": "ABC123",
                     "fileSize": "189.54 KB",
                     "fileSizeInBytes": 189537
                 }]
             },
             {
                 "name": "attachments",
                 "error": false,
                 "documents": [{
                     "id": "11002077",
                     "name": "Dokument 2",
                     "internalName": "document 2",
                     "brand": "Marke 1",
                     "brandIcon": "http://localhost:9000/assets/images/brand-preview.png",
                     "outdated": false,
                     "previewUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                     "mediumUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                     "pages": [
                         {
                             "pageNumber": 2,
                             "pageName": "2",
                             "previewUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                             "mediumUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg"
                         }
                     ]
                 }]
             }
         ]
    }]
}
400 Missing parameter or malformed request
Content-Type: application/json 
{
    "success": false,
    "error": true,
    "message": "The parameter {missingParameter} must be filled."
}
401 Authentication required but none provided
Content-Type: application/json
403 Invalid authentication or missing permission
Content-Type: application/json
404 Resource not found
Content-Type: application/json
405 Incorrect request method, e.g. GET instead of POST
Content-Type: application/json
500 Unexpected server-side error
Content-Type: application/json

Fetch Complete Information of Products V1 Deprecated

Allows to fetch extensive product information in different formats (existence flag, JSON or HTML). Up to 30 products can be requested by numbering the parameters itemNumber, supplierNumber or productId upwards.

GET JSON /portals/api/v1/product/data
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
user User name true john.doe
gtin1 Specifies the GTIN of the product to search for. Can be used as an alternative to 'itemNumber1'. false 12345678901231
itemNumber1 Specifies the item number to search for. Required if no 'productId1' is provided. false 2186 183
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
model1 Specifies the model of the product to search for. Can be used as an alternative to 'itemNumber1'. false Model 2186 White
productId1 Specifies the product entity ID to search for. Required if no 'itemNumber1' is provided. false ABC123
queries Specifies the information to fetch for each product. Provide no suffix for JSON Data, suffix '-html' for rendered HTML and '-exists' for a boolean flag. This parameter could be provided multiple times with one parameter-value-pair for each queried information. See Produktdaten for possible values. false attachments-html
queries1 Specifies the information to fetch for a specific product. Provide no suffix for JSON Data, suffix '-html' for rendered HTML and '-exists' for a boolean flag. This parameter could be provided multiple times with one parameter-value-pair for each queried information. false attachments-html
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
supplierNumber1 Specifies the number of the supplier of the product to search for. false WI
Responses
Description Example
200 Images and document pages for multiple products.
Content-Type: application/json 
{
    "success": true,
    "error": false,
    "products": [{
         "productId": "ABC123",
         "supplierNumber": "WI",
         "itemNumber": "2186 183",
         "resolved": true,
         "queries": [
             {
                 "name": "product-images",
                 "error": false,
                 "images": [{
                     "type": "COLORED_IMAGE",
                     "typeName": "Produktbild",
                     "description": null,
                     "filename": "product.png",
                     "iconUrl": "https://oxomi.com/shared-media/epoch/.../oxomi/attachments/other.png",
                     "downloadUrl": "https://oxomi.com/dasd/pd/attachments/.../.../.../product.png",
                     "fingerprint": "ABC123",
                     "fileSize": "189.54 KB",
                     "fileSizeInBytes": 189537
                 }]
             },
             {
                 "name": "attachments",
                 "error": false,
                 "documents": [{
                     "id": "11002077",
                     "name": "Dokument 1",
                     "internalName": "document 1",
                     "brand": "Marke 1",
                     "brandIcon": "http://localhost:9000/assets/images/brand-preview.png",
                     "outdated": false,
                     "previewUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                     "mediumUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                     "pages": [
                         {
                             "pageNumber": 1,
                             "pageName": "1",
                             "previewUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                             "mediumUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg"
                         }
                     ]
                 }]
             }
         ]
     },{
         "productId": "ABC124",
         "supplierNumber": "WI",
         "itemNumber": "2186 184",
         resolved: true,
         "queries": [
             {
                 "name": "product-images",
                 "error": false,
                 "images": [{
                     "type": "COLORED_IMAGE",
                     "typeName": "Produktbild",
                     "description": null,
                     "filename": "product2.png",
                     "iconUrl": "https://oxomi.com/shared-media/epoch/.../oxomi/attachments/other.png",
                     "downloadUrl": "https://oxomi.com/dasd/pd/attachments/.../.../.../product2.png",
                     "fingerprint": "ABC123",
                     "fileSize": "189.54 KB",
                     "fileSizeInBytes": 189537
                 }]
             },
             {
                 "name": "attachments",
                 "error": false,
                 "documents": [{
                     "id": "11002077",
                     "name": "Dokument 2",
                     "internalName": "document 2",
                     "brand": "Marke 1",
                     "brandIcon": "http://localhost:9000/assets/images/brand-preview.png",
                     "outdated": false,
                     "previewUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                     "mediumUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                     "pages": [
                         {
                             "pageNumber": 2,
                             "pageName": "2",
                             "previewUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg",
                             "mediumUrl": "http://localhost:9000/dasd/p/documents/.../.../....jpg"
                         }
                     ]
                 }]
             }
         ]
    }]
}
400 Missing parameter or malformed request
Content-Type: application/json 
{
    "success": false,
    "error": true,
    "message": "The parameter {missingParameter} must be filled."
}
401 Authentication required but none provided
Content-Type: application/json
403 Invalid authentication or missing permission
Content-Type: application/json
404 Resource not found
Content-Type: application/json
405 Incorrect request method, e.g. GET instead of POST
Content-Type: application/json
500 Unexpected server-side error
Content-Type: application/json

Product Availability

Obtains product availability details from manufacturers. Up to 100 items can be requested by numbering the parameters item, quantity and unit upwards.

Documentation

POST JSON /portals/api/v1/products/availability
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
itemNumber1 Item number true 2186 183
mode Mode (cached or live) true live
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
user User name true john.doe
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
quantity1 Item quantity false 500
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
supplierNumber1 Supplier number in the partnership false WI
unit1 Item unit related to the item quantity false PCE
Responses
Description Example
200 Successful response
Content-Type: application/json 
{
  items: [
    {
      "itemNumber": "2186 183",
      "normalizedItemNumber": "2186183",
      "supplierNumber": "WI",
      "requestedQuantity": 500,
      "cached": false,
      "unknownPartner": false,
      "expectedRenewedAvailability": "2022-08-15",
      "unit": "PCE",
      "unitName": "Stück",
      "stock": 1200,
      "stockIndicator": "LOW",
      "stockMessage": "Geringer Bestand: 1.200 Stk",
      "computedStockMessage": "Geringer Bestand: 1.200 Stk",
      "manufacturerStockMessage": "",
      "manufacturingTimeDays": null
    }
  ]
}
400 Missing parameter or malformed request
Content-Type: application/json 
{
    "success": false,
    "error": true,
    "message": "The parameter {missingParameter} must be filled."
}
401 Authentication required but none provided
Content-Type: application/json
403 Invalid authentication or missing permission
Content-Type: application/json
404 Resource not found
Content-Type: application/json
405 Incorrect request method, e.g. GET instead of POST
Content-Type: application/json
500 Unexpected server-side error
Content-Type: application/json

Product Availability

Obtains product availability details from manufacturers. Up to 100 items can be requested.

Documentation

POST XML /portals/api/xml/v1/products/availability
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
mode Mode (cached or live) true live
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
user User name true john.doe
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
Requests
Description Example
Single item
Content-Type: text/xml 
<items>
  <mode>cached</mode>
  <item>
    <itemNumber>2186 183</itemNumber>
    <supplierNumber>WI</supplierNumber>
    <quantity>500</quantity>
    <unit>PCE</unit>
  </item>
</items>
Responses
Description Example
200 Single item
Content-Type: text/xml 
<items>
   <item>
     <itemNumber>2186 183</itemNumber>
     <normalizedItemNumber>2186183</normalizedItemNumber>
     <supplierNumber>WI</supplierNumber>
     <requestedQuantity>500</requestedQuantity>
     <cached>false</cached>
     <unknownPartner>false</unknownPartner>
     <expectedRenewedAvailability>2022-08-15</expectedRenewedAvailability>
     <unit>PCE</unit>
     <unitName>Stück</unitName>
     <stock>1200</stock>
     <stockIndicator>LOW</stockIndicator>
     <stockMessage>Geringer Bestand: 1.200 Stk</stockMessage>
     <computedStockMessage>Geringer Bestand: 1.200 Stk</computedStockMessage>
     <manufacturerStockMessage/>
     <manufacturingTimeDays/>
   </item>
 </items>
400 Missing parameter or malformed request
Content-Type: text/xml 
<result>
    <success>false</success>
    <error>true</error>
    <message>The parameter {missingParameter} must be filled.</message>
</result>
401 Authentication required but none provided
Content-Type: text/xml
403 Invalid authentication or missing permission
Content-Type: text/xml
404 Resource not found
Content-Type: text/xml
405 Incorrect request method, e.g. GET instead of POST
Content-Type: text/xml
500 Unexpected server-side error
Content-Type: text/xml

Resolve GTIN to Product

Resolves a product from a given GTIN13 or GTIN14.

Documentation

GET JSON /portals/api/v1/products/resolve-gtin
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
gtin A valid GTIN13 or GTIN14 that should be resolved to a supplier and item number pair. true 12345678901231
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
user User name true john.doe
filterCountry The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
filterLanguage The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
Responses
Description Example
200 Product resolved
Content-Type: application/json 
{
  "success": true,
  "error": false,
  "resolved": true,
  "supplierNumber": "0815",
  "supplierItemNumber": "PRODUCT-123"
}
200 Product not found
Content-Type: application/json 
{
  "success": true,
  "error": false,
  "resolved": false
}
400 Missing parameter or malformed request
Content-Type: application/json 
{
    "success": false,
    "error": true,
    "message": "The parameter {missingParameter} must be filled."
}
401 Authentication required but none provided
Content-Type: application/json
403 Invalid authentication or missing permission
Content-Type: application/json
404 Resource not found
Content-Type: application/json
405 Incorrect request method, e.g. GET instead of POST
Content-Type: application/json
500 Unexpected server-side error
Content-Type: application/json

Resolve GTIN to Product

Resolves a product from a given GTIN13 or GTIN14.

Documentation

GET XML /portals/api/xml/v1/products/resolve-gtin
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
gtin A valid GTIN13 or GTIN14 that should be resolved to a supplier and item number pair. true 00012345600012
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
user User name true john.doe
filterCountry The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
filterLanguage The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
Responses
Description Example
200 Product resolved
Content-Type: text/xml 
<result>
    <success>true</success>
    <error>false</error>
    <resolved>true</itemFound>
    <supplierNumber>0815</supplierNumber>
    <supplierItemNumber>PRODUCT-123</supplierItemNumber>
</result>
200 Product not found
Content-Type: text/xml 
<result>
    <success>true</success>
    <error>false</error>
    <resolved>false</itemFound>
</result>
400 Missing parameter or malformed request
Content-Type: text/xml 
<result>
    <success>false</success>
    <error>true</error>
    <message>The parameter {missingParameter} must be filled.</message>
</result>
401 Authentication required but none provided
Content-Type: text/xml
403 Invalid authentication or missing permission
Content-Type: text/xml
404 Resource not found
Content-Type: text/xml
405 Incorrect request method, e.g. GET instead of POST
Content-Type: text/xml
500 Unexpected server-side error
Content-Type: text/xml

Synchronize Product Information Graph V2

Provides an API to synchronize / query products which have changed since the last sync in the product information graph for the given portal.

GET JSON /portals/api/v2/products/changed
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
apiToken The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. true KJ9M1HEM2KEVRQS2KQFPO2TRS8
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
syncStart A date and time that indicates, when the sync was started. true 2022-11-23 10:19:42
user User name true john.doe
blocks A comma-separated string deciding which blocks should be included in the response. The PRICES block is only available in selected portals. false CLASSIFICATIONS,FEATURES,PROPERTIES,TEXTS,IMAGES,ATTACHMENTS,PRICES
classificationLabelLanguages The language codes to which classification and feature codes will be translated. No classification labels will be returned if this parameter is not set. false en,de
continuationToken If the query result is too large for one response, this indicates the id of the product where the next query should continue. If the returned value is "-", the query reached the last block of data and no more products are available. false K58LMG8E9SI5PR9LR8NBHMO9K8
filterCountry The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
filterLanguage The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
supplierNumber Specifies the number of the supplier to filter by. false 0815
Responses
Description Example
200 A list of products.
Content-Type: application/json 
{
    "success": true,
    "error": false,
    "products": [
        {
            "id": "VHPKG8BLQEKO58DKT2LEDD55EC",
            "visibleItemNumber": "ST.001.A",
            "itemNumber": "ST.001.A",
            "gtin": "00012345600012",
            "model": "ST 001 A",
            "supplierNumber": "1351",
            "supplierNumbers": ["1351, 1352, 1353"],
            "productGroup": "product_group_code",
            "productGroupName": "product_group_name",
            "lang": "de",
            "countries": ["de", "at"],
            "lifecycle": "ACTIVE",
            "brand": {
                "id": "DIS0LA5ACOU1IC717VV3I614CS",
                "name": "ST Sanitär",
                "slogan": "",
                "mediumImageUrl": "https://oxomi.com/dasd/cv/tenants/12a92bfe3b2034486fd4aead68919f37/tenant-medium/HNO1Q2SULBJG4K7NIA2LCRGQKO.png",
                "manufacturerName": "ST Sanitary Inc",
                "manufacturerPostalAddress": "ST Sanitary, 69 W 14th St, 10011 New York, US",
                "manufacturerElectronicAddress": "st-sanitary@oxomi.local",
                "distributorName": "ST Sanitär Europa GmbH",
                "distributorPostalAddress": "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
                "distributorElectronicAddress": "st-sanitaer-eu@oxomi.local"
            },
            "seriesCode": "ST-CeramX",
            "seriesNormalizedCode": "st-ceramx",
            "seriesName": "ST-CeramX",
            "series": {
                "name": "ST-CeramX",
                "slogan": "",
                "marketingText": "",
                "previewImageUrl": "https://oxomi.com/dasd/cv/series/e92f41b798d4c638b98cb5f85fef056c/series-image-medium/4AIFG0TFLD16CTHA6GCBV97HFO.jpg",
                "mediumImageUrl": "https://oxomi.com/dasd/p/series/bc6dcf5b301b36734563223c67d5252b/4AIFG0TFLD16CTHA6GCBV97HFO/7N58C0OMOMTP5BM74AKJ34BEH8.jpg"
            },
            "shortText": "Halbeinbauwaschtisch weiß mit Tisch schwarz",
            "type": "PRODUCT",
            "variantGroup": "WT3690",
            "variantPriority": 100,
            "variantMaster": {
                "filename": "WT3690.png",
                "description": "",
                "previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "previewIsVariantImage": true
            },
            "classifications": [
                {
                    "classificationSystem": "ETIM-9",
                    "classificationCode": "EC011550",
                    "groupCode": "EG017110",
                    "labels": {
                        "classificationCode": {
                            "de": "Waschbecken",
                            "en": "Washbasin"
                        },
                        "groupCode": {
                            "de": "Sanitärkeramiken",
                            "en": "(Wastewater) reception devices"
                        }
                    }
                },
                {
                    "classificationSystem": "CUSTOM",
                    "classificationCode": "-"
                }
            ],
            "features": [
                {
                    "classificationSystem": "CUSTOM",
                    "code": "Made-To-Order",
                    "value": "false",
                    "value2": null,
                    "unit": null
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF002169",
                    "value": "EV000572",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": null,
                    "labels": {
                        "code": {
                            "de": "Werkstoff",
                            "en": "Material"
                        },
                        "value": {
                            "de": "Keramik",
                            "en": "Ceramics"
                        }
                    }
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF020348",
                    "value": "true",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": null,
                    "labels": {
                        "code": {
                            "de": "Mit Überlauf",
                            "en": "With overflow"
                        },
                        "value": {
                            "de": "Ja",
                            "en": "Yes"
                        }
                    }
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF020710",
                    "value": "4",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": "EU570448",
                    "labels": {
                        "code": {
                            "de": "Durchmesser Ablaufloch",
                            "en": "Diameter of drain hole"
                        },
                        "effectiveUnit": {
                            "de": "mm",
                            "en": "mm"
                        }
                    }
                }
            ],
            "properties": [
                {
                    "code": "COUNTRY_OF_ORIGIN",
                    "value": "de",
                    "value2": null
                }
            ],
            "texts": [
                {
                    "type": "DESCRIPTION",
                    "lang": "de",
                    "textOriginal": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
                }
            ],
            "images": [
                {
                    "type": "COLORED_IMAGE",
                    "filename": "item_thumbnail_large.jpg",
                    "priority": 1,
                    "previewImageUrl": "https://oxomi.com/dasd/cv/attachments/d36c132820dc57343fa350a9c2836cc3/product-image-preview/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
                    "mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/ff54d388b2af51ff9869be6dcd24f2f0/product-image-medium/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
                    "hdImageUrl": "https://oxomi.com/dasd/cv/attachments/2d946a64f7d6fc6ba359e269a5c5c260/product-image-hd/J4DGE7N3OQQIT64MGU542OE2CG.jpg"
                }
            ],
            "attachments": [
                {
                    "type": "BROCHURE",
                    "filename": "external_file.pdf",
                    "url": "https://example.com/external_file.pdf"
                },
                {
                    "type": "INSTALLATION_MANUAL",
                    "filename": "installation_manual.pdf",
                    "url": "https://oxomi.com/dasd/pd/attachments/12e1d4314c3afe29e750b72c8c3e9b63/M119BM49VBK9A2I2Q2FGC7MV34/FQ2KDGARVFKADDOE79RN04ADU0/katalog_as_arbeitsschutz_en.pdf"
                }
            ],
            "pricing": {
                "discountGroup": "discount_group_code",
                "bonusGroup": "bonus_group_code",
                "prices": [
                    {
                        "type": "LIST_EXCL_VAT",
                        "amount": "15.00",
                        "currency": "EUR",
                        "priceLine": null,
                        "lowerBound": 1,
                        "validFrom": "2024-01-01",
                        "validUntil": null
                    },
                    {
                        "type": "RRP_INCL_VAT",
                        "amount": "39.99",
                        "currency": "EUR",
                        "priceLine": null,
                        "lowerBound": 1,
                        "validFrom": "2024-01-01",
                        "validUntil": null
                    }
                ]
            }
        }
    ],
    "continuationToken": "-"
}
Download Schema
400 Missing parameter or malformed request
Content-Type: application/json 
{
    "success": false,
    "error": true,
    "message": "The parameter {missingParameter} must be filled."
}
401 Authentication required but none provided
Content-Type: application/json
403 Invalid authentication or missing permission
Content-Type: application/json
404 Resource not found
Content-Type: application/json
405 Incorrect request method, e.g. GET instead of POST
Content-Type: application/json
500 Unexpected server-side error
Content-Type: application/json

Synchronize Product Information Graph V1 Deprecated

Provides an API to synchronize / query products which have changed since the last sync in the product information graph for the given portal.

GET JSON /portals/api/v1/products/changed
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
apiToken The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. true KJ9M1HEM2KEVRQS2KQFPO2TRS8
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
syncStart A date and time that indicates, when the sync was started. true 2022-11-23 10:19:42
user User name true john.doe
blocks A comma-separated string deciding which blocks should be included in the response. false CLASSIFICATIONS,FEATURES,PROPERTIES,TEXTS,IMAGES,ATTACHMENTS
classificationLabelLanguages The language codes to which classification and feature codes will be translated. No classification labels will be returned if this parameter is not set. false en,de
continuationToken If the query result is too large for one response, this indicates the id of the product where the next query should continue. If the returned value is "-", the query reached the last block of data and no more products are available. false K58LMG8E9SI5PR9LR8NBHMO9K8
filterCountry The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
filterLanguage The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
supplierNumber Specifies the number of the supplier to filter by. false 0815
Responses
Description Example
200 A list of products.
Content-Type: application/json 
{
    "success": true,
    "error": false,
    "products": [
        {
            "id": "VHPKG8BLQEKO58DKT2LEDD55EC",
            "visibleItemNumber": "ST.001.A",
            "itemNumber": "ST.001.A",
            "gtin": "00012345600012",
            "model": "ST 001 A",
            "supplierNumber": "1351",
            "lang": "de",
            "countries": ["de", "at"],
            "lifecycle": "ACTIVE",
            "brand": {
                "id": "DIS0LA5ACOU1IC717VV3I614CS",
                "name": "ST Sanitär",
                "slogan": "",
                "mediumImageUrl": "https://oxomi.com/dasd/cv/tenants/12a92bfe3b2034486fd4aead68919f37/tenant-medium/HNO1Q2SULBJG4K7NIA2LCRGQKO.png",
                "manufacturerName": "ST Sanitary Inc",
                "manufacturerPostalAddress": "ST Sanitary, 69 W 14th St, 10011 New York, US",
                "manufacturerElectronicAddress": "st-sanitary@oxomi.local",
                "distributorName": "ST Sanitär Europa GmbH",
                "distributorPostalAddress": "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
                "distributorElectronicAddress": "st-sanitaer-eu@oxomi.local"
            },
            "seriesCode": "ST-CeramX",
            "seriesNormalizedCode": "st-ceramx",
            "seriesName": "ST-CeramX",
            "series": {
                "name": "ST-CeramX",
                "slogan": "",
                "marketingText": "",
                "previewImageUrl": "https://oxomi.com/dasd/cv/series/e92f41b798d4c638b98cb5f85fef056c/series-image-medium/4AIFG0TFLD16CTHA6GCBV97HFO.jpg",
                "mediumImageUrl": "https://oxomi.com/dasd/p/series/bc6dcf5b301b36734563223c67d5252b/4AIFG0TFLD16CTHA6GCBV97HFO/7N58C0OMOMTP5BM74AKJ34BEH8.jpg"
            },
            "shortText": "Halbeinbauwaschtisch weiß mit Tisch schwarz",
            "type": "PRODUCT",
            "variantGroup": "WT3690",
            "variantPriority": 100,
            "variantMaster": {
                "filename": "WT3690.png",
                "description": "",
                "previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "previewIsVariantImage": true
            },
            "classifications": [
                {
                    "classificationSystem": "ETIM-9",
                    "classificationCode": "EC011550",
                    "groupCode": "EG017110",
                    "labels": {
                        "classificationCode": {
                            "de": "Waschbecken",
                            "en": "Washbasin"
                        },
                        "groupCode": {
                            "de": "Sanitärkeramiken",
                            "en": "(Wastewater) reception devices"
                        }
                    }
                },
                {
                    "classificationSystem": "CUSTOM",
                    "classificationCode": "-"
                }
            ],
            "features": [
                {
                    "classificationSystem": "CUSTOM",
                    "code": "Made-To-Order",
                    "value": "false",
                    "value2": null,
                    "unit": null
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF002169",
                    "value": "EV000572",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": null,
                    "labels": {
                        "code": {
                            "de": "Werkstoff",
                            "en": "Material"
                        },
                        "value": {
                            "de": "Keramik",
                            "en": "Ceramics"
                        }
                    }
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF020348",
                    "value": "true",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": null,
                    "labels": {
                        "code": {
                            "de": "Mit Überlauf",
                            "en": "With overflow"
                        },
                        "value": {
                            "de": "Ja",
                            "en": "Yes"
                        }
                    }
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF020710",
                    "value": "4",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": "EU570448",
                    "labels": {
                        "code": {
                            "de": "Durchmesser Ablaufloch",
                            "en": "Diameter of drain hole"
                        },
                        "effectiveUnit": {
                            "de": "mm",
                            "en": "mm"
                        }
                    }
                }
            ],
            "properties": [
                {
                    "code": "COUNTRY_OF_ORIGIN",
                    "value": "de",
                    "value2": null
                }
            ],
            "texts": [
                {
                    "type": "DESCRIPTION",
                    "lang": "de",
                    "textOriginal": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
                }
            ],
            "image": [
                {
                    "type": "COLORED_IMAGE",
                    "filename": "item_thumbnail_large.jpg",
                    "priority": 1,
                    "previewImageUrl": "https://oxomi.com/dasd/cv/attachments/d36c132820dc57343fa350a9c2836cc3/product-image-preview/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
                    "mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/ff54d388b2af51ff9869be6dcd24f2f0/product-image-medium/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
                    "hdImageUrl": "https://oxomi.com/dasd/cv/attachments/2d946a64f7d6fc6ba359e269a5c5c260/product-image-hd/J4DGE7N3OQQIT64MGU542OE2CG.jpg"
                }
            ],
            "attachments": [
                {
                    "type": "BROCHURE",
                    "filename": "external_file.pdf",
                    "url": "https://example.com/external_file.pdf"
                },
                {
                    "type": "INSTALLATION_MANUAL",
                    "filename": "installation_manual.pdf",
                    "url": "https://oxomi.com/dasd/pd/attachments/12e1d4314c3afe29e750b72c8c3e9b63/M119BM49VBK9A2I2Q2FGC7MV34/FQ2KDGARVFKADDOE79RN04ADU0/katalog_as_arbeitsschutz_en.pdf"
                }
            ]
        }
    ],
    "continuationToken": "-"
}
400 Missing parameter or malformed request
Content-Type: application/json 
{
    "success": false,
    "error": true,
    "message": "The parameter {missingParameter} must be filled."
}
401 Authentication required but none provided
Content-Type: application/json
403 Invalid authentication or missing permission
Content-Type: application/json
404 Resource not found
Content-Type: application/json
405 Incorrect request method, e.g. GET instead of POST
Content-Type: application/json
500 Unexpected server-side error
Content-Type: application/json

Fetch individual products in SPX (formerly SCAT) format V2

With the provided itemNumber and/or GTIN.

GET JSON /portals/api/v2/products/spx
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
apiToken The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. true KJ9M1HEM2KEVRQS2KQFPO2TRS8
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
user User name true john.doe
blocks A comma-separated string deciding which blocks should be included in the response. The PRICES block is only available in selected portals. false CLASSIFICATIONS,FEATURES,PROPERTIES,TEXTS,IMAGES,ATTACHMENTS,PRICES
classificationLabelLanguages The language codes to which classification and feature codes will be translated. No classification labels will be returned if this parameter is not set. false en,de
filterCountry The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
filterLanguage The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
gtin Specifies the GTIN to filter by. Required if no 'itemNumber' is provided. false 00012345600012
itemNumber Specifies the item number to filter by. Required if no 'gtin' is provided. false ST.001.A
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
supplierNumber Specifies the number of the supplier to filter by. false 0815
Responses
Description Example
200 A list of products.
Content-Type: application/json 
{
    "success": true,
    "error": false,
    "products": [
        {
            "id": "VHPKG8BLQEKO58DKT2LEDD55EC",
            "visibleItemNumber": "ST.001.A",
            "itemNumber": "ST.001.A",
            "gtin": "00012345600012",
            "model": "ST 001 A",
            "supplierNumber": "1351",
            "supplierNumbers": ["1351, 1352, 1353"],
            "productGroup": "product_group_code",
            "productGroupName": "product_group_name",
            "lang": "de",
            "countries": ["de", "at"],
            "lifecycle": "ACTIVE",
            "brand": {
                "id": "DIS0LA5ACOU1IC717VV3I614CS",
                "name": "ST Sanitär",
                "slogan": "",
                "mediumImageUrl": "https://oxomi.com/dasd/cv/tenants/12a92bfe3b2034486fd4aead68919f37/tenant-medium/HNO1Q2SULBJG4K7NIA2LCRGQKO.png",
                "manufacturerName": "ST Sanitary Inc",
                "manufacturerPostalAddress": "ST Sanitary, 69 W 14th St, 10011 New York, US",
                "manufacturerElectronicAddress": "st-sanitary@oxomi.local",
                "distributorName": "ST Sanitär Europa GmbH",
                "distributorPostalAddress": "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
                "distributorElectronicAddress": "st-sanitaer-eu@oxomi.local"
            },
            "seriesCode": "ST-CeramX",
            "seriesNormalizedCode": "st-ceramx",
            "seriesName": "ST-CeramX",
            "series": {
                "name": "ST-CeramX",
                "slogan": "",
                "marketingText": "",
                "previewImageUrl": "https://oxomi.com/dasd/cv/series/e92f41b798d4c638b98cb5f85fef056c/series-image-medium/4AIFG0TFLD16CTHA6GCBV97HFO.jpg",
                "mediumImageUrl": "https://oxomi.com/dasd/p/series/bc6dcf5b301b36734563223c67d5252b/4AIFG0TFLD16CTHA6GCBV97HFO/7N58C0OMOMTP5BM74AKJ34BEH8.jpg"
            },
            "shortText": "Halbeinbauwaschtisch weiß mit Tisch schwarz",
            "type": "PRODUCT",
            "variantGroup": "WT3690",
            "variantPriority": 100,
            "variantMaster": {
                "filename": "WT3690.png",
                "description": "",
                "previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "previewIsVariantImage": true
            },
            "classifications": [
                {
                    "classificationSystem": "ETIM-9",
                    "classificationCode": "EC011550",
                    "groupCode": "EG017110",
                    "labels": {
                        "classificationCode": {
                            "de": "Waschbecken",
                            "en": "Washbasin"
                        },
                        "groupCode": {
                            "de": "Sanitärkeramiken",
                            "en": "(Wastewater) reception devices"
                        }
                    }
                },
                {
                    "classificationSystem": "CUSTOM",
                    "classificationCode": "-"
                }
            ],
            "features": [
                {
                    "classificationSystem": "CUSTOM",
                    "code": "Made-To-Order",
                    "value": "false",
                    "value2": null,
                    "unit": null
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF002169",
                    "value": "EV000572",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": null,
                    "labels": {
                        "code": {
                            "de": "Werkstoff",
                            "en": "Material"
                        },
                        "value": {
                            "de": "Keramik",
                            "en": "Ceramics"
                        }
                    }
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF020348",
                    "value": "true",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": null,
                    "labels": {
                        "code": {
                            "de": "Mit Überlauf",
                            "en": "With overflow"
                        },
                        "value": {
                            "de": "Ja",
                            "en": "Yes"
                        }
                    }
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF020710",
                    "value": "4",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": "EU570448",
                    "labels": {
                        "code": {
                            "de": "Durchmesser Ablaufloch",
                            "en": "Diameter of drain hole"
                        },
                        "effectiveUnit": {
                            "de": "mm",
                            "en": "mm"
                        }
                    }
                }
            ],
            "properties": [
                {
                    "code": "COUNTRY_OF_ORIGIN",
                    "value": "de",
                    "value2": null
                }
            ],
            "texts": [
                {
                    "type": "DESCRIPTION",
                    "lang": "de",
                    "textOriginal": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
                }
            ],
            "images": [
                {
                    "type": "COLORED_IMAGE",
                    "filename": "item_thumbnail_large.jpg",
                    "priority": 1,
                    "previewImageUrl": "https://oxomi.com/dasd/cv/attachments/d36c132820dc57343fa350a9c2836cc3/product-image-preview/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
                    "mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/ff54d388b2af51ff9869be6dcd24f2f0/product-image-medium/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
                    "hdImageUrl": "https://oxomi.com/dasd/cv/attachments/2d946a64f7d6fc6ba359e269a5c5c260/product-image-hd/J4DGE7N3OQQIT64MGU542OE2CG.jpg"
                }
            ],
            "attachments": [
                {
                    "type": "BROCHURE",
                    "filename": "external_file.pdf",
                    "url": "https://example.com/external_file.pdf"
                },
                {
                    "type": "INSTALLATION_MANUAL",
                    "filename": "installation_manual.pdf",
                    "url": "https://oxomi.com/dasd/pd/attachments/12e1d4314c3afe29e750b72c8c3e9b63/M119BM49VBK9A2I2Q2FGC7MV34/FQ2KDGARVFKADDOE79RN04ADU0/katalog_as_arbeitsschutz_en.pdf"
                }
            ],
            "pricing": {
                "discountGroup": "discount_group_code",
                "bonusGroup": "bonus_group_code",
                "prices": [
                    {
                        "type": "LIST_EXCL_VAT",
                        "amount": "15.00",
                        "currency": "EUR",
                        "priceLine": null,
                        "lowerBound": 1,
                        "validFrom": "2024-01-01",
                        "validUntil": null
                    },
                    {
                        "type": "RRP_INCL_VAT",
                        "amount": "39.99",
                        "currency": "EUR",
                        "priceLine": null,
                        "lowerBound": 1,
                        "validFrom": "2024-01-01",
                        "validUntil": null
                    }
                ]
            }
        }
    ],
    "continuationToken": "-"
}
Download Schema
400 Missing parameter or malformed request
Content-Type: application/json 
{
    "success": false,
    "error": true,
    "message": "The parameter {missingParameter} must be filled."
}
401 Authentication required but none provided
Content-Type: application/json
403 Invalid authentication or missing permission
Content-Type: application/json
404 Resource not found
Content-Type: application/json
405 Incorrect request method, e.g. GET instead of POST
Content-Type: application/json
500 Unexpected server-side error
Content-Type: application/json

Fetch individual products in SPX (formerly SCAT) format V1 Deprecated

With the provided itemNumber and/or GTIN.

GET JSON /portals/api/v1/products/scat
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
apiToken The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. true KJ9M1HEM2KEVRQS2KQFPO2TRS8
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
user User name true john.doe
blocks A comma-separated string deciding which blocks should be included in the response. false CLASSIFICATIONS,FEATURES,PROPERTIES,TEXTS,IMAGES,ATTACHMENTS
classificationLabelLanguages The language codes to which classification and feature codes will be translated. No classification labels will be returned if this parameter is not set. false en,de
filterCountry The country to filter by. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
filterLanguage The language to filter by in case of multi language portals. Provide a two-letter ISO code. Note that internationalisation is a paid feature that needs to be purchased and enabled separately. false de
gtin Specifies the GTIN to filter by. Required if no 'itemNumber' is provided. false 00012345600012
itemNumber Specifies the item number to filter by. Required if no 'gtin' is provided. false ST.001.A
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
supplierNumber Specifies the number of the supplier to filter by. false 0815
Responses
Description Example
200 A list of products.
Content-Type: application/json 
{
    "success": true,
    "error": false,
    "products": [
        {
            "id": "VHPKG8BLQEKO58DKT2LEDD55EC",
            "visibleItemNumber": "ST.001.A",
            "itemNumber": "ST.001.A",
            "gtin": "00012345600012",
            "model": "ST 001 A",
            "supplierNumber": "1351",
            "lang": "de",
            "countries": ["de", "at"],
            "lifecycle": "ACTIVE",
            "brand": {
                "id": "DIS0LA5ACOU1IC717VV3I614CS",
                "name": "ST Sanitär",
                "slogan": "",
                "mediumImageUrl": "https://oxomi.com/dasd/cv/tenants/12a92bfe3b2034486fd4aead68919f37/tenant-medium/HNO1Q2SULBJG4K7NIA2LCRGQKO.png",
                "manufacturerName": "ST Sanitary Inc",
                "manufacturerPostalAddress": "ST Sanitary, 69 W 14th St, 10011 New York, US",
                "manufacturerElectronicAddress": "st-sanitary@oxomi.local",
                "distributorName": "ST Sanitär Europa GmbH",
                "distributorPostalAddress": "ST Sanitär, Sanitärstrasse 1, 73630 Remshalden, GERMANY",
                "distributorElectronicAddress": "st-sanitaer-eu@oxomi.local"
            },
            "seriesCode": "ST-CeramX",
            "seriesNormalizedCode": "st-ceramx",
            "seriesName": "ST-CeramX",
            "series": {
                "name": "ST-CeramX",
                "slogan": "",
                "marketingText": "",
                "previewImageUrl": "https://oxomi.com/dasd/cv/series/e92f41b798d4c638b98cb5f85fef056c/series-image-medium/4AIFG0TFLD16CTHA6GCBV97HFO.jpg",
                "mediumImageUrl": "https://oxomi.com/dasd/p/series/bc6dcf5b301b36734563223c67d5252b/4AIFG0TFLD16CTHA6GCBV97HFO/7N58C0OMOMTP5BM74AKJ34BEH8.jpg"
            },
            "shortText": "Halbeinbauwaschtisch weiß mit Tisch schwarz",
            "type": "PRODUCT",
            "variantGroup": "WT3690",
            "variantPriority": 100,
            "variantMaster": {
                "filename": "WT3690.png",
                "description": "",
                "previewImageUrl": "https://oxomi.com/dasd/cv/attachments/709ca1f160f101961dd1f4707063439d/product-image-preview/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/2fed30507966c3d484a6a345c1373f61/product-image-medium/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "hdImageUrl": "https://oxomi.com/dasd/cv/attachments/b0dc3031cfbd17b829573a5c59a4a8d9/product-image-hd/JCBACKBR3GL10V95SFNSMC75U8.jpg",
                "previewIsVariantImage": true
            },
            "classifications": [
                {
                    "classificationSystem": "ETIM-9",
                    "classificationCode": "EC011550",
                    "groupCode": "EG017110",
                    "labels": {
                        "classificationCode": {
                            "de": "Waschbecken",
                            "en": "Washbasin"
                        },
                        "groupCode": {
                            "de": "Sanitärkeramiken",
                            "en": "(Wastewater) reception devices"
                        }
                    }
                },
                {
                    "classificationSystem": "CUSTOM",
                    "classificationCode": "-"
                }
            ],
            "features": [
                {
                    "classificationSystem": "CUSTOM",
                    "code": "Made-To-Order",
                    "value": "false",
                    "value2": null,
                    "unit": null
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF002169",
                    "value": "EV000572",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": null,
                    "labels": {
                        "code": {
                            "de": "Werkstoff",
                            "en": "Material"
                        },
                        "value": {
                            "de": "Keramik",
                            "en": "Ceramics"
                        }
                    }
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF020348",
                    "value": "true",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": null,
                    "labels": {
                        "code": {
                            "de": "Mit Überlauf",
                            "en": "With overflow"
                        },
                        "value": {
                            "de": "Ja",
                            "en": "Yes"
                        }
                    }
                },
                {
                    "classificationSystem": "ETIM-9",
                    "code": "EF020710",
                    "value": "4",
                    "value2": null,
                    "unit": null,
                    "effectiveUnit": "EU570448",
                    "labels": {
                        "code": {
                            "de": "Durchmesser Ablaufloch",
                            "en": "Diameter of drain hole"
                        },
                        "effectiveUnit": {
                            "de": "mm",
                            "en": "mm"
                        }
                    }
                }
            ],
            "properties": [
                {
                    "code": "COUNTRY_OF_ORIGIN",
                    "value": "de",
                    "value2": null
                }
            ],
            "texts": [
                {
                    "type": "DESCRIPTION",
                    "lang": "de",
                    "textOriginal": "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
                }
            ],
            "image": [
                {
                    "type": "COLORED_IMAGE",
                    "filename": "item_thumbnail_large.jpg",
                    "priority": 1,
                    "previewImageUrl": "https://oxomi.com/dasd/cv/attachments/d36c132820dc57343fa350a9c2836cc3/product-image-preview/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
                    "mediumImageUrl": "https://oxomi.com/dasd/cv/attachments/ff54d388b2af51ff9869be6dcd24f2f0/product-image-medium/J4DGE7N3OQQIT64MGU542OE2CG.jpg",
                    "hdImageUrl": "https://oxomi.com/dasd/cv/attachments/2d946a64f7d6fc6ba359e269a5c5c260/product-image-hd/J4DGE7N3OQQIT64MGU542OE2CG.jpg"
                }
            ],
            "attachments": [
                {
                    "type": "BROCHURE",
                    "filename": "external_file.pdf",
                    "url": "https://example.com/external_file.pdf"
                },
                {
                    "type": "INSTALLATION_MANUAL",
                    "filename": "installation_manual.pdf",
                    "url": "https://oxomi.com/dasd/pd/attachments/12e1d4314c3afe29e750b72c8c3e9b63/M119BM49VBK9A2I2Q2FGC7MV34/FQ2KDGARVFKADDOE79RN04ADU0/katalog_as_arbeitsschutz_en.pdf"
                }
            ]
        }
    ],
    "continuationToken": "-"
}
400 Missing parameter or malformed request
Content-Type: application/json 
{
    "success": false,
    "error": true,
    "message": "The parameter {missingParameter} must be filled."
}
401 Authentication required but none provided
Content-Type: application/json
403 Invalid authentication or missing permission
Content-Type: application/json
404 Resource not found
Content-Type: application/json
405 Incorrect request method, e.g. GET instead of POST
Content-Type: application/json
500 Unexpected server-side error
Content-Type: application/json

Synchronize Portal API-Token Date

Provides an API to synchronize the sync date of the provided API key to the given date.

GET JSON /portals/api/v1/core/update-sync-date
Parameters
Name Description Required Example
accessToken Access token for non-public portals. When submitting a user or roles, the respective values need to be considered during the computation of the token. See Authentifizierung for details. true d0765f518ff0cab426dbbd6d467c9967
apiToken The ID of the portal's API-Token to use for this request. The API-Token also needs to be considered during the computation of the access token. See Authentifizierung for details. true KJ9M1HEM2KEVRQS2KQFPO2TRS8
date A date and time to which the sync date of the API key should be set to. true 2022-11-23 10:19:42
portal Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. true 9999999
user User name true john.doe
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. false de
roles Comma-separated list of roles assigned to the user. Can be omitted if roles are not in use, or if the portal is public. false Heating,Electronics,Top-Customer
Responses
Description Example
200 Successful response
Content-Type: application/json 
{
    "success": true,
    "error": false
}
400 Missing parameter or malformed request
Content-Type: application/json 
{
    "success": false,
    "error": true,
    "message": "The parameter {missingParameter} must be filled."
}
401 Authentication required but none provided
Content-Type: application/json
403 Invalid authentication or missing permission
Content-Type: application/json
404 Resource not found
Content-Type: application/json
405 Incorrect request method, e.g. GET instead of POST
Content-Type: application/json
500 Unexpected server-side error
Content-Type: application/json