2. Public API Explorer
  3. Product Information

Public API: Product Information

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

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 Example
accessToken
Required
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. d0765f518ff0cab426dbbd6d467c9967
portal
Required
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. 9999999
user
Required
User name john.doe
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. 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. 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

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 Example
accessToken
Required
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. d0765f518ff0cab426dbbd6d467c9967
portal
Required
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. 9999999
user
Required
User name john.doe
gtin1 Specifies the GTIN of the product to search for. Can be used as an alternative to 'itemNumber1'. 12345678901231
itemNumber1 Specifies the item number to search for. Required if no 'productId1' is provided. 2186 183
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. de
model1 Specifies the model of the product to search for. Can be used as an alternative to 'itemNumber1'. Model 2186 White
productId1 Specifies the product entity ID to search for. Required if no 'itemNumber1' is provided. 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. 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. 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. Heating,Electronics,Top-Customer
supplierNumber1 Specifies the number of the supplier of the product to search for. 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 Example
accessToken
Required
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. d0765f518ff0cab426dbbd6d467c9967
itemNumber1
Required
Item number 2186 183
mode
Required
Mode (cached or live) live
portal
Required
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. 9999999
user
Required
User name john.doe
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. de
quantity1 Item quantity 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. Heating,Electronics,Top-Customer
supplierNumber1 Supplier number in the partnership WI
unit1 Item unit related to the item quantity 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 Example
accessToken
Required
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. d0765f518ff0cab426dbbd6d467c9967
mode
Required
Mode (cached or live) live
portal
Required
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. 9999999
user
Required
User name john.doe
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. 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. 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 Example
accessToken
Required
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. d0765f518ff0cab426dbbd6d467c9967
gtin
Required
A valid GTIN13 or GTIN14 that should be resolved to a supplier and item number pair. 12345678901231
portal
Required
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. 9999999
user
Required
User name 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. 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. de
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. 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. 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 Example
accessToken
Required
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. d0765f518ff0cab426dbbd6d467c9967
gtin
Required
A valid GTIN13 or GTIN14 that should be resolved to a supplier and item number pair. 00012345600012
portal
Required
Globally unique alpha-numeric code as set up or automatically assigned. Also visible in the respective URL on the Portals page. 9999999
user
Required
User name 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. 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. de
language Language to use for human-readable data. Does not affect content where applicable. Provide a two-letter ISO code. 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. 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